Remove handling of the unitTestInject* bits in base MTRDevice.

These injections need to be handled by subclasses, because the subclasses do
very different report processing and have different mechanisms for getting
reports.

Once these implementations are removed, the following become unreachable and can
be removed:

* _handleEventReport
* _handleReportBegin
* _handleAttributeReport
* _handleReportEnd

Once those are removed, the following become unreachable or unused and can be
removed:

* _receivingReport (always false)
* _receivingPrimingReport (always false, because _receivingReport is always false)
* _changeState
* _callDelegateDeviceCachePrimed
* unreportedEvents

Author: bzbarsky-apple

src/darwin/Framework/CHIP/MTRDevice.mm

@@ -260,9 +260,6 @@ @interface MTRDevice ()
 @property (nonatomic, readonly) os_unfair_lock timeSyncLock;
 
 @property (nonatomic) chip::FabricIndex fabricIndex;
-@property (nonatomic) NSMutableArray<NSDictionary<NSString *, id> *> * unreportedEvents;
-@property (nonatomic) BOOL receivingReport;
-@property (nonatomic) BOOL receivingPrimingReport;
 
 // TODO: instead of all the BOOL properties that are some facet of the state, move to internal state machine that has (at least):
 //   Actively receiving report
@@ -371,6 +368,7 @@ - (instancetype)initForSubclassesWithNodeID:(NSNumber *)nodeID controller:(MTRDe
         _delegates = [NSMutableSet set];
         _deviceController = controller;
         _nodeID = nodeID;
+        _state = MTRDeviceStateUnknown;
     }
 
     return self;
