Add support for notifying the delegate when device configuration changes (project-chip#33146)

* Add support for notifying the delegate when device configuration changes

- Device configuration changes include updates in attributes parts list, server list,
  device type list, cluster revision or feature map in the descriptor cluster

- Add a test to verify the delegate is notified when device configuration changes

* Restyled by clang-format

* Change device list to device type list

* Add accepted commands list and attribute list to the list of attributes that qualify as device configuration changes

* Set _deviceConfigurationChanged to NO in _handleReportEnd

* Update src/darwin/Framework/CHIP/MTRDevice.h

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

* Apply suggestions from code review

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

* Addressed review comments

* Restyled by clang-format

* Apply suggestions from code review

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

* Update code to set _deviceConfigurationChanged correctly in _getAttributesToReportWithReportedValues

- Add more tests to verify that for attributes that don't affect device configuration changed, the
  delegate callback is not called. Also add tests for testing an attribute report having multiple
  attributes one of which causes device configuration changed.

* Restyled by clang-format

* Add logs to test the multiple attribute report

* Fix the checkAttributeReportTriggersConfigurationChanged API and invert the expectation for device configuration changed when expectConfigurationChanged is set to NO

* Restyled by clang-format

* Apply suggestions from code review

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

* Addressed comments

---------

Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>

Author: 3 people

src/darwin/Framework/CHIP/MTRDevice.h

@@ -423,6 +423,14 @@ MTR_EXTERN NSString * const MTRDataVersionKey MTR_NEWLY_AVAILABLE;
  */
 - (void)deviceCachePrimed:(MTRDevice *)device MTR_NEWLY_AVAILABLE;
 
+/**
+ * This is called when the MTRDevice object detects a change in the device configuration.
+ *
+ * Device configuration is the set of functionality implemented by the device.
+ *
+ */
+- (void)deviceConfigurationChanged:(MTRDevice *)device MTR_NEWLY_AVAILABLE;
+
 @end
 
 @interface MTRDevice (Deprecated)

src/darwin/Framework/CHIP/MTRDevice.mm

@@ -378,6 +378,10 @@ @implementation MTRDevice {
     // ReadClient).  Nil if we have had no such failures.
     NSDate * _Nullable _lastSubscriptionFailureTime;
     MTRDeviceConnectivityMonitor * _connectivityMonitor;
+
+    // This boolean keeps track of any device configuration changes received in an attribute report.
+    // If this is true when the report ends, we notify the delegate.
+    BOOL _deviceConfigurationChanged;
 }
 
 - (instancetype)initWithNodeID:(NSNumber *)nodeID controller:(MTRDeviceController *)controller
@@ -1090,6 +1094,19 @@ - (void)_handleReportEnd
         _clusterDataToPersist = nil;
     }
 
+    // After the handling of the report, if we detected a device configuration change, notify the delegate
+    // of the same.
+    if (_deviceConfigurationChanged) {
+        id<MTRDeviceDelegate> delegate = _weakDelegate.strongObject;
+        if (delegate) {
+            dispatch_async(_delegateQueue, ^{
+                if ([delegate respondsToSelector:@selector(deviceConfigurationChanged:)])
+                    [delegate deviceConfigurationChanged:self];
+            });
+        }
+        _deviceConfigurationChanged = NO;
+    }
+
 // For unit testing only
 #ifdef DEBUG
     id delegate = _weakDelegate.strongObject;
@@ -1132,6 +1149,15 @@ - (void)unitTestInjectEventReport:(NSArray<NSDictionary<NSString *, id> *> *)eve
         [self _handleEventReport:eventReport];
     });
 }
+
+- (void)unitTestInjectAttributeReport:(NSArray<NSDictionary<NSString *, id> *> *)attributeReport
+{
+    dispatch_async(self.queue, ^{
+        [self _handleReportBegin];
+        [self _handleAttributeReport:attributeReport];
+        [self _handleReportEnd];
+    });
+}
 #endif
 
 - (void)_handleEventReport:(NSArray<NSDictionary<NSString *, id> *> *)eventReport
@@ -2443,6 +2469,30 @@ - (void)_noteDataVersion:(NSNumber *)dataVersion forClusterPath:(MTRClusterPath
     }
 }
 
+- (BOOL)_attributeAffectsDeviceConfiguration:(MTRAttributePath *)attributePath
+{
+    // Check for attributes in the descriptor cluster that affect device configuration.
+    if (attributePath.cluster.unsignedLongValue == MTRClusterIDTypeDescriptorID) {
+        switch (attributePath.attribute.unsignedLongValue) {
+        case MTRAttributeIDTypeClusterDescriptorAttributePartsListID:
+        case MTRAttributeIDTypeClusterDescriptorAttributeServerListID:
+        case MTRAttributeIDTypeClusterDescriptorAttributeDeviceTypeListID: {
+            return YES;
+        }
+        }
+    }
+
+    // Check for global attributes that affect device configuration.
+    switch (attributePath.attribute.unsignedLongValue) {
+    case MTRAttributeIDTypeGlobalAttributeAcceptedCommandListID:
+    case MTRAttributeIDTypeGlobalAttributeAttributeListID:
+    case MTRAttributeIDTypeGlobalAttributeClusterRevisionID:
+    case MTRAttributeIDTypeGlobalAttributeFeatureMapID:
+        return YES;
+    }
+    return NO;
+}
+
 // assume lock is held
 - (NSArray *)_getAttributesToReportWithReportedValues:(NSArray<NSDictionary<NSString *, id> *> *)reportedAttributeValues
 {
@@ -2495,6 +2545,12 @@ - (NSArray *)_getAttributesToReportWithReportedValues:(NSArray<NSDictionary<NSSt
             // Now that we have grabbed previousValue, update our cache with the attribute value.
             if (readCacheValueChanged) {
                 [self _setCachedAttributeValue:attributeDataValue forPath:attributePath];
+                if (!_deviceConfigurationChanged) {
+                    _deviceConfigurationChanged = [self _attributeAffectsDeviceConfiguration:attributePath];
+                    if (_deviceConfigurationChanged) {
+                        MTR_LOG_INFO("Device configuration changed due to changes in attribute %@", attributePath);
+                    }
+                }
             }
 
 #ifdef DEBUG