[Darwin] MTRDevice attribute cache persistent storage local test facility #32181
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pullapprove
bot
requested review from
andy31415,
andyg-apple,
anush-apple,
arkq,
bzbarsky-apple,
carol-apple,
cecille,
chrisdecenzo,
chshu,
chulspro,
cliffamzn,
Damian-Nordic,
dhrishi,
harsha-rajendran,
hawk248,
hicklin,
jepenven-silabs,
jmartinez-silabs,
jmeg-sfy,
joonhaengHeo,
kkasperczyk-no,
kpschoedel,
ksperling-apple,
lazarkov,
lpbeliveau-silabs,
LuDuda and
mhazley
pullapprove
bot
requested review from
sharadb-amazon,
tcarmelveilleux,
tecimovic,
tehampson,
tima-q,
tobiasgraf,
turon,
vivien-apple,
wiba-nordic,
woody-apple,
younghak-hwang,
yufengwangca and
yunhanw-google
woody-apple
approved these changes
Feb 16, 2024
|
PR #32181: Size comparison from 573511d to 664cd44 Decreases (2 builds for efr32)
Full report (73 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, qpg, stm32, telink)
|
andy31415
approved these changes
Feb 16, 2024
|
PR #32181: Size comparison from 573511d to 2f3cf59 Decreases (2 builds for efr32)
Full report (73 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, qpg, stm32, telink)
|
|
PR #32181: Size comparison from 573511d to 3a95425 Decreases (7 builds for cc13x4_26x4, efr32)
Full report (73 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, qpg, stm32, telink)
|
|
PR #32181: Size comparison from 573511d to 1c95fd6 Increases (50 builds for cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, qpg, stm32, telink)
Decreases (7 builds for cc13x4_26x4, efr32, linux)
Full report (73 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, qpg, stm32, telink)
|
|
PR #32181: Size comparison from 573511d to 1b003b7 Increases (50 builds for cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, qpg, stm32, telink)
Decreases (7 builds for cc13x4_26x4, efr32, linux)
Full report (73 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, qpg, stm32, telink)
|
Comment on lines
+1
to
+3
| // | ||
| /** | ||
| * Copyright (c) 2023 Project CHIP Authors |
There was a problem hiding this comment.
What's with the stray comment at the top? And the incorrect copyright date?
There was a problem hiding this comment.
That's an Xcode bug in the handling of the "new source file" template and needs to be removed by hand.
|
|
||
| MTR_EXTERN @interface MTRDeviceControllerLocalTestStorage : NSObject<MTRDeviceControllerStorageDelegate> | ||
|
|
||
| // Setting this variable only affects subsequent MTRDeviceController initializations |
There was a problem hiding this comment.
This needs much better documentation. What does setting this variable to true actually do?
Comment on lines
+1
to
+3
| // | ||
| /** | ||
| * Copyright (c) 2023 Project CHIP Authors |
There was a problem hiding this comment.
Again, these comments look broken.
| @@ -129,10 +118,19 @@ @interface MTRDeviceTests : XCTestCase | |||
|
|
|||
| @implementation MTRDeviceTests | |||
|
|
|||
| #if MTR_PER_CONTROLLER_STORAGE_ENABLED | |||
| static BOOL slocalTestStorageEnabledBeforeUnitTest; | |||
There was a problem hiding this comment.
"sLocale", not "slocal"?
Comment on lines
-1239
to
+1245
| // affect this subscription erroring out correctly. | ||
| // affect this subscription erroring out correctly. |
There was a problem hiding this comment.
This indent change looks wrong to me.
Comment on lines
-1603
to
+1615
| // affect this subscription erroring out correctly. | ||
| // affect this subscription erroring out correctly. |
There was a problem hiding this comment.
Again, this indent change is broken.
| { | ||
| dispatch_queue_t queue = dispatch_get_main_queue(); | ||
|
|
||
| // First start with clean slate and |
| #pragma mark - Declarations for internal methods | ||
|
|
||
| // MTRDeviceControllerDataStore.h includes C++ header, and so we need to declare the methods separately | ||
| @protocol MTRDeviceControllerDataStoreAttributeStoreMethods |
There was a problem hiding this comment.
These bits used to be #ifdef DEBUG. Why the change?
Comment on lines
+1
to
+3
| // | ||
| /** | ||
| * Copyright (c) 2023 Project CHIP Authors |
There was a problem hiding this comment.
Same issue as the other comments.
| @@ -240,6 +240,8 @@ | |||
| 5ACDDD7D27CD16D200EFD68A /* MTRClusterStateCacheContainer.mm in Sources */ = {isa = PBXBuildFile; fileRef = 5ACDDD7C27CD16D200EFD68A /* MTRClusterStateCacheContainer.mm */; }; | |||
| 5ACDDD7E27CD3F3A00EFD68A /* MTRClusterStateCacheContainer_Internal.h in Headers */ = {isa = PBXBuildFile; fileRef = 5ACDDD7B27CD14AF00EFD68A /* MTRClusterStateCacheContainer_Internal.h */; }; | |||
| 5AE6D4E427A99041001F2493 /* MTRDeviceTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 5AE6D4E327A99041001F2493 /* MTRDeviceTests.m */; }; | |||
| 75139A6F2B7FE5E900E3A919 /* MTRDeviceControllerLocalTestStorage.m in Sources */ = {isa = PBXBuildFile; fileRef = 75139A6E2B7FE5E900E3A919 /* MTRDeviceControllerLocalTestStorage.m */; }; | |||
| 75139A702B7FE68C00E3A919 /* MTRDeviceControllerLocalTestStorage.h in Headers */ = {isa = PBXBuildFile; fileRef = 75139A6D2B7FE5D600E3A919 /* MTRDeviceControllerLocalTestStorage.h */; settings = {ATTRIBUTES = (Private, ); }; }; | |||
There was a problem hiding this comment.
Why is this a private header? Things compile fine if I set it to be a project header....
| { | ||
| if (sharingType == MTRStorageSharingTypeNotShared) { | ||
| NSUserDefaults * defaults = [[NSUserDefaults alloc] initWithSuiteName:kLocalTestUserDefaultDomain]; | ||
| NSData * storedData = [defaults dataForKey:key]; |
There was a problem hiding this comment.
As we figured out on Slack: this is going to cause anything that involves multiple controllers to break, because they will stomp on each other's storage.... Probably need to include the controller id in the key, but then the persistence aspect might break unless people use stable ids.
| @@ -173,12 +174,31 @@ - (instancetype)initWithFactory:(MTRDeviceControllerFactory *)factory | |||
| return nil; | |||
| } | |||
|
|
|||
| id<MTRDeviceControllerStorageDelegate> storageDelegateToUse = storageDelegate; | |||
| #if MTR_PER_CONTROLLER_STORAGE_ENABLED | |||
There was a problem hiding this comment.
This could be moved out of the real code by exposing _controllerDataStore as writable to tests, or factoring this logic out into a internal createControllerDataStore method that the test can override by sub-classing MTRDeviceController.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #31966
But mainly this PR adds a facility to test MTRDevice attribute cache persistent storage when the MTRDeviceController does not have a per controller storage delegate.
On macOS the storage can be turned on with the command:
and turned off with: