Skip to content

Commit

Permalink
zone log verbosity (#3613)
Browse files Browse the repository at this point in the history
* Bunch of stuff
* Bump firebase
* Cleanup
  • Loading branch information
jamesdaniels authored Jan 16, 2025
1 parent 8ce95bf commit 35e0a98
Show file tree
Hide file tree
Showing 31 changed files with 771 additions and 682 deletions.
22 changes: 20 additions & 2 deletions docs/zones.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,26 @@ Observables, Promise-based APIs, and those with callbacks will purposely destabi

When using a Firebase or RxFire API without importing from AngularFire or if AngularFire APIs are used outside of an injection context you _may_ experience instability.

instability can be difficult to track down ([see Resolving zone pollution in the Angular docs](https://angular.dev/best-practices/zone-pollution)). To help with debugging, AngularFire emits warnings when it is unable to Zone wrap an API while in dev-mode. **Often these messages can be safely ignored** but we'd rather be verbose.

When an application is unstable change-detection, two-way binding, and rehydration may not work as expected—leading to both subtle and non-subtle bugs in your application. Further, server-side rendering (SSR) and static site generation (SSG/pre-rendering) may timeout or render a blank page.

There are a number of situations where AngularFire's Zone wrapping is inconsequential such adding/deleting/updating a document in response to user-input, signing a user in, calling a Cloud Function, etc. So long as no long-lived side-effects are kicked off, your application should be ok. Most Promise based APIs are fairly safe without zone wrapping.

## Logging

You may see a log warning, `Calling Firebase APIs outside of an Injection context may destabilize your application leading to subtle change-detection and hydration bugs. Find more at https://github.com/angular/angularfire/blob/main/docs/zones.md` when developing your application.

Instability can be difficult to track down. To help with debugging, AngularFire emits warnings when it is unable to Zone wrap an API while in dev-mode. **Often these messages can be safely ignored** but we'd rather be verbose.

There are three logging levels in AngularFire:

* **Silent**: when the logging level is set to silent only the above banner is displayed when AngularFire APIs are called outside of an injection context, this is the default when using Zoneless change-detection.
* **Warn**: when the logging level is set to warn, only blocking reads, long-lived tasks, and APIs with high risk of destabilizing your application are called, this is the default when using ZoneJS.
* **Verbose**: when the logging level is set to verbose, all AngularFire APIs called outside of an injection context are logged—helping you track down APIs that may be destabilizing your application

You can change the log-level like so:

```ts
import { setLogLevel, LogLevel } from "@angular/fire";

setLogLevel(LogLevel.VERBOSE);
```
403 changes: 202 additions & 201 deletions package-lock.json

Large diffs are not rendered by default.

6 changes: 1 addition & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"@angular/router": "^19.0.0",
"@schematics/angular": "^19.0.0",
"esbuild": "^0.24.0",
"firebase": "^11.0.0",
"firebase": "^11.2.0",
"firebase-functions": "^6.1.0",
"fs-extra": "^8.0.1",
"fuzzy": "^0.1.3",
Expand Down Expand Up @@ -118,9 +118,5 @@
"tslint": "~6.1.0",
"typescript": ">=5.5 <5.7"
},
"overrides": {
"@angular/compiler-cli": "^19.0.0",
"firebase": "^11.0.0"
},
"typings": "index.d.ts"
}
Loading

0 comments on commit 35e0a98

Please sign in to comment.