Repository navigation
feat(zones)!: remove callback pending tasks right after the callback - #3837
Conversation
A wrapped callback read (onSnapshot, onAuthStateChanged, onValue and the other callback-taking functions wrapped with a pending task) removed Angular's pending task through setTimeout(taskDone, 0), so the task outlived the first callback by one setTimeout(fn, 0) delay, and the same on unsubscribe, next to a 2021 TODO asking for a microtask instead. The task is now removed right after the callback body and right after the unsubscribe call, the same way Angular's own pendingUntilEvent removes its task, inside a finally so a callback that throws does not leave its task behind. The task now goes away before any setTimeout(fn, 0) callback registered when the callback was delivered, and a zone.js server render reports stable about a millisecond sooner after a single callback read's first value. BREAKING CHANGE: a callback read's pending task is removed right after its first callback runs, and right after unsubscribe, instead of one setTimeout(fn, 0) delay later. whenStable() and server rendering can resolve up to that much sooner after the first value. Angular's own change-detection tick still runs on a timer, so a test that advances fake timers before awaiting whenStable() still needs the advance.
angular#3837 removes a callback read's pending task right after the callback instead of one setTimeout(fn, 0) delay later. As a breaking change it needs a section in the upgrade guide: what moves sooner, and which tests notice. Refs angular#3836
tyler-reitz
left a comment
There was a problem hiding this comment.
Requesting changes for one spec.
The unsubscribe spec passes even when the task is never released. Deleting taskDone() from the unsubscribe finally and rebuilding leaves karma at 142/142, because the 500ms fallback in observeRelease() resolves to the same all-false value that spec expects. The other three assert afterCallbackBody: true, which the fallback can't produce. Having the remover resolve with released: true and the fallback with released: false would separate the two.
Non-blocking: this conflicts with #3829 in src/zones.ts and src/zones.spec.ts. When resolving, I'd put #3829's injector.destroyed early return inside the new try, so a handler that runs after teardown still releases its task.
Otherwise checked: all four new specs fail against main's zones.ts, and the branch builds with no generated-file drift and passes 142/142 locally.
…rotask angular#3829's destroyed-injector early return now sits inside the try, so the finally removes the pending task on that path too. The argument loop is main's, without the TODO this branch deleted. angular#3829's spec comment about a 0 ms timer now gives the reason the per-spec counter still holds. # Conflicts: # src/zones.spec.ts # src/zones.ts
The unsubscribe spec expected all four recorded fields false, which is what the 500 ms fallback records when the remover is never called, so it passed with the unsubscribe removal deleted. Each result now carries released, true from the remover and false from the fallback. A new spec removes the task for a handler that fires after its child environment injector is destroyed. It fails if the destroyed-injector early return is moved outside the try.
|
Thanks for catching that, @tyler-reitz. Both points are in. Unsubscribe spec
Merge with #3829
|
* docs: say which wrapped calls do not hold the app unstable docs/zones.md says callback APIs hold the app unstable until an initial value, so a server render waits for data. #3827 makes a set of calls exceptions because their first callback may never come. Waiting on a callback that never comes would keep the app from ever becoming stable. List those calls in docs/zones.md, and point at onValue, object, list, listVal and fromRef with the value event as the calls that still make a server render wait. In docs/database.md, say the same under stateChanges, auditTrail and fromRef. Refs #3826 * docs: describe firebase 13 support in the v22 upgrade guide #3831 lets AngularFire 22 accept firebase 12 or 13, and the ng update migration now writes the range of the firebase major already installed. The upgrade guide still said the migration writes ^12.18.0 and quoted peer warnings that name only that range. State the supported range and what the migration writes, update the Yarn 1 and pnpm 9/10 warnings to their current wording, and add a section on moving to firebase 13: VertexAIBackend is removed and its packages declare Node 24.12 or later. Refs #3830 * docs: describe microtask delivery in the v22 upgrade guide #3833 moves every Observable read from a setInterval timer to the next microtask checkpoint. As a breaking change it needs a section in the upgrade guide: which tests now see a value they used to wait for, the setTimeout ordering flip, and the zoneless server render case for hand-written TransferState entries. Refs #3832 * docs: describe the callback pending-task change in the v22 upgrade guide #3837 removes a callback read's pending task right after the callback instead of one setTimeout(fn, 0) delay later. As a breaking change it needs a section in the upgrade guide: what moves sooner, and which tests notice. Refs #3836 * docs: say a handler passed as an observer object is wrapped too #3829 wraps a handler passed as an observer object, such as { next, error }, the way it wraps a function, so the injection context reaches both forms. Refs #3828 * docs(compat): add a setup section in NgModule and standalone form The compat API's setup steps left docs/install-and-setup.md when #3236 rewrote it for the modular API, and nothing replaced them. docs/compat.md had no setup at all, the Realtime Database pages pointed at an "Installation guide" that no longer covered compat, and no page showed the standalone form. A standalone app with only the modular providers then fails its first compat injection with NG0201 for angularfire2.app.options (#3683). The new section on docs/compat.md gives both forms, says when the modular providers may stay, states the error the missing module produces, and lists the compat module of each product. The twelve compat pages that had an NgModule-only snippet or no setup at all now point at it. Fixes #3683 * docs: say which package managers refuse an incompatible firebase The v22 upgrade guide said an incompatible firebase is refused at install time. Only npm refuses it, and only when package.json requests the incompatible version. Yarn and pnpm install it with a warning. * docs: say which Firestore functions are not zone wrapped #3842 re-exports Firestore's query and reference builders, field values, comparators and setLogLevel without the zone wrapper. In docs/zones.md, add a paragraph listing them, change the switchMap example to a read, since building the query no longer warns, and say the Verbose log level covers only wrapped calls. Refs #3842 * docs(auth): build the server app with initializeBrowserOrServerApp The server-rendering guide's step 4 becomes the one call, the five details become three, the App Check token gets a relay section, the response gets a Cache-Control header, and the manual callback stays in a "Building the app yourself" section that step 4 points at, for apps that prefer it or whose AngularFire version has no such function. The release modes say what a throwing ngOnDestroy does to a timed release. * docs(auth): describe the sample as an example of the one-call server app The sample app now has one provideFirebaseApp with initializeBrowserOrServerApp in its shared app.config.ts (#3845), so the sentence about its split client and server files no longer holds. Refs #3843 * docs: say how to move from 22.0.0-rc.0 in the v22 upgrade guide The guide covered upgrades from 21, a 21 release candidate and a 22 canary build, but not from the first 22 release candidate. ng add saves a prerelease as an exact version, so an app on 22.0.0-rc.0 stays there until ng update @angular/fire@next moves it. That command also runs migration-v22 again, which reports "No changes made" for a firebase entry already inside the supported range. Refs #3834 * docs(auth): say which hooks stop a releaseAfterRender release The caveat on releaseAfterRender said a throwing ngOnDestroy "stops that teardown". It now says the release is a DestroyRef.onDestroy callback, that Angular runs it after every service's and component's ngOnDestroy, and that an ngOnDestroy method or an ApplicationRef.onDestroy listener that throws keeps it from running. The default release, which does not run during the injector's destroy, is unaffected either way. A new paragraph says to call initializeBrowserOrServerApp in app.config.ts rather than a route's providers: a route's child injector is not destroyed with the request, so a release registered there never runs. Refs #3844 * docs(auth): say the default release still happens from a route's providers Tyler asked on #3844 whether the default release, now tied to a root service, releases a server app built in a lazy route's providers. It does: the request's root injector is destroyed, the route's child injector is not, so only a releaseAfterRender release registered there is lost. Checked with a child environment injector that is never destroyed, in both modes. Refs #3844 * docs: add onConfigUpdate to the calls that do not hold the app unstable #3829 set onConfigUpdate to blockUntilFirst: false in tools/build.ts, because its observer runs only when a fetched template differs from the active one. The list in docs/zones.md left it out. Found in the #3835 review. Refs #3829 * docs(auth): say a second provideFirebaseApp can render signed out The bullet said a second registration makes a signed-in render fail on a freshly started server. With more than one registration, FirebaseApp resolves to the default app. Run on fresh servers, a second plain initializeApp(config) registration creates that app on the first request, so signed-in pages render signed out with no error. Only when no registration creates the default app, as with two initializeBrowserOrServerApp registrations, does the render fail, and only until a signed-out request creates it. Found in the #3835 review. Refs #3844
Checklist
setTimeout(fn, 0)later #3836yarn install,yarn testrun successfully? yes, asnpm ciandnpm testDescription
Removes the pending task a callback-taking wrapper registers in a
finallyright after the callback body, and right after the unsubscribe call, instead of throughsetTimeout(taskDone, 0)insrc/zones.ts. Deletes the 2021 TODO next to the wrapping call that asked for this.finallyruns whether the callback returns or throws, so a throwing callback does not leave its task behind, which the timer also guaranteed.pendingUntilEventworks: it forwards the value and then removes its task synchronously.What this grants, measured on Angular 22.2 zone.js and zoneless apps, before and after:
setTimeout(fn, 0)callback registered at delivery, in every run: a synthetic callback in Chrome and Firefox, the unsubscribe path, and the realonSnapshotagainst the Firestore emulator. With Realtime Database on cached data, where the SDK invokes the callback inside the registering call, the task is removed inside that call.What does not change:
whenStable()resolves under fake timers. Angular's change-detection tick is itself a timer, so a test that advances fake timers before awaitingwhenStable()still needs the advance, before and after.What upgrading apps may notice:
whenStable()and server rendering follow a callback read's first value onesetTimeout(fn, 0)delay sooner.Verification:
src/zones.spec.ts, each observing the remover functionPendingTasks.add()returns. All four fail onmainand pass here:setTimeout(fn, 0)callback registered just before deliverynpm run lint,npm run test:node,npm run test:chrome-headlessandnpm run test:firefox-headlesspass on the branch.