Skip to content

fix(zone.js): add __Zone_ignore_on_properties to ZoneGlobalConfigurations #50737

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.

Sign up for GitHub

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

Closed
arturovt wants to merge 1 commit into from
Closed

fix(zone.js): add __Zone_ignore_on_properties to ZoneGlobalConfigurations #50737

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions packages/zone.js/lib/zone.configurations.api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,48 @@ declare global {
*/
__zone_symbol__UNPATCHED_EVENTS?: string[];

/**
* Define a list of `on` properties to be ignored when being monkey patched by the `zone.js`.
*
* By default, `zone.js` monkey patches `on` properties on inbuilt browser classes as
* `WebSocket`, `XMLHttpRequest`, `Worker`, `HTMLElement` and others (see `patchTargets` in
* `propertyDescriptorPatch`). `on` properties may be `WebSocket.prototype.onclose`,
* `XMLHttpRequest.prototype.onload`, etc.
*
* Sometimes, we're not able to customise third-party libraries, which setup `on` listeners.
* Given a library creates a `Websocket` and sets `socket.onmessage`, this will impact
* performance if the `onmessage` property is set within the Angular zone, because this will
* trigger change detection on any message coming through the socket. We can exclude specific
* targets and their `on` properties from being patched by zone.js.
*
* Users can achieve this by defining `__Zone_ignore_on_properties`, it expects an array of
* objects where `target` is the actual object `on` properties will be set on:
* ```
* __Zone_ignore_on_properties = [
* {
* target: WebSocket.prototype,
* ignoreProperties: ['message', 'close', 'open']
* }
* ];
* ```
*
* In order to check whether `on` properties have been successfully ignored or not, it's enough
* to open the console in the browser, run `WebSocket.prototype` and expand the object, we
* should see the following:
* ```
* {
* __zone_symbol__ononclosepatched: true,
* __zone_symbol__ononerrorpatched: true,
* __zone_symbol__ononmessagepatched: true,
* __zone_symbol__ononopenpatched: true
* }
* ```
* These `__zone_symbol__*` properties are set by zone.js when `on` properties have been patched
* previously. When `__Zone_ignore_on_properties` is setup, we should not see those properties
* on targets.
*/
__Zone_ignore_on_properties?: {target: any; ignoreProperties: string[];}[];

/**
* Define the event names of the passive listeners.
*
Expand Down