From 813c2455b7af50f9f39810040a7e0782b22c05fc Mon Sep 17 00:00:00 2001
From: Ethan Zhou <73028112+ethanzhouyc@users.noreply.github.com>
Date: Mon, 28 Oct 2024 17:12:28 -0400
Subject: [PATCH 1/8] update zap version to 10.24 (#36271)

---
 scripts/setup/zap.json             | 4 ++--
 scripts/setup/zap.version          | 2 +-
 scripts/tools/zap/zap_execution.py | 2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/scripts/setup/zap.json b/scripts/setup/zap.json
index 8b18116caaa5be..8b64288e667f04 100644
--- a/scripts/setup/zap.json
+++ b/scripts/setup/zap.json
@@ -8,13 +8,13 @@
                 "mac-amd64",
                 "windows-amd64"
             ],
-            "tags": ["version:2@v2024.10.15-nightly.1"]
+            "tags": ["version:2@v2024.10.24-nightly.1"]
         },
         {
             "_comment": "Always get the amd64 version on mac until usable arm64 zap build is available",
             "path": "fuchsia/third_party/zap/mac-amd64",
             "platforms": ["mac-arm64"],
-            "tags": ["version:2@v2024.10.15-nightly.1"]
+            "tags": ["version:2@v2024.10.24-nightly.1"]
         }
     ]
 }
diff --git a/scripts/setup/zap.version b/scripts/setup/zap.version
index e58d8c5cac5d73..0696cc2123a3ed 100644
--- a/scripts/setup/zap.version
+++ b/scripts/setup/zap.version
@@ -1 +1 @@
-v2024.10.15-nightly
+v2024.10.24-nightly
diff --git a/scripts/tools/zap/zap_execution.py b/scripts/tools/zap/zap_execution.py
index 9ed0b0f222ab38..72d68a74ffd4c2 100644
--- a/scripts/tools/zap/zap_execution.py
+++ b/scripts/tools/zap/zap_execution.py
@@ -23,7 +23,7 @@
 # Use scripts/tools/zap/version_update.py to manage ZAP versioning as many
 # files may need updating for versions
 #
-MIN_ZAP_VERSION = '2024.10.15'
+MIN_ZAP_VERSION = '2024.10.24'
 
 
 class ZapTool:

From bcdddaa9fd53d8b6d71daf6dde6d5276ce4c8d5c Mon Sep 17 00:00:00 2001
From: Junior Martinez <67972863+jmartinez-silabs@users.noreply.github.com>
Date: Mon, 28 Oct 2024 17:48:23 -0400
Subject: [PATCH 2/8] =?UTF-8?q?[Silabs]=20Add=20logs=20for=20ble=20connect?=
 =?UTF-8?q?ion=20negotiations=20events.=20add=20a=20step=20to=20increa?=
 =?UTF-8?q?=E2=80=A6=20(#36254)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Add logs for ble connection negotiations events. add a step to increase the ble connection timeout when it is under a prefer threshold.

* Update src/platform/silabs/efr32/BLEManagerImpl.cpp

Co-authored-by: Kiel Oleson <kielo@apple.com>

* Apply suggestions from code review

Co-authored-by: Ricardo Casallas <77841255+rcasallas-silabs@users.noreply.github.com>

---------

Co-authored-by: Kiel Oleson <kielo@apple.com>
Co-authored-by: Ricardo Casallas <77841255+rcasallas-silabs@users.noreply.github.com>
---
 src/platform/silabs/BLEManagerImpl.h         |  1 +
 src/platform/silabs/efr32/BLEManagerImpl.cpp | 28 ++++++++++++++++++--
 2 files changed, 27 insertions(+), 2 deletions(-)

diff --git a/src/platform/silabs/BLEManagerImpl.h b/src/platform/silabs/BLEManagerImpl.h
index 9380accce38e55..9ebf113c4f8afa 100644
--- a/src/platform/silabs/BLEManagerImpl.h
+++ b/src/platform/silabs/BLEManagerImpl.h
@@ -68,6 +68,7 @@ class BLEManagerImpl final : public BLEManager, private BleLayer, private BlePla
     int32_t SendBLEAdvertisementCommand(void);
 #else
     void HandleConnectEvent(volatile sl_bt_msg_t * evt);
+    void HandleConnectParams(volatile sl_bt_msg_t * evt);
     void HandleConnectionCloseEvent(volatile sl_bt_msg_t * evt);
     void HandleWriteEvent(volatile sl_bt_msg_t * evt);
     void UpdateMtu(volatile sl_bt_msg_t * evt);
diff --git a/src/platform/silabs/efr32/BLEManagerImpl.cpp b/src/platform/silabs/efr32/BLEManagerImpl.cpp
index ef553bffa152a1..1f8704896f71cb 100644
--- a/src/platform/silabs/efr32/BLEManagerImpl.cpp
+++ b/src/platform/silabs/efr32/BLEManagerImpl.cpp
@@ -674,6 +674,21 @@ void BLEManagerImpl::HandleConnectEvent(volatile sl_bt_msg_t * evt)
     PlatformMgr().ScheduleWork(DriveBLEState, 0);
 }
 