@@ -820,41 +818,6 @@ - (void)_callFirstDelegateSynchronouslyWithBlock:(void (^)(id<MTRDeviceDelegate>
 }
 #endif
 
-- (void)_callDelegateDeviceCachePrimed
-{
-    os_unfair_lock_assert_owner(&self->_lock);
-    [self _callDelegatesWithBlock:^(id<MTRDeviceDelegate> delegate) {
-        if ([delegate respondsToSelector:@selector(deviceCachePrimed:)]) {
-            [delegate deviceCachePrimed:self];
-        }
-    }];
-}
-
-// assume lock is held
-- (void)_changeState:(MTRDeviceState)state
-{
-    os_unfair_lock_assert_owner(&self->_lock);
-    MTRDeviceState lastState = _state;
-    _state = state;
-    if (lastState != state) {
-        if (state != MTRDeviceStateReachable) {
-            MTR_LOG("%@ reachability state change %lu => %lu, set estimated start time to nil", self, static_cast<unsigned long>(lastState),
-                static_cast<unsigned long>(state));
-            _estimatedStartTime = nil;
-            _estimatedStartTimeFromGeneralDiagnosticsUpTime = nil;
-        } else {
-            MTR_LOG(
-                "%@ reachability state change %lu => %lu", self, static_cast<unsigned long>(lastState), static_cast<unsigned long>(state));
-        }
-        [self _callDelegatesWithBlock:^(id<MTRDeviceDelegate> delegate) {
-            [delegate device:self stateChanged:state];
-        }];
-    } else {
-        MTR_LOG(
-            "%@ Not reporting reachability state change, since no change in state %lu => %lu", self, static_cast<unsigned long>(lastState), static_cast<unsigned long>(state));
-    }
-}
-
 #ifdef DEBUG
 - (MTRInternalDeviceState)_getInternalState
 {
@@ -906,20 +869,6 @@ - (BOOL)_deviceUsesThread
     return (networkCommissioningClusterFeatureMapValue & MTRNetworkCommissioningFeatureThreadNetworkInterface) != 0 ? YES : NO;
 }
 
-- (void)_handleReportBegin
-{
-    std::lock_guard lock(_lock);
-
-    _receivingReport = YES;
-    if (_state != MTRDeviceStateReachable) {
-        [self _changeState:MTRDeviceStateReachable];
-    }
-
-    // If we currently don't have an established subscription, this must be a
-    // priming report.
-    _receivingPrimingReport = YES;
-}
-
 - (NSDictionary<MTRClusterPath *, MTRDeviceClusterData *> *)_clusterDataToPersistSnapshot
 {
     os_unfair_lock_assert_owner(&self->_lock);
@@ -1202,49 +1151,6 @@ - (void)setStorageBehaviorConfiguration:(MTRDeviceStorageBehaviorConfiguration *
     [self _resetStorageBehaviorState];
 }
 
-- (void)_handleReportEnd
-{
-    std::lock_guard lock(_lock);
-    _receivingReport = NO;
-    _receivingPrimingReport = NO;
-    _estimatedStartTimeFromGeneralDiagnosticsUpTime = nil;
-
-    [self _scheduleClusterDataPersistence];
-
-    // After the handling of the report, if we detected a device configuration change, notify the delegate
-    // of the same.
-    if (_deviceConfigurationChanged) {
-        [self _callDelegatesWithBlock:^(id<MTRDeviceDelegate> delegate) {
-            if ([delegate respondsToSelector:@selector(deviceConfigurationChanged:)]) {
-                [delegate deviceConfigurationChanged:self];
-            }
-        }];
-        _deviceConfigurationChanged = NO;
-    }
-
-    // Do this after the _deviceConfigurationChanged check, so that we don't
-    // call deviceConfigurationChanged: immediately after telling our delegate
-    // we are now primed.
-    //
-    // TODO: Maybe we shouldn't dispatch deviceConfigurationChanged: for the
-    // initial priming bits?
-    if (!_deviceCachePrimed) {
-        // This is the end of the priming sequence of data reports, so we have
-        // all the data for the device now.
-        _deviceCachePrimed = YES;
-        [self _callDelegateDeviceCachePrimed];
-    }
-
-// For unit testing only
-#ifdef DEBUG
-    [self _callDelegatesWithBlock:^(id testDelegate) {
-        if ([testDelegate respondsToSelector:@selector(unitTestReportEndForDevice:)]) {
-            [testDelegate unitTestReportEndForDevice:self];
-        }
-    }];
-#endif
-}
-
 - (BOOL)_interestedPaths:(NSArray * _Nullable)interestedPaths includesAttributePath:(MTRAttributePath *)attributePath
 {
     for (id interestedPath in interestedPaths) {
@@ -1316,29 +1222,15 @@ - (void)_reportAttributes:(NSArray<NSDictionary<NSString *, id> *> *)attributes
     }
 }
 
-- (void)_handleAttributeReport:(NSArray<NSDictionary<NSString *, id> *> *)attributeReport fromSubscription:(BOOL)isFromSubscription
-{
-    std::lock_guard lock(_lock);
-
-    // _getAttributesToReportWithReportedValues will log attribute paths reported
-    [self _reportAttributes:[self _getAttributesToReportWithReportedValues:attributeReport fromSubscription:isFromSubscription]];
-}
-
 #ifdef DEBUG
 - (void)unitTestInjectEventReport:(NSArray<NSDictionary<NSString *, id> *> *)eventReport
 {
-    dispatch_async(self.queue, ^{
-        [self _handleEventReport:eventReport];
-    });
+    NSAssert(NO, @"Unit test injection of reports needs to be handled by subclasses");
 }
 
 - (void)unitTestInjectAttributeReport:(NSArray<NSDictionary<NSString *, id> *> *)attributeReport fromSubscription:(BOOL)isFromSubscription
 {
-    dispatch_async(self.queue, ^{
-        [self _handleReportBegin];
-        [self _handleAttributeReport:attributeReport fromSubscription:isFromSubscription];
-        [self _handleReportEnd];
-    });
+    NSAssert(NO, @"Unit test injection of reports needs to be handled by subclasses");
 }
 #endif
 
@@ -1396,111 +1288,6 @@ - (BOOL)_interestedPaths:(NSArray * _Nullable)interestedPaths includesEventPath:
     return filteredEvents;
 }
 
-- (void)_handleEventReport:(NSArray<NSDictionary<NSString *, id> *> *)eventReport
-{
-    std::lock_guard lock(_lock);
-
-    NSDate * oldEstimatedStartTime = _estimatedStartTime;
-    // Combine with previous unreported events, if they exist
-    NSMutableArray * reportToReturn;
-    if (_unreportedEvents) {
-        reportToReturn = _unreportedEvents;
-    } else {
-        reportToReturn = [NSMutableArray array];
-    }
-    for (NSDictionary<NSString *, id> * eventDict in eventReport) {
-        // Whenever a StartUp event is received, reset the estimated start time
-        //   New subscription case
-        //     - Starts Unreachable
-        //     - Start CASE and send subscription request
-        //     - Receive priming report ReportBegin
-        //     - Optionally receive UpTime attribute - update time and save start time estimate
-        //     - Optionally receive StartUp event
-        //       - Set estimated system time from event receipt time, or saved UpTime estimate if exists
-        //     - ReportEnd handler clears the saved start time estimate based on UpTime
-        //   Subscription dropped from client point of view case
-        //     - Starts Unreachable
-        //     - Resubscribe happens after some time, and then same as the above
-        //   Server resuming subscription after reboot case
-        //     - Starts Reachable
-        //     - Receive priming report ReportBegin
-        //     - Optionally receive UpTime attribute - update time and save value
-        //     - Optionally receive StartUp event
-        //       - Set estimated system time from event receipt time, or saved UpTime estimate if exists
-        //     - ReportEnd handler clears the saved start time estimate based on UpTime
-        //   Server resuming subscription after timeout case
-        //     - Starts Reachable
-        //     - Receive priming report ReportBegin
-        //     - Optionally receive UpTime attribute - update time and save value
-        //     - ReportEnd handler clears the saved start time estimate based on UpTime
-        MTREventPath * eventPath = eventDict[MTREventPathKey];
-        BOOL isStartUpEvent = (eventPath.cluster.unsignedLongValue == MTRClusterIDTypeBasicInformationID)
-            && (eventPath.event.unsignedLongValue == MTREventIDTypeClusterBasicInformationEventStartUpID);
-        if (isStartUpEvent) {
-            if (_estimatedStartTimeFromGeneralDiagnosticsUpTime) {
-                // If UpTime was received, make use of it as mark of system start time
-                MTR_LOG("%@ StartUp event: set estimated start time forward to %@", self,
-                    _estimatedStartTimeFromGeneralDiagnosticsUpTime);
-                _estimatedStartTime = _estimatedStartTimeFromGeneralDiagnosticsUpTime;
-            } else {
-                // If UpTime was not received, reset estimated start time in case of reboot
-                MTR_LOG("%@ StartUp event: set estimated start time to nil", self);
-                _estimatedStartTime = nil;
-            }
-        }
-
-        // If event time is of MTREventTimeTypeSystemUpTime type, then update estimated start time as needed
-        NSNumber * eventTimeTypeNumber = eventDict[MTREventTimeTypeKey];
-        if (!eventTimeTypeNumber) {
-            MTR_LOG_ERROR("%@ Event %@ missing event time type", self, eventDict);
-            continue;
-        }
-        MTREventTimeType eventTimeType = (MTREventTimeType) eventTimeTypeNumber.unsignedIntegerValue;
-        if (eventTimeType == MTREventTimeTypeSystemUpTime) {
-            NSNumber * eventTimeValueNumber = eventDict[MTREventSystemUpTimeKey];
-            if (!eventTimeValueNumber) {
-                MTR_LOG_ERROR("%@ Event %@ missing event time value", self, eventDict);
-                continue;
-            }
-            NSTimeInterval eventTimeValue = eventTimeValueNumber.doubleValue;
-            NSDate * potentialSystemStartTime = [NSDate dateWithTimeIntervalSinceNow:-eventTimeValue];
-            if (!_estimatedStartTime || ([potentialSystemStartTime compare:_estimatedStartTime] == NSOrderedAscending)) {
-                _estimatedStartTime = potentialSystemStartTime;
-            }
-        }
-
-        NSMutableDictionary * eventToReturn = eventDict.mutableCopy;
-        if (_receivingPrimingReport) {
-            eventToReturn[MTREventIsHistoricalKey] = @(YES);
-        } else {
-            eventToReturn[MTREventIsHistoricalKey] = @(NO);
-        }
-
-        [reportToReturn addObject:eventToReturn];
-    }
-    if (oldEstimatedStartTime != _estimatedStartTime) {
-        MTR_LOG("%@ updated estimated start time to %@", self, _estimatedStartTime);
-    }
-
-    __block BOOL delegatesCalled = NO;
-    [self _iterateDelegatesWithBlock:^(MTRDeviceDelegateInfo * delegateInfo) {
-        // _iterateDelegatesWithBlock calls this with an autorelease pool, and so temporary filtered event reports don't bloat memory
-        NSArray<NSDictionary<NSString *, id> *> * filteredEvents = [self _filteredEvents:reportToReturn forInterestedPaths:delegateInfo.interestedPathsForEvents];
-        if (filteredEvents.count) {
-            [delegateInfo callDelegateWithBlock:^(id<MTRDeviceDelegate> delegate) {
-                [delegate device:self receivedEventReport:filteredEvents];
-            }];
-            delegatesCalled = YES;
-        }
-    }];
-    if (delegatesCalled) {
-        _unreportedEvents = nil;
-    } else {
-        // save unreported events
-        _unreportedEvents = reportToReturn;
-    }
-}
-
 #ifdef DEBUG
 - (void)unitTestClearClusterData
 {
@@ -1639,7 +1426,6 @@ - (void)_setCachedAttributeValue:(MTRDeviceDataValueDictionary _Nullable)value f
 
     if (value != nil
         && isFromSubscription
-        && !_receivingPrimingReport
         && AttributeHasChangesOmittedQuality(path)) {
         // Do not persist new values for Changes Omitted Quality (aka C Quality)
         // attributes unless they're part of a Priming Report or from a read response.
@@ -2374,11 +2160,6 @@ - (NSArray *)_getAttributesToReportWithReportedValues:(NSArray<NSDictionary<NSSt
             continue;
         }
 
-        // Additional signal to help mark events as being received during priming report in the event the device rebooted and we get a subscription resumption priming report without noticing it became unreachable first
-        if (_receivingReport && AttributeHasChangesOmittedQuality(attributePath)) {
-            _receivingPrimingReport = YES;
-        }
-
         // check if value is different than cache, and report if needed
         BOOL shouldReportAttribute = NO;