docs: fix #19989, add zone flags(blacklist/module) in guide #21701

JiaLiPassion · 2018-01-22T16:49:06Z

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] angular.io application / infrastructure changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: #19989

What is the new behavior?

add document for zone.js flags.

// __Zone_disable_requestAnimationFrame = true; // disable patch requestAnimationFrame
// __Zone_disable_blocking = true; // disable patch (alert/prompt/confirm)
// __Zone_disable_XHR = true; // disable patch XMLHttpRequest
// __Zone_disable_geolocation = true; // disable patch geolocation
// __Zone_disable_PromiseRejectionEvent = true; // disable trigger promise rejection event
// __zone_symbol__BLACK_LISTED_EVENTS = ['scroll', 'mousemove']; // disable patch specified eventNames

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

mary-poppins · 2018-01-22T20:41:59Z

You can preview f7afee2 at https://pr21701-f7afee2.ngbuilds.io/.

IgorMinar

I asked @mhevery to review the other recommendations

IgorMinar · 2018-01-22T23:25:59Z

aio/content/guide/browser-support.md

@@ -610,16 +610,23 @@ computed with the <a href="http://closure-compiler.appspot.com/home">closure com
 {@a non-cli}
 ## Polyfills for non-CLI users

-If you aren't using the CLI, you should add your polyfill scripts directly to the host web page (`index.html`), perhaps like this.
+If you aren't using the CLI, you should add your polyfill scripts directly to the host web page (`index.html`), perhaps like this. Before loading zone.js, you can also configure some flags which can disable zone interception for some asynchronous activities to improve performance. 


this reads kind of poorly. could you move this sentence into a comment that would be part of the snippet below?

@IgorMinar , got it, I will move it.

mary-poppins · 2018-01-23T00:14:07Z

You can preview 71fa7f4 at https://pr21701-71fa7f4.ngbuilds.io/.

IgorMinar · 2018-01-23T00:16:54Z

aio/content/guide/browser-support.md

+  &lt;script>
+    /**
+     * you can configure some zone flags which can disable zone interception for some
+     * asynchronous activities to improve performance.


... improve startup performance - use these options only if you know what you are doing as it could result in hard to trace down bugs.

@IgorMinar , got it, I will update it, thank you.

IgorMinar · 2018-01-23T00:19:32Z

aio/content/guide/browser-support.md

+    // __Zone_disable_XHR = true; // disable patch XMLHttpRequest
+    // __Zone_disable_geolocation = true; // disable patch geolocation
+    // __Zone_disable_PromiseRejectionEvent = true; // disable trigger promise rejection event
+    // __zone_symbol__BLACK_LISTED_EVENTS = ['scroll', 'mousemove']; // disable patch specified eventNames


I talked to @mhevery and we think that reducing the list only to "on" events, request animation frame, and BLACK_LISTED_EVENTS would be generally more useful. the other settings don't make a big difference in practice.

@IgorMinar , got it, I will update it.

mary-poppins · 2018-01-23T00:36:41Z

You can preview 6ce315c at https://pr21701-6ce315c.ngbuilds.io/.

IgorMinar · 2018-01-23T00:50:03Z

thanks!!

PR Close #21701

…ngular#21701) PR Close angular#21701

angular-automatic-lock-bot · 2019-09-13T05:22:11Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

googlebot added the cla: yes label Jan 22, 2018

mhevery added the aio: preview label Jan 22, 2018

mhevery requested review from mhevery and IgorMinar January 22, 2018 20:42

mhevery added the comp: aio label Jan 22, 2018

gkalpak added comp: docs and removed comp: aio labels Jan 22, 2018

IgorMinar suggested changes Jan 22, 2018

View reviewed changes

mhevery assigned mhevery and IgorMinar Jan 22, 2018

JiaLiPassion force-pushed the blacklistevent branch from f7afee2 to 71fa7f4 Compare January 23, 2018 00:06

IgorMinar reviewed Jan 23, 2018

View reviewed changes

docs: fix angular#19989, add zone flags(blacklist/module) in guide

6ce315c

JiaLiPassion force-pushed the blacklistevent branch from 71fa7f4 to 6ce315c Compare January 23, 2018 00:27

JiaLiPassion mentioned this pull request Jan 23, 2018

feat(@schematics/angular): add zone.js flags which can disable some patch angular/devkit#401

Merged

IgorMinar approved these changes Jan 23, 2018

View reviewed changes

IgorMinar added action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release labels Jan 23, 2018

mhevery pushed a commit that referenced this pull request Jan 23, 2018

docs: fix #19989, add zone flags(blacklist/module) in guide (#21701)

eecdf34

PR Close #21701

mhevery closed this in e82812b Jan 23, 2018

jbogarthyde pushed a commit to jbogarthyde/angular that referenced this pull request Feb 23, 2018

docs: fix angular#19989, add zone flags(blacklist/module) in guide (a…

493e9dc

…ngular#21701) PR Close angular#21701

leo6104 pushed a commit to leo6104/angular that referenced this pull request Mar 25, 2018

docs: fix angular#19989, add zone flags(blacklist/module) in guide (a…

f4ed8f4

…ngular#21701) PR Close angular#21701

angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 13, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: fix #19989, add zone flags(blacklist/module) in guide #21701

docs: fix #19989, add zone flags(blacklist/module) in guide #21701

JiaLiPassion commented Jan 22, 2018

mary-poppins commented Jan 22, 2018

IgorMinar left a comment

IgorMinar Jan 22, 2018

JiaLiPassion Jan 23, 2018

mary-poppins commented Jan 23, 2018

IgorMinar Jan 23, 2018

JiaLiPassion Jan 23, 2018

IgorMinar Jan 23, 2018

JiaLiPassion Jan 23, 2018

mary-poppins commented Jan 23, 2018

IgorMinar commented Jan 23, 2018

angular-automatic-lock-bot bot commented Sep 13, 2019

docs: fix #19989, add zone flags(blacklist/module) in guide #21701

docs: fix #19989, add zone flags(blacklist/module) in guide #21701

Conversation

JiaLiPassion commented Jan 22, 2018

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

mary-poppins commented Jan 22, 2018

IgorMinar left a comment

Choose a reason for hiding this comment

IgorMinar Jan 22, 2018

Choose a reason for hiding this comment

JiaLiPassion Jan 23, 2018

Choose a reason for hiding this comment

mary-poppins commented Jan 23, 2018

IgorMinar Jan 23, 2018

Choose a reason for hiding this comment

JiaLiPassion Jan 23, 2018

Choose a reason for hiding this comment

IgorMinar Jan 23, 2018

Choose a reason for hiding this comment

JiaLiPassion Jan 23, 2018

Choose a reason for hiding this comment

mary-poppins commented Jan 23, 2018

IgorMinar commented Jan 23, 2018

angular-automatic-lock-bot bot commented Sep 13, 2019