Repository navigation
fix: ignore state changes reported while a controller is being restored #1133
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| import { Accessory } from "../Accessory"; | ||
| import { ControllerIdentifier, ControllerServiceMap, SerializableController, StateChangeDelegate } from "../controller"; | ||
| import * as uuid from "../util/uuid"; | ||
| import { ControllerStorage } from "./ControllerStorage"; | ||
|
|
||
| interface State { | ||
| first?: string; | ||
| second?: string; | ||
| } | ||
|
|
||
| // restores its state in two steps and reports a state change in between, like a controller whose | ||
| // characteristic updates during deserialize trigger its own change listeners | ||
| class SteppedController implements SerializableController<ControllerServiceMap, State> { | ||
| state: State = {}; | ||
| protected stateChangeDelegate?: StateChangeDelegate; | ||
|
|
||
| controllerId(): ControllerIdentifier { | ||
| return "stepped"; | ||
| } | ||
|
|
||
| constructServices(): ControllerServiceMap { | ||
| return {}; | ||
| } | ||
|
|
||
| initWithServices(): void | ControllerServiceMap { | ||
| return undefined; | ||
| } | ||
|
|
||
| configureServices(): void { | ||
| // nothing to configure | ||
| } | ||
|
|
||
| handleControllerRemoved(): void { | ||
| // nothing to clean up | ||
| } | ||
|
|
||
| serialize(): State | undefined { | ||
| return { ...this.state }; | ||
| } | ||
|
|
||
| deserialize(serialized: State): void { | ||
| this.state.first = serialized.first; | ||
| this.stateChangeDelegate?.(); | ||
| this.state.second = serialized.second; | ||
| } | ||
|
|
||
| setupStateChangeDelegate(delegate?: StateChangeDelegate): void { | ||
| this.stateChangeDelegate = delegate; | ||
| } | ||
|
|
||
| handleFactoryReset(): void { | ||
| this.state = {}; | ||
| } | ||
| } | ||
|
|
||
| // can't read its stored data and reports the reset, like the adaptive lighting controller | ||
| class UnreadableController extends SteppedController { | ||
| controllerId(): ControllerIdentifier { | ||
| return "unreadable"; | ||
| } | ||
|
|
||
| deserialize(): void { | ||
| throw new Error("unreadable"); | ||
| } | ||
|
|
||
| handleFactoryReset(): void { | ||
| super.handleFactoryReset(); | ||
| this.stateChangeDelegate?.(); | ||
| } | ||
| } | ||
|
|
||
| describe("ControllerStorage", () => { | ||
| test("state changes reported while restoring do not overwrite the stored data", () => { | ||
| const accessory = new Accessory("Test", uuid.generate("controller-storage")); | ||
| const storage = new ControllerStorage(accessory); | ||
| const controller = new SteppedController(); | ||
| storage.trackController(controller); | ||
|
|
||
| // @ts-expect-error: private access | ||
| storage.init([{ type: "stepped", controllerData: { data: { first: "a", second: "b" } } }]); | ||
|
|
||
| expect(controller.state).toEqual({ first: "a", second: "b" }); | ||
| // @ts-expect-error: private access | ||
| expect(storage.controllerData.stepped.data).toEqual({ first: "a", second: "b" }); | ||
|
|
||
| controller.state.second = "c"; | ||
| // @ts-expect-error: private access | ||
| storage.handleStateChange(controller); | ||
| // @ts-expect-error: private access | ||
| expect(storage.controllerData.stepped.data).toEqual({ first: "a", second: "c" }); | ||
| // @ts-expect-error: private access | ||
| clearTimeout(storage.queuedSaveTimeout); | ||
| }); | ||
|
|
||
| test("the reset after unreadable stored data is saved", () => { | ||
| const accessory = new Accessory("Test", uuid.generate("controller-storage-reset")); | ||
| const storage = new ControllerStorage(accessory); | ||
| const controller = new UnreadableController(); | ||
| storage.trackController(controller); | ||
| const warn = jest.spyOn(console, "warn").mockImplementation(() => undefined); | ||
|
|
||
| // @ts-expect-error: private access | ||
| storage.init([{ type: "unreadable", controllerData: { data: { first: "a", second: "b" } } }]); | ||
|
|
||
| expect(warn).toHaveBeenCalledTimes(1); | ||
| // @ts-expect-error: private access | ||
| expect(storage.controllerData.unreadable.data).toEqual({}); | ||
| warn.mockRestore(); | ||
| // @ts-expect-error: private access | ||
| clearTimeout(storage.queuedSaveTimeout); | ||
| }); | ||
| }); |
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.