introduce mCatsMatchCheckIn to indicate whether cats for icd registration matched with the current subscription

Author: yunhanw-google

src/app/InteractionModelEngine.cpp

@@ -1069,18 +1069,14 @@ void InteractionModelEngine::OnResponseTimeout(Messaging::ExchangeContext * ec)
 }
 
 #if CHIP_CONFIG_ENABLE_READ_CLIENT
-void InteractionModelEngine::OnActiveModeNotification(ScopedNodeId aPeer, uint64_t aMonitoredSubject)
+void InteractionModelEngine::OnActiveModeNotification(ScopedNodeId aPeer)
 {
     for (ReadClient * pListItem = mpActiveReadClientList; pListItem != nullptr;)
     {
         auto pNextItem = pListItem->GetNextClient();
         // It is possible that pListItem is destroyed by the app in OnActiveModeNotification.
         // Get the next item before invoking `OnActiveModeNotification`.
-        // If caseTag for current subscription does not match with the one set in ICDManagementCluster::RegisterClient for check-in,
-        // when receiving check-in message, OnActiveModeNotification would do nothing for current subscription.
-        if (ScopedNodeId(pListItem->GetPeerNodeId(), pListItem->GetFabricIndex()) == aPeer &&
-           pListItem->GetSubjectDescriptor().HasValue() && pListItem->GetSubjectDescriptor().Value().cats.CheckSubjectAgainstCATs(aMonitoredSubject) &&
-           pListItem->GetSubjectDescriptor().Value().subject == aMonitoredSubject)
+        if (ScopedNodeId(pListItem->GetPeerNodeId(), pListItem->GetFabricIndex()) == aPeer)
         {
             pListItem->OnActiveModeNotification();
         }

src/app/InteractionModelEngine.h

@@ -238,7 +238,7 @@ class InteractionModelEngine : public Messaging::UnsolicitedMessageHandler,
      *
      *  See ReadClient::OnActiveModeNotification
      */
-    void OnActiveModeNotification(ScopedNodeId aPeer, uint64_t aMonitoredSubject);
+    void OnActiveModeNotification(ScopedNodeId aPeer);
 
     /**
      *  Used to notify when a peer becomes LIT ICD or vice versa.

src/app/ReadClient.cpp

@@ -490,6 +490,10 @@ void ReadClient::OnActiveModeNotification()
     // called, either mEventPathParamsListSize or mAttributePathParamsListSize is not 0.
     VerifyOrDie(mReadPrepareParams.mEventPathParamsListSize != 0 || mReadPrepareParams.mAttributePathParamsListSize != 0);
 
+    // If mCatsMatchCheckIn is true, it means cats used in icd registration matches with the one in current subscription, OnActiveModeNotification
+    // continues to revive the subscription as needed, otherwise, do nothing.
+    VerifyOrReturn(mReadPrepareParams.mCatsMatchCheckIn);
+
     // When we reach here, the subscription definitely exceeded the liveness timeout. Just continue the unfinished resubscription
     // logic in `OnLivenessTimeoutCallback`.
     if (IsInactiveICDSubscription())

src/app/ReadClient.h

@@ -509,12 +509,6 @@ class ReadClient : public Messaging::ExchangeDelegate
      */
     Optional<System::Clock::Timeout> GetSubscriptionTimeout();
 
-    Optional<Access::SubjectDescriptor> GetSubjectDescriptor() const
-    {
-        VerifyOrReturnValue(mReadPrepareParams.mSessionHolder, NullOptional);
-        return MakeOptional(mReadPrepareParams.mSessionHolder->AsSecureSession()->GetSubjectDescriptor());
-    }
-
 private:
     friend class TestReadInteraction;
     friend class InteractionModelEngine;

src/app/ReadPrepareParams.h

@@ -49,6 +49,9 @@ struct ReadPrepareParams
     bool mIsFabricFiltered              = true;
     bool mIsPeerLIT                     = false;
 
+    // see ReadClient::OnActiveModeNotification
+    bool mCatsMatchCheckIn              = true;
+
     ReadPrepareParams() {}
     ReadPrepareParams(const SessionHandle & sessionHandle) { mSessionHolder.Grab(sessionHandle); }
     ReadPrepareParams(ReadPrepareParams && other) : mSessionHolder(other.mSessionHolder)
@@ -66,6 +69,7 @@ struct ReadPrepareParams
         mTimeout                           = other.mTimeout;
         mIsFabricFiltered                  = other.mIsFabricFiltered;
         mIsPeerLIT                         = other.mIsPeerLIT;
+        mCatsMatchCheckIn                  = other.mCatsMatchCheckIn;
         other.mpEventPathParamsList        = nullptr;
         other.mEventPathParamsListSize     = 0;
         other.mpAttributePathParamsList    = nullptr;
@@ -91,6 +95,7 @@ struct ReadPrepareParams
         mTimeout                           = other.mTimeout;
         mIsFabricFiltered                  = other.mIsFabricFiltered;
         mIsPeerLIT                         = other.mIsPeerLIT;
+        mCatsMatchCheckIn                  = other.mCatsMatchCheckIn;
         other.mpEventPathParamsList        = nullptr;
         other.mEventPathParamsListSize     = 0;
         other.mpAttributePathParamsList    = nullptr;

src/app/icd/client/CheckInHandler.cpp

@@ -138,7 +138,7 @@ CHIP_ERROR CheckInHandler::OnMessageReceived(Messaging::ExchangeContext * ec, co
         mpICDClientStorage->StoreEntry(clientInfo);
         mpCheckInDelegate->OnCheckInComplete(clientInfo);
 #if CHIP_CONFIG_ENABLE_READ_CLIENT
-        mpImEngine->OnActiveModeNotification(clientInfo.peer_node, clientInfo.monitored_subject);
+        mpImEngine->OnActiveModeNotification(clientInfo.peer_node);
 #endif // CHIP_CONFIG_ENABLE_READ_CLIENT
     }
 

src/app/icd/client/RefreshKeySender.cpp

@@ -69,7 +69,7 @@ CHIP_ERROR RefreshKeySender::RegisterClientWithNewKey(Messaging::ExchangeManager
 
         mpCheckInDelegate->OnCheckInComplete(mICDClientInfo);
 #if CHIP_CONFIG_ENABLE_READ_CLIENT
-        mpImEngine->OnActiveModeNotification(mICDClientInfo.peer_node, mICDClientInfo.monitored_subject);
+        mpImEngine->OnActiveModeNotification(mICDClientInfo.peer_node);
 #endif // CHIP_CONFIG_ENABLE_READ_CLIENT
         mpCheckInDelegate->OnKeyRefreshDone(this, CHIP_NO_ERROR);
     };

src/controller/tests/data_model/TestRead.cpp

@@ -2330,7 +2330,7 @@ TEST_F(TestRead, TestSubscribe_OnActiveModeNotification)
         GetLoopback().mNumMessagesToDrop = 0;
         callback.ClearCounters();
         InteractionModelEngine::GetInstance()->OnActiveModeNotification(
-            ScopedNodeId(readClient.GetPeerNodeId(), readClient.GetFabricIndex()), readClient.GetSubjectDescriptor().Value().subject);
+            ScopedNodeId(readClient.GetPeerNodeId(), readClient.GetFabricIndex()));
         EXPECT_EQ(callback.mOnResubscriptionsAttempted, 1);
         EXPECT_EQ(callback.mLastError, CHIP_ERROR_TIMEOUT);
 
@@ -2393,7 +2393,7 @@ TEST_F(TestRead, TestSubscribeFailed_OnActiveModeNotification)
         GetLoopback().mNumMessagesToDrop = 0;
         callback.ClearCounters();
         InteractionModelEngine::GetInstance()->OnActiveModeNotification(
-            ScopedNodeId(readClient.GetPeerNodeId(), readClient.GetFabricIndex()), readClient.GetSubjectDescriptor().Value().subject);
+            ScopedNodeId(readClient.GetPeerNodeId(), readClient.GetFabricIndex()));
         //
         // Drive servicing IO till we have established a subscription.
         //