src/app/CommandHandlerImpl.h - third_party/github/project-chip/connectedhomeip - Git at Google

 /*
  *    Copyright (c) 2020-2024 Project CHIP Authors
  *    All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
  *    You may obtain a copy of the License at
  *
  *        http://www.apache.org/licenses/LICENSE-2.0
  *
  *    Unless required by applicable law or agreed to in writing, software
  *    distributed under the License is distributed on an "AS IS" BASIS,
  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
 #pragma once

 #include <app/CommandHandler.h>

 #include <app/CommandPathRegistry.h>
 #include <app/MessageDef/InvokeRequestMessage.h>
 #include <app/MessageDef/InvokeResponseMessage.h>
 #include <lib/core/TLV.h>
 #include <lib/core/TLVDebug.h>
 #include <lib/support/BitFlags.h>
 #include <lib/support/Scoped.h>
 #include <messaging/ExchangeHolder.h>
 #include <messaging/Flags.h>
 #include <protocols/Protocols.h>
 #include <protocols/interaction_model/Constants.h>
 #include <protocols/interaction_model/StatusCode.h>
 #include <system/SystemPacketBuffer.h>
 #include <system/TLVPacketBufferBackingStore.h>

 namespace chip {
 namespace app {

 class CommandHandlerImpl : public CommandHandler
 {
 public:
     class Callback
     {
     public:
         virtual ~Callback() = default;

         /*
          * Method that signals to a registered callback that this object
          * has completed doing useful work and is now safe for release/destruction.
          */
         virtual void OnDone(CommandHandlerImpl & apCommandObj) = 0;

         /*
          * Upon processing of a CommandDataIB, this method is invoked to dispatch the command
          * to the right server-side handler provided by the application.
          */
         virtual void DispatchCommand(CommandHandlerImpl & apCommandObj, const ConcreteCommandPath & aCommandPath,
                                      TLV::TLVReader & apPayload) = 0;

         /*
          * Check to see if a command implementation exists for a specific
          * concrete command path.  If it does, Success will be returned.  If
          * not, one of UnsupportedEndpoint, UnsupportedCluster, or
          * UnsupportedCommand will be returned, depending on how the command
          * fails to exist.
          */
         virtual Protocols::InteractionModel::Status CommandExists(const ConcreteCommandPath & aCommandPath) = 0;
     };

     struct InvokeResponseParameters
     {
         InvokeResponseParameters(const ConcreteCommandPath & aRequestCommandPath) : mRequestCommandPath(aRequestCommandPath) {}

         InvokeResponseParameters & SetStartOrEndDataStruct(bool aStartOrEndDataStruct)
         {
             mStartOrEndDataStruct = aStartOrEndDataStruct;
             return *this;
         }

         ConcreteCommandPath mRequestCommandPath;
         /**
          * Whether the method this is being provided to should start/end the TLV container for the CommandFields element
          * within CommandDataIB.
          */
         bool mStartOrEndDataStruct = true;
     };

     struct TestOnlyOverrides
     {
     public:
         CommandPathRegistry * commandPathRegistry          = nullptr;
         CommandHandlerExchangeInterface * commandResponder = nullptr;
     };

     /*
      * The callback passed in has to outlive this CommandHandler object.
      */
     CommandHandlerImpl(Callback * apCallback);

     /*
      * The destructor will also invalidate all Handles created for this CommandHandlerImpl.
      */
     virtual ~CommandHandlerImpl();

     /*
      * Constructor to override the number of supported paths per invoke and command responder.
      *
      * The callback and any pointers passed via TestOnlyOverrides must outlive this
      * CommandHandlerImpl object.
      *
      * For testing purposes.
      */
     CommandHandlerImpl(TestOnlyOverrides & aTestOverride, Callback * apCallback);

     /**************** CommandHandler interface implementation ***********************/

     using CommandHandler::AddResponseData;
     using CommandHandler::AddStatus;
     using CommandHandler::FallibleAddStatus;

     void FlushAcksRightAwayOnSlowCommand() override;

     CHIP_ERROR FallibleAddStatus(const ConcreteCommandPath & aRequestCommandPath,
                                  const Protocols::InteractionModel::ClusterStatusCode & aStatus,
                                  const char * context = nullptr) override;
     void AddStatus(const ConcreteCommandPath & aCommandPath, const Protocols::InteractionModel::ClusterStatusCode & aStatus,
                    const char * context = nullptr) override;

     CHIP_ERROR AddResponseData(const ConcreteCommandPath & aRequestCommandPath, CommandId aResponseCommandId,
                                const DataModel::EncodableToTLV & aEncodable) override;
     void AddResponse(const ConcreteCommandPath & aRequestCommandPath, CommandId aResponseCommandId,
                      const DataModel::EncodableToTLV & aEncodable) override;

     Access::SubjectDescriptor GetSubjectDescriptor() const override;
     FabricIndex GetAccessingFabricIndex() const override;
     bool IsTimedInvoke() const override;
     Messaging::ExchangeContext * GetExchangeContext() const override;

     /**************** Implementation-specific logic ***********************/

     /*
      * Main entrypoint for this class to handle an InvokeRequestMessage.
      *
      * This function MAY call the registered OnDone callback before returning.
      * To prevent immediate OnDone invocation, callers can wrap their CommandHandlerImpl instance
      * within a CommandHandler::Handle.
      *
      * isTimedInvoke is true if and only if this is part of a Timed Invoke
      * transaction (i.e. was preceded by a Timed Request).  If we reach here,
      * the timer verification has already been done.
      *
      * commandResponder handles sending InvokeResponses, added by clusters, to the client. The
      * command responder object must outlive this CommandHandler object. It is only safe to
      * release after the caller of OnInvokeCommandRequest receives the OnDone callback.
      */
     Protocols::InteractionModel::Status OnInvokeCommandRequest(CommandHandlerExchangeInterface & commandResponder,
                                                                System::PacketBufferHandle && payload, bool isTimedInvoke);

     /**
      * Checks that all CommandDataIB within InvokeRequests satisfy the spec's general
      * constraints for CommandDataIB. Additionally checks that InvokeRequestMessage is
      * properly formatted.
      *
      * This also builds a registry to ensure that all commands can be responded
      * to with the data required as per spec.
      */
     CHIP_ERROR ValidateInvokeRequestMessageAndBuildRegistry(InvokeRequestMessage::Parser & invokeRequestMessage);

     /**
      * This adds a new CommandDataIB element into InvokeResponses for the associated
      * aRequestCommandPath. This adds up until the `CommandFields` element within
      * `CommandDataIB`.
      *
      * This call will fail if CommandHandler is already in the middle of building a
      * CommandStatusIB or CommandDataIB (i.e. something has called Prepare*, without
      * calling Finish*), or is already sending InvokeResponseMessage.
      *
      * Upon success, the caller is expected to call `FinishCommand` once they have added
      * all the fields into the CommandFields element of CommandDataIB.
      *
      * @param [in] aResponseCommandPath the concrete response path that we are sending to Requester.
      * @param [in] aPrepareParameters struct containing paramters needs for preparing a command. Data
      *             such as request path, and whether this method should start the CommandFields element within
      *             CommandDataIB.
      */
     CHIP_ERROR PrepareInvokeResponseCommand(const ConcreteCommandPath & aResponseCommandPath,
                                             const InvokeResponseParameters & aPrepareParameters);

     /**
      * Finishes the CommandDataIB element within the InvokeResponses.
      *
      * Caller must have first successfully called `PrepareInvokeResponseCommand`.
      *
      * @param [in] aEndDataStruct end the TLV container for the CommandFields element within
      *             CommandDataIB. This should match the boolean passed into Prepare*.
      *
      * @return CHIP_ERROR_INCORRECT_STATE
      *                      If device has not previously successfully called
      *                      `PrepareInvokeResponseCommand`.
      * @return CHIP_ERROR_BUFFER_TOO_SMALL
      *                      If writing the values needed to finish the InvokeReponseIB
      *                      with the current contents of the InvokeResponseMessage
      *                      would exceed the limit. When this error occurs, it is possible
      *                      we have already closed some of the IB Builders that were
      *                      previously started in `PrepareInvokeResponseCommand`.
      * @return CHIP_ERROR_NO_MEMORY
      *                      If TLVWriter attempted to allocate an output buffer failed due to
      *                      lack of memory.
      * @return other        Other TLVWriter related errors. Typically occurs if
      *                      `GetCommandDataIBTLVWriter()` was called and used incorrectly.
      */
     // TODO(#30453): We should be able to eliminate the chances of OOM issues with reserve.
     // This will be completed in a follow up PR.
     CHIP_ERROR FinishCommand(bool aEndDataStruct = true);

     TLV::TLVWriter * GetCommandDataIBTLVWriter();

 #if CHIP_WITH_NLFAULTINJECTION

     enum class NlFaultInjectionType : uint8_t
     {
         SeparateResponseMessages,
         SeparateResponseMessagesAndInvertedResponseOrder,
         SkipSecondResponse
     };

     /**
      * @brief Sends InvokeResponseMessages with injected faults for certification testing.
      *
      * The Test Harness (TH) uses this to simulate various server response behaviors,
      * ensuring the Device Under Test (DUT) handles responses per specification.
      *
      * This function strictly validates the DUT's InvokeRequestMessage against the test plan.
      * If deviations occur, the TH terminates with a detailed error message.
      *
      * @param commandResponder commandResponder that will send the InvokeResponseMessages to the client.
      * @param payload Payload of the incoming InvokeRequestMessage from the client.
      * @param isTimedInvoke Indicates whether the interaction is timed.
      * @param faultType The specific type of fault to inject into the response.
      */
     // TODO(#30453): After refactoring CommandHandler for better unit testability, create a
     // unit test specifically for the fault injection behavior.
     void TestOnlyInvokeCommandRequestWithFaultsInjected(CommandHandlerExchangeInterface & commandResponder,
                                                         System::PacketBufferHandle && payload, bool isTimedInvoke,
                                                         NlFaultInjectionType faultType);
 #endif // CHIP_WITH_NLFAULTINJECTION

 protected:
     // Lifetime management for CommandHandler::Handle

     void IncrementHoldOff(Handle * apHandle) override;
     void DecrementHoldOff(Handle * apHandle) override;

 private:
     friend class TestCommandInteraction;
     friend class CommandHandler::Handle;

     enum class State : uint8_t
     {
         Idle,                ///< Default state that the object starts out in, where no work has commenced
         NewResponseMessage,  ///< mInvokeResponseBuilder is ready, with no responses added.
         Preparing,           ///< We are prepaing the command or status header.
         AddingCommand,       ///< In the process of adding a command.
         AddedCommand,        ///< A command has been completely encoded and is awaiting transmission.
         DispatchResponses,   ///< The command response(s) are being dispatched.
         AwaitingDestruction, ///< The object has completed its work and is awaiting destruction by the application.
     };

     /**
      * @brief Best effort to add InvokeResponse to InvokeResponseMessage.
      *
      * Tries to add response using lambda. Upon failure to add response, attempts
      * to rollback the InvokeResponseMessage to a known good state. If failure is due
      * to insufficient space in the current InvokeResponseMessage:
      *  - Finalizes the current InvokeResponseMessage.
      *  - Allocates a new InvokeResponseMessage.
      *  - Reattempts to add the InvokeResponse to the new InvokeResponseMessage.
      *
      * @param [in] addResponseFunction A lambda function responsible for adding the
      *             response to the current InvokeResponseMessage.
      */
     template <typename Function>
     CHIP_ERROR TryAddingResponse(Function && addResponseFunction)
     {
         // Invalidate any existing rollback backups. The addResponseFunction is
         // expected to create a new backup during either PrepareInvokeResponseCommand
         // or PrepareStatus execution. Direct invocation of
         // CreateBackupForResponseRollback is avoided since the buffer used by
         // InvokeResponseMessage might not be allocated until a Prepare* function
         // is called.
         mRollbackBackupValid = false;
         CHIP_ERROR err       = addResponseFunction();
         if (err == CHIP_NO_ERROR)
         {
             return CHIP_NO_ERROR;
         }
         // The error value of RollbackResponse is not important if it fails, we prioritize
         // conveying the error generated by addResponseFunction to the caller.
         if (RollbackResponse() != CHIP_NO_ERROR)
         {
             return err;
         }
         // If we failed to add a command due to lack of space in the
         // packet, we will make another attempt to add the response using
         // an additional InvokeResponseMessage.
         if (mState != State::AddedCommand || err != CHIP_ERROR_NO_MEMORY)
         {
             return err;
         }
         ReturnErrorOnFailure(FinalizeInvokeResponseMessageAndPrepareNext());
         err = addResponseFunction();
         if (err != CHIP_NO_ERROR)
         {
             // The return value of RollbackResponse is ignored, as we prioritize
             // conveying the error generated by addResponseFunction to the
             // caller.
             RollbackResponse();
         }
         return err;
     }

     void MoveToState(const State aTargetState);
     const char * GetStateStr() const;

     /**
      * Create a backup to enable rolling back to the state prior to ResponseData encoding in the event of failure.
      */
     void CreateBackupForResponseRollback();

     /**
      * Rollback the state to before encoding the current ResponseData (before calling PrepareInvokeResponseCommand / PrepareStatus)
      *
      * Requires CreateBackupForResponseRollback to be called at the start of PrepareInvokeResponseCommand / PrepareStatus
      */
     CHIP_ERROR RollbackResponse();

     /*
      * This forcibly closes the exchange context if a valid one is pointed to. Such a situation does
      * not arise during normal message processing flows that all normally call Close() above. This can only
      * arise due to application-initiated destruction of the object when this object is handling receiving/sending
      * message payloads.
      */
     void Abort();

     /*
      * Allocates a packet buffer used for encoding an invoke response payload.
      *
      * This can be called multiple times safely, as it will only allocate the buffer once for the lifetime
      * of this object.
      */
     CHIP_ERROR AllocateBuffer();

     /**
      * This will add a new CommandStatusIB element into InvokeResponses. It will put the
      * aCommandPath into the CommandPath element within CommandStatusIB.
      *
      * This call will fail if CommandHandler is already in the middle of building a
      * CommandStatusIB or CommandDataIB (i.e. something has called Prepare*, without
      * calling Finish*), or is already sending InvokeResponseMessage.
      *
      * Upon success, the caller is expected to call `FinishStatus` once they have encoded
      * StatusIB.
      *
      * @param [in] aCommandPath the concrete path of the command we are responding to.
      */
     CHIP_ERROR PrepareStatus(const ConcreteCommandPath & aCommandPath);

     /**
      * Finishes the CommandStatusIB element within the InvokeResponses.
      *
      * Caller must have first successfully called `PrepareStatus`.
      */
     CHIP_ERROR FinishStatus();

     CHIP_ERROR PrepareInvokeResponseCommand(const CommandPathRegistryEntry & apCommandPathRegistryEntry,
                                             const ConcreteCommandPath & aCommandPath, bool aStartDataStruct);

     CHIP_ERROR FinalizeLastInvokeResponseMessage() { return FinalizeInvokeResponseMessage(/* aHasMoreChunks = */ false); }

     CHIP_ERROR FinalizeInvokeResponseMessageAndPrepareNext();

     CHIP_ERROR FinalizeInvokeResponseMessage(bool aHasMoreChunks);

     Protocols::InteractionModel::Status ProcessInvokeRequest(System::PacketBufferHandle && payload, bool isTimedInvoke);

     /**
      * Called internally to signal the completion of all work on this object, gracefully close the
      * exchange (by calling into the base class) and finally, signal to a registerd callback that it's
      * safe to release this object.
      */
     void Close();

     /**
      * ProcessCommandDataIB is only called when a unicast invoke command request is received
      * It requires the endpointId in its command path to be able to dispatch the command
      */
     Protocols::InteractionModel::Status ProcessCommandDataIB(CommandDataIB::Parser & aCommandElement);

     /**
      * ProcessGroupCommandDataIB is only called when a group invoke command request is received
      * It doesn't need the endpointId in it's command path since it uses the GroupId in message metadata to find it
      */
     Protocols::InteractionModel::Status ProcessGroupCommandDataIB(CommandDataIB::Parser & aCommandElement);

     CHIP_ERROR TryAddStatusInternal(const ConcreteCommandPath & aCommandPath, const StatusIB & aStatus);

     CHIP_ERROR AddStatusInternal(const ConcreteCommandPath & aCommandPath, const StatusIB & aStatus);

     /**
      * If this function fails, it may leave our TLV buffer in an inconsistent state.
      * Callers should snapshot as needed before calling this function, and roll back
      * as needed afterward.
      *
      * @param [in] aRequestCommandPath the concrete path of the command we are responding to
      * @param [in] aResponseCommandId the id of the command to encode
      * @param [in] aEncodable the data to encode for the given aResponseCommandId
      */
     CHIP_ERROR TryAddResponseData(const ConcreteCommandPath & aRequestCommandPath, CommandId aResponseCommandId,
                                   const DataModel::EncodableToTLV & aEncodable);

     void SetExchangeInterface(CommandHandlerExchangeInterface * commandResponder);

     /**
      * Check whether the InvokeRequest we are handling is targeted to a group.
      */
     bool IsGroupRequest() { return mGroupRequest; }

     bool ResponsesAccepted() { return !(mGroupRequest || mpResponder == nullptr); }

     /**
      * Sets the state flag to keep the information that request we are handling is targeted to a group.
      */
     void SetGroupRequest(bool isGroupRequest) { mGroupRequest = isGroupRequest; }

     CommandPathRegistry & GetCommandPathRegistry() const { return *mCommandPathRegistry; }

     size_t MaxPathsPerInvoke() const { return mMaxPathsPerInvoke; }

     void AddToHandleList(Handle * handle);

     void RemoveFromHandleList(Handle * handle);

     void InvalidateHandles();

     bool TestOnlyIsInIdleState() const { return mState == State::Idle; }

     Callback * mpCallback = nullptr;
     InvokeResponseMessage::Builder mInvokeResponseBuilder;
     TLV::TLVType mDataElementContainerType = TLV::kTLVType_NotSpecified;
     size_t mPendingWork                    = 0;
     /* List to store all currently-outstanding Handles for this Command Handler.*/
     IntrusiveList<Handle> mpHandleList;

     chip::System::PacketBufferTLVWriter mCommandMessageWriter;
     TLV::TLVWriter mBackupWriter;
     size_t mMaxPathsPerInvoke = CHIP_CONFIG_MAX_PATHS_PER_INVOKE;
     // TODO(#30453): See if we can reduce this size for the default cases
     // TODO Allow flexibility in registration.
     BasicCommandPathRegistry<CHIP_CONFIG_MAX_PATHS_PER_INVOKE> mBasicCommandPathRegistry;
     CommandPathRegistry * mCommandPathRegistry = &mBasicCommandPathRegistry;
     std::optional<uint16_t> mRefForResponse;

     CommandHandlerExchangeInterface * mpResponder = nullptr;

     State mState = State::Idle;
     State mBackupState;
     ScopedChangeOnly<bool> mInternalCallToAddResponseData{ false };
     bool mSuppressResponse                 = false;
     bool mTimedRequest                     = false;
     bool mGroupRequest                     = false;
     bool mBufferAllocated                  = false;
     bool mReserveSpaceForMoreChunkMessages = false;
     // TODO(#32486): We should introduce breaking change where calls to add CommandData
     // need to use AddResponse, and not CommandHandler primitives directly using
     // GetCommandDataIBTLVWriter.
     bool mRollbackBackupValid = false;
     // If mGoneAsync is true, we have finished out initial processing of the
     // incoming invoke.  After this point, our session could go away at any
     // time.
     bool mGoneAsync = false;
 };
 } // namespace app
 } // namespace chip
	/*
	* Copyright (c) 2020-2024 Project CHIP Authors
	* All rights reserved.
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/
	#pragma once

	#include <app/CommandHandler.h>

	#include <app/CommandPathRegistry.h>
	#include <app/MessageDef/InvokeRequestMessage.h>
	#include <app/MessageDef/InvokeResponseMessage.h>
	#include <lib/core/TLV.h>
	#include <lib/core/TLVDebug.h>
	#include <lib/support/BitFlags.h>
	#include <lib/support/Scoped.h>
	#include <messaging/ExchangeHolder.h>
	#include <messaging/Flags.h>
	#include <protocols/Protocols.h>
	#include <protocols/interaction_model/Constants.h>
	#include <protocols/interaction_model/StatusCode.h>
	#include <system/SystemPacketBuffer.h>
	#include <system/TLVPacketBufferBackingStore.h>

	namespace chip {
	namespace app {

	class CommandHandlerImpl : public CommandHandler
	{
	public:
	class Callback
	{
	public:
	virtual ~Callback() = default;

	/*
	* Method that signals to a registered callback that this object
	* has completed doing useful work and is now safe for release/destruction.
	*/
	virtual void OnDone(CommandHandlerImpl & apCommandObj) = 0;

	/*
	* Upon processing of a CommandDataIB, this method is invoked to dispatch the command
	* to the right server-side handler provided by the application.
	*/
	virtual void DispatchCommand(CommandHandlerImpl & apCommandObj, const ConcreteCommandPath & aCommandPath,
	TLV::TLVReader & apPayload) = 0;

	/*
	* Check to see if a command implementation exists for a specific
	* concrete command path. If it does, Success will be returned. If
	* not, one of UnsupportedEndpoint, UnsupportedCluster, or
	* UnsupportedCommand will be returned, depending on how the command
	* fails to exist.
	*/
	virtual Protocols::InteractionModel::Status CommandExists(const ConcreteCommandPath & aCommandPath) = 0;
	};

	struct InvokeResponseParameters
	{
	InvokeResponseParameters(const ConcreteCommandPath & aRequestCommandPath) : mRequestCommandPath(aRequestCommandPath) {}

	InvokeResponseParameters & SetStartOrEndDataStruct(bool aStartOrEndDataStruct)
	{
	mStartOrEndDataStruct = aStartOrEndDataStruct;
	return *this;
	}

	ConcreteCommandPath mRequestCommandPath;
	/**
	* Whether the method this is being provided to should start/end the TLV container for the CommandFields element
	* within CommandDataIB.
	*/
	bool mStartOrEndDataStruct = true;
	};

	struct TestOnlyOverrides
	{
	public:
	CommandPathRegistry * commandPathRegistry = nullptr;
	CommandHandlerExchangeInterface * commandResponder = nullptr;
	};

	/*
	* The callback passed in has to outlive this CommandHandler object.
	*/
	CommandHandlerImpl(Callback * apCallback);

	/*
	* The destructor will also invalidate all Handles created for this CommandHandlerImpl.
	*/
	virtual ~CommandHandlerImpl();

	/*
	* Constructor to override the number of supported paths per invoke and command responder.
	*
	* The callback and any pointers passed via TestOnlyOverrides must outlive this
	* CommandHandlerImpl object.
	*
	* For testing purposes.
	*/
	CommandHandlerImpl(TestOnlyOverrides & aTestOverride, Callback * apCallback);

	/************** CommandHandler interface implementation *********************/

	using CommandHandler::AddResponseData;
	using CommandHandler::AddStatus;
	using CommandHandler::FallibleAddStatus;

	void FlushAcksRightAwayOnSlowCommand() override;

	CHIP_ERROR FallibleAddStatus(const ConcreteCommandPath & aRequestCommandPath,
	const Protocols::InteractionModel::ClusterStatusCode & aStatus,
	const char * context = nullptr) override;
	void AddStatus(const ConcreteCommandPath & aCommandPath, const Protocols::InteractionModel::ClusterStatusCode & aStatus,
	const char * context = nullptr) override;

	CHIP_ERROR AddResponseData(const ConcreteCommandPath & aRequestCommandPath, CommandId aResponseCommandId,
	const DataModel::EncodableToTLV & aEncodable) override;
	void AddResponse(const ConcreteCommandPath & aRequestCommandPath, CommandId aResponseCommandId,
	const DataModel::EncodableToTLV & aEncodable) override;

	Access::SubjectDescriptor GetSubjectDescriptor() const override;
	FabricIndex GetAccessingFabricIndex() const override;
	bool IsTimedInvoke() const override;
	Messaging::ExchangeContext * GetExchangeContext() const override;

	/************** Implementation-specific logic *********************/

	/*
	* Main entrypoint for this class to handle an InvokeRequestMessage.
	*
	* This function MAY call the registered OnDone callback before returning.
	* To prevent immediate OnDone invocation, callers can wrap their CommandHandlerImpl instance
	* within a CommandHandler::Handle.
	*
	* isTimedInvoke is true if and only if this is part of a Timed Invoke
	* transaction (i.e. was preceded by a Timed Request). If we reach here,
	* the timer verification has already been done.
	*
	* commandResponder handles sending InvokeResponses, added by clusters, to the client. The
	* command responder object must outlive this CommandHandler object. It is only safe to
	* release after the caller of OnInvokeCommandRequest receives the OnDone callback.
	*/
	Protocols::InteractionModel::Status OnInvokeCommandRequest(CommandHandlerExchangeInterface & commandResponder,
	System::PacketBufferHandle && payload, bool isTimedInvoke);

	/**
	* Checks that all CommandDataIB within InvokeRequests satisfy the spec's general
	* constraints for CommandDataIB. Additionally checks that InvokeRequestMessage is
	* properly formatted.
	*
	* This also builds a registry to ensure that all commands can be responded
	* to with the data required as per spec.
	*/
	CHIP_ERROR ValidateInvokeRequestMessageAndBuildRegistry(InvokeRequestMessage::Parser & invokeRequestMessage);

	/**
	* This adds a new CommandDataIB element into InvokeResponses for the associated
	* aRequestCommandPath. This adds up until the `CommandFields` element within
	* `CommandDataIB`.
	*
	* This call will fail if CommandHandler is already in the middle of building a
	* CommandStatusIB or CommandDataIB (i.e. something has called Prepare*, without
	* calling Finish*), or is already sending InvokeResponseMessage.
	*
	* Upon success, the caller is expected to call `FinishCommand` once they have added
	* all the fields into the CommandFields element of CommandDataIB.
	*
	* @param [in] aResponseCommandPath the concrete response path that we are sending to Requester.
	* @param [in] aPrepareParameters struct containing paramters needs for preparing a command. Data
	* such as request path, and whether this method should start the CommandFields element within
	* CommandDataIB.
	*/
	CHIP_ERROR PrepareInvokeResponseCommand(const ConcreteCommandPath & aResponseCommandPath,
	const InvokeResponseParameters & aPrepareParameters);

	/**
	* Finishes the CommandDataIB element within the InvokeResponses.
	*
	* Caller must have first successfully called `PrepareInvokeResponseCommand`.
	*
	* @param [in] aEndDataStruct end the TLV container for the CommandFields element within
	* CommandDataIB. This should match the boolean passed into Prepare*.
	*
	* @return CHIP_ERROR_INCORRECT_STATE
	* If device has not previously successfully called
	* `PrepareInvokeResponseCommand`.
	* @return CHIP_ERROR_BUFFER_TOO_SMALL
	* If writing the values needed to finish the InvokeReponseIB
	* with the current contents of the InvokeResponseMessage
	* would exceed the limit. When this error occurs, it is possible
	* we have already closed some of the IB Builders that were
	* previously started in `PrepareInvokeResponseCommand`.
	* @return CHIP_ERROR_NO_MEMORY
	* If TLVWriter attempted to allocate an output buffer failed due to
	* lack of memory.
	* @return other Other TLVWriter related errors. Typically occurs if
	* `GetCommandDataIBTLVWriter()` was called and used incorrectly.
	*/
	// TODO(#30453): We should be able to eliminate the chances of OOM issues with reserve.
	// This will be completed in a follow up PR.
	CHIP_ERROR FinishCommand(bool aEndDataStruct = true);

	TLV::TLVWriter * GetCommandDataIBTLVWriter();

	#if CHIP_WITH_NLFAULTINJECTION

	enum class NlFaultInjectionType : uint8_t
	{
	SeparateResponseMessages,
	SeparateResponseMessagesAndInvertedResponseOrder,
	SkipSecondResponse
	};

	/**
	* @brief Sends InvokeResponseMessages with injected faults for certification testing.
	*
	* The Test Harness (TH) uses this to simulate various server response behaviors,
	* ensuring the Device Under Test (DUT) handles responses per specification.
	*
	* This function strictly validates the DUT's InvokeRequestMessage against the test plan.
	* If deviations occur, the TH terminates with a detailed error message.
	*
	* @param commandResponder commandResponder that will send the InvokeResponseMessages to the client.
	* @param payload Payload of the incoming InvokeRequestMessage from the client.
	* @param isTimedInvoke Indicates whether the interaction is timed.
	* @param faultType The specific type of fault to inject into the response.
	*/
	// TODO(#30453): After refactoring CommandHandler for better unit testability, create a
	// unit test specifically for the fault injection behavior.
	void TestOnlyInvokeCommandRequestWithFaultsInjected(CommandHandlerExchangeInterface & commandResponder,
	System::PacketBufferHandle && payload, bool isTimedInvoke,
	NlFaultInjectionType faultType);
	#endif // CHIP_WITH_NLFAULTINJECTION

	protected:
	// Lifetime management for CommandHandler::Handle

	void IncrementHoldOff(Handle * apHandle) override;
	void DecrementHoldOff(Handle * apHandle) override;

	private:
	friend class TestCommandInteraction;
	friend class CommandHandler::Handle;

	enum class State : uint8_t
	{
	Idle, ///< Default state that the object starts out in, where no work has commenced
	NewResponseMessage, ///< mInvokeResponseBuilder is ready, with no responses added.
	Preparing, ///< We are prepaing the command or status header.
	AddingCommand, ///< In the process of adding a command.
	AddedCommand, ///< A command has been completely encoded and is awaiting transmission.
	DispatchResponses, ///< The command response(s) are being dispatched.
	AwaitingDestruction, ///< The object has completed its work and is awaiting destruction by the application.
	};

	/**
	* @brief Best effort to add InvokeResponse to InvokeResponseMessage.
	*
	* Tries to add response using lambda. Upon failure to add response, attempts
	* to rollback the InvokeResponseMessage to a known good state. If failure is due
	* to insufficient space in the current InvokeResponseMessage:
	* - Finalizes the current InvokeResponseMessage.
	* - Allocates a new InvokeResponseMessage.
	* - Reattempts to add the InvokeResponse to the new InvokeResponseMessage.
	*
	* @param [in] addResponseFunction A lambda function responsible for adding the
	* response to the current InvokeResponseMessage.
	*/
	template <typename Function>
	CHIP_ERROR TryAddingResponse(Function && addResponseFunction)
	{
	// Invalidate any existing rollback backups. The addResponseFunction is
	// expected to create a new backup during either PrepareInvokeResponseCommand
	// or PrepareStatus execution. Direct invocation of
	// CreateBackupForResponseRollback is avoided since the buffer used by
	// InvokeResponseMessage might not be allocated until a Prepare* function
	// is called.
	mRollbackBackupValid = false;
	CHIP_ERROR err = addResponseFunction();
	if (err == CHIP_NO_ERROR)
	{
	return CHIP_NO_ERROR;
	}
	// The error value of RollbackResponse is not important if it fails, we prioritize
	// conveying the error generated by addResponseFunction to the caller.
	if (RollbackResponse() != CHIP_NO_ERROR)
	{
	return err;
	}
	// If we failed to add a command due to lack of space in the
	// packet, we will make another attempt to add the response using
	// an additional InvokeResponseMessage.
	if (mState != State::AddedCommand \|\| err != CHIP_ERROR_NO_MEMORY)
	{
	return err;
	}
	ReturnErrorOnFailure(FinalizeInvokeResponseMessageAndPrepareNext());
	err = addResponseFunction();
	if (err != CHIP_NO_ERROR)
	{
	// The return value of RollbackResponse is ignored, as we prioritize
	// conveying the error generated by addResponseFunction to the
	// caller.
	RollbackResponse();
	}
	return err;
	}

	void MoveToState(const State aTargetState);
	const char * GetStateStr() const;

	/**
	* Create a backup to enable rolling back to the state prior to ResponseData encoding in the event of failure.
	*/
	void CreateBackupForResponseRollback();

	/**
	* Rollback the state to before encoding the current ResponseData (before calling PrepareInvokeResponseCommand / PrepareStatus)
	*
	* Requires CreateBackupForResponseRollback to be called at the start of PrepareInvokeResponseCommand / PrepareStatus
	*/
	CHIP_ERROR RollbackResponse();

	/*
	* This forcibly closes the exchange context if a valid one is pointed to. Such a situation does
	* not arise during normal message processing flows that all normally call Close() above. This can only
	* arise due to application-initiated destruction of the object when this object is handling receiving/sending
	* message payloads.
	*/
	void Abort();

	/*
	* Allocates a packet buffer used for encoding an invoke response payload.
	*
	* This can be called multiple times safely, as it will only allocate the buffer once for the lifetime
	* of this object.
	*/
	CHIP_ERROR AllocateBuffer();

	/**
	* This will add a new CommandStatusIB element into InvokeResponses. It will put the
	* aCommandPath into the CommandPath element within CommandStatusIB.
	*
	* This call will fail if CommandHandler is already in the middle of building a
	* CommandStatusIB or CommandDataIB (i.e. something has called Prepare*, without
	* calling Finish*), or is already sending InvokeResponseMessage.
	*
	* Upon success, the caller is expected to call `FinishStatus` once they have encoded
	* StatusIB.
	*
	* @param [in] aCommandPath the concrete path of the command we are responding to.
	*/
	CHIP_ERROR PrepareStatus(const ConcreteCommandPath & aCommandPath);

	/**
	* Finishes the CommandStatusIB element within the InvokeResponses.
	*
	* Caller must have first successfully called `PrepareStatus`.
	*/
	CHIP_ERROR FinishStatus();

	CHIP_ERROR PrepareInvokeResponseCommand(const CommandPathRegistryEntry & apCommandPathRegistryEntry,
	const ConcreteCommandPath & aCommandPath, bool aStartDataStruct);

	CHIP_ERROR FinalizeLastInvokeResponseMessage() { return FinalizeInvokeResponseMessage(/* aHasMoreChunks = */ false); }

	CHIP_ERROR FinalizeInvokeResponseMessageAndPrepareNext();

	CHIP_ERROR FinalizeInvokeResponseMessage(bool aHasMoreChunks);

	Protocols::InteractionModel::Status ProcessInvokeRequest(System::PacketBufferHandle && payload, bool isTimedInvoke);

	/**
	* Called internally to signal the completion of all work on this object, gracefully close the
	* exchange (by calling into the base class) and finally, signal to a registerd callback that it's
	* safe to release this object.
	*/
	void Close();

	/**
	* ProcessCommandDataIB is only called when a unicast invoke command request is received
	* It requires the endpointId in its command path to be able to dispatch the command
	*/
	Protocols::InteractionModel::Status ProcessCommandDataIB(CommandDataIB::Parser & aCommandElement);

	/**
	* ProcessGroupCommandDataIB is only called when a group invoke command request is received
	* It doesn't need the endpointId in it's command path since it uses the GroupId in message metadata to find it
	*/
	Protocols::InteractionModel::Status ProcessGroupCommandDataIB(CommandDataIB::Parser & aCommandElement);

	CHIP_ERROR TryAddStatusInternal(const ConcreteCommandPath & aCommandPath, const StatusIB & aStatus);

	CHIP_ERROR AddStatusInternal(const ConcreteCommandPath & aCommandPath, const StatusIB & aStatus);

	/**
	* If this function fails, it may leave our TLV buffer in an inconsistent state.
	* Callers should snapshot as needed before calling this function, and roll back
	* as needed afterward.
	*
	* @param [in] aRequestCommandPath the concrete path of the command we are responding to
	* @param [in] aResponseCommandId the id of the command to encode
	* @param [in] aEncodable the data to encode for the given aResponseCommandId
	*/
	CHIP_ERROR TryAddResponseData(const ConcreteCommandPath & aRequestCommandPath, CommandId aResponseCommandId,
	const DataModel::EncodableToTLV & aEncodable);

	void SetExchangeInterface(CommandHandlerExchangeInterface * commandResponder);

	/**
	* Check whether the InvokeRequest we are handling is targeted to a group.
	*/
	bool IsGroupRequest() { return mGroupRequest; }

	bool ResponsesAccepted() { return !(mGroupRequest \|\| mpResponder == nullptr); }

	/**
	* Sets the state flag to keep the information that request we are handling is targeted to a group.
	*/
	void SetGroupRequest(bool isGroupRequest) { mGroupRequest = isGroupRequest; }

	CommandPathRegistry & GetCommandPathRegistry() const { return *mCommandPathRegistry; }

	size_t MaxPathsPerInvoke() const { return mMaxPathsPerInvoke; }

	void AddToHandleList(Handle * handle);

	void RemoveFromHandleList(Handle * handle);

	void InvalidateHandles();

	bool TestOnlyIsInIdleState() const { return mState == State::Idle; }

	Callback * mpCallback = nullptr;
	InvokeResponseMessage::Builder mInvokeResponseBuilder;
	TLV::TLVType mDataElementContainerType = TLV::kTLVType_NotSpecified;
	size_t mPendingWork = 0;
	/* List to store all currently-outstanding Handles for this Command Handler.*/
	IntrusiveList<Handle> mpHandleList;

	chip::System::PacketBufferTLVWriter mCommandMessageWriter;
	TLV::TLVWriter mBackupWriter;
	size_t mMaxPathsPerInvoke = CHIP_CONFIG_MAX_PATHS_PER_INVOKE;
	// TODO(#30453): See if we can reduce this size for the default cases
	// TODO Allow flexibility in registration.
	BasicCommandPathRegistry<CHIP_CONFIG_MAX_PATHS_PER_INVOKE> mBasicCommandPathRegistry;
	CommandPathRegistry * mCommandPathRegistry = &mBasicCommandPathRegistry;
	std::optional<uint16_t> mRefForResponse;

	CommandHandlerExchangeInterface * mpResponder = nullptr;

	State mState = State::Idle;
	State mBackupState;
	ScopedChangeOnly<bool> mInternalCallToAddResponseData{ false };
	bool mSuppressResponse = false;
	bool mTimedRequest = false;
	bool mGroupRequest = false;
	bool mBufferAllocated = false;
	bool mReserveSpaceForMoreChunkMessages = false;
	// TODO(#32486): We should introduce breaking change where calls to add CommandData
	// need to use AddResponse, and not CommandHandler primitives directly using
	// GetCommandDataIBTLVWriter.
	bool mRollbackBackupValid = false;
	// If mGoneAsync is true, we have finished out initial processing of the
	// incoming invoke. After this point, our session could go away at any
	// time.
	bool mGoneAsync = false;
	};
	} // namespace app
	} // namespace chip