Make zone handlers call zone.run to run callbacks. #2451
Merged
Conversation
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
The platform library `Zone` implementation will change to not use `bindCallbackGuarded` in the `Timer` constructors and top-level `scheduleMicrotask` function. Instead it only calls `registerCallback`, and then the `Zone.create{,Periodic}Timer` and `Zone.scheduleMicrotask` are in charge of using `Zone.runGuarded` on the callback when timer/microtask event happens. This ensures that a surrounding zone's `registerCallback` can't make the callback throw in a way that is outside of the `runGuarded` call. 
PR HealthChangelog Entry ✔️
Changes to files need to be accounted for in their respective changelogs. |
lrhn commented Jan 24, 2025
| the callback of a periodic timer would immediately invoke | ||
| the same timer. | ||
| * Move to `dart-lang/test` monorepo. | ||
| * Require Dart 3.5. |
There was a problem hiding this comment.
Didn't actually change pubspec.yaml.
(Only one of the first and last line here is correct and needed.)
lrhn commented Jan 24, 2025
| throw StateError('Exceeded timeout $timeout while flushing timers'); | ||
| } | ||
| | ||
| if (flushPeriodicTimers) return _timers.isNotEmpty; |
There was a problem hiding this comment.
The list is never empty here, it always contains at least timer, which is never removed until it is _fired.
lrhn commented Jan 24, 2025
| // (and advancing time to their next due time) | ||
| // if flushing periodic timers, | ||
| // or if there is any non-periodic timer left. | ||
| return flushPeriodicTimers || _timers.any((timer) => !timer.isPeriodic); |
There was a problem hiding this comment.
This function should just check whether to run the current timer, which it should unless it's not due, we're not flushing periodic timers, and all remaining timers (including this one) are periodic timers.
lrhn commented Jan 24, 2025
| ..run((_) { | ||
| // Do not use [neverCalled] from package:test. | ||
| // It schedules timers to "pump the event loop", | ||
| // which stalls the test if you don't call `elapse` or `flushTimers`. |
There was a problem hiding this comment.
I tried, it did not go well.
lrhn commented Jan 24, 2025
| | ||
| group('elapseBlocking', () { | ||
| test('should elapse time without calling timers', () { | ||
| Timer(elapseBy ~/ 2, neverCalled); |
There was a problem hiding this comment.
This timer is created outside of a FakeAsync, to run in 12 hours.
Lucky that the test runner kills the process when all tests are successfully completed..
natebosch approved these changes Jan 25, 2025
copybara-service bot pushed a commit to dart-lang/sdk that referenced this pull request Jan 27, 2025
Revisions updated by `dart tools/rev_sdk_deps.dart`. core (https://github.com/dart-lang/core/compare/72a2060..3b35aca): 3b35aca9 2025-01-24 Devon Carew update the topics section of several pubspecs (dart-lang/core#854) ecosystem (https://github.com/dart-lang/ecosystem/compare/682c8ef..c4a163a): c4a163a 2025-01-23 Devon Carew print detailed info about the leaked APIs to stdout in the workflow (dart-lang/ecosystem#339) test (https://github.com/dart-lang/test/compare/7fc9521..92eed6c): 92eed6c4 2025-01-27 Lasse R.H. Nielsen Make zone handlers call zone.run to run callbacks. (dart-lang/test#2451) ad04f172 2025-01-24 Devon Carew add a pull request labeler; add issue tracker links; update codeowners file (dart-lang/test#2452) 1f292db8 2025-01-24 Lasse R.H. Nielsen Don't require Dart 3.5. a56fa947 2025-01-24 Lasse R.H. Nielsen Accept extra `run`s in test. Move to Dart 3.5. 4bd54972 2025-01-24 Lasse R.H. Nielsen Clean-up. Accidentally merged a removed lint back in. 9fa57d16 2025-01-24 Lasse R.H. Nielsen Make zone handlers call zone.run to run callbacks. webdev (https://github.com/dart-lang/webdev/compare/9430dd7..5dc7950): 5dc79508 2025-01-24 Jessy Yameogo Added support for callLibraryMethod with the DDC library bundle format. (dart-lang/webdev#2577) 1d0b32c2 2025-01-24 Srujan Gaddam Reset DWDS to 24.3.4-wip (dart-lang/webdev#2580) 1990d29a 2025-01-23 Srujan Gaddam Implement hot restart for DDC library bundle format and publish 24.3.3 (dart-lang/webdev#2576) Change-Id: Ifa23e74a1399ac7ec70a99750419b915a2efbb19 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/406120 Reviewed-by: Konstantin Shcheglov <scheglov@google.com> Commit-Queue: Konstantin Shcheglov <scheglov@google.com> Auto-Submit: Devon Carew <devoncarew@google.com>
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.
The platform library
Zoneimplementation will change to not usebindCallbackGuardedin theTimerconstructors and top-levelscheduleMicrotaskfunction.Instead it only calls
registerCallback, and then theZone.create{,Periodic}TimerandZone.scheduleMicrotaskare in charge of usingZone.runGuardedon the callback when timer/microtask event happens.This ensures that a surrounding zone's
registerCallbackcan't make the callback throw in a way that is outside of therunGuardedcall.Also makes periodic timers that are delayed past multiple tick points, update their
tickcount by more than one instead of running multiple times, like timers should.Adds testing of using the
FakeAsync'sZonefunctions directly, and embedding it in another zone to check that it does run usingZone.run.Adds testing of periodic timers incrementing
tickby more than one.