Remove StatusIB::InitFromChipError. (project-chip#34712)

bzbarsky-apple · web-flow · commit 26c816a5a618 · 2024-08-02T19:32:04.000Z
The constructor is a better fit for being able to convert CHIP_ERROR to
ClusterStatusCode and then to StatusIB.
diff --git a/examples/chip-tool/commands/common/RemoteDataModelLogger.cpp b/examples/chip-tool/commands/common/RemoteDataModelLogger.cpp
@@ -160,8 +160,7 @@ CHIP_ERROR LogErrorAsJSON(const CHIP_ERROR & error)
     VerifyOrReturnError(gDelegate != nullptr, CHIP_NO_ERROR);
 
     Json::Value value;
-    chip::app::StatusIB status;
-    status.InitFromChipError(error);
+    chip::app::StatusIB status(error);
     return LogError(value, status);
 }
 
diff --git a/examples/fabric-admin/commands/common/RemoteDataModelLogger.cpp b/examples/fabric-admin/commands/common/RemoteDataModelLogger.cpp
@@ -160,8 +160,7 @@ CHIP_ERROR LogErrorAsJSON(const CHIP_ERROR & error)
     VerifyOrReturnError(gDelegate != nullptr, CHIP_NO_ERROR);
 
     Json::Value value;
-    chip::app::StatusIB status;
-    status.InitFromChipError(error);
+    chip::app::StatusIB status(error);
     return LogError(value, status);
 }
 
diff --git a/src/app/CommandSender.h b/src/app/CommandSender.h
@@ -100,8 +100,8 @@ class CommandSender final : public Messaging::ExchangeDelegate
          * - CHIP_ERROR_TIMEOUT: A response was not received within the expected response timeout.
          * - CHIP_ERROR_*TLV*: A malformed, non-compliant response was received from the server.
          * - CHIP_ERROR encapsulating a StatusIB: If we got a non-path-specific
-         *   status response from the server.  In that case,
-         *   StatusIB::InitFromChipError can be used to extract the status.
+         *   status response from the server.  In that case, constructing
+         *   a StatusIB from the error can be used to extract the status.
          * - CHIP_ERROR*: All other cases.
          */
         CHIP_ERROR error;
diff --git a/src/app/CommandSenderLegacyCallback.h b/src/app/CommandSenderLegacyCallback.h
@@ -65,8 +65,8 @@ class CommandSenderLegacyCallback
      * - CHIP_ERROR_TIMEOUT: A response was not received within the expected response timeout.
      * - CHIP_ERROR_*TLV*: A malformed, non-compliant response was received from the server.
      * - CHIP_ERROR encapsulating a StatusIB: If we got a non-path-specific or path-specific
-     *   status response from the server.  In that case,
-     *   StatusIB::InitFromChipError can be used to extract the status.
+     *   status response from the server.  In that case, constructing a
+     *   StatusIB from the error can be used to extract the status.
      *      - Note: a CommandSender using `CommandSender::Callback` only supports sending
      *        a single InvokeRequest. As a result, only one path-specific error is expected
      *        to ever be sent to the OnError callback.
diff --git a/src/app/MessageDef/StatusIB.cpp b/src/app/MessageDef/StatusIB.cpp
@@ -149,7 +149,7 @@ CHIP_ERROR StatusIB::ToChipError() const
     return ChipError(ChipError::SdkPart::kIMGlobalStatus, to_underlying(mStatus));
 }
 
