[ICD][Server][Checkin]Try to Send check-in message if allowed when subscription goes away in LIT (project-chip#41147) (project-chip#41575)

yunhanw-google · restyled-commits · web-flow · commit e37a11224f30 · 2025-10-22T08:55:58.000-04:00
* Send out check-in message when report timesout

* Restyled by whitespace

* Restyled by clang-format

* fix comment

* store subject descriptor in read handler

* check session is valid before reading subject descriptor from it

* address comments

* address comments

* Restyled by whitespace

* Restyled by clang-format

* fix missing macro

---------

Co-authored-by: Restyled.io &lt;commits@restyled.io&gt;
diff --git a/src/app/ReadHandler.cpp b/src/app/ReadHandler.cpp
@@ -250,7 +250,6 @@ CHIP_ERROR ReadHandler::OnStatusResponse(Messaging::ExchangeContext * apExchange
                 err = SendSubscribeResponse();
 
                 SetStateFlag(ReadHandlerFlags::ActiveSubscription);
-
                 auto * appCallback = mManagementCallback.GetAppCallback();
                 if (appCallback)
                 {
@@ -411,6 +410,31 @@ void ReadHandler::OnResponseTimeout(Messaging::ExchangeContext * apExchangeConte
 {
     ChipLogError(DataManagement, "Time out! failed to receive status response from Exchange: " ChipLogFormatExchange,
                  ChipLogValueExchange(apExchangeContext));
+#if CHIP_CONFIG_ENABLE_ICD_SERVER && CHIP_CONFIG_ENABLE_ICD_CIP && CHIP_CONFIG_ENABLE_ICD_CHECK_IN_ON_REPORT_TIMEOUT
+    switch (mState)
+    {
+    case HandlerState::AwaitingReportResponse:
+        if (IsType(InteractionType::Subscribe) && !IsPriming())
+        {
+            // Trigger check-in message when a non-priming subscription report times out.
+            ChipLogError(DataManagement, "Trigger check-in message when non-priming subscription report times out");
+            if (mSessionHandle)
+            {
+                chip::app::ICDNotifier::GetInstance().NotifySendCheckIn(GetSubjectDescriptor());
+            }
+            else
+            {
+                ChipLogError(DataManagement, "Failed to get subject descriptor for sending check-in message on report timeout");
+            }
+        }
+        break;
+    case HandlerState::CanStartReporting:
+    case HandlerState::Idle:
+    default:
+        break;
+    }
+#endif // CHIP_CONFIG_ENABLE_ICD_CIP && CHIP_CONFIG_ENABLE_ICD_SERVER
+
 #if CHIP_CONFIG_PERSIST_SUBSCRIPTIONS
     Close(CloseOptions::kKeepPersistedSubscription);
 #else
diff --git a/src/app/icd/icd.gni b/src/app/icd/icd.gni
@@ -16,6 +16,9 @@ declare_args() {
   # Matter SDK Configuration flag to enable ICD server functionality
   chip_enable_icd_server = false
 
+  # Enable the ICD server check-in on report timeout
+  chip_enable_icd_checkin_on_report_timeout = true
+
   chip_enable_icd_lit = false
 
   # Matter SDK Configuration flag to make the ICD manager emit a report on entering active mode
diff --git a/src/app/icd/server/BUILD.gn b/src/app/icd/server/BUILD.gn
@@ -43,6 +43,7 @@ buildconfig_header("icd-server-buildconfig") {
     "CHIP_CONFIG_ENABLE_ICD_DSLS=${chip_enable_icd_dsls}",
     "ICD_REPORT_ON_ENTER_ACTIVE_MODE=${chip_icd_report_on_active_mode}",
     "ICD_MAX_NOTIFICATION_SUBSCRIBERS=${icd_max_notification_subscribers}",
+    "CHIP_CONFIG_ENABLE_ICD_CHECK_IN_ON_REPORT_TIMEOUT=${chip_enable_icd_checkin_on_report_timeout}",
   ]
 
   visibility = [ ":icd-server-config" ]
@@ -66,6 +67,7 @@ source_set("notifier") {
 
   deps = [
     ":icd-server-config",
+    "${chip_root}/src/access:types",
     "${chip_root}/src/lib/core",
   ]
 }
diff --git a/src/app/icd/server/ICDManager.cpp b/src/app/icd/server/ICDManager.cpp
@@ -136,9 +136,10 @@ uint32_t ICDManager::StayActiveRequest(uint32_t stayActiveDuration)
 }
 
 #if CHIP_CONFIG_ENABLE_ICD_CIP
-void ICDManager::SendCheckInMsgs()
+void ICDManager::SendCheckInMsgs(Optional<Access::SubjectDescriptor> specificSubject)
 {
 #if !(CONFIG_BUILD_FOR_HOST_UNIT_TEST)
+    VerifyOrDie(SupportsFeature(Feature::kCheckInProtocolSupport));
     VerifyOrDie(mStorage != nullptr);
     VerifyOrDie(mFabricTable != nullptr);
 
@@ -173,7 +174,13 @@ void ICDManager::SendCheckInMsgs()
                 continue;
             }
 
-            if (!ShouldCheckInMsgsBeSentAtActiveModeFunction(entry.fabricIndex, entry.monitoredSubject))
+            if (specificSubject.HasValue() && !ShouldSendCheckInMessageForSpecificSubject(entry, specificSubject.Value()))
+            {
+                continue;
+            }
+
+            if (!specificSubject.HasValue() &&
+                !ShouldCheckInMsgsBeSentAtActiveModeFunction(entry.fabricIndex, entry.monitoredSubject))
             {
                 continue;
             }
@@ -209,6 +216,24 @@ void ICDManager::SendCheckInMsgs()
 #endif // !(CONFIG_BUILD_FOR_HOST_UNIT_TEST)
 }
 
+bool ICDManager::ShouldSendCheckInMessageForSpecificSubject(const ICDMonitoringEntry & entry,
+                                                            const Access::SubjectDescriptor & specificSubject)
+{
+    if (specificSubject.fabricIndex != entry.fabricIndex)
+    {
+        return false;
+    }
+
+    if (specificSubject.cats.CheckSubjectAgainstCATs(entry.monitoredSubject) || entry.monitoredSubject == specificSubject.subject)
+    {
+        ChipLogProgress(AppServer, "Proceed to send Check-In msg for specific subject: " ChipLogFormatX64,
+                        ChipLogValueX64(specificSubject.subject));
+        return true;
+    }
+
+    return false;
+}
+
 bool ICDManager::CheckInMessagesWouldBeSent(const std::function<ShouldCheckInMsgsBeSentFunction> & shouldCheckInMsgsBeSentFunction)
 {
     VerifyOrReturnValue(shouldCheckInMsgsBeSentFunction, false);
@@ -479,10 +504,7 @@ void ICDManager::UpdateOperationState(OperationalState state)
             }
 
 #if CHIP_CONFIG_ENABLE_ICD_CIP
-            if (SupportsFeature(Feature::kCheckInProtocolSupport))
-            {
-                SendCheckInMsgs();
-            }
+            SendCheckInMsgs();
 #endif // CHIP_CONFIG_ENABLE_ICD_CIP
 
             postObserverEvent(ObserverEventType::EnterActiveMode);
@@ -661,6 +683,14 @@ void ICDManager::OnSubscriptionReport()
     this->UpdateOperationState(OperationalState::ActiveMode);
 }
 
+#if CHIP_CONFIG_ENABLE_ICD_SERVER && CHIP_CONFIG_ENABLE_ICD_CIP && CHIP_CONFIG_ENABLE_ICD_CHECK_IN_ON_REPORT_TIMEOUT
+void ICDManager::OnSendCheckIn(const Access::SubjectDescriptor & subject)
+{
+    ChipLogProgress(AppServer, "Received OnSendCheckIn for subject: " ChipLogFormatX64, ChipLogValueX64(subject.subject));
+    SendCheckInMsgs(MakeOptional(subject));
+}
+#endif // CHIP_CONFIG_ENABLE_ICD_SERVER && CHIP_CONFIG_ENABLE_ICD_CIP && CHIP_CONFIG_ENABLE_ICD_CHECK_IN_ON_REPORT_TIMEOUT
+
 void ICDManager::ExtendActiveMode(Milliseconds16 extendDuration)
 {
     DeviceLayer::SystemLayer().ExtendTimerTo(extendDuration, OnActiveModeDone, this);
diff --git a/src/app/icd/server/ICDManager.h b/src/app/icd/server/ICDManager.h
@@ -249,6 +249,10 @@ class ICDManager : public ICDListener, public TestEventTriggerHandler
     void OnICDManagementServerEvent(ICDManagementEvents event) override;
     void OnSubscriptionReport() override;
 
+#if CHIP_CONFIG_ENABLE_ICD_SERVER && CHIP_CONFIG_ENABLE_ICD_CIP && CHIP_CONFIG_ENABLE_ICD_CHECK_IN_ON_REPORT_TIMEOUT
+    void OnSendCheckIn(const Access::SubjectDescriptor & subject) override;
+#endif // CHIP_CONFIG_ENABLE_ICD_SERVER && CHIP_CONFIG_ENABLE_ICD_CIP && CHIP_CONFIG_ENABLE_ICD_CHECK_IN_ON_REPORT_TIMEOUT
+
 private:
     // TODO : Once <gtest/gtest_prod.h> can be included, use FRIEND_TEST for the friend class.
     friend class TestICDManager_TestShouldCheckInMsgsBeSentAtActiveModeFunction_Test;
@@ -334,7 +338,9 @@ class ICDManager : public ICDListener, public TestEventTriggerHandler
      *       ShouldCheckInMsgsBeSentAtActiveModeFunction. If we should, we allocate an ICDCheckInSender which tries to send a
      *       Check-In message to the registered client.
      */
-    void SendCheckInMsgs();
+    void SendCheckInMsgs(Optional<Access::SubjectDescriptor> specificSubject = Optional<Access::SubjectDescriptor>());
+    bool ShouldSendCheckInMessageForSpecificSubject(const ICDMonitoringEntry & entry,
+                                                    const Access::SubjectDescriptor & specificSubject);
 
     /**
      * @brief See function implementation in .cpp for details on this function.
diff --git a/src/app/icd/server/ICDNotifier.cpp b/src/app/icd/server/ICDNotifier.cpp
@@ -135,5 +135,18 @@ void ICDNotifier::NotifySubscriptionReport()
     }
 }
 
+#if CHIP_CONFIG_ENABLE_ICD_SERVER && CHIP_CONFIG_ENABLE_ICD_CIP && CHIP_CONFIG_ENABLE_ICD_CHECK_IN_ON_REPORT_TIMEOUT
+void ICDNotifier::NotifySendCheckIn(const chip::Access::SubjectDescriptor & subject)
+{
+    for (auto subscriber : mSubscribers)
+    {
+        if (subscriber != nullptr)
+        {
+            subscriber->OnSendCheckIn(subject);
+        }
+    }
+}
+#endif // CHIP_CONFIG_ENABLE_ICD_SERVER && CHIP_CONFIG_ENABLE_ICD_CIP && CHIP_CONFIG_ENABLE_ICD_CHECK_IN_ON_REPORT_TIMEOUT
+
 } // namespace app
 } // namespace chip
diff --git a/src/app/icd/server/ICDNotifier.h b/src/app/icd/server/ICDNotifier.h
@@ -16,10 +16,10 @@
  */
 #pragma once
 
+#include <access/SubjectDescriptor.h>
 #include <app/icd/server/ICDServerConfig.h>
 #include <lib/core/CHIPError.h>
 #include <lib/support/BitFlags.h>
-
 namespace chip {
 namespace app {
 
@@ -106,6 +106,16 @@ class ICDListener
      * It informs the subscriber that a subscription report data is being sent.
      */
     virtual void OnSubscriptionReport() = 0;
+
+#if CHIP_CONFIG_ENABLE_ICD_SERVER && CHIP_CONFIG_ENABLE_ICD_CIP && CHIP_CONFIG_ENABLE_ICD_CHECK_IN_ON_REPORT_TIMEOUT
+    /**
+     * @brief This function is called for all subscribers of the ICDNotifier when it calls NotifySendCheckIn.
+     * It informs the subscriber that a Check-In message needs to be sent for the provided subject.
+     *
+     * @param subject : The subject descriptor for which the Check-In message needs to be sent.
+     */
+    virtual void OnSendCheckIn(const chip::Access::SubjectDescriptor & subject) = 0;
+#endif // CHIP_CONFIG_ENABLE_ICD_SERVER && CHIP_CONFIG_ENABLE_ICD_CIP && CHIP_CONFIG_ENABLE_ICD_CHECK_IN_ON_REPORT_TIMEOUT
 };
 
 class ICDNotifier
@@ -130,6 +140,10 @@ class ICDNotifier
     void NotifyICDManagementEvent(ICDListener::ICDManagementEvents event);
     void NotifySubscriptionReport();
 
+#if CHIP_CONFIG_ENABLE_ICD_SERVER && CHIP_CONFIG_ENABLE_ICD_CIP && CHIP_CONFIG_ENABLE_ICD_CHECK_IN_ON_REPORT_TIMEOUT
+    void NotifySendCheckIn(const chip::Access::SubjectDescriptor & subject);
+#endif // CHIP_CONFIG_ENABLE_ICD_SERVER && CHIP_CONFIG_ENABLE_ICD_CIP && CHIP_CONFIG_ENABLE_ICD_CHECK_IN_ON_REPORT_TIMEOUT
+
     inline void BroadcastActiveRequest(ICDListener::KeepActiveFlags request, bool notify)
     {
         (notify) ? NotifyActiveRequestNotification(request) : NotifyActiveRequestWithdrawal(request);

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ buildconfig_header("icd-server-buildconfig") {`
`43`	`43`	`"CHIP_CONFIG_ENABLE_ICD_DSLS=${chip_enable_icd_dsls}",`
`44`	`44`	`"ICD_REPORT_ON_ENTER_ACTIVE_MODE=${chip_icd_report_on_active_mode}",`
`45`	`45`	`"ICD_MAX_NOTIFICATION_SUBSCRIBERS=${icd_max_notification_subscribers}",`
	`46`	`+ "CHIP_CONFIG_ENABLE_ICD_CHECK_IN_ON_REPORT_TIMEOUT=${chip_enable_icd_checkin_on_report_timeout}",`
`46`	`47`	`]`
`47`	`48`
`48`	`49`	`visibility = [ ":icd-server-config" ]`
`@@ -66,6 +67,7 @@ source_set("notifier") {`
`66`	`67`
`67`	`68`	`deps = [`
`68`	`69`	`":icd-server-config",`
	`70`	`+ "${chip_root}/src/access:types",`
`69`	`71`	`"${chip_root}/src/lib/core",`
`70`	`72`	`]`
`71`	`73`	`}`