CASE: move busy wait time parsing in status report module (project-chip#38491)

* move busy wait time parsing in status report module

* remove the unnecessary comment and use std::optional instead of
chip::Optional

* fix clang-tidy

Author: shubhamdp

src/protocols/secure_channel/PairingSession.h

@@ -183,25 +183,11 @@ class DLL_EXPORT PairingSession : public SessionDelegate
         }
 
         Optional<uintptr_t> protocolData;
-        if (report.GetGeneralCode() == Protocols::SecureChannel::GeneralStatusCode::kBusy &&
-            report.GetProtocolCode() == Protocols::SecureChannel::kProtocolCodeBusy)
+        if (report.IsBusy() && report.GetMinimumWaitTime().has_value())
         {
-            if (!report.GetProtocolData().IsNull())
-            {
-                Encoding::LittleEndian::Reader reader(report.GetProtocolData()->Start(), report.GetProtocolData()->DataLength());
-
-                uint16_t minimumWaitTime = 0;
-                CHIP_ERROR waitTimeErr   = reader.Read16(&minimumWaitTime).StatusCode();
-                if (waitTimeErr != CHIP_NO_ERROR)
-                {
-                    ChipLogError(SecureChannel, "Failed to read the minimum wait time: %" CHIP_ERROR_FORMAT, waitTimeErr.Format());
-                }
-                else
-                {
-                    ChipLogProgress(SecureChannel, "Received busy status report with minimum wait time: %u ms", minimumWaitTime);
-                    protocolData.Emplace(minimumWaitTime);
-                }
-            }
+            System::Clock::Milliseconds16 minimumWaitTime = report.GetMinimumWaitTime().value();
+            ChipLogProgress(SecureChannel, "Received busy status report with minimum wait time: %u ms", minimumWaitTime.count());
+            protocolData.Emplace(minimumWaitTime.count());
         }
 
         // It's very important that we propagate the return value from

src/protocols/secure_channel/StatusReport.cpp

@@ -16,6 +16,7 @@
  *    limitations under the License.
  */
 
+#include <optional>
 #include <protocols/secure_channel/Constants.h>
 #include <protocols/secure_channel/StatusReport.h>
 
@@ -70,6 +71,14 @@ CHIP_ERROR StatusReport::Parse(System::PacketBufferHandle buf)
         {
             return CHIP_ERROR_NO_MEMORY;
         }
+
+        if (IsBusy())
+        {
+            Encoding::LittleEndian::Reader reader(mProtocolData->Start(), mProtocolData->DataLength());
+            uint16_t tmpMinimumWaitTime = 0;
+            ReturnErrorOnFailure(reader.Read16(&tmpMinimumWaitTime).StatusCode());
+            mMinimumWaitTime = std::make_optional<System::Clock::Milliseconds16>(tmpMinimumWaitTime);
+        }
     }
     else
     {
@@ -95,6 +104,11 @@ size_t StatusReport::Size() const
     return WriteToBuffer(emptyBuf).Needed();
 }
 
+bool StatusReport::IsBusy() const
+{
+    return (mGeneralCode == GeneralStatusCode::kBusy && mProtocolCode == kProtocolCodeBusy);
+}
+
 System::PacketBufferHandle StatusReport::MakeBusyStatusReportMessage(System::Clock::Milliseconds16 minimumWaitTime)
 {
     using namespace Protocols::SecureChannel;
@@ -113,6 +127,7 @@ System::PacketBufferHandle StatusReport::MakeBusyStatusReportMessage(System::Clo
 
     // Build a busy status report
     StatusReport statusReport(GeneralStatusCode::kBusy, Protocols::SecureChannel::Id, kProtocolCodeBusy, std::move(handle));
+    statusReport.mMinimumWaitTime = std::make_optional<System::Clock::Milliseconds16>(minimumWaitTime);
 
     // Build the status report message
     handle = System::PacketBufferHandle::New(statusReport.Size());

src/protocols/secure_channel/StatusReport.h

@@ -18,7 +18,9 @@
 
 #pragma once
 
+#include <lib/core/Optional.h>
 #include <lib/support/BufferWriter.h>
+#include <optional>
 #include <protocols/Protocols.h>
 #include <protocols/secure_channel/Constants.h>
 #include <system/SystemClock.h>
@@ -95,6 +97,17 @@ class DLL_EXPORT StatusReport
     uint16_t GetProtocolCode() const { return mProtocolCode; }
     const System::PacketBufferHandle & GetProtocolData() const { return mProtocolData; }
 
+    /**
+     * Returns the minimum wait time if the status report is of type busy.
+     * If status report is not busy, then this is an empty optional.
+     */
+    std::optional<System::Clock::Milliseconds16> GetMinimumWaitTime() const { return mMinimumWaitTime; }
+
+    /**
+     *  Returns true if the status report is of type busy.
+     */
+    bool IsBusy() const;
+
     /**
      * Builds a busy status report with protocol data containing the minimum wait time.
      *
@@ -108,7 +121,7 @@ class DLL_EXPORT StatusReport
     GeneralStatusCode mGeneralCode;
     Protocols::Id mProtocolId;
     uint16_t mProtocolCode;
-
+    std::optional<System::Clock::Milliseconds16> mMinimumWaitTime;
     System::PacketBufferHandle mProtocolData;
 };
 

src/protocols/secure_channel/tests/TestStatusReport.cpp

@@ -124,15 +124,13 @@ TEST_F(TestStatusReport, TestMakeBusyStatusReport)
     EXPECT_EQ(reportToParse.GetGeneralCode(), generalCode);
     EXPECT_EQ(reportToParse.GetProtocolId(), protocolId);
     EXPECT_EQ(reportToParse.GetProtocolCode(), protocolCode);
-
-    const System::PacketBufferHandle & rcvData = reportToParse.GetProtocolData();
-    ASSERT_FALSE(rcvData.IsNull());
-    EXPECT_EQ(rcvData->DataLength(), sizeof(minimumWaitTime));
-
-    uint16_t readMinimumWaitTime = 0;
-    Encoding::LittleEndian::Reader reader(rcvData->Start(), rcvData->DataLength());
-    EXPECT_EQ(reader.Read16(&readMinimumWaitTime).StatusCode(), CHIP_NO_ERROR);
-    EXPECT_EQ(System::Clock::Milliseconds16(readMinimumWaitTime), minimumWaitTime);
+    EXPECT_TRUE(reportToParse.IsBusy());
+    auto tmpMinimumWaitTime = reportToParse.GetMinimumWaitTime();
+    EXPECT_TRUE(tmpMinimumWaitTime.has_value());
+    if (tmpMinimumWaitTime.has_value())
+    {
+        EXPECT_EQ(tmpMinimumWaitTime.value(), minimumWaitTime);
+    }
 }
 
 // Test Suite