diagnostic-logs-delegate: Add default implementation for EndLogCollec…

…tion - The one-argument EndLogCollection method is retained for backward compatibility. - The new two-argument overloaded EndLogCollection method will serve as the primary method to be implemented in delegates.
project-chip · Dec 19, 2024 · 5154436 · 5154436
1 parent 38bf32b
commit 5154436
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 24 deletions.
diff --git a/examples/temperature-measurement-app/esp32/main/diagnostic-logs-provider-delegate-impl.cpp b/examples/temperature-measurement-app/esp32/main/diagnostic-logs-provider-delegate-impl.cpp
@@ -65,7 +65,7 @@ CHIP_ERROR LogProvider::GetLogForIntent(IntentEnum intent, MutableByteSpan & out
     err = CollectLog(sessionHandle, outBuffer, unusedOutIsEndOfLog);
     VerifyOrReturnError(CHIP_NO_ERROR == err, err, outBuffer.reduce_size(0));
 
-    err = EndLogCollection(sessionHandle);
+    err = EndLogCollection(sessionHandle, err);
     VerifyOrReturnError(CHIP_NO_ERROR == err, err, outBuffer.reduce_size(0));
 
     return CHIP_NO_ERROR;
@@ -276,21 +276,6 @@ CHIP_ERROR LogProvider::StartLogCollection(IntentEnum intent, LogSessionHandle &
     return CHIP_NO_ERROR;
 }
 
-CHIP_ERROR LogProvider::EndLogCollection(LogSessionHandle sessionHandle)
-{
-    VerifyOrReturnValue(sessionHandle != kInvalidLogSessionHandle, CHIP_ERROR_INVALID_ARGUMENT);
-    VerifyOrReturnValue(mSessionContextMap.count(sessionHandle), CHIP_ERROR_INVALID_ARGUMENT);
-
-    LogContext * context = mSessionContextMap[sessionHandle];
-    VerifyOrReturnError(context, CHIP_ERROR_INCORRECT_STATE);
-
-    CleanupLogContextForIntent(context);
-    Platform::MemoryFree(context);
-    mSessionContextMap.erase(sessionHandle);
-
-    return CHIP_NO_ERROR;
-}
-
 CHIP_ERROR LogProvider::EndLogCollection(LogSessionHandle sessionHandle, CHIP_ERROR error)
 {
     if (error != CHIP_NO_ERROR)

diff --git a/...s/temperature-measurement-app/esp32/main/include/diagnostic-logs-provider-delegate-impl.h b/...s/temperature-measurement-app/esp32/main/include/diagnostic-logs-provider-delegate-impl.h
@@ -44,7 +44,6 @@ class LogProvider : public DiagnosticLogsProviderDelegate
     /////////// DiagnosticLogsProviderDelegate Interface /////////
     CHIP_ERROR StartLogCollection(IntentEnum intent, LogSessionHandle & outHandle, Optional<uint64_t> & outTimeStamp,
                                   Optional<uint64_t> & outTimeSinceBoot) override;
-    CHIP_ERROR EndLogCollection(LogSessionHandle sessionHandle) override;
     CHIP_ERROR EndLogCollection(LogSessionHandle sessionHandle, CHIP_ERROR error) override;
     CHIP_ERROR CollectLog(LogSessionHandle sessionHandle, MutableByteSpan & outBuffer, bool & outIsEndOfLog) override;
     size_t GetSizeForIntent(IntentEnum intent) override;

diff --git a/src/app/clusters/diagnostic-logs-server/BDXDiagnosticLogsProvider.cpp b/src/app/clusters/diagnostic-logs-server/BDXDiagnosticLogsProvider.cpp
@@ -191,7 +191,11 @@ void BDXDiagnosticLogsProvider::OnAckReceived()
     // If the buffer has empty space, end the log collection session.
     if (isEndOfLog)
     {
-        mDelegate->EndLogCollection(mLogSessionHandle);
+        err = mDelegate->EndLogCollection(mLogSessionHandle, err);
+        if (err == CHIP_ERROR_NOT_IMPLEMENTED)
+        {
+            ChipLogError(DeviceLayer, "EndLogCollection not implemented in the delegate. Falling back to default behavior.");
+        }
         mLogSessionHandle = kInvalidLogSessionHandle;
     }
 
@@ -279,7 +283,11 @@ void BDXDiagnosticLogsProvider::Reset(CHIP_ERROR error)
 
     if (mDelegate != nullptr)
     {
-        mDelegate->EndLogCollection(mLogSessionHandle, error);
+        CHIP_ERROR err = mDelegate->EndLogCollection(mLogSessionHandle, error);
+        if (err == CHIP_ERROR_NOT_IMPLEMENTED)
+        {
+            ChipLogError(DeviceLayer, "EndLogCollection not implemented in the delegate. Falling back to default behavior.");
+        }
         mDelegate = nullptr;
     }
 

diff --git a/src/app/clusters/diagnostic-logs-server/DiagnosticLogsProviderDelegate.h b/src/app/clusters/diagnostic-logs-server/DiagnosticLogsProviderDelegate.h
@@ -58,10 +58,13 @@ class DiagnosticLogsProviderDelegate
      * This must be called if StartLogCollection happens successfully and a valid sessionHandle has been
      * returned from StartLogCollection.
      *
-     * @param[in] sessionHandle  The unique handle for this log session returned from a call to StartLogCollection.
+     * @note New implementations should override the two-argument version instead, as it is the primary
+     *       method invoked during log collection.
      *
+     * @param[in] sessionHandle  The unique handle for this log session returned from a call to StartLogCollection.
+     * @return CHIP_ERROR_NOT_IMPLEMENTED by default unless overridden.
      */
-    virtual CHIP_ERROR EndLogCollection(LogSessionHandle sessionHandle) = 0;
+    virtual CHIP_ERROR EndLogCollection(LogSessionHandle sessionHandle) { return CHIP_ERROR_NOT_IMPLEMENTED; }
 
     /**
      * Called to end log collection for the log session identified by sessionHandle.
@@ -74,9 +77,7 @@ class DiagnosticLogsProviderDelegate
      * @param[in] sessionHandle  The unique handle for this log session returned from a call to StartLogCollection.
      * @param[in] error          A CHIP_ERROR value indicating the reason for ending the log collection.
      *                           It is permissible to pass CHIP_NO_ERROR to indicate normal termination.
-     * @note Derived classes can override this method to handle additional termination logic specific to their
-     *       implementation. If not overridden, this default implementation calls EndLogCollection with only
-     *       sessionHandle.
+     * @return CHIP_ERROR_NOT_IMPLEMENTED by default unless overridden.
      *
      */
     virtual CHIP_ERROR EndLogCollection(LogSessionHandle sessionHandle, CHIP_ERROR error)