examples/fabric-admin/device_manager/DeviceSubscription.cpp

/*
 *   Copyright (c) 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.
 *
 */

#include "DeviceSubscription.h"

#if defined(PW_RPC_ENABLED)
#include "rpc/RpcClient.h"
#endif

#include <app/InteractionModelEngine.h>
#include <app/server/Server.h>

#include <app-common/zap-generated/ids/Attributes.h>
#include <app-common/zap-generated/ids/Clusters.h>
#include <device_manager/DeviceManager.h>

using namespace ::chip;
using namespace ::chip::app;
using chip::app::ReadClient;

namespace {

void OnDeviceConnectedWrapper(void * context, Messaging::ExchangeManager & exchangeMgr, const SessionHandle & sessionHandle)
{
    reinterpret_cast<DeviceSubscription *>(context)->OnDeviceConnected(exchangeMgr, sessionHandle);
}

void OnDeviceConnectionFailureWrapper(void * context, const ScopedNodeId & peerId, CHIP_ERROR error)
{
    reinterpret_cast<DeviceSubscription *>(context)->OnDeviceConnectionFailure(peerId, error);
}

} // namespace

DeviceSubscription::DeviceSubscription() :
    mOnDeviceConnectedCallback(OnDeviceConnectedWrapper, this),
    mOnDeviceConnectionFailureCallback(OnDeviceConnectionFailureWrapper, this)
{}

void DeviceSubscription::OnAttributeData(const ConcreteDataAttributePath & path, TLV::TLVReader * data, const StatusIB & status)
{
    VerifyOrDie(path.mEndpointId == kRootEndpointId);
    VerifyOrDie(path.mClusterId == Clusters::AdministratorCommissioning::Id);

    switch (path.mAttributeId)
    {
    case Clusters::AdministratorCommissioning::Attributes::WindowStatus::Id: {
        Clusters::AdministratorCommissioning::CommissioningWindowStatusEnum windowStatus;
        CHIP_ERROR err = data->Get(windowStatus);
        VerifyOrReturn(err == CHIP_NO_ERROR, ChipLogError(NotSpecified, "Failed to read WindowStatus"));
        VerifyOrReturn(windowStatus != Clusters::AdministratorCommissioning::CommissioningWindowStatusEnum::kUnknownEnumValue);
#if defined(PW_RPC_ENABLED)
        mCurrentAdministratorCommissioningAttributes.window_status = static_cast<uint32_t>(windowStatus);
#endif
        mChangeDetected = true;
        break;
    }
    case Clusters::AdministratorCommissioning::Attributes::AdminFabricIndex::Id: {
#if defined(PW_RPC_ENABLED)
        FabricIndex fabricIndex;
        CHIP_ERROR err                                                       = data->Get(fabricIndex);
        mCurrentAdministratorCommissioningAttributes.has_opener_fabric_index = err == CHIP_NO_ERROR;
        if (mCurrentAdministratorCommissioningAttributes.has_opener_fabric_index)
        {
            mCurrentAdministratorCommissioningAttributes.opener_fabric_index = static_cast<uint32_t>(fabricIndex);
        }
#endif
        mChangeDetected = true;
        break;
    }
    case Clusters::AdministratorCommissioning::Attributes::AdminVendorId::Id: {
#if defined(PW_RPC_ENABLED)
        VendorId vendorId;
        CHIP_ERROR err                                                    = data->Get(vendorId);
        mCurrentAdministratorCommissioningAttributes.has_opener_vendor_id = err == CHIP_NO_ERROR;
        if (mCurrentAdministratorCommissioningAttributes.has_opener_vendor_id)
        {
            mCurrentAdministratorCommissioningAttributes.opener_vendor_id = static_cast<uint32_t>(vendorId);
        }
#endif
        mChangeDetected = true;
        break;
    }
    default:
        break;
    }
}

void DeviceSubscription::OnReportEnd()
{
    // Report end is at the end of all attributes (success)
    if (mChangeDetected)
    {
#if defined(PW_RPC_ENABLED)
        AdminCommissioningAttributeChanged(mCurrentAdministratorCommissioningAttributes);
#else
        ChipLogError(NotSpecified, "Cannot forward Administrator Commissioning Attribute to fabric bridge: RPC not enabled");
#endif
        mChangeDetected = false;
    }
}

void DeviceSubscription::OnDone(ReadClient * apReadClient)
{
    // After calling mOnDoneCallback we are indicating that `this` is deleted and we shouldn't do anything else with
    // DeviceSubscription.
    MoveToState(State::AwaitingDestruction);
    mOnDoneCallback(mScopedNodeId);
}

void DeviceSubscription::OnError(CHIP_ERROR error)
{
    ChipLogProgress(NotSpecified, "Error subscribing: %" CHIP_ERROR_FORMAT, error.Format());
}

void DeviceSubscription::OnDeviceConnected(Messaging::ExchangeManager & exchangeMgr, const SessionHandle & sessionHandle)
{
    if (mState == State::Stopping)
    {
        // After calling mOnDoneCallback we are indicating that `this` is deleted and we shouldn't do anything else with
        // DeviceSubscription.
        MoveToState(State::AwaitingDestruction);
        mOnDoneCallback(mScopedNodeId);
        return;
    }
    VerifyOrDie(mState == State::Connecting);
    mClient = std::make_unique<ReadClient>(app::InteractionModelEngine::GetInstance(), &exchangeMgr /* echangeMgr */,
                                           *this /* callback */, ReadClient::InteractionType::Subscribe);
    VerifyOrDie(mClient);

    AttributePathParams readPaths[1];
    readPaths[0] = AttributePathParams(kRootEndpointId, Clusters::AdministratorCommissioning::Id);

    ReadPrepareParams readParams(sessionHandle);

    readParams.mpAttributePathParamsList    = readPaths;
    readParams.mAttributePathParamsListSize = 1;
    readParams.mMaxIntervalCeilingSeconds   = 5 * 60;

    CHIP_ERROR err = mClient->SendRequest(readParams);

    if (err != CHIP_NO_ERROR)
    {
        ChipLogError(NotSpecified, "Failed to issue subscription to AdministratorCommissioning data");
        // After calling mOnDoneCallback we are indicating that `this` is deleted and we shouldn't do anything else with
        // DeviceSubscription.
        MoveToState(State::AwaitingDestruction);
        mOnDoneCallback(mScopedNodeId);
        return;
    }
    MoveToState(State::SubscriptionStarted);
}

void DeviceSubscription::MoveToState(const State aTargetState)
{
    mState = aTargetState;
    ChipLogDetail(NotSpecified, "DeviceSubscription moving to [%10.10s]", GetStateStr());
}

const char * DeviceSubscription::GetStateStr() const
{
    switch (mState)
    {
    case State::Idle:
        return "Idle";

    case State::Connecting:
        return "Connecting";

    case State::Stopping:
        return "Stopping";

    case State::SubscriptionStarted:
        return "SubscriptionStarted";

    case State::AwaitingDestruction:
        return "AwaitingDestruction";
    }
    return "N/A";
}

void DeviceSubscription::OnDeviceConnectionFailure(const ScopedNodeId & peerId, CHIP_ERROR error)
{
    VerifyOrDie(mState == State::Connecting || mState == State::Stopping);
    ChipLogError(NotSpecified, "DeviceSubscription failed to connect to " ChipLogFormatX64, ChipLogValueX64(peerId.GetNodeId()));
    // TODO(#35333) Figure out how we should recover if we fail to connect and mState == State::Connecting.

    // After calling mOnDoneCallback we are indicating that `this` is deleted and we shouldn't do anything else with
    // DeviceSubscription.
    MoveToState(State::AwaitingDestruction);
    mOnDoneCallback(mScopedNodeId);
}

CHIP_ERROR DeviceSubscription::StartSubscription(OnDoneCallback onDoneCallback, Controller::DeviceController & controller,
                                                 ScopedNodeId scopedNodeId)
{
    assertChipStackLockedByCurrentThread();
    VerifyOrDie(mState == State::Idle);
    VerifyOrReturnError(controller.GetFabricIndex() == scopedNodeId.GetFabricIndex(), CHIP_ERROR_INVALID_ARGUMENT);

    mScopedNodeId = scopedNodeId;

#if defined(PW_RPC_ENABLED)
    mCurrentAdministratorCommissioningAttributes                 = chip_rpc_AdministratorCommissioningChanged_init_default;
    mCurrentAdministratorCommissioningAttributes.has_id          = true;
    mCurrentAdministratorCommissioningAttributes.id.node_id      = scopedNodeId.GetNodeId();
    mCurrentAdministratorCommissioningAttributes.id.fabric_index = scopedNodeId.GetFabricIndex();
    mCurrentAdministratorCommissioningAttributes.window_status =
        static_cast<uint32_t>(Clusters::AdministratorCommissioning::CommissioningWindowStatusEnum::kWindowNotOpen);
#endif

    mOnDoneCallback = onDoneCallback;
    MoveToState(State::Connecting);
    CHIP_ERROR err =
        controller.GetConnectedDevice(scopedNodeId.GetNodeId(), &mOnDeviceConnectedCallback, &mOnDeviceConnectionFailureCallback);
    if (err != CHIP_NO_ERROR)
    {
        MoveToState(State::Idle);
    }
    return err;
}

void DeviceSubscription::StopSubscription()
{
    assertChipStackLockedByCurrentThread();
    VerifyOrDie(mState != State::Idle);
    // Something is seriously wrong if we die on the line below
    VerifyOrDie(mState != State::AwaitingDestruction);

    if (mState == State::Stopping)
    {
        // Stop is called again while we are still waiting on connected callbacks
        return;
    }

    if (mState == State::Connecting)
    {
        MoveToState(State::Stopping);
        return;
    }

    // By calling reset on our ReadClient we terminate the subscription.
    VerifyOrDie(mClient);
    mClient.reset();
    // After calling mOnDoneCallback we are indicating that `this` is deleted and we shouldn't do anything else with
    // DeviceSubscription.
    MoveToState(State::AwaitingDestruction);
    mOnDoneCallback(mScopedNodeId);
}