Address API review issues in MTRDeviceController. (#23512)
This is a re-landing of PR #22596 but with changes made for backwards compat.
* Make MTRBaseDevice creation synchronous. This requires updates to
MTRBaseDeviceOverXPC to do the possible async getting of the controller id it
needs during its async operations, not when getting the device object.
* Deprecate pairDevice methods.
* Rename "commissionDevice" to "commissionNodeWithID".
* Rename "stopDevicePairing" to "cancelCommissioningForNodeID" and document.
* Rename "getDeviceBeingCommissioned" to "getDeviceBeingCommissionedWithNodeID".
* Various documentation improvements.
* Fix signature of computePaseVerifier.
The header changes not accompanied by backwards-compat shims are OK for the
following reasons:
* In MTRDeviceController.h, the change to isRunning is binary and source
compatible.
* MTRDeviceControllerOverXPC_Internal.h is not public API.
* MTRDeviceController_Internal.h is not public API.
* MTRDeviceOverXPC.h is not public API.
* The changes to MTRSetupPayload.h are backward-compatible.
diff --git a/src/darwin/Framework/CHIPTests/MTRDeviceTests.m b/src/darwin/Framework/CHIPTests/MTRDeviceTests.m
index a01e9b8..a3a55d0 100644
--- a/src/darwin/Framework/CHIPTests/MTRDeviceTests.m
+++ b/src/darwin/Framework/CHIPTests/MTRDeviceTests.m
@@ -39,7 +39,6 @@
#define MANUAL_INDIVIDUAL_TEST 0
static const uint16_t kPairingTimeoutInSeconds = 10;
-static const uint16_t kCASESetupTimeoutInSeconds = 30;
static const uint16_t kTimeoutInSeconds = 3;
static const uint64_t kDeviceId = 0x12344321;
static NSString * kOnboardingPayload = @"MT:-24J0AFN00KA0648G00";
@@ -61,13 +60,12 @@
MTRDeviceController * controller = sController;
XCTAssertNotNil(controller);
- [controller getBaseDevice:kDeviceId
- queue:dispatch_get_main_queue()
- completion:^(MTRBaseDevice * _Nullable device, NSError * _Nullable error) {
- XCTAssertEqual(error.code, 0);
- [expectation fulfill];
- mConnectedDevice = device;
- }];
+ // For now keep the async dispatch, but could we just
+ // synchronously fulfill the expectation here?
+ dispatch_async(dispatch_get_main_queue(), ^{
+ [expectation fulfill];
+ mConnectedDevice = [MTRBaseDevice deviceWithNodeID:@(kDeviceId) controller:controller];
+ });
}
static MTRBaseDevice * GetConnectedDevice(void)
@@ -101,7 +99,9 @@
XCTAssertEqual(error.code, 0);
NSError * commissionError = nil;
- [sController commissionDevice:kDeviceId commissioningParams:[[MTRCommissioningParameters alloc] init] error:&commissionError];
+ [sController commissionNodeWithID:@(kDeviceId)
+ commissioningParams:[[MTRCommissioningParameters alloc] init]
+ error:&commissionError];
XCTAssertNil(commissionError);
// Keep waiting for onCommissioningComplete
@@ -200,16 +200,6 @@
XCTAssertNil(error);
[self waitForExpectationsWithTimeout:kPairingTimeoutInSeconds handler:nil];
-
- __block XCTestExpectation * connectionExpectation = [self expectationWithDescription:@"CASE established"];
- [controller getBaseDevice:kDeviceId
- queue:dispatch_get_main_queue()
- completion:^(MTRBaseDevice * _Nullable device, NSError * _Nullable error) {
- XCTAssertEqual(error.code, 0);
- [connectionExpectation fulfill];
- connectionExpectation = nil;
- }];
- [self waitForExpectationsWithTimeout:kCASESetupTimeoutInSeconds handler:nil];
}
- (void)shutdownStack
@@ -1131,17 +1121,7 @@
MTRDeviceController * controller = sController;
XCTAssertNotNil(controller);
- __block MTRBaseDevice * device;
- __block XCTestExpectation * connectionExpectation = [self expectationWithDescription:@"CASE established"];
- [controller getBaseDevice:kDeviceId
- queue:dispatch_get_main_queue()
- completion:^(MTRBaseDevice * _Nullable retrievedDevice, NSError * _Nullable error) {
- XCTAssertEqual(error.code, 0);
- [connectionExpectation fulfill];
- connectionExpectation = nil;
- device = retrievedDevice;
- }];
- [self waitForExpectationsWithTimeout:kCASESetupTimeoutInSeconds handler:nil];
+ MTRBaseDevice * device = [MTRBaseDevice deviceWithNodeID:@(kDeviceId) controller:controller];
XCTestExpectation * expectation = [self expectationWithDescription:@"ReuseMTRClusterObjectFirstCall"];