-void StatusIB::InitFromChipError(CHIP_ERROR aError)
+StatusIB::StatusIB(CHIP_ERROR aError)
 {
     if (aError.IsPart(ChipError::SdkPart::kIMClusterStatus))
     {
@@ -204,8 +204,7 @@ bool FormatStatusIBError(char * buf, uint16_t bufSize, CHIP_ERROR err)
     constexpr size_t formattedSize = max(sizeof(generalFormat) + statusNameMaxLength, sizeof(clusterFormat));
     char formattedString[formattedSize];
 
-    StatusIB status;
-    status.InitFromChipError(err);
+    StatusIB status(err);
     if (status.mClusterStatus.HasValue())
     {
         snprintf(formattedString, formattedSize, clusterFormat, status.mClusterStatus.Value());
diff --git a/src/app/MessageDef/StatusIB.h b/src/app/MessageDef/StatusIB.h
@@ -60,7 +60,7 @@ struct StatusIB
         }
     }
 
-    explicit StatusIB(CHIP_ERROR error) { InitFromChipError(error); }
+    explicit StatusIB(CHIP_ERROR error);
 
     enum class Tag : uint8_t
     {
@@ -105,13 +105,6 @@ struct StatusIB
      */
     CHIP_ERROR ToChipError() const;
 
-    /**
-     * Extract a CHIP_ERROR into this StatusIB.  If IsIMStatus() is false for
-     * the error, this might do a best-effort attempt to come up with a
-     * corresponding StatusIB, defaulting to a generic Status::Failure.
-     */
-    void InitFromChipError(CHIP_ERROR aError);
-
     /**
      * Test whether this status is a success.
      */
diff --git a/src/app/ReadClient.h b/src/app/ReadClient.h
@@ -195,8 +195,8 @@ class ReadClient : public Messaging::ExchangeDelegate
          * - CHIP_ERROR_TIMEOUT: A response was not received within the expected response timeout.
          * - CHIP_ERROR_*TLV*: A malformed, non-compliant response was received from the server.
          * - CHIP_ERROR encapsulating a StatusIB: If we got a non-path-specific
-         *   status response from the server.  In that case,
-         *   StatusIB::InitFromChipError can be used to extract the status.
+         *   status response from the server.  In that case, constructing
+         *   a StatusIB from the error can be used to extract the status.
          * - CHIP_ERROR*: All other cases.
          *
          * This object MUST continue to exist after this call is completed. The application shall wait until it
diff --git a/src/app/TimedRequest.h b/src/app/TimedRequest.h
@@ -38,8 +38,8 @@ class TimedRequest
     // but came in after we sent a timed request).
     //
     // If the response is a failure StatusResponse, its status will be
-    // encapsulated in the CHIP_ERROR this returns.  In that case,
-    // StatusIB::InitFromChipError can be used to extract the status.
+    // encapsulated in the CHIP_ERROR this returns.  In that case, constructing
+    // a StatusIB from the error can be used to extract the status.
     static CHIP_ERROR HandleResponse(const PayloadHeader & aPayloadHeader, System::PacketBufferHandle && aPayload);
 };
 
diff --git a/src/app/WriteClient.h b/src/app/WriteClient.h
@@ -88,8 +88,8 @@ class WriteClient : public Messaging::ExchangeDelegate
          * - CHIP_ERROR_TIMEOUT: A response was not received within the expected response timeout.
          * - CHIP_ERROR_*TLV*: A malformed, non-compliant response was received from the server.
          * - CHIP_ERROR encapsulating a StatusIB: If we got a non-path-specific
-         *   status response from the server.  In that case,
-         *   StatusIB::InitFromChipError can be used to extract the status.
+         *   status response from the server.  In that case, constructing
+         *   a StatusIB from the error can be used to extract the status.
          * - CHIP_ERROR*: All other cases.
          *
          * The WriteClient object MUST continue to exist after this call is completed. The application shall wait until it
diff --git a/src/app/tests/TestStatusIB.cpp b/src/app/tests/TestStatusIB.cpp
@@ -46,8 +46,7 @@ class TestStatusIB : public ::testing::Test
 #define VERIFY_ROUNDTRIP(err, status)                                                                                              \
     do                                                                                                                             \
     {                                                                                                                              \
-        StatusIB newStatus;                                                                                                        \
-        newStatus.InitFromChipError(err);                                                                                          \
+        StatusIB newStatus(err);                                                                                                   \
         EXPECT_EQ(newStatus.mStatus, status.mStatus);                                                                              \
         EXPECT_EQ(newStatus.mClusterStatus, status.mClusterStatus);                                                                \
     } while (0);
@@ -86,16 +85,14 @@ TEST_F(TestStatusIB, TestStatusIBToFromChipError)
     err            = status.ToChipError();
     EXPECT_NE(err, CHIP_NO_ERROR);
     {
-        StatusIB newStatus;
-        newStatus.InitFromChipError(err);
+        StatusIB newStatus(err);
         EXPECT_EQ(newStatus.mStatus, Status::Failure);
         EXPECT_EQ(newStatus.mClusterStatus, status.mClusterStatus);
     }
 
     err = CHIP_ERROR_NO_MEMORY;
     {
-        StatusIB newStatus;
-        newStatus.InitFromChipError(err);
+        StatusIB newStatus(err);
         EXPECT_EQ(newStatus.mStatus, Status::Failure);
         EXPECT_FALSE(newStatus.mClusterStatus.HasValue());
     }
diff --git a/src/controller/TypedReadCallback.h b/src/controller/TypedReadCallback.h
@@ -43,8 +43,8 @@ namespace Controller {
  *     encapsulate a StatusIB).  This could be a path-specific error or it
  *     could be a general error for the entire request; the distinction is not
  *     that important, because we only have one path involved.  If the
- *     CHIP_ERROR encapsulates a StatusIB, StatusIB::InitFromChipError can be
- *     used to extract the status.
+ *     CHIP_ERROR encapsulates a StatusIB, constructing a StatusIB from it will
+ *     extract the status.
  */
 template <typename DecodableAttributeType>
 class TypedReadAttributeCallback final : public app::ReadClient::Callback

Original file line number	Diff line number	Diff line change
`@@ -160,8 +160,7 @@ CHIP_ERROR LogErrorAsJSON(const CHIP_ERROR & error)`
`160`	`160`	`VerifyOrReturnError(gDelegate != nullptr, CHIP_NO_ERROR);`
`161`	`161`
`162`	`162`	`Json::Value value;`
`163`		`- chip::app::StatusIB status;`
`164`		`- status.InitFromChipError(error);`
	`163`	`+ chip::app::StatusIB status(error);`
`165`	`164`	`return LogError(value, status);`
`166`	`165`	`}`
`167`	`166`
Original file line number	Diff line number	Diff line change
`@@ -149,7 +149,7 @@ CHIP_ERROR StatusIB::ToChipError() const`
`149`	`149`	`return ChipError(ChipError::SdkPart::kIMGlobalStatus, to_underlying(mStatus));`
`150`	`150`	`}`
`151`	`151`
`152`		`-void StatusIB::InitFromChipError(CHIP_ERROR aError)`
	`152`	`+StatusIB::StatusIB(CHIP_ERROR aError)`
`153`	`153`	`{`
`154`	`154`	`if (aError.IsPart(ChipError::SdkPart::kIMClusterStatus))`
`155`	`155`	`{`
`@@ -204,8 +204,7 @@ bool FormatStatusIBError(char * buf, uint16_t bufSize, CHIP_ERROR err)`
`204`	`204`	`constexpr size_t formattedSize = max(sizeof(generalFormat) + statusNameMaxLength, sizeof(clusterFormat));`
`205`	`205`	`char formattedString[formattedSize];`
`206`	`206`
`207`		`- StatusIB status;`
`208`		`- status.InitFromChipError(err);`
	`207`	`+ StatusIB status(err);`
`209`	`208`	`if (status.mClusterStatus.HasValue())`
`210`	`209`	`{`
`211`	`210`	`snprintf(formattedString, formattedSize, clusterFormat, status.mClusterStatus.Value());`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ struct StatusIB`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`
`63`		`- explicit StatusIB(CHIP_ERROR error) { InitFromChipError(error); }`
	`63`	`+ explicit StatusIB(CHIP_ERROR error);`
`64`	`64`
`65`	`65`	`enum class Tag : uint8_t`
`66`	`66`	`{`
`@@ -105,13 +105,6 @@ struct StatusIB`
`105`	`105`	`*/`
`106`	`106`	`CHIP_ERROR ToChipError() const;`
`107`	`107`
`108`		`- /**`
`109`		`- * Extract a CHIP_ERROR into this StatusIB. If IsIMStatus() is false for`
`110`		`- * the error, this might do a best-effort attempt to come up with a`
`111`		`- * corresponding StatusIB, defaulting to a generic Status::Failure.`
`112`		`- */`
`113`		`- void InitFromChipError(CHIP_ERROR aError);`
`114`		`-`
`115`	`108`	`/**`
`116`	`109`	`* Test whether this status is a success.`
`117`	`110`	`*/`