-
-
Notifications
You must be signed in to change notification settings - Fork 225
Fix stale timer cleanup hiding restarted timers #644
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
Open
1074016045
wants to merge
2
commits into
Ebullioscopic:dev
Choose a base branch
from
1074016045:agent/fix-timer-session-cleanup-race
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
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
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
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,41 @@ | ||
| /* | ||
| * Atoll (DynamicIsland) | ||
| * Copyright (C) 2024-2026 Atoll Contributors | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| */ | ||
|
|
||
| import Foundation | ||
|
|
||
| /// Gives each timer run its own identity so delayed work from an earlier run | ||
| /// cannot mutate a timer that was started in the meantime. | ||
| struct TimerLifecycle { | ||
| private(set) var sessionID: UUID? | ||
| private(set) var completedSessionID: UUID? | ||
|
|
||
| @discardableResult | ||
| mutating func beginSession() -> UUID { | ||
| let sessionID = UUID() | ||
| self.sessionID = sessionID | ||
| completedSessionID = nil | ||
| return sessionID | ||
| } | ||
|
|
||
| @discardableResult | ||
| mutating func completeSession() -> UUID? { | ||
| completedSessionID = sessionID | ||
| return completedSessionID | ||
| } | ||
|
|
||
| mutating func endSession() { | ||
| sessionID = nil | ||
| completedSessionID = nil | ||
| } | ||
|
|
||
| func isCurrent(_ candidate: UUID) -> Bool { | ||
| sessionID == candidate | ||
| } | ||
| } |
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
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,32 @@ | ||
| import Foundation | ||
|
|
||
| @main | ||
| struct TimerLifecycleRegression { | ||
| static func main() { | ||
| var lifecycle = TimerLifecycle() | ||
|
|
||
| let completedTimer = lifecycle.beginSession() | ||
| precondition(lifecycle.isCurrent(completedTimer)) | ||
| precondition(lifecycle.completeSession() == completedTimer) | ||
| precondition(lifecycle.completedSessionID == completedTimer) | ||
| var islandIsVisible = true | ||
|
|
||
| // Reusing the same duration or external timer ID must still create a | ||
| // different run. Cleanup captured for completedTimer is now stale. | ||
| let replacementTimer = lifecycle.beginSession() | ||
| precondition(replacementTimer != completedTimer) | ||
| precondition(!lifecycle.isCurrent(completedTimer)) | ||
| precondition(lifecycle.isCurrent(replacementTimer)) | ||
| precondition(lifecycle.completedSessionID == nil) | ||
|
|
||
| // This is the guard used by delayed Island cleanup. The stale closure | ||
| // must leave the replacement timer visible. | ||
| if lifecycle.isCurrent(completedTimer) { | ||
| islandIsVisible = false | ||
| } | ||
| precondition(islandIsVisible) | ||
|
|
||
| lifecycle.endSession() | ||
| precondition(!lifecycle.isCurrent(replacementTimer)) | ||
| } | ||
| } |
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,35 @@ | ||
| import os | ||
| import pathlib | ||
| import subprocess | ||
| import tempfile | ||
| import unittest | ||
|
|
||
|
|
||
| ROOT = pathlib.Path(__file__).resolve().parents[1] | ||
|
|
||
|
|
||
| class TimerLifecycleTests(unittest.TestCase): | ||
| def test_replacement_session_invalidates_delayed_cleanup_token(self): | ||
| with tempfile.TemporaryDirectory() as temporary_directory: | ||
| temporary_path = pathlib.Path(temporary_directory) | ||
| executable = temporary_path / "timer-lifecycle-regression" | ||
| environment = os.environ.copy() | ||
| environment["CLANG_MODULE_CACHE_PATH"] = str(temporary_path / "module-cache") | ||
| environment["SWIFT_MODULECACHE_PATH"] = str(temporary_path / "module-cache") | ||
| subprocess.run( | ||
| [ | ||
| "swiftc", | ||
| str(ROOT / "DynamicIsland/managers/TimerLifecycle.swift"), | ||
| str(ROOT / "tests/TimerLifecycleRegression.swift"), | ||
| "-o", | ||
| str(executable), | ||
| ], | ||
| check=True, | ||
| cwd=ROOT, | ||
| env=environment, | ||
| ) | ||
| subprocess.run([str(executable)], check=True, cwd=ROOT) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| unittest.main() |
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.