+void BLEManagerImpl::HandleConnectParams(volatile sl_bt_msg_t * evt)
+{
+    sl_bt_evt_connection_parameters_t * con_param_evt = (sl_bt_evt_connection_parameters_t *) &(evt->data);
+
+    if (con_param_evt->timeout < BLE_CONFIG_TIMEOUT)
+    {
+        ChipLogProgress(DeviceLayer, "Request to increase the connection timeout from %d to %d", con_param_evt->timeout,
+                        BLE_CONFIG_TIMEOUT);
+        sl_bt_connection_set_parameters(con_param_evt->connection, BLE_CONFIG_MIN_INTERVAL, BLE_CONFIG_MAX_INTERVAL,
+                                        BLE_CONFIG_LATENCY, BLE_CONFIG_TIMEOUT, BLE_CONFIG_MIN_CE_LENGTH, BLE_CONFIG_MAX_CE_LENGTH);
+    }
+
+    PlatformMgr().ScheduleWork(DriveBLEState, 0);
+}
+
 void BLEManagerImpl::HandleConnectionCloseEvent(volatile sl_bt_msg_t * evt)
 {
     sl_bt_evt_connection_closed_t * conn_evt = (sl_bt_evt_connection_closed_t *) &(evt->data);
@@ -1061,11 +1076,20 @@ extern "C" void sl_bt_on_event(sl_bt_msg_t * evt)
     }
     break;
     case sl_bt_evt_connection_parameters_id: {
-        // ChipLogProgress(DeviceLayer, "Connection parameter ID received");
+        ChipLogProgress(DeviceLayer, "Connection parameter ID received - i:%d, l:%d, t:%d, sm:%d",
+                        evt->data.evt_connection_parameters.interval, evt->data.evt_connection_parameters.latency,
+                        evt->data.evt_connection_parameters.timeout, evt->data.evt_connection_parameters.security_mode);
+        chip::DeviceLayer::Internal::BLEMgrImpl().HandleConnectParams(evt);
     }
     break;
     case sl_bt_evt_connection_phy_status_id: {
-        // ChipLogProgress(DeviceLayer, "PHY update procedure is completed");
+        ChipLogProgress(DeviceLayer, "Connection phy status ID received - phy:%d", evt->data.evt_connection_phy_status.phy);
+    }
+    break;
+    case sl_bt_evt_connection_data_length_id: {
+        ChipLogProgress(DeviceLayer, "Connection data length ID received - txL:%d, txT:%d, rxL:%d, rxL:%d",
+                        evt->data.evt_connection_data_length.tx_data_len, evt->data.evt_connection_data_length.tx_time_us,
+                        evt->data.evt_connection_data_length.rx_data_len, evt->data.evt_connection_data_length.rx_time_us);
     }
     break;
     case sl_bt_evt_connection_closed_id: {

From cea1e36e314a760e0e633dcc735de9a1d130cfde Mon Sep 17 00:00:00 2001
From: Vivien Nicolas <vnicolas@apple.com>
Date: Tue, 29 Oct 2024 01:49:04 +0100
Subject: [PATCH 3/8] =?UTF-8?q?[darwin-framework-tool]=20Set=20device=20de?=
 =?UTF-8?q?legate=20when=20using=20MTRDevice=20with=20=E2=80=93use-mtr-dev?=
 =?UTF-8?q?ice=20(#36263)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 examples/darwin-framework-tool/BUILD.gn       |  2 +
 .../commands/clusters/ReportCommandBridge.h   |  4 +-
 .../commands/common/CHIPCommandBridge.h       |  2 +
 .../commands/common/CHIPCommandBridge.mm      | 15 ++++
 .../commands/common/DeviceDelegate.h          | 23 +++++++
 .../commands/common/DeviceDelegate.mm         | 69 +++++++++++++++++++
 .../Matter.xcodeproj/project.pbxproj          |  8 +++
 7 files changed, 120 insertions(+), 3 deletions(-)
 create mode 100644 examples/darwin-framework-tool/commands/common/DeviceDelegate.h
 create mode 100644 examples/darwin-framework-tool/commands/common/DeviceDelegate.mm

diff --git a/examples/darwin-framework-tool/BUILD.gn b/examples/darwin-framework-tool/BUILD.gn
index 0d1e142f1074df..1c492ba10a1241 100644
--- a/examples/darwin-framework-tool/BUILD.gn
+++ b/examples/darwin-framework-tool/BUILD.gn
@@ -194,6 +194,8 @@ executable("darwin-framework-tool") {
     "commands/common/CertificateIssuer.mm",
     "commands/common/ControllerStorage.h",
     "commands/common/ControllerStorage.mm",
+    "commands/common/DeviceDelegate.h",
+    "commands/common/DeviceDelegate.mm",
     "commands/common/MTRDevice_Externs.h",
     "commands/common/MTRError.mm",
     "commands/common/MTRError_Utils.h",
diff --git a/examples/darwin-framework-tool/commands/clusters/ReportCommandBridge.h b/examples/darwin-framework-tool/commands/clusters/ReportCommandBridge.h
index cd8125e3b12273..ba3428341ec8e8 100644
--- a/examples/darwin-framework-tool/commands/clusters/ReportCommandBridge.h
+++ b/examples/darwin-framework-tool/commands/clusters/ReportCommandBridge.h
@@ -105,9 +105,7 @@ class ReadAttribute : public ModelCommand {
             LogNSError("Error reading attribute", error);
             RemoteDataModelLogger::LogAttributeErrorAsJSON(endpoint, cluster, attribute, error);
         } else {
-            for (id item in values) {
-                NSLog(@"Response Item: %@", [item description]);
-            }
+            NSLog(@"cluster (0x%08" PRIX32 ") ReadAttribute (0x%08" PRIX32 ") on endpoint %u: %@", mClusterId, mAttributeId, endpointId, values);
             RemoteDataModelLogger::LogAttributeAsJSON(endpoint, cluster, attribute, values);
         }
 
diff --git a/examples/darwin-framework-tool/commands/common/CHIPCommandBridge.h b/examples/darwin-framework-tool/commands/common/CHIPCommandBridge.h
index 90f3a6c56415f6..2f53c0dd7bc4db 100644
--- a/examples/darwin-framework-tool/commands/common/CHIPCommandBridge.h
+++ b/examples/darwin-framework-tool/commands/common/CHIPCommandBridge.h
@@ -52,6 +52,7 @@ class CHIPCommandBridge : public Command {
         AddArgument("commissioner-vendor-id", 0, UINT16_MAX, &mCommissionerVendorId,
             "The vendor id to use for darwin-framework-tool. If not provided, chip::VendorId::TestVendor1 (65521, 0xFFF1) will be "
             "used.");
+        AddArgument("pretend-thread-enabled", 0, 1, &mPretendThreadEnabled, "When the command is issued using an MTRDevice (via -use-mtr-device), instructs the MTRDevice to treat the target device as a Thread device.");
     }
 
     /////////// Command Interface /////////
@@ -164,4 +165,5 @@ class CHIPCommandBridge : public Command {
     chip::Optional<char *> mPaaTrustStorePath;
     chip::Optional<chip::VendorId> mCommissionerVendorId;
     std::string mCurrentIdentity;
+    chip::Optional<bool> mPretendThreadEnabled;
 };
diff --git a/examples/darwin-framework-tool/commands/common/CHIPCommandBridge.mm b/examples/darwin-framework-tool/commands/common/CHIPCommandBridge.mm
index b237acaa5b7132..2eba24c84ad44c 100644
--- a/examples/darwin-framework-tool/commands/common/CHIPCommandBridge.mm
+++ b/examples/darwin-framework-tool/commands/common/CHIPCommandBridge.mm
@@ -28,12 +28,15 @@
 #import "CHIPCommandStorageDelegate.h"
 #import "CertificateIssuer.h"
 #import "ControllerStorage.h"
+#import "DeviceDelegate.h"
 #include "MTRError_Utils.h"
 
 #include <map>
 #include <string>
 
 static CHIPToolPersistentStorageDelegate * storage = nil;
+static DeviceDelegate * sDeviceDelegate = nil;
+static dispatch_queue_t sDeviceDelegateDispatchQueue = nil;
 std::set<CHIPCommandBridge *> CHIPCommandBridge::sDeferredCleanups;
 std::map<std::string, MTRDeviceController *> CHIPCommandBridge::mControllers;
 dispatch_queue_t CHIPCommandBridge::mOTAProviderCallbackQueue;
@@ -302,6 +305,18 @@
     __auto_type * device = [MTRDevice deviceWithNodeID:@(nodeId) controller:controller];
     VerifyOrReturnValue(nil != device, nil);
 
+    // The device delegate is initialized only once, when the first MTRDevice is created.
+    // As a result, subsequent commands using --use-mtr-device don’t need to specify the
+    // `--pretend-thread-enabled 1` argument again. Any further attempts to set it to `0` will also be ignored.
+    if (sDeviceDelegate == nil) {
+        sDeviceDelegate = [[DeviceDelegate alloc] init];
+        sDeviceDelegateDispatchQueue = dispatch_queue_create("com.chip.devicedelegate", DISPATCH_QUEUE_SERIAL_WITH_AUTORELEASE_POOL);
+        if (mPretendThreadEnabled.ValueOr(false)) {
+            [sDeviceDelegate setPretendThreadEnabled:YES];
+        }
+    }
+    [device addDelegate:sDeviceDelegate queue:sDeviceDelegateDispatchQueue];
+
     return device;
 }
 
diff --git a/examples/darwin-framework-tool/commands/common/DeviceDelegate.h b/examples/darwin-framework-tool/commands/common/DeviceDelegate.h
new file mode 100644
index 00000000000000..a3f5cf427f191c
--- /dev/null
+++ b/examples/darwin-framework-tool/commands/common/DeviceDelegate.h
@@ -0,0 +1,23 @@
+/*
+ *   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.
+ *
+ */
+
+#import <Matter/Matter.h>
+
+@interface DeviceDelegate : NSObject <MTRDeviceDelegate>
+- (void)setPretendThreadEnabled:(BOOL)threadEnabled;
+@end
diff --git a/examples/darwin-framework-tool/commands/common/DeviceDelegate.mm b/examples/darwin-framework-tool/commands/common/DeviceDelegate.mm
new file mode 100644
index 00000000000000..ecf8e708e26ff3
--- /dev/null
+++ b/examples/darwin-framework-tool/commands/common/DeviceDelegate.mm
@@ -0,0 +1,69 @@
+/*
+ *   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.
+ *
+ */
+
+#import "DeviceDelegate.h"
+
+#include <lib/support/logging/CHIPLogging.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface DeviceDelegate ()
+@property (nonatomic, readwrite) BOOL threadEnabled;
+@end
+
+@implementation DeviceDelegate
+- (instancetype)init
+{
+    if (self = [super init]) {
+        _threadEnabled = NO;
+    }
+    return self;
+}
+
+- (void)device:(MTRDevice *)device stateChanged:(MTRDeviceState)state
+{
+}
+
+- (void)device:(MTRDevice *)device receivedAttributeReport:(NSArray<NSDictionary<NSString *, id> *> *)attributeReport
+{
+}
+
+- (void)device:(MTRDevice *)device receivedEventReport:(NSArray<NSDictionary<NSString *, id> *> *)eventReport
+{
+}
+
+- (void)deviceCachePrimed:(MTRDevice *)device
+{
+}
+
+- (void)deviceConfigurationChanged:(MTRDevice *)device
+{
+}
+
+- (void)setPretendThreadEnabled:(BOOL)threadEnabled
+{
+    _threadEnabled = threadEnabled;
+}
+
+- (BOOL)unitTestPretendThreadEnabled:(MTRDevice *)device
+{
+    return _threadEnabled;
+}
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/src/darwin/Framework/Matter.xcodeproj/project.pbxproj b/src/darwin/Framework/Matter.xcodeproj/project.pbxproj
index 6a802900d8d30c..673f1cacaabc10 100644
--- a/src/darwin/Framework/Matter.xcodeproj/project.pbxproj
+++ b/src/darwin/Framework/Matter.xcodeproj/project.pbxproj
@@ -336,6 +336,8 @@
 		B2E0D7B7245B0B5C003C5B48 /* MTRQRCodeSetupPayloadParser.mm in Sources */ = {isa = PBXBuildFile; fileRef = B2E0D7AE245B0B5C003C5B48 /* MTRQRCodeSetupPayloadParser.mm */; };
 		B2E0D7B8245B0B5C003C5B48 /* MTRSetupPayload.h in Headers */ = {isa = PBXBuildFile; fileRef = B2E0D7AF245B0B5C003C5B48 /* MTRSetupPayload.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		B2E0D7B9245B0B5C003C5B48 /* MTRSetupPayload.mm in Sources */ = {isa = PBXBuildFile; fileRef = B2E0D7B0245B0B5C003C5B48 /* MTRSetupPayload.mm */; };
+		B409D0AE2CCFB89600A7ED5A /* DeviceDelegate.h in Headers */ = {isa = PBXBuildFile; fileRef = B409D0AC2CCFB89600A7ED5A /* DeviceDelegate.h */; };
+		B409D0AF2CCFB89600A7ED5A /* DeviceDelegate.mm in Sources */ = {isa = PBXBuildFile; fileRef = B409D0AD2CCFB89600A7ED5A /* DeviceDelegate.mm */; };
 		B43B39EA2CB859A5006AA284 /* DumpMemoryGraphCommand.mm in Sources */ = {isa = PBXBuildFile; fileRef = B43B39E62CB859A5006AA284 /* DumpMemoryGraphCommand.mm */; };
 		B43B39EB2CB859A5006AA284 /* LeaksTool.mm in Sources */ = {isa = PBXBuildFile; fileRef = B43B39E82CB859A5006AA284 /* LeaksTool.mm */; };
 		B43B39EC2CB859A5006AA284 /* DumpMemoryGraphCommand.h in Headers */ = {isa = PBXBuildFile; fileRef = B43B39E52CB859A5006AA284 /* DumpMemoryGraphCommand.h */; };
@@ -800,6 +802,8 @@
 		B2E0D7AE245B0B5C003C5B48 /* MTRQRCodeSetupPayloadParser.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = MTRQRCodeSetupPayloadParser.mm; sourceTree = "<group>"; };
 		B2E0D7AF245B0B5C003C5B48 /* MTRSetupPayload.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MTRSetupPayload.h; sourceTree = "<group>"; };
 		B2E0D7B0245B0B5C003C5B48 /* MTRSetupPayload.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = MTRSetupPayload.mm; sourceTree = "<group>"; };
+		B409D0AC2CCFB89600A7ED5A /* DeviceDelegate.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = DeviceDelegate.h; sourceTree = "<group>"; };
+		B409D0AD2CCFB89600A7ED5A /* DeviceDelegate.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = DeviceDelegate.mm; sourceTree = "<group>"; };
 		B43B39E42CB859A5006AA284 /* Commands.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = Commands.h; sourceTree = "<group>"; };
 		B43B39E52CB859A5006AA284 /* DumpMemoryGraphCommand.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = DumpMemoryGraphCommand.h; sourceTree = "<group>"; };
 		B43B39E62CB859A5006AA284 /* DumpMemoryGraphCommand.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = DumpMemoryGraphCommand.mm; sourceTree = "<group>"; };
@@ -1013,6 +1017,8 @@
 		037C3D9B2991BD4F00B7EEE2 /* common */ = {
 			isa = PBXGroup;
 			children = (
+				B409D0AC2CCFB89600A7ED5A /* DeviceDelegate.h */,
+				B409D0AD2CCFB89600A7ED5A /* DeviceDelegate.mm */,
 				B43B39EF2CB99090006AA284 /* CertificateIssuer.h */,
 				B43B39F02CB99090006AA284 /* CertificateIssuer.mm */,
 				B43B39F12CB99090006AA284 /* ControllerStorage.h */,
@@ -1673,6 +1679,7 @@
 				B4F773CA2CB54B61008C6B23 /* LeakChecker.h in Headers */,
 				B43B39F82CB99090006AA284 /* CertificateIssuer.h in Headers */,
 				B43B39F92CB99090006AA284 /* PreferencesStorage.h in Headers */,
+				B409D0AE2CCFB89600A7ED5A /* DeviceDelegate.h in Headers */,
 				B43B39FA2CB99090006AA284 /* ControllerStorage.h in Headers */,
 				037C3DB82991BD5000B7EEE2 /* ClusterCommandBridge.h in Headers */,
 				037C3DC82991BD5100B7EEE2 /* CHIPToolKeypair.h in Headers */,
@@ -2058,6 +2065,7 @@
 				0382FA302992F40C00247BBB /* ComplexArgumentParser.cpp in Sources */,
 				039145E12993102B00257B3E /* main.mm in Sources */,
 				037C3DD42991BD5200B7EEE2 /* logging.mm in Sources */,
+				B409D0AF2CCFB89600A7ED5A /* DeviceDelegate.mm in Sources */,
 				512431282BA0C8BF000BC136 /* SetMRPParametersCommand.mm in Sources */,
 				512431292BA0C8BF000BC136 /* ResetMRPParametersCommand.mm in Sources */,
 				037C3DB32991BD5000B7EEE2 /* OpenCommissioningWindowCommand.mm in Sources */,

From 73a1c0b740f81d1c28dff25d60dda3e4fc322f71 Mon Sep 17 00:00:00 2001
From: Vivien Nicolas <vnicolas@apple.com>
Date: Tue, 29 Oct 2024 03:20:16 +0100
Subject: [PATCH 4/8] [examples-app] Add options to configure MRP intervals at
 application launch (#36272)

---
 examples/platform/linux/Options.cpp | 49 +++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/examples/platform/linux/Options.cpp b/examples/platform/linux/Options.cpp
index 6f8afea5bb496b..30732ae7e0a034 100644
--- a/examples/platform/linux/Options.cpp
+++ b/examples/platform/linux/Options.cpp
@@ -46,6 +46,10 @@
 #include <system/SystemFaultInjection.h>
 #endif
 
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
+#include <messaging/ReliableMessageProtocolConfig.h>
+#endif
+
 using namespace chip;
 using namespace chip::ArgParser;
 using namespace chip::Platform;
@@ -112,6 +116,9 @@ enum
     kDeviceOption_WiFiSupports5g,
 #if CONFIG_BUILD_FOR_HOST_UNIT_TEST
     kDeviceOption_SubscriptionResumptionRetryIntervalSec,
+    kDeviceOption_IdleRetransmitTimeout,
+    kDeviceOption_ActiveRetransmitTimeout,
+    kDeviceOption_ActiveThresholdTime,
 #endif
 #if CHIP_WITH_NLFAULTINJECTION
     kDeviceOption_FaultInjection,
@@ -187,6 +194,9 @@ OptionDef sDeviceOptionDefs[] = {
 #if CONFIG_BUILD_FOR_HOST_UNIT_TEST
     { "subscription-capacity", kArgumentRequired, kDeviceOption_SubscriptionCapacity },
     { "subscription-resumption-retry-interval", kArgumentRequired, kDeviceOption_SubscriptionResumptionRetryIntervalSec },
+    { "idle-retransmit-timeout", kArgumentRequired, kDeviceOption_IdleRetransmitTimeout },
+    { "active-retransmit-timeout", kArgumentRequired, kDeviceOption_ActiveRetransmitTimeout },
+    { "active-threshold-time", kArgumentRequired, kDeviceOption_ActiveThresholdTime },
 #endif
 #if CHIP_WITH_NLFAULTINJECTION
     { "faults", kArgumentRequired, kDeviceOption_FaultInjection },
@@ -335,6 +345,19 @@ const char * sDeviceOptionHelp =
     "       Max number of subscriptions the device will allow\n"
     "  --subscription-resumption-retry-interval\n"
     "       subscription timeout resumption retry interval in seconds\n"
+    "  --idle-retransmit-timeout <timeout>\n"
+    "      Sets the MRP idle retry interval (in milliseconds).\n"
+    "      This interval is used by the peer to calculate the retransmission timeout when the current device is considered idle.\n"
+    "\n"
+    "  --active-retransmit-timeout <timeout>\n"
+    "      Sets the MRP active retry interval (in milliseconds).\n"
+    "      This interval is used by the peer to calculate the retransmission timeout when the current device is considered "
+    "active.\n"
+    "\n"
+    "  --active-threshold-time <time>\n"
+    "      Sets the MRP active threshold (in milliseconds).\n"
+    "      Specifies the time after which the device transitions from active to idle.\n"
+    "\n"
 #endif
 #if CHIP_WITH_NLFAULTINJECTION
     "  --faults <fault-string,...>\n"
@@ -663,6 +686,32 @@ bool HandleOption(const char * aProgram, OptionSet * aOptions, int aIdentifier,
     case kDeviceOption_SubscriptionResumptionRetryIntervalSec:
         LinuxDeviceOptions::GetInstance().subscriptionResumptionRetryIntervalSec = static_cast<int32_t>(atoi(aValue));
         break;
+    case kDeviceOption_IdleRetransmitTimeout: {
+        auto mrpConfig            = GetLocalMRPConfig().ValueOr(GetDefaultMRPConfig());
+        auto idleRetransTimeout   = System::Clock::Milliseconds32(static_cast<uint32_t>(strtoul(aValue, nullptr, 0)));
+        auto activeRetransTimeout = mrpConfig.mActiveRetransTimeout;
+        auto activeThresholdTime  = mrpConfig.mActiveThresholdTime;
+        OverrideLocalMRPConfig(idleRetransTimeout, activeRetransTimeout, activeThresholdTime);
+        break;
+    }
+
+    case kDeviceOption_ActiveRetransmitTimeout: {
+        auto mrpConfig            = GetLocalMRPConfig().ValueOr(GetDefaultMRPConfig());
+        auto idleRetransTimeout   = mrpConfig.mIdleRetransTimeout;
+        auto activeRetransTimeout = System::Clock::Milliseconds32(static_cast<uint32_t>(strtoul(aValue, nullptr, 0)));
+        auto activeThresholdTime  = mrpConfig.mActiveThresholdTime;
+        OverrideLocalMRPConfig(idleRetransTimeout, activeRetransTimeout, activeThresholdTime);
+        break;
+    }
+
+    case kDeviceOption_ActiveThresholdTime: {
+        auto mrpConfig            = GetLocalMRPConfig().ValueOr(GetDefaultMRPConfig());
+        auto idleRetransTimeout   = mrpConfig.mIdleRetransTimeout;
+        auto activeRetransTimeout = mrpConfig.mActiveRetransTimeout;
+        auto activeThresholdTime  = System::Clock::Milliseconds16(static_cast<uint16_t>(strtoul(aValue, nullptr, 0)));
+        OverrideLocalMRPConfig(idleRetransTimeout, activeRetransTimeout, activeThresholdTime);
+        break;
+    }
 #endif
 #if CHIP_WITH_NLFAULTINJECTION
     case kDeviceOption_FaultInjection: {

From b25200a9aa707d2f0cb623663539cce576511a52 Mon Sep 17 00:00:00 2001
From: C Freeman <cecille@google.com>
Date: Mon, 28 Oct 2024 23:10:00 -0400
Subject: [PATCH 5/8] Documentation: more handbook re-org (#36208)

* Documentation: gather IDs and codes into dir

* Documentation: Consolidate zap/codegen

* Update docs/getting_started/changing_examples.md

Co-authored-by: Jeff Bumgardner <jbumgardner@google.com>

* Fix a couple of missed doc refs

* Fix some paths for the CI checkers

* Not sure why it's not finding this on the CI

* fix zap output directory

---------

Co-authored-by: Andrei Litvin <andy314@gmail.com>
Co-authored-by: Jeff Bumgardner <jbumgardner@google.com>
---
 .github/workflows/zap_templates.yaml          |   2 +-
 .restyled.yaml                                |   4 +--
 .spellcheck.yml                               |   2 +-
 .../cluster_and_device_type_dev.md            |  10 ++++----
 docs/getting_started/changing_examples.md     |  24 ++++++++++++++----
 docs/getting_started/first_example.md         |   2 +-
 docs/getting_started/index.md                 |   2 --
 docs/guides/simulated_device_linux.md         |   4 +--
 docs/{ => ids_and_codes}/ERROR_CODES.md       |   0
 docs/ids_and_codes/index.md                   |  10 ++++++++
 docs/{ => ids_and_codes}/spec_clusters.md     |   0
 docs/{ => ids_and_codes}/zap_clusters.md      |   0
 docs/index.md                                 |   7 ++---
 docs/{ => zap_and_codegen}/code_generation.md |   5 ++++
 .../img/zap1.png                              | Bin
 .../img/zap2.png                              | Bin
 .../img/zap3.png                              | Bin
 .../img/zap4.png                              | Bin
 .../img/zap5.png                              | Bin
 .../img/zap6.png                              | Bin
 .../img/zap_compiler.png                      | Bin
 docs/zap_and_codegen/index.md                 |   8 ++++++
 .../zap.md => zap_and_codegen/zap_intro.md}   |   0
 scripts/tools/zap_regen_all.py                |   2 +-
 24 files changed, 56 insertions(+), 26 deletions(-)
 rename docs/{ => ids_and_codes}/ERROR_CODES.md (100%)
 create mode 100644 docs/ids_and_codes/index.md
 rename docs/{ => ids_and_codes}/spec_clusters.md (100%)
 rename docs/{ => ids_and_codes}/zap_clusters.md (100%)
 rename docs/{ => zap_and_codegen}/code_generation.md (98%)
 rename docs/{getting_started => zap_and_codegen}/img/zap1.png (100%)
 rename docs/{getting_started => zap_and_codegen}/img/zap2.png (100%)
 rename docs/{getting_started => zap_and_codegen}/img/zap3.png (100%)
 rename docs/{getting_started => zap_and_codegen}/img/zap4.png (100%)
 rename docs/{getting_started => zap_and_codegen}/img/zap5.png (100%)
 rename docs/{getting_started => zap_and_codegen}/img/zap6.png (100%)
 rename docs/{getting_started => zap_and_codegen}/img/zap_compiler.png (100%)
 create mode 100644 docs/zap_and_codegen/index.md
 rename docs/{getting_started/zap.md => zap_and_codegen/zap_intro.md} (100%)

diff --git a/.github/workflows/zap_templates.yaml b/.github/workflows/zap_templates.yaml
index 717f8ca95628fa..383a98583bd9fc 100644
--- a/.github/workflows/zap_templates.yaml
+++ b/.github/workflows/zap_templates.yaml
@@ -62,7 +62,7 @@ jobs:
             - name: Generate all
               run: ./scripts/run_in_build_env.sh scripts/tools/zap_regen_all.py
             - name: Generate script-maintained items (ERROR_CODES.md)
-              run: ./scripts/run_in_build_env.sh "scripts/error_table.py > docs/ERROR_CODES.md"
+              run: ./scripts/run_in_build_env.sh "scripts/error_table.py > docs/ids_and_codes/ERROR_CODES.md"
             - name: Ensure git works in current working directory
               run: git config --global --add safe.directory `pwd`
             - name: Check for uncommited changes
diff --git a/.restyled.yaml b/.restyled.yaml
index c201729d30e41a..446dad740b96a5 100644
--- a/.restyled.yaml
+++ b/.restyled.yaml
@@ -83,9 +83,7 @@ exclude:
     - "scripts/setup/bootstrap.sh" # tries to quote loop variable
     - "integrations/docker/build-all.sh" # tries to quote loop variable
     - "scripts/setup/pigweed.json" # TODO(#29547). This file is temporary copy from pigweed repo that has minor edits. No restyle help in diff.
-    - "docs/ERROR_CODES.md" # generated by scripts, not easy to align tables
-    - "docs/zap_clusters.md" # generated by scripts, not easy to align tables
-    - "docs/spec_clusters.md" # generated by scripts, not easy to align tables
+    - "docs/ids_and_codes/**" # generated by scripts, not easy to align tables
     - "docs/testing/yaml_pseudocluster.md" # generated by scripts, restyler makes the tables render improperly
     - "docs/testing/yaml_schema.md" # generated by scripts, restyler makes the tables render improperly
 
diff --git a/.spellcheck.yml b/.spellcheck.yml
index 757034586b9bd0..36461334c881ee 100644
--- a/.spellcheck.yml
+++ b/.spellcheck.yml
@@ -65,7 +65,7 @@ matrix:
       # converts markdown to HTML
       - pyspelling.filters.markdown:
     sources:
-      - '**/*.md|!third_party/**|!examples/common/**/repo/**|!docs/ERROR_CODES.md|!docs/clusters.md|!docs/testing/yaml_schema.md|!docs/testing/yaml_pseudocluster.md|!docs/testing/python.md|!docs/testing/ChipDeviceCtrlAPI.md|!docs/issue_triage.md'
+      - '**/*.md|!third_party/**|!examples/common/**/repo/**|!docs/ids_and_codes/ERROR_CODES.md|!docs/clusters.md|!docs/testing/yaml_schema.md|!docs/testing/yaml_pseudocluster.md|!docs/testing/python.md|!docs/testing/ChipDeviceCtrlAPI.md|!docs/issue_triage.md'
     aspell:
       ignore-case: true
       camel-case: true
diff --git a/docs/cluster_and_device_type_dev/cluster_and_device_type_dev.md b/docs/cluster_and_device_type_dev/cluster_and_device_type_dev.md
index a19336a5939b73..ad509ea57a418b 100644
--- a/docs/cluster_and_device_type_dev/cluster_and_device_type_dev.md
+++ b/docs/cluster_and_device_type_dev/cluster_and_device_type_dev.md
@@ -48,11 +48,11 @@ Note that the output should also be verified against the spec using the
 -   Goal: get zap to understand the new cluster so it can be used on devices
     (XML and glue)
 
-![](../getting_started/img/zap_compiler.png)
+![](../zap_and_codegen/img/zap_compiler.png)
 
 ### Cluster definitions and ZAP
 
-Please see [ZAP](../getting_started/zap.md) for an introduction to ZAP.
+Please see [ZAP](../zap_and_codegen/zap_intro.md) for an introduction to ZAP.
 
 After implementing the changes outlined in the wiki article, your cluster and
 device type should show up in zap. you can check this by running zaptool with
@@ -64,17 +64,17 @@ To ensure the cluster and device type are correctly implemented for ZAP, open
 the endpoint configuration and ensure the device type appears in the device type
 list.
 
-![](../getting_started/img/zap3.png)
+![](../zap_and_codegen/img/zap3.png)
 
 Next, check your cluster. The "domain" parameter in the XML controls which group
 the cluster is in. It should have all the expected attributes, commands and
 events.
 
-![](../getting_started/img/zap4.png)
+![](../zap_and_codegen/img/zap4.png)
 
 Last, ensure that your attributes have the storage option set appropriately.
 
-![](../getting_started/img/zap5.png)
+![](../zap_and_codegen/img/zap5.png)
 
 ### Cluster implementation - Ember and overrides
 
diff --git a/docs/getting_started/changing_examples.md b/docs/getting_started/changing_examples.md
index 611610ce43fb59..02ba357d861300 100644
--- a/docs/getting_started/changing_examples.md
+++ b/docs/getting_started/changing_examples.md
@@ -4,10 +4,10 @@ The composition of most examples in the SDK is static and code generated.
 
 The tool used to describe and change the composition of an example is called
 ZAP. More information about ZAP and a walk-through of the tool can be found in
-the [ZAP introduction](./zap.md). The composition of the device is captured in a
-.zap file, which is readable by the ZAP tool. This is then compiled into a
-human-readable .matter file, which is used to build the static features of the
-example.
+the [ZAP introduction](../zap_and_codegen/zap_intro.md). The composition of the
+device is captured in a .zap file, which is readable by the ZAP tool. This is
+then compiled into a human-readable .matter file, which is used to build the
+static features of the example.
 
 To change the composition of a device example, you need to
 
@@ -35,7 +35,8 @@ This will open the ZAP GUI tool, which can be used to change the endpoint
 composition, clusters, features, attributes, commands and events exposed by the
 device.
 
-Details of how to use the tool can be found in the [ZAP Introduction](./zap.md).
+Details of how to use the tool can be found in the
+[ZAP Introduction](../zap_and_codegen/zap_intro.md).
 
 ## Running code generation
 
@@ -62,3 +63,16 @@ recompile the .zap files for all the examples and the controller.
 
 After generating the .matter file, re-build the example. Instructions for
 building examples are given in [Building your first example](./first_example.md)
+
+## Ensuring device conformance
+
+After changing the examples, it is important to ensure they remain spec
+compliant. Although there are numerous certification tests to check the various
+parts of the device, the tests most likely to be affected by changes to ZAP are
+the conformance tests, which ensure that the device included meets the
+conformance requirements for clusters and device types. To run conformance tests
+against the example app, see [Testing](../testing/index.md). The tests that
+ensure the device composition is spec compliant are found in
+[Device Basic Composition Test](../../src/python_testing/TC_DeviceBasicComposition.py)
+and
+[Device Conformance Tests](../../src/python_testing/TC_DeviceConformance.py).
diff --git a/docs/getting_started/first_example.md b/docs/getting_started/first_example.md
index d75d9e7b1a4fee..7b005f3adc63db 100644
--- a/docs/getting_started/first_example.md
+++ b/docs/getting_started/first_example.md
@@ -37,7 +37,7 @@ for testing. More information about the python controller can be found in the
 
 The examples directory contains a set of apps using an example device
 composition \.zap file. For more information about device composition and zap,
-see [ZAP documentation](./zap.md).
+see [ZAP documentation](../zap_and_codegen/zap_intro.md).
 
 This quick start guide will walk you through
 
diff --git a/docs/getting_started/index.md b/docs/getting_started/index.md
index 1bfbe3f57cc333..fc8b9bd1713085 100644
--- a/docs/getting_started/index.md
+++ b/docs/getting_started/index.md
@@ -10,11 +10,9 @@ The following docs are a brief introduction to SDK development.
 first_example
 changing_examples
 SDKBasics
-zap
 
 ```
 
 -   [Running your first example](./first_example.md)
 -   [Changing examples](./changing_examples.md)
 -   [SDK Architecture Overview](./SDKBasics.md)
--   [ZAP Introduction](./zap.md)
diff --git a/docs/guides/simulated_device_linux.md b/docs/guides/simulated_device_linux.md
index db7e6bc4ef55ad..eb4d6d7564c0c6 100644
--- a/docs/guides/simulated_device_linux.md
+++ b/docs/guides/simulated_device_linux.md
@@ -19,8 +19,8 @@ is defined by a ZAP config file and tests can be added with a
 
 -   [Building Prerequisites](./BUILDING.md#prerequisites)
 -   [Prepare For Building](./BUILDING.md#prepare-for-building)
--   [Code Generate](../code_generation.md)
--   [ZAP Installed](../code_generation.md#installing-zap-and-environment-variables)
+-   [Code Generate](../zap_and_codegen/code_generation.md)
+-   [ZAP Installed](../zap_and_codegen/code_generation.md#installing-zap-and-environment-variables)
 
 ## Building the default Simulated App with Script
 
diff --git a/docs/ERROR_CODES.md b/docs/ids_and_codes/ERROR_CODES.md
similarity index 100%
rename from docs/ERROR_CODES.md
rename to docs/ids_and_codes/ERROR_CODES.md
diff --git a/docs/ids_and_codes/index.md b/docs/ids_and_codes/index.md
new file mode 100644
index 00000000000000..ef87b9ca01c569
--- /dev/null
+++ b/docs/ids_and_codes/index.md
@@ -0,0 +1,10 @@
+# IDs and Codes
+
+
+```{toctree}
+:glob:
+:maxdepth: 1
+
+*
+
+```
diff --git a/docs/spec_clusters.md b/docs/ids_and_codes/spec_clusters.md
similarity index 100%
rename from docs/spec_clusters.md
rename to docs/ids_and_codes/spec_clusters.md
diff --git a/docs/zap_clusters.md b/docs/ids_and_codes/zap_clusters.md
similarity index 100%
rename from docs/zap_clusters.md
rename to docs/ids_and_codes/zap_clusters.md
diff --git a/docs/index.md b/docs/index.md
index 89e4661e2a0e1e..cd5fe17d102fd4 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -10,6 +10,7 @@ VSCODE_DEVELOPMENT
 ci-cd/index
 development_controllers/index
 getting_started/index
+ids_and_codes/index
 cluster_and_device_type_dev/index
 guides/index
 platforms/index
@@ -19,14 +20,10 @@ product_considerations/index
 testing/index
 tips_and_troubleshooting/index
 tools/index
+zap_and_codegen/index
 BUG_REPORT
-code_generation
-zap_clusters
-spec_clusters
 upgrading
-ERROR_CODES
 issue_triage
-
 ```
 
 ```{include} README.md
diff --git a/docs/code_generation.md b/docs/zap_and_codegen/code_generation.md
similarity index 98%
rename from docs/code_generation.md
rename to docs/zap_and_codegen/code_generation.md
index bf5b6f3036963a..e6ff51b3182e77 100644
--- a/docs/code_generation.md
+++ b/docs/zap_and_codegen/code_generation.md
@@ -197,6 +197,11 @@ via `-o/--output-dir`.
 ./scripts/tools/zap/generate.py $PATH_TO_ZAP_FILE
 ```
 
+Rebuild the application.
+
+It is also recommended to run device composition tests to ensure the selected
+composition is spec compliant (see [Testing](../testing))
+
 ### Compile-time code generation / pre-generated code
 
 A subset of code generation (both `codegen.py` and `zap-cli`) is done at compile
diff --git a/docs/getting_started/img/zap1.png b/docs/zap_and_codegen/img/zap1.png
similarity index 100%
rename from docs/getting_started/img/zap1.png
rename to docs/zap_and_codegen/img/zap1.png
diff --git a/docs/getting_started/img/zap2.png b/docs/zap_and_codegen/img/zap2.png
similarity index 100%
rename from docs/getting_started/img/zap2.png
rename to docs/zap_and_codegen/img/zap2.png
diff --git a/docs/getting_started/img/zap3.png b/docs/zap_and_codegen/img/zap3.png
similarity index 100%
rename from docs/getting_started/img/zap3.png
rename to docs/zap_and_codegen/img/zap3.png
diff --git a/docs/getting_started/img/zap4.png b/docs/zap_and_codegen/img/zap4.png
similarity index 100%
rename from docs/getting_started/img/zap4.png
rename to docs/zap_and_codegen/img/zap4.png
diff --git a/docs/getting_started/img/zap5.png b/docs/zap_and_codegen/img/zap5.png
similarity index 100%
rename from docs/getting_started/img/zap5.png
rename to docs/zap_and_codegen/img/zap5.png
diff --git a/docs/getting_started/img/zap6.png b/docs/zap_and_codegen/img/zap6.png
similarity index 100%
rename from docs/getting_started/img/zap6.png
rename to docs/zap_and_codegen/img/zap6.png
diff --git a/docs/getting_started/img/zap_compiler.png b/docs/zap_and_codegen/img/zap_compiler.png
similarity index 100%
rename from docs/getting_started/img/zap_compiler.png
rename to docs/zap_and_codegen/img/zap_compiler.png
diff --git a/docs/zap_and_codegen/index.md b/docs/zap_and_codegen/index.md
new file mode 100644
index 00000000000000..7301f03b2147d7
--- /dev/null
+++ b/docs/zap_and_codegen/index.md
@@ -0,0 +1,8 @@
+# ZAP and Codegen
+
+```{toctree}
+:glob:
+:maxdepth: 1
+
+*
+```
diff --git a/docs/getting_started/zap.md b/docs/zap_and_codegen/zap_intro.md
similarity index 100%
rename from docs/getting_started/zap.md
rename to docs/zap_and_codegen/zap_intro.md
diff --git a/scripts/tools/zap_regen_all.py b/scripts/tools/zap_regen_all.py
index afe931fd8609a6..0284e9eff9dd93 100755
--- a/scripts/tools/zap_regen_all.py
+++ b/scripts/tools/zap_regen_all.py
@@ -414,7 +414,7 @@ def getCodegenTemplates():
     targets.append(JinjaCodegenTarget(
         generator="summary-markdown",
         idl_path="src/controller/data_model/controller-clusters.matter",
-        output_directory="docs"))
+        output_directory="docs/ids_and_codes"))
 
     return targets
 

From c18a6de603c31c14d4b86390f47ffee02a8514c9 Mon Sep 17 00:00:00 2001
From: jungwook-park <lian.park@lge.com>
Date: Tue, 29 Oct 2024 13:55:07 +0900
Subject: [PATCH 6/8] [WebOS] Add a Header file for fixing build error (#36278)

Change
 - Added a header file in WebOS Platform to fix build error

Testing
 - Tested done on WebOS
---
 src/platform/webos/DiagnosticDataProviderImpl.cpp | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/platform/webos/DiagnosticDataProviderImpl.cpp b/src/platform/webos/DiagnosticDataProviderImpl.cpp
index 22f90ed72e3bd6..51868a556e5077 100644
--- a/src/platform/webos/DiagnosticDataProviderImpl.cpp
+++ b/src/platform/webos/DiagnosticDataProviderImpl.cpp
@@ -24,6 +24,7 @@
 #include <platform/internal/CHIPDeviceLayerInternal.h>
 
 #include <lib/support/CHIPMem.h>
+#include <lib/support/CHIPMemString.h>
 #include <lib/support/logging/CHIPLogging.h>
 #include <platform/DiagnosticDataProvider.h>
 #include <platform/webos/ConnectivityUtils.h>

From fa4664124960105b993b235604f43db03b5d17f7 Mon Sep 17 00:00:00 2001
From: Andrei Litvin <andy314@gmail.com>
Date: Tue, 29 Oct 2024 10:19:01 -0400
Subject: [PATCH 7/8] Event validation simplification - pull logic into
 InteractionModelEngine.cpp only (#36251)

* Pull back the event path validity mixin, start with a datamodel implementation

* Fix compile logic after I moved things away

* Add one more check

* Restyle

* Fix typo

* Fix includes

* Restyle

* Update src/app/InteractionModelEngine.cpp

Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>

* Rename method

* Restyle

* More renames

* Restyle

* Fix some renames

* Restyle

* A few more renames

* Restyle

---------

Co-authored-by: Andrei Litvin <andreilitvin@google.com>
Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>
---
 src/app/BUILD.gn                              |   6 +-
 src/app/InteractionModelEngine.cpp            | 181 +++++++++++++++---
 .../CodegenDataModelProvider.cpp              |  28 ---
 .../CodegenDataModelProvider.h                |   2 -
 src/app/codegen-data-model-provider/model.gni |   1 -
 src/app/data-model-provider/Provider.h        |  10 -
 src/app/ember_coupling/BUILD.gn               |  23 ---
 .../ember_coupling/EventPathValidity.mixin.h  | 104 ----------
 src/app/tests/test-interaction-model-api.h    |   5 -
 .../tests/data_model/DataModelFixtures.h      |   5 -
 10 files changed, 153 insertions(+), 212 deletions(-)
 delete mode 100644 src/app/ember_coupling/BUILD.gn
 delete mode 100644 src/app/ember_coupling/EventPathValidity.mixin.h

diff --git a/src/app/BUILD.gn b/src/app/BUILD.gn
index 13a15f2d7c87be..0a000a2d005c6b 100644
--- a/src/app/BUILD.gn
+++ b/src/app/BUILD.gn
@@ -255,7 +255,6 @@ static_library("interaction-model") {
       "reporting/Read-Ember.cpp",
       "reporting/Read-Ember.h",
     ]
-    public_deps += [ "${chip_root}/src/app/ember_coupling" ]
   } else if (chip_use_data_model_interface == "check") {
     sources += [
       "reporting/Read-Checked.cpp",
@@ -265,10 +264,7 @@ static_library("interaction-model") {
       "reporting/Read-Ember.cpp",
       "reporting/Read-Ember.h",
     ]
-    public_deps += [
-      "${chip_root}/src/app/data-model-provider",
-      "${chip_root}/src/app/ember_coupling",
-    ]
+    public_deps += [ "${chip_root}/src/app/data-model-provider" ]
   } else {  # enabled
     sources += [
       "reporting/Read-DataModel.cpp",
diff --git a/src/app/InteractionModelEngine.cpp b/src/app/InteractionModelEngine.cpp
index 40ec6e71b3210b..49baa705d84ce1 100644
--- a/src/app/InteractionModelEngine.cpp
+++ b/src/app/InteractionModelEngine.cpp
@@ -27,10 +27,13 @@
 
 #include <cinttypes>
 
+#include <access/AccessRestrictionProvider.h>
+#include <access/Privilege.h>
 #include <access/RequestPath.h>
 #include <access/SubjectDescriptor.h>
 #include <app/AppConfig.h>
 #include <app/CommandHandlerInterfaceRegistry.h>
+#include <app/EventPathParams.h>
 #include <app/RequiredPrivilege.h>
 #include <app/data-model-provider/ActionReturnStatus.h>
 #include <app/data-model-provider/MetadataTypes.h>
@@ -39,6 +42,7 @@
 #include <app/util/af-types.h>
 #include <app/util/ember-compatibility-functions.h>
 #include <app/util/endpoint-config-api.h>
+#include <lib/core/CHIPError.h>
 #include <lib/core/DataModelTypes.h>
 #include <lib/core/Global.h>
 #include <lib/core/TLVUtilities.h>
@@ -53,12 +57,148 @@
 #include <app/codegen-data-model-provider/Instance.h>
 #endif
 
-#if !CHIP_CONFIG_USE_DATA_MODEL_INTERFACE
-#include <app/ember_coupling/EventPathValidity.mixin.h> // nogncheck
-#endif
-
 namespace chip {
 namespace app {
+namespace {
+
+/**
+ * Helper to handle wildcard events in the event path.
+ *
+ * Validates that ACL access is permitted to:
+ *    - Cluster::View in case the path is a wildcard for the event id
+ *    - Event read if the path is a concrete event path
+ */
+bool MayHaveAccessibleEventPathForEndpointAndCluster(const ConcreteClusterPath & path, const EventPathParams & aEventPath,
+                                                     const Access::SubjectDescriptor & aSubjectDescriptor)
+{
+    Access::RequestPath requestPath{ .cluster     = path.mClusterId,
+                                     .endpoint    = path.mEndpointId,
+                                     .requestType = Access::RequestType::kEventReadRequest };
+
+    Access::Privilege requiredPrivilege = Access::Privilege::kView;
+
+    if (!aEventPath.HasWildcardEventId())
+    {
+        requestPath.entityId = aEventPath.mEventId;
+        requiredPrivilege =
+            RequiredPrivilege::ForReadEvent(ConcreteEventPath(path.mEndpointId, path.mClusterId, aEventPath.mEventId));
+    }
+
+    return (Access::GetAccessControl().Check(aSubjectDescriptor, requestPath, requiredPrivilege) == CHIP_NO_ERROR);
+}
+
+#if CHIP_CONFIG_USE_DATA_MODEL_INTERFACE
+
+bool MayHaveAccessibleEventPathForEndpoint(DataModel::Provider * aProvider, EndpointId aEndpoint,
+                                           const EventPathParams & aEventPath, const Access::SubjectDescriptor & aSubjectDescriptor)
+{
+    if (!aEventPath.HasWildcardClusterId())
+    {
+        return MayHaveAccessibleEventPathForEndpointAndCluster(ConcreteClusterPath(aEndpoint, aEventPath.mClusterId), aEventPath,
+                                                               aSubjectDescriptor);
+    }
+
+    DataModel::ClusterEntry clusterEntry = aProvider->FirstCluster(aEventPath.mEndpointId);
+    while (clusterEntry.IsValid())
+    {
+        if (MayHaveAccessibleEventPathForEndpointAndCluster(clusterEntry.path, aEventPath, aSubjectDescriptor))
+        {
+            return true;
+        }
+        clusterEntry = aProvider->NextCluster(clusterEntry.path);
+    }
+
+    return false;
+}
+
+bool MayHaveAccessibleEventPath(DataModel::Provider * aProvider, const EventPathParams & aEventPath,
+                                const Access::SubjectDescriptor & subjectDescriptor)
+{
+    VerifyOrReturnValue(aProvider != nullptr, false);
+
+    if (!aEventPath.HasWildcardEndpointId())
+    {
+        return MayHaveAccessibleEventPathForEndpoint(aProvider, aEventPath.mEndpointId, aEventPath, subjectDescriptor);
+    }
+
+    for (EndpointId endpointId = aProvider->FirstEndpoint(); endpointId != kInvalidEndpointId;
+         endpointId            = aProvider->NextEndpoint(endpointId))
+    {
+        if (MayHaveAccessibleEventPathForEndpoint(aProvider, endpointId, aEventPath, subjectDescriptor))
+        {
+            return true;
+        }
+    }
+    return false;
+}
+
+#else
+
+/**
+ * Helper to handle wildcard clusters in the event path.
+ */
+bool MayHaveAccessibleEventPathForEndpoint(EndpointId aEndpoint, const EventPathParams & aEventPath,
+                                           const Access::SubjectDescriptor & aSubjectDescriptor)
+{
+    if (aEventPath.HasWildcardClusterId())
+    {
+        auto * endpointType = emberAfFindEndpointType(aEndpoint);
+        if (endpointType == nullptr)
+        {
+            // Not going to have any valid paths in here.
+            return false;
+        }
+
+        for (decltype(endpointType->clusterCount) idx = 0; idx < endpointType->clusterCount; ++idx)
+        {
+            bool mayHaveAccessiblePath = MayHaveAccessibleEventPathForEndpointAndCluster(
+                ConcreteClusterPath(aEndpoint, endpointType->cluster[idx].clusterId), aEventPath, aSubjectDescriptor);
+            if (mayHaveAccessiblePath)
+            {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    auto * cluster = emberAfFindServerCluster(aEndpoint, aEventPath.mClusterId);
+    if (cluster == nullptr)
+    {
+        // Nothing valid here.
+        return false;
+    }
+    return MayHaveAccessibleEventPathForEndpointAndCluster(ConcreteClusterPath(aEndpoint, cluster->clusterId), aEventPath,
+                                                           aSubjectDescriptor);
+}
+
+bool MayHaveAccessibleEventPath(const EventPathParams & aEventPath, const Access::SubjectDescriptor & aSubjectDescriptor)
+{
+    if (!aEventPath.HasWildcardEndpointId())
+    {
+        // No need to check whether the endpoint is enabled, because
+        // emberAfFindEndpointType returns null for disabled endpoints.
+        return MayHaveAccessibleEventPathForEndpoint(aEventPath.mEndpointId, aEventPath, aSubjectDescriptor);
+    }
+
+    for (uint16_t endpointIndex = 0; endpointIndex < emberAfEndpointCount(); ++endpointIndex)
+    {
+        if (!emberAfEndpointIndexIsEnabled(endpointIndex))
+        {
+            continue;
+        }
+        if (MayHaveAccessibleEventPathForEndpoint(emberAfEndpointFromIndex(endpointIndex), aEventPath, aSubjectDescriptor))
+        {
+            return true;
+        }
+    }
+
+    // none of the paths matched
+    return false;
+}
+#endif
+
+} // namespace
 
 class AutoReleaseSubscriptionInfoIterator
 {
@@ -583,30 +723,13 @@ CHIP_ERROR InteractionModelEngine::ParseEventPaths(const Access::SubjectDescript
             continue;
         }
 
-#if CHIP_CONFIG_USE_DATA_MODEL_INTERFACE
-        aHasValidEventPath = mDataModelProvider->EventPathIncludesAccessibleConcretePath(eventPath, aSubjectDescriptor);
-#else
         // The definition of "valid path" is "path exists and ACL allows
         // access".  We need to do some expansion of wildcards to handle that.
-        if (eventPath.HasWildcardEndpointId())
-        {
-            for (uint16_t endpointIndex = 0; !aHasValidEventPath && endpointIndex < emberAfEndpointCount(); ++endpointIndex)
-            {
-                if (!emberAfEndpointIndexIsEnabled(endpointIndex))
-                {
-                    continue;
-                }
-                aHasValidEventPath =
-                    HasValidEventPathForEndpoint(emberAfEndpointFromIndex(endpointIndex), eventPath, aSubjectDescriptor);
-            }
-        }
-        else
-        {
-            // No need to check whether the endpoint is enabled, because
-            // emberAfFindEndpointType returns null for disabled endpoints.
-            aHasValidEventPath = HasValidEventPathForEndpoint(eventPath.mEndpointId, eventPath, aSubjectDescriptor);
-        }
-#endif // CHIP_CONFIG_USE_EMBER_DATA_MODEL
+#if CHIP_CONFIG_USE_DATA_MODEL_INTERFACE
+        aHasValidEventPath = MayHaveAccessibleEventPath(mDataModelProvider, eventPath, aSubjectDescriptor);
+#else
+        aHasValidEventPath = MayHaveAccessibleEventPath(eventPath, aSubjectDescriptor);
+#endif
     }
 
     if (err == CHIP_ERROR_END_OF_TLV)
@@ -676,7 +799,7 @@ Protocols::InteractionModel::Status InteractionModelEngine::OnReadInitialRequest
             size_t requestedEventPathCount     = 0;
             AttributePathIBs::Parser attributePathListParser;
             bool hasValidAttributePath = false;
-            bool hasValidEventPath     = false;
+            bool mayHaveValidEventPath = false;
 
             CHIP_ERROR err = subscribeRequestParser.GetAttributeRequests(&attributePathListParser);
             if (err == CHIP_NO_ERROR)
@@ -699,7 +822,7 @@ Protocols::InteractionModel::Status InteractionModelEngine::OnReadInitialRequest
             if (err == CHIP_NO_ERROR)
             {
                 auto subjectDescriptor = apExchangeContext->GetSessionHandle()->AsSecureSession()->GetSubjectDescriptor();
-                err = ParseEventPaths(subjectDescriptor, eventPathListParser, hasValidEventPath, requestedEventPathCount);
+                err = ParseEventPaths(subjectDescriptor, eventPathListParser, mayHaveValidEventPath, requestedEventPathCount);
                 if (err != CHIP_NO_ERROR)
                 {
                     return Status::InvalidAction;
@@ -719,7 +842,7 @@ Protocols::InteractionModel::Status InteractionModelEngine::OnReadInitialRequest
                 return Status::InvalidAction;
             }
 
-            if (!hasValidAttributePath && !hasValidEventPath)
+            if (!hasValidAttributePath && !mayHaveValidEventPath)
             {
                 ChipLogError(InteractionModel,
                              "Subscription from [%u:" ChipLogFormatX64 "] has no access at all. Rejecting request.",
diff --git a/src/app/codegen-data-model-provider/CodegenDataModelProvider.cpp b/src/app/codegen-data-model-provider/CodegenDataModelProvider.cpp
index dd320e5d03780a..eab221a86906b8 100644
--- a/src/app/codegen-data-model-provider/CodegenDataModelProvider.cpp
+++ b/src/app/codegen-data-model-provider/CodegenDataModelProvider.cpp
@@ -33,9 +33,6 @@
 #include <lib/core/DataModelTypes.h>
 #include <lib/support/CodeUtils.h>
 
-// separated out for code-reuse
-#include <app/ember_coupling/EventPathValidity.mixin.h>
-
 #include <optional>
 #include <variant>
 
@@ -772,30 +769,5 @@ std::optional<DataModel::DeviceTypeEntry> CodegenDataModelProvider::NextDeviceTy
     return DeviceTypeEntryFromEmber(deviceTypes[idx]);
 }
 
-bool CodegenDataModelProvider::EventPathIncludesAccessibleConcretePath(const EventPathParams & path,
-                                                                       const Access::SubjectDescriptor & descriptor)
-{
-
-    if (!path.HasWildcardEndpointId())
-    {
-        // No need to check whether the endpoint is enabled, because
-        // emberAfFindEndpointType returns null for disabled endpoints.
-        return HasValidEventPathForEndpoint(path.mEndpointId, path, descriptor);
-    }
-
-    for (uint16_t endpointIndex = 0; endpointIndex < emberAfEndpointCount(); ++endpointIndex)
-    {
-        if (!emberAfEndpointIndexIsEnabled(endpointIndex))
-        {
-            continue;
-        }
-        if (HasValidEventPathForEndpoint(emberAfEndpointFromIndex(endpointIndex), path, descriptor))
-        {
-            return true;
-        }
-    }
-    return false;
-}
-
 } // namespace app
 } // namespace chip
diff --git a/src/app/codegen-data-model-provider/CodegenDataModelProvider.h b/src/app/codegen-data-model-provider/CodegenDataModelProvider.h
index 5c87e264fd2aea..7549ef1fd44c27 100644
--- a/src/app/codegen-data-model-provider/CodegenDataModelProvider.h
+++ b/src/app/codegen-data-model-provider/CodegenDataModelProvider.h
@@ -141,8 +141,6 @@ class CodegenDataModelProvider : public chip::app::DataModel::Provider
         return CHIP_NO_ERROR;
     }
 
-    bool EventPathIncludesAccessibleConcretePath(const EventPathParams & path,
-                                                 const Access::SubjectDescriptor & descriptor) override;
     DataModel::ActionReturnStatus ReadAttribute(const DataModel::ReadAttributeRequest & request,
                                                 AttributeValueEncoder & encoder) override;
     DataModel::ActionReturnStatus WriteAttribute(const DataModel::WriteAttributeRequest & request,
diff --git a/src/app/codegen-data-model-provider/model.gni b/src/app/codegen-data-model-provider/model.gni
index 4205c6fcd73c25..f134d51fdd6a33 100644
--- a/src/app/codegen-data-model-provider/model.gni
+++ b/src/app/codegen-data-model-provider/model.gni
@@ -39,6 +39,5 @@ codegen_data_model_SOURCES = [
 codegen_data_model_PUBLIC_DEPS = [
   "${chip_root}/src/app/common:attribute-type",
   "${chip_root}/src/app/data-model-provider",
-  "${chip_root}/src/app/ember_coupling",
   "${chip_root}/src/app/codegen-data-model-provider:instance-header",
 ]
diff --git a/src/app/data-model-provider/Provider.h b/src/app/data-model-provider/Provider.h
index 2bafd1a944ecbb..16dd7327a35a37 100644
--- a/src/app/data-model-provider/Provider.h
+++ b/src/app/data-model-provider/Provider.h
@@ -59,16 +59,6 @@ class Provider : public ProviderMetadataTree
     // event emitting, path marking and other operations
     virtual InteractionModelContext CurrentContext() const { return mContext; }
 
-    /// Validates that the given event path is supported, where path may contain wildcards.
-    ///
-    /// If any wild cards exist on the given path, the implementation is expected to validate
-    /// that an accessible event path exists on some wildcard expansion.
-    ///
-    /// At the very minimum this will validate that a valid endpoint/cluster can be expanded
-    /// from the input path and that the given descriptor has access to it.
-    virtual bool EventPathIncludesAccessibleConcretePath(const EventPathParams & path,
-                                                         const Access::SubjectDescriptor & descriptor) = 0;
-
     /// TEMPORARY/TRANSITIONAL requirement for transitioning from ember-specific code
     ///   ReadAttribute is REQUIRED to perform:
     ///     - ACL validation (see notes on OperationFlags::kInternal)
diff --git a/src/app/ember_coupling/BUILD.gn b/src/app/ember_coupling/BUILD.gn
deleted file mode 100644
index 422fc8bef795a7..00000000000000
--- a/src/app/ember_coupling/BUILD.gn
+++ /dev/null
@@ -1,23 +0,0 @@
-# Copyright (c) 2024 Project CHIP Authors
-#
-# 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.
-
-import("//build_overrides/chip.gni")
-
-# The sources in this directory exist to limit the amount of code duplication
-# and assume strong ember and access coupling
-#
-# They are NOT stand-alone compilable and are rather for `#include` support.
-source_set("ember_coupling") {
-  sources = [ "EventPathValidity.mixin.h" ]
-}
diff --git a/src/app/ember_coupling/EventPathValidity.mixin.h b/src/app/ember_coupling/EventPathValidity.mixin.h
deleted file mode 100644
index 54b8bcf1965089..00000000000000
--- a/src/app/ember_coupling/EventPathValidity.mixin.h
+++ /dev/null
@@ -1,104 +0,0 @@
-/*
- *
- *    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.
- */
-
-// This is intended as a TOP LEVEL INCLUDE inside code that uses it
-
-namespace chip {
-namespace app {
-namespace {
-
-static bool CanAccessEvent(const Access::SubjectDescriptor & aSubjectDescriptor, const ConcreteClusterPath & aPath,
-                           Access::Privilege aNeededPrivilege)
-{
-    Access::RequestPath requestPath{ .cluster     = aPath.mClusterId,
-                                     .endpoint    = aPath.mEndpointId,
-                                     .requestType = Access::RequestType::kEventReadRequest };
-    // leave requestPath.entityId optional value unset to indicate wildcard
-    CHIP_ERROR err = Access::GetAccessControl().Check(aSubjectDescriptor, requestPath, aNeededPrivilege);
-    return (err == CHIP_NO_ERROR);
-}
-
-static bool CanAccessEvent(const Access::SubjectDescriptor & aSubjectDescriptor, const ConcreteEventPath & aPath)
-{
-    Access::RequestPath requestPath{ .cluster     = aPath.mClusterId,
-                                     .endpoint    = aPath.mEndpointId,
-                                     .requestType = Access::RequestType::kEventReadRequest,
-                                     .entityId    = aPath.mEventId };
-    CHIP_ERROR err = Access::GetAccessControl().Check(aSubjectDescriptor, requestPath, RequiredPrivilege::ForReadEvent(aPath));
-    return (err == CHIP_NO_ERROR);
-}
-
-/**
- * Helper to handle wildcard events in the event path.
- */
-static bool HasValidEventPathForEndpointAndCluster(EndpointId aEndpoint, const EmberAfCluster * aCluster,
-                                                   const EventPathParams & aEventPath,
-                                                   const Access::SubjectDescriptor & aSubjectDescriptor)
-{
-    if (aEventPath.HasWildcardEventId())
-    {
-        // We have no way to expand wildcards.  Just assume that we would need
-        // View permissions for whatever events are involved.
-        ConcreteClusterPath clusterPath(aEndpoint, aCluster->clusterId);
-        return CanAccessEvent(aSubjectDescriptor, clusterPath, Access::Privilege::kView);
-    }
-
-    ConcreteEventPath path(aEndpoint, aCluster->clusterId, aEventPath.mEventId);
-    return CanAccessEvent(aSubjectDescriptor, path);
-}
-
-/**
- * Helper to handle wildcard clusters in the event path.
- */
-static bool HasValidEventPathForEndpoint(EndpointId aEndpoint, const EventPathParams & aEventPath,
-                                         const Access::SubjectDescriptor & aSubjectDescriptor)
-{
-    if (aEventPath.HasWildcardClusterId())
-    {
-        auto * endpointType = emberAfFindEndpointType(aEndpoint);
-        if (endpointType == nullptr)
-        {
-            // Not going to have any valid paths in here.
-            return false;
-        }
-
-        for (decltype(endpointType->clusterCount) idx = 0; idx < endpointType->clusterCount; ++idx)
-        {
-            bool hasValidPath =
-                HasValidEventPathForEndpointAndCluster(aEndpoint, &endpointType->cluster[idx], aEventPath, aSubjectDescriptor);
-            if (hasValidPath)
-            {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    auto * cluster = emberAfFindServerCluster(aEndpoint, aEventPath.mClusterId);
-    if (cluster == nullptr)
-    {
-        // Nothing valid here.
-        return false;
-    }
-    return HasValidEventPathForEndpointAndCluster(aEndpoint, cluster, aEventPath, aSubjectDescriptor);
-}
-
-} // namespace
-} // namespace app
-} // namespace chip
diff --git a/src/app/tests/test-interaction-model-api.h b/src/app/tests/test-interaction-model-api.h
index ae5cc63df7293a..df410c656b9b03 100644
--- a/src/app/tests/test-interaction-model-api.h
+++ b/src/app/tests/test-interaction-model-api.h
@@ -117,11 +117,6 @@ class TestImCustomDataModel : public DataModel::Provider
 
     CHIP_ERROR Shutdown() override { return CHIP_NO_ERROR; }
 
-    bool EventPathIncludesAccessibleConcretePath(const EventPathParams & path,
-                                                 const Access::SubjectDescriptor & descriptor) override
-    {
-        return true;
-    }
     DataModel::ActionReturnStatus ReadAttribute(const DataModel::ReadAttributeRequest & request,
                                                 AttributeValueEncoder & encoder) override;
     DataModel::ActionReturnStatus WriteAttribute(const DataModel::WriteAttributeRequest & request,
diff --git a/src/controller/tests/data_model/DataModelFixtures.h b/src/controller/tests/data_model/DataModelFixtures.h
index bdc251ecb7d9eb..e9b32aead650ee 100644
--- a/src/controller/tests/data_model/DataModelFixtures.h
+++ b/src/controller/tests/data_model/DataModelFixtures.h
@@ -115,11 +115,6 @@ class CustomDataModel : public DataModel::Provider
 
     CHIP_ERROR Shutdown() override { return CHIP_NO_ERROR; }
 
-    bool EventPathIncludesAccessibleConcretePath(const EventPathParams & path,
-                                                 const Access::SubjectDescriptor & descriptor) override
-    {
-        return true;
-    }
     DataModel::ActionReturnStatus ReadAttribute(const DataModel::ReadAttributeRequest & request,
                                                 AttributeValueEncoder & encoder) override;
     DataModel::ActionReturnStatus WriteAttribute(const DataModel::WriteAttributeRequest & request,

From 3d80093d7c4eb645ddedc42ccae5e0930ce7c97a Mon Sep 17 00:00:00 2001
From: Jake Ororke <jororke@csa-iot.org>
Date: Tue, 29 Oct 2024 08:18:55 -0700
Subject: [PATCH 8/8] [Fix] Created possible fix for issue #229: Remove PICS
 from python PWRTL tests (#34094)

* Created possible fix for issue #229:
- Removed PICS if statements from TC_PWRTL_2_1 test module
- Added if statements to check if attribute ID's for available and active endpoints gathered from DUT's are contained in attribute list
- Updated method from NullValue to also include checking for empty lists from DUT's for available and active endpoints

* Restyled by autopep8

* Updated TC_PWRTL_2_1.py:
- Added else condition to return for cases where active or available attribute ID's were not in attibute list on DUT

* Restyled by autopep8

* Updated TC_PWRTL_2_1 test module:
- Replaced method for setting endpoint variable
- Removed null check for available endpoints in test step 2.
- Reworded verbiage for skipping test step 3 if condition is not met.

* Restyled by autopep8

* Updated TC_PWRTL_2_1 test module

- Fixed found linting errors

* Updated TC_PWRTL_2_1 test module:
- Resolved new found linting errors.

* Restyled by autopep8

* Apply suggestions from code review

Co-authored-by: C Freeman <cecille@google.com>

* Update src/python_testing/TC_PWRTL_2_1.py

Co-authored-by: C Freeman <cecille@google.com>

---------

Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: C Freeman <cecille@google.com>
---
 src/python_testing/TC_PWRTL_2_1.py | 47 +++++++++++++++++++-----------
 1 file changed, 30 insertions(+), 17 deletions(-)

diff --git a/src/python_testing/TC_PWRTL_2_1.py b/src/python_testing/TC_PWRTL_2_1.py
index 3de09c6e9356dc..9d4b3de97704d5 100644
--- a/src/python_testing/TC_PWRTL_2_1.py
+++ b/src/python_testing/TC_PWRTL_2_1.py
@@ -53,30 +53,43 @@ async def test_TC_PWRTL_2_1(self):
 
         endpoint = self.user_params.get("endpoint", 1)
 
-        self.print_step(1, "Commissioning, already done")
+        powertop_attr_list = Clusters.Objects.PowerTopology.Attributes.AttributeList
+        powertop_cluster = Clusters.Objects.PowerTopology
+        attribute_list = await self.read_single_attribute_check_success(endpoint=endpoint, cluster=powertop_cluster, attribute=powertop_attr_list)
+        avail_endpoints_attr_id = Clusters.Objects.PowerTopology.Attributes.ActiveEndpoints.attribute_id
+        act_endpoints_attr_id = Clusters.Objects.PowerTopology.Attributes.AvailableEndpoints.attribute_id
 
-        if not self.check_pics("PWRTL.S.A0000"):
-            logging.info("Test skipped because PICS PWRTL.S.A0000 is not set")
-            return
+        self.print_step(1, "Commissioning, already done")
 
         self.print_step(2, "Read AvailableAttributes attribute")
-        available_endpoints = await self.read_single_attribute_check_success(endpoint=endpoint, cluster=Clusters.Objects.PowerTopology, attribute=attributes.AvailableEndpoints)
+        if avail_endpoints_attr_id in attribute_list:
+            available_endpoints = await self.read_single_attribute_check_success(endpoint=endpoint, cluster=Clusters.Objects.PowerTopology, attribute=attributes.AvailableEndpoints)
 
-        asserts.assert_less_equal(len(available_endpoints), 20,
-                                  "AvailableEndpoints length %d must be less than 21!" % len(available_endpoints))
+            if available_endpoints == []:
+                logging.info("AvailableEndpoints is an empty list")
+            else:
+                logging.info("AvailableEndpoints: %s" % (available_endpoints))
+                asserts.assert_less_equal(len(available_endpoints), 20,
+                                          "AvailableEndpoints length %d must be less than 21!" % len(available_endpoints))
 
-        if not self.check_pics("PWRTL.S.A0001"):
-            logging.info("Test skipped because PICS PWRTL.S.A0001 is not set")
-            return
+        else:
+            self.mark_current_step_skipped()
 
         self.print_step(3, "Read ActiveEndpoints attribute")
-        active_endpoints = await self.read_single_attribute_check_success(endpoint=endpoint, cluster=Clusters.Objects.PowerTopology,  attribute=attributes.ActiveEndpoints)
-        logging.info("ActiveEndpoints: %s" % (active_endpoints))
-        asserts.assert_less_equal(len(active_endpoints), 20,
-                                  "ActiveEndpoints length %d must be less than 21!" % len(active_endpoints))
-        # Verify that ActiveEndpoints is a subset of AvailableEndpoints
-        asserts.assert_true(set(active_endpoints).issubset(set(available_endpoints)),
-                            "ActiveEndpoints should be a subset of AvailableEndpoints")
+
+        if act_endpoints_attr_id in attribute_list:
+            active_endpoints = await self.read_single_attribute_check_success(endpoint=endpoint, cluster=Clusters.Objects.PowerTopology,  attribute=attributes.ActiveEndpoints)
+            logging.info("ActiveEndpoints: %s" % (active_endpoints))
+            asserts.assert_less_equal(len(active_endpoints), 20,
+                                      "ActiveEndpoints length %d must be less than 21!" % len(active_endpoints))
+
+            if available_endpoints == []:
+                # Verify that ActiveEndpoints is a subset of AvailableEndpoints
+                asserts.assert_true(set(active_endpoints).issubset(set(available_endpoints)),
+                                    "ActiveEndpoints should be a subset of AvailableEndpoints")
+
+        else:
+            self.mark_current_step_skipped()
 
 
 if __name__ == "__main__":