Remove now-unused InteractionModelDelegate (#14594)

project-chip · Mar 4, 2022 · b33f8f1 · b33f8f1
1 parent e26e857
commit b33f8f1
Show file tree

Hide file tree

Showing 22 changed files with 43 additions and 125 deletions.
diff --git a/src/app/AttributePathExpandIterator.cpp b/src/app/AttributePathExpandIterator.cpp
@@ -22,7 +22,6 @@
 #include <app/ClusterInfo.h>
 #include <app/ConcreteAttributePath.h>
 #include <app/EventManagement.h>
-#include <app/InteractionModelDelegate.h>
 #include <lib/core/CHIPCore.h>
 #include <lib/core/CHIPTLVDebug.hpp>
 #include <lib/support/CodeUtils.h>

diff --git a/src/app/AttributePathExpandIterator.h b/src/app/AttributePathExpandIterator.h
@@ -27,7 +27,6 @@
 #include <app/ClusterInfo.h>
 #include <app/ConcreteAttributePath.h>
 #include <app/EventManagement.h>
-#include <app/InteractionModelDelegate.h>
 #include <lib/core/CHIPCore.h>
 #include <lib/core/CHIPTLVDebug.hpp>
 #include <lib/support/CodeUtils.h>

diff --git a/src/app/BUILD.gn b/src/app/BUILD.gn
@@ -58,6 +58,7 @@ static_library("app") {
     "EventPathParams.h",
     "InteractionModelEngine.cpp",
     "InteractionModelRevision.h",
+    "InteractionModelTimeout.h",
     "MessageDef/ArrayBuilder.cpp",
     "MessageDef/ArrayParser.cpp",
     "MessageDef/AttributeDataIB.cpp",

diff --git a/src/app/CommandHandler.h b/src/app/CommandHandler.h
@@ -25,7 +25,6 @@
 #pragma once
 
 #include <app/ConcreteCommandPath.h>
-#include <app/InteractionModelDelegate.h>
 #include <app/data-model/Encode.h>
 #include <lib/core/CHIPCore.h>
 #include <lib/core/CHIPTLV.h>

diff --git a/src/app/CommandSender.h b/src/app/CommandSender.h
@@ -27,7 +27,6 @@
 #include <type_traits>
 
 #include <app/CommandPathParams.h>
-#include <app/InteractionModelDelegate.h>
 #include <app/MessageDef/InvokeRequestMessage.h>
 #include <app/MessageDef/InvokeResponseMessage.h>
 #include <app/MessageDef/StatusIB.h>

diff --git a/src/app/InteractionModelDelegate.h b/src/app/InteractionModelDelegate.h
diff --git a/src/app/InteractionModelEngine.h b/src/app/InteractionModelEngine.h
@@ -46,7 +46,6 @@
 #include <app/CommandSender.h>
 #include <app/ConcreteAttributePath.h>
 #include <app/ConcreteCommandPath.h>
-#include <app/InteractionModelDelegate.h>
 #include <app/ReadClient.h>
 #include <app/ReadHandler.h>
 #include <app/StatusResponse.h>
@@ -58,6 +57,7 @@
 
 namespace chip {
 namespace app {
+
 /**
  * @class InteractionModelEngine
  *
@@ -82,7 +82,6 @@ class InteractionModelEngine : public Messaging::ExchangeDelegate, public Comman
      *  Initialize the InteractionModel Engine.
      *
      *  @param[in]    apExchangeMgr    A pointer to the ExchangeManager object.
-     *  @param[in]    apDelegate       InteractionModelDelegate set by application.
      *
      *  @retval #CHIP_ERROR_INCORRECT_STATE If the state is not equal to
      *          kState_NotInitialized.

diff --git a/src/app/InteractionModelTimeout.h b/src/app/InteractionModelTimeout.h
@@ -0,0 +1,28 @@
+/*
+ *    Copyright (c) 2022 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#pragma once
+
+#include <system/SystemClock.h>
+
+namespace chip {
+namespace app {
+
+static constexpr System::Clock::Timeout kImMessageTimeout = System::Clock::Seconds16(12);
+
+} // namespace app
+} // namespace chip
diff --git a/src/app/ReadClient.h b/src/app/ReadClient.h
@@ -27,8 +27,8 @@
 #include <app/ConcreteAttributePath.h>
 #include <app/EventHeader.h>
 #include <app/EventPathParams.h>
-#include <app/InteractionModelDelegate.h>
 #include <app/MessageDef/ReadRequestMessage.h>
+#include <app/MessageDef/StatusIB.h>
 #include <app/MessageDef/StatusResponseMessage.h>
 #include <app/MessageDef/SubscribeRequestMessage.h>
 #include <app/MessageDef/SubscribeResponseMessage.h>
@@ -187,7 +187,7 @@ class ReadClient : public Messaging::ExchangeDelegate
      *
      *  @param[in]    apImEngine       A valid pointer to the IM engine.
      *  @param[in]    apExchangeMgr    A pointer to the ExchangeManager object.
-     *  @param[in]    apCallback       InteractionModelDelegate set by application.
+     *  @param[in]    apCallback       Callback set by application.
      *  @param[in]    aInteractionType Type of interaction (read or subscribe)
      *
      *  @retval #CHIP_ERROR_INCORRECT_STATE incorrect state if it is already initialized

diff --git a/src/app/ReadHandler.h b/src/app/ReadHandler.h
@@ -29,7 +29,6 @@
 #include <app/AttributePathExpandIterator.h>
 #include <app/ClusterInfo.h>
 #include <app/EventManagement.h>
-#include <app/InteractionModelDelegate.h>
 #include <app/MessageDef/AttributePathIBs.h>
 #include <app/MessageDef/EventPathIBs.h>
 #include <lib/core/CHIPCore.h>

diff --git a/src/app/ReadPrepareParams.h b/src/app/ReadPrepareParams.h
@@ -20,6 +20,7 @@
 
 #include <app/AttributePathParams.h>
 #include <app/EventPathParams.h>
+#include <app/InteractionModelTimeout.h>
 #include <app/util/basic-types.h>
 #include <lib/core/CHIPCore.h>
 #include <lib/core/CHIPTLV.h>

diff --git a/src/app/TimedHandler.cpp b/src/app/TimedHandler.cpp
@@ -17,7 +17,6 @@
  */
 
 #include "TimedHandler.h"
-#include <app/InteractionModelDelegate.h>
 #include <app/InteractionModelEngine.h>
 #include <app/MessageDef/TimedRequestMessage.h>
 #include <app/StatusResponse.h>

diff --git a/src/app/WriteClient.h b/src/app/WriteClient.h
@@ -20,7 +20,6 @@
 
 #include <app/AttributePathParams.h>
 #include <app/ConcreteAttributePath.h>
-#include <app/InteractionModelDelegate.h>
 #include <app/MessageDef/AttributeDataIBs.h>
 #include <app/MessageDef/AttributeStatusIB.h>
 #include <app/MessageDef/StatusIB.h>
@@ -111,7 +110,7 @@ class WriteClient : public Messaging::ExchangeDelegate
      *  of this instance.
      *
      *  @param[in]    apExchangeMgr    A pointer to the ExchangeManager object.
-     *  @param[in]    apDelegate       InteractionModelDelegate set by application.
+     *  @param[in]    apCallback       Callback set by application.
      *  @param[in]    aTimedWriteTimeoutMs If provided, do a timed write using this timeout.
      */
     WriteClient(Messaging::ExchangeManager * apExchangeMgr, Callback * apCallback,

diff --git a/src/app/WriteHandler.h b/src/app/WriteHandler.h
@@ -18,7 +18,6 @@
 
 #pragma once
 #include <app/AttributePathParams.h>
-#include <app/InteractionModelDelegate.h>
 #include <app/MessageDef/WriteResponseMessage.h>
 #include <lib/core/CHIPCore.h>
 #include <lib/core/CHIPTLVDebug.hpp>
@@ -46,8 +45,6 @@ class WriteHandler
      *  construction until a call to Shutdown is made to terminate the
      *  instance.
      *
-     *  @param[in]    apDelegate       InteractionModelDelegate set by application.
-     *
      *  @retval #CHIP_ERROR_INCORRECT_STATE If the state is not equal to
      *          kState_NotInitialized.
      *  @retval #CHIP_NO_ERROR On success.

diff --git a/src/app/tests/TestAttributePathExpandIterator.cpp b/src/app/tests/TestAttributePathExpandIterator.cpp
@@ -21,7 +21,6 @@
 #include <app/ClusterInfo.h>
 #include <app/ConcreteAttributePath.h>
 #include <app/EventManagement.h>
-#include <app/InteractionModelDelegate.h>
 #include <app/util/mock/Constants.h>
 #include <lib/core/CHIPCore.h>
 #include <lib/core/CHIPTLVDebug.hpp>

diff --git a/src/app/tests/TestWriteInteraction.cpp b/src/app/tests/TestWriteInteraction.cpp
@@ -270,7 +270,6 @@ void TestWriteInteraction::TestWriteHandler(nlTestSuite * apSuite, void * apCont
 
             app::WriteHandler writeHandler;
 
-            chip::app::InteractionModelDelegate IMdelegate;
             System::PacketBufferHandle buf = System::PacketBufferHandle::New(System::PacketBuffer::kMaxSize);
             err                            = writeHandler.Init();
 

diff --git a/src/app/tests/integration/chip_im_initiator.cpp b/src/app/tests/integration/chip_im_initiator.cpp
@@ -126,8 +126,7 @@ void HandleSubscribeReportComplete()
            static_cast<double>(transitTime.count()) / 1000);
 }
 
-class MockInteractionModelApp : public chip::app::InteractionModelDelegate,
-                                public ::chip::app::CommandSender::Callback,
+class MockInteractionModelApp : public ::chip::app::CommandSender::Callback,
                                 public ::chip::app::WriteClient::Callback,
                                 public ::chip::app::ReadClient::Callback
 {

diff --git a/src/app/tests/integration/chip_im_responder.cpp b/src/app/tests/integration/chip_im_responder.cpp
@@ -117,7 +117,6 @@ CHIP_ERROR WriteSingleClusterData(const Access::SubjectDescriptor & aSubjectDesc
 } // namespace chip
 
 namespace {
-bool testSyncReport = false;
 chip::TransportMgr<chip::Transport::UDP> gTransportManager;
 chip::SecurePairingUsingTestSecret gTestPairing;
 LivenessEventGenerator gLivenessGenerator;
@@ -139,45 +138,11 @@ void InitializeEventLogging(chip::Messaging::ExchangeManager * apMgr)
                                                       gCircularEventBuffer, logStorageResources, nullptr, 0, nullptr);
 }
 
-void MutateClusterHandler(chip::System::Layer * systemLayer, void * appState)
-{
-    chip::app::ClusterInfo dirtyPath;
-    dirtyPath.mClusterId  = kTestClusterId;
-    dirtyPath.mEndpointId = kTestEndpointId;
-    printf("MutateClusterHandler is triggered...");
-    // send dirty change
-    if (!testSyncReport)
-    {
-        dirtyPath.mAttributeId = 1;
-        chip::app::InteractionModelEngine::GetInstance()->GetReportingEngine().SetDirty(dirtyPath);
-        chip::app::InteractionModelEngine::GetInstance()->GetReportingEngine().ScheduleRun();
-        chip::DeviceLayer::SystemLayer().StartTimer(chip::System::Clock::Seconds16(1), MutateClusterHandler, NULL);
-        testSyncReport = true;
-    }
-    else
-    {
-        dirtyPath.mAttributeId = 10; // unknown field
-        chip::app::InteractionModelEngine::GetInstance()->GetReportingEngine().SetDirty(dirtyPath);
-        // send sync message(empty report)
-        chip::app::InteractionModelEngine::GetInstance()->GetReportingEngine().ScheduleRun();
-    }
-}
-
-class MockInteractionModelApp : public chip::app::InteractionModelDelegate
-{
-public:
-    virtual CHIP_ERROR SubscriptionEstablished(const chip::app::ReadHandler * apReadHandler)
-    {
-        chip::DeviceLayer::SystemLayer().StartTimer(chip::System::Clock::Seconds16(1), MutateClusterHandler, NULL);
-        return CHIP_NO_ERROR;
-    }
-};
 } // namespace
 
 int main(int argc, char * argv[])
 {
     CHIP_ERROR err = CHIP_NO_ERROR;
-    MockInteractionModelApp mockDelegate;
     chip::Optional<chip::Transport::PeerAddress> peer(chip::Transport::Type::kUndefined);
     const chip::FabricIndex gFabricIndex = 0;
 

diff --git a/src/app/util/mock/attribute-storage.cpp b/src/app/util/mock/attribute-storage.cpp
@@ -40,7 +40,6 @@
 #include <app/ClusterInfo.h>
 #include <app/ConcreteAttributePath.h>
 #include <app/EventManagement.h>
-#include <app/InteractionModelDelegate.h>
 #include <lib/core/CHIPCore.h>
 #include <lib/core/CHIPEncoding.h>
 #include <lib/core/CHIPTLVDebug.hpp>

diff --git a/src/controller/CHIPDeviceController.h b/src/controller/CHIPDeviceController.h
@@ -30,7 +30,6 @@
 
 #include <app/CASEClientPool.h>
 #include <app/CASESessionManager.h>
-#include <app/InteractionModelDelegate.h>
 #include <app/OperationalDeviceProxy.h>
 #include <app/OperationalDeviceProxyPool.h>
 #include <controller/AbstractDnssdDiscoveryController.h>
@@ -167,11 +166,11 @@ typedef void (*OnOpenCommissioningWindow)(void * context, NodeId deviceId, CHIP_
  *   and device pairing information for individual devices). Alternatively, this class can retrieve the
  *   relevant information when the application tries to communicate with the device
  */
-class DLL_EXPORT DeviceController : public SessionRecoveryDelegate,
+class DLL_EXPORT DeviceController : public SessionRecoveryDelegate
 #if CHIP_DEVICE_CONFIG_ENABLE_DNSSD
-                                    public AbstractDnssdDiscoveryController,
+    ,
+                                    public AbstractDnssdDiscoveryController
 #endif
-                                    public app::InteractionModelDelegate
 {
 public:
     DeviceController();

diff --git a/src/controller/TypedReadCallback.h b/src/controller/TypedReadCallback.h
@@ -20,7 +20,6 @@
 
 #include <app/BufferedReadCallback.h>
 #include <app/ConcreteAttributePath.h>
-#include <app/InteractionModelDelegate.h>
 #include <app/data-model/Decode.h>
 #include <functional>
 #include <lib/support/CHIPMem.h>
@@ -31,11 +30,12 @@ namespace Controller {
 /*
  * This provides an adapter class that implements ReadClient::Callback and provides three additional
  * features:
- *  1. The ability to pass in std::function closures to permit more flexible programming scenarios than are provided by the strict
- *     delegate interface stipulated by by InteractionModelDelegate.
+ *  1. The ability to pass in std::function closures to permit more flexible
+ *     programming scenarios than are provided by the strict delegate interface
+ *     stipulated by ReadClient::Callback.
  *
- *  2. Automatic decoding of attribute data provided in the TLVReader by InteractionModelDelegate::OnReportData into a decoded
- *     cluster object.
+ *  2. Automatic decoding of attribute data provided in the TLVReader by
+ *     ReadClient::Callback::OnAttributeData into a decoded cluster object.
  *
  *  3. Automatically representing all errors as a CHIP_ERROR (which might
  *     encapsulate a StatusIB).  This could be a path-specific error or it

diff --git a/src/controller/python/chip/interaction_model/Delegate.h b/src/controller/python/chip/interaction_model/Delegate.h
@@ -19,7 +19,6 @@
 
 #include <type_traits>
 
-#include <app/InteractionModelDelegate.h>
 #include <controller/CHIPDeviceController.h>
 
 namespace chip {