From b2da1b043c4cd6b7140d6373655c03bdaff502ae Mon Sep 17 00:00:00 2001
From: Andrei Litvin <andy314@gmail.com>
Date: Thu, 22 Feb 2024 13:44:16 -0500
Subject: [PATCH] Move CommandSender and PendingResponseTracker to IM. (#32227)

* Move CommandSender and PendingResponseTracker to IM.

Previous location of these files was `app` however this created
apparent circular dependencies for includes.

* Restyle

* CommandSender is now tracked

* Move read and write clients to interactionmodel as well

* Also pull in interactionmodelhelper .... this is a very poorly named file

---------

Co-authored-by: Andrei Litvin <andreilitvin@google.com>
---
 .github/workflows/lint.yml |  4 ----
 src/app/BUILD.gn           | 30 ++++++++++++++++--------------
 src/app/CommandSender.cpp  |  8 +-------
 3 files changed, 17 insertions(+), 25 deletions(-)

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 66405b9e615b6d..69613217033e8b 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -95,14 +95,11 @@ jobs:
                      --known-failure app/att-storage.h \
                      --known-failure app/CommandHandler.h \
                      --known-failure app/CommandHandlerInterface.h \
-                     --known-failure app/CommandSender.h \
                      --known-failure app/CommandSenderLegacyCallback.h \
                      --known-failure app/CompatEnumNames.h \
                      --known-failure app/data-model/ListLargeSystemExtensions.h \
                      --known-failure app/EventHeader.h \
                      --known-failure app/EventLoggingTypes.h \
-                     --known-failure app/InteractionModelHelper.h \
-                     --known-failure app/ReadClient.h \
                      --known-failure app/ReadHandler.h \
                      --known-failure app/ReadPrepareParams.h \
                      --known-failure app/reporting/tests/MockReportScheduler.cpp \
@@ -132,7 +129,6 @@ jobs:
                      --known-failure app/util/odd-sized-integers.h \
                      --known-failure app/util/util.cpp \
                      --known-failure app/util/util.h \
-                     --known-failure app/WriteClient.h \
                      --known-failure app/WriteHandler.h \
                      --known-failure lib/core/CHIPVendorIdentifiers.hpp \
                      --known-failure platform/DeviceSafeQueue.cpp \
diff --git a/src/app/BUILD.gn b/src/app/BUILD.gn
index ec520e005b0d80..f714560afc15cb 100644
--- a/src/app/BUILD.gn
+++ b/src/app/BUILD.gn
@@ -140,16 +140,24 @@ static_library("interaction-model") {
     "CASEClientPool.h",
     "CASESessionManager.cpp",
     "CASESessionManager.h",
+    "CommandSender.cpp",
+    "CommandSender.h",
     "DeviceProxy.cpp",
     "DeviceProxy.h",
     "InteractionModelDelegatePointers.cpp",
     "InteractionModelDelegatePointers.h",
     "InteractionModelEngine.cpp",
     "InteractionModelEngine.h",
+    "InteractionModelHelper.h",
     "InteractionModelTimeout.h",
     "OperationalSessionSetup.cpp",
     "OperationalSessionSetup.h",
     "OperationalSessionSetupPool.h",
+    "PendingResponseTracker.h",
+    "PendingResponseTrackerImpl.cpp",
+    "PendingResponseTrackerImpl.h",
+    "ReadClient.h",  # TODO: cpp is only included conditionally. Needs logic
+                     # fixing
     "RequiredPrivilege.cpp",
     "RequiredPrivilege.h",
     "StatusResponse.cpp",
@@ -157,6 +165,10 @@ static_library("interaction-model") {
     "SubscriptionResumptionStorage.h",
     "TimedHandler.cpp",
     "TimedHandler.h",
+    "TimedRequest.cpp",
+    "TimedRequest.h",
+    "WriteClient.cpp",
+    "WriteClient.h",
     "reporting/Engine.cpp",
     "reporting/Engine.h",
     "reporting/ReportScheduler.h",
@@ -184,6 +196,10 @@ static_library("interaction-model") {
 
   public_configs = [ "${chip_root}/src:includes" ]
 
+  if (chip_enable_read_client) {
+    sources += [ "ReadClient.cpp" ]
+  }
+
   if (chip_persist_subscriptions) {
     sources += [
       "SimpleSubscriptionResumptionStorage.cpp",
@@ -228,7 +244,6 @@ static_library("app") {
     "CommandResponseHelper.h",
     "CommandResponseSender.cpp",
     "CommandResponseSender.h",
-    "CommandSender.cpp",
     "DefaultAttributePersistenceProvider.cpp",
     "DefaultAttributePersistenceProvider.h",
     "DeferredAttributePersistenceProvider.cpp",
@@ -240,26 +255,17 @@ static_library("app") {
     "FailSafeContext.cpp",
     "FailSafeContext.h",
     "OTAUserConsentCommon.h",
-    "PendingResponseTracker.h",
-    "PendingResponseTrackerImpl.cpp",
-    "PendingResponseTrackerImpl.h",
     "ReadHandler.cpp",
     "SafeAttributePersistenceProvider.h",
-    "TimedRequest.cpp",
-    "TimedRequest.h",
     "TimerDelegates.cpp",
     "TimerDelegates.h",
-    "WriteClient.cpp",
     "WriteHandler.cpp",
 
     # TODO: the following items cannot be included due to interaction-model circularity
     #       (app depending on im and im including these headers):
     #       Name with _ so that linter does not recognize it
     # "CommandHandler._h"
-    # "CommandSender._h",
-    # "ReadClient._h",
     # "ReadHandler._h",
-    # "WriteClient._h",
     # "WriteHandler._h"
 
     # TODO: the following items cannot be included due to platform includes not being
@@ -288,10 +294,6 @@ static_library("app") {
       "BufferedReadCallback.h",
       "ClusterStateCache.cpp",
       "ClusterStateCache.h",
-      "ReadClient.cpp",
-
-      # TODO: cannot include "ReadClient._h" because interaction-model backreference
-      #       Name with _ so that linter does not recognize it
     ]
   }
 
diff --git a/src/app/CommandSender.cpp b/src/app/CommandSender.cpp
index 03ce2786b93d8d..18f4e755835076 100644
--- a/src/app/CommandSender.cpp
+++ b/src/app/CommandSender.cpp
@@ -16,15 +16,9 @@
  *    limitations under the License.
  */
 
-/**
- *    @file
- *      This file defines objects for a CHIP IM Invoke Command Sender
- *
- */
-
 #include "CommandSender.h"
-#include "InteractionModelEngine.h"
 #include "StatusResponse.h"
+#include <app/InteractionModelTimeout.h>
 #include <app/TimedRequest.h>
 #include <platform/LockTracker.h>
 #include <protocols/Protocols.h>