fix(core): check global ngDevMode is defined before checking value #32079

filipesilva · 2019-08-09T15:05:46Z

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
Documentation content changes
angular.io application / infrastructure changes
Other... Please describe:

What is the current behavior?

Fix #31595

What is the new behavior?

ngDevMode is defined without being a toplevel side effect.

Does this PR introduce a breaking change?

Yes
No

Other information

filipesilva · 2019-08-09T15:07:04Z

Note for reviewers: the main changes are in packages/core/src/util/ng_dev_mode.ts.

petebacondarwin

LGTM for ngcc

petebacondarwin · 2019-08-09T15:08:07Z

packages/core/src/di/injector_compatibility.ts

-      // TODO(misko): uncomment the next line once `ngDevMode` works with closure.
-      // if(ngDevMode) debugger;
+      // TODO(misko): uncomment the next line once `getNgDevMode()` works with closure.
+      // if(getNgDevMode()) debugger;


Will getNgDevMode() work with closure?

No idea. It seemed to not work with ngDevMode either.

petebacondarwin · 2019-08-09T15:10:17Z

packages/core/src/util/empty.ts

@@ -18,8 +18,8 @@ export const EMPTY_OBJ: {} = {};
 export const EMPTY_ARRAY: any[] = [];

 // freezing the values prevents any code from accidentally inserting new values in
-if (typeof ngDevMode !== 'undefined' && ngDevMode) {
-  // These property accesses can be ignored because ngDevMode will be set to false
+if (typeof getNgDevMode() !== 'undefined' && getNgDevMode()) {


Is the typeof getNgDevMode() !== 'undefined' needed still?

No, I think not. Nice catch!

mary-poppins · 2019-08-09T15:17:04Z

You can preview 35534b5 at https://pr32079-35534b5.ngbuilds.io/.

mary-poppins · 2019-08-09T15:26:59Z

You can preview a15e75a at https://pr32079-a15e75a.ngbuilds.io/.

filipesilva · 2019-08-09T16:12:50Z

Blocked on rollup/rollup#3044, this syntax change is causing the side effect test and golden symbol tests to erroneously retain code.

mary-poppins · 2019-08-09T16:54:14Z

You can preview 8f4ef0d at https://pr32079-8f4ef0d.ngbuilds.io/.

mhevery · 2019-08-12T16:27:04Z

packages/compiler-cli/ngcc/test/host/esm2015_host_spec.ts

@@ -479,7 +479,7 @@ runInEachFileSystem(() => {
    }

    function compileNgModuleFactory__POST_R3__(injector, options, moduleType) {
-      ngDevMode && assertNgModuleType(moduleType);
+      getNgDevMode() && assertNgModuleType(moduleType);


sorry for the nit pick, but I would prefer isNgDevMode()

mhevery · 2019-08-12T16:27:28Z

packages/core/src/di/injector_compatibility.ts

-      // TODO(misko): uncomment the next line once `ngDevMode` works with closure.
-      // if(ngDevMode) debugger;
+      // TODO(misko): uncomment the next line once `getNgDevMode()` works with closure.
+      // if(getNgDevMode()) debugger;


mhevery · 2019-08-12T16:27:44Z

packages/core/src/di/r3_injector.ts

 import {OnDestroy} from '../interface/lifecycle_hooks';
 import {Type} from '../interface/type';
 import {throwCyclicDependencyError, throwInvalidProviderError, throwMixedMultiProviderError} from '../render3/errors';
 import {deepForEach} from '../util/array_utils';
+import {getNgDevMode} from '../util/ng_dev_mode';


love the explicit import!

mhevery · 2019-08-12T16:35:32Z

packages/core/src/util/ng_dev_mode.ts

 * as much early warning and errors as possible.
 *
 * NOTE: changes to the `ngDevMode` name must be synced with `compiler-cli/src/tooling.ts`.
 */
-if (typeof ngDevMode === 'undefined' || ngDevMode) {
-  ngDevModeResetPerfCounters();
+export function getNgDevMode() {


What if the getNgDevMode instead of being a function would be a constant such as:

export const isNgDevMode = (typeof ngDevMode === 'undefined' || ngDevMode) && ngDevModeResetPerfCounters();

This way it should still be:

explicit import

should be tree shakable

does not need function in-lining, so it should have better warmup characteristics.

I think that would work, and be a nicer approach overall.

I don't think this would work. Imagine a case where ngDevMode is imported across chunks. In such a case the optimizer would not be able to tree shake this statements.

mary-poppins · 2019-08-12T18:51:33Z

You can preview 4a450a5 at https://pr32079-4a450a5.ngbuilds.io/.

filipesilva · 2019-08-12T19:46:20Z

packages/core/src/util/ng_dev_mode_perf_counters.ts

+ * found in the LICENSE file at https://angular.io/license
+ */
+
+export interface NgDevModePerfCounters {


Moved the interface to avoid a circular dependency (ng_dev_mode.ts -> captured_globals.ts -> ng_dev_mode.ts).

filipesilva · 2019-08-12T19:47:57Z

packages/core/src/util/captured_globals.ts

@@ -0,0 +1,26 @@
+


This file should also capture ngI18nClosureMode and localize in the future, providing similar usage patterns as ngDevMode in this PR.

mary-poppins · 2019-08-12T19:50:10Z

You can preview 1d42191 at https://pr32079-1d42191.ngbuilds.io/.

mary-poppins · 2019-08-12T19:56:13Z

You can preview 8093353 at https://pr32079-8093353.ngbuilds.io/.

googlebot · 2019-09-11T16:27:47Z

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

ℹ️ Googlers: Go here for more info.

AndrewKushnir · 2019-09-11T16:30:29Z

One more presubmit, to make sure g3 checks are "green":

Fix angular#31595

…ffects

googlebot · 2019-09-11T17:26:45Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

mary-poppins · 2019-09-11T17:34:23Z

You can preview 3597281 at https://pr32079-3597281.ngbuilds.io/.

googlebot · 2019-09-11T17:34:25Z

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

ℹ️ Googlers: Go here for more info.

AndrewKushnir · 2019-09-11T17:35:10Z

FYI, most recent VE and Ivy presubmits are successful.

kara

LGTM

kara · 2019-09-11T17:46:45Z

merge-assistance: global approval

matsko · 2019-09-12T00:30:20Z

@filipesilva this fails on patch.

…ngular#32079) Fix angular#31595 PR Close angular#32079

angular-automatic-lock-bot · 2019-10-13T16:05:52Z

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.}

filipesilva added the target: major This PR is targeted for the next major release label Aug 9, 2019

filipesilva requested review from mhevery, IgorMinar and clydin August 9, 2019 15:05

filipesilva requested review from a team as code owners August 9, 2019 15:05

googlebot added the cla: yes label Aug 9, 2019

filipesilva added target: patch This PR is targeted for the next patch release and removed target: major This PR is targeted for the next major release labels Aug 9, 2019

filipesilva mentioned this pull request Aug 9, 2019

ReferenceError: ngDevMode is not defined #31595

Closed

petebacondarwin approved these changes Aug 9, 2019

View reviewed changes

filipesilva force-pushed the ngdevmode-side-effects branch 2 times, most recently from 1d9bb3f to a15e75a Compare August 9, 2019 15:19

filipesilva force-pushed the ngdevmode-side-effects branch from a15e75a to 8f4ef0d Compare August 9, 2019 16:45

mhevery reviewed Aug 12, 2019

View reviewed changes

filipesilva force-pushed the ngdevmode-side-effects branch from 8f4ef0d to 4a450a5 Compare August 12, 2019 18:41

filipesilva force-pushed the ngdevmode-side-effects branch from 4a450a5 to 1d42191 Compare August 12, 2019 19:44

filipesilva commented Aug 12, 2019

View reviewed changes

filipesilva force-pushed the ngdevmode-side-effects branch 2 times, most recently from 8093353 to 0c2d747 Compare August 12, 2019 19:53

AndrewKushnir added cla: yes and removed cla: no labels Sep 11, 2019

filipesilva and others added 5 commits September 11, 2019 19:26

fix(core): initialize global ngDevMode without toplevel side effects

4e8d54c

Fix angular#31595

fixup! fix(core): initialize global ngDevMode without toplevel side e…

b86b306

…ffects

fixup! fix(core): initialize global ngDevMode without toplevel side e…

53ee0b1

…ffects

fixup! fix(core): initialize global ngDevMode without toplevel side e…

17984cf

…ffects

fixup! fix(core): initialize global ngDevMode without toplevel side e…

3597281

…ffects

alan-agius4 force-pushed the ngdevmode-side-effects branch from d4fedc2 to 3597281 Compare September 11, 2019 17:26

googlebot added cla: no and removed cla: yes labels Sep 11, 2019

AndrewKushnir added cla: yes and removed cla: no labels Sep 11, 2019

kara approved these changes Sep 11, 2019

View reviewed changes

kara unassigned alan-agius4 Sep 11, 2019

kara added the merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note label Sep 11, 2019

matsko added target: major This PR is targeted for the next major release and removed target: patch This PR is targeted for the next patch release labels Sep 12, 2019

matsko closed this in 5f095a5 Sep 12, 2019

alan-agius4 mentioned this pull request Sep 19, 2019

fix(ivy): ensure that window.ng utilities are published when NgModules are used #32725

Closed

arnehoek pushed a commit to arnehoek/angular that referenced this pull request Sep 26, 2019

fix(core): initialize global ngDevMode without toplevel side effects (a…

da2114e

…ngular#32079) Fix angular#31595 PR Close angular#32079

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(core): check global ngDevMode is defined before checking value #32079

fix(core): check global ngDevMode is defined before checking value #32079

filipesilva commented Aug 9, 2019 •

edited

filipesilva commented Aug 9, 2019

petebacondarwin left a comment

petebacondarwin Aug 9, 2019

filipesilva Aug 9, 2019

mhevery Aug 12, 2019

petebacondarwin Aug 9, 2019

filipesilva Aug 9, 2019

mary-poppins commented Aug 9, 2019

mary-poppins commented Aug 9, 2019

filipesilva commented Aug 9, 2019 •

edited

mary-poppins commented Aug 9, 2019

mhevery Aug 12, 2019

mhevery Aug 12, 2019

mhevery Aug 12, 2019

mhevery Aug 12, 2019

filipesilva Aug 12, 2019

mhevery Aug 28, 2019

mary-poppins commented Aug 12, 2019

filipesilva Aug 12, 2019

filipesilva Aug 12, 2019

mhevery Aug 12, 2019

mary-poppins commented Aug 12, 2019

mary-poppins commented Aug 12, 2019

googlebot commented Sep 11, 2019

AndrewKushnir commented Sep 11, 2019

googlebot commented Sep 11, 2019

mary-poppins commented Sep 11, 2019

googlebot commented Sep 11, 2019

AndrewKushnir commented Sep 11, 2019

kara left a comment

kara commented Sep 11, 2019

matsko commented Sep 12, 2019

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

fix(core): check global ngDevMode is defined before checking value #32079

fix(core): check global ngDevMode is defined before checking value #32079

Conversation

filipesilva commented Aug 9, 2019 • edited

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

filipesilva commented Aug 9, 2019

petebacondarwin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mary-poppins commented Aug 9, 2019

mary-poppins commented Aug 9, 2019

filipesilva commented Aug 9, 2019 • edited

mary-poppins commented Aug 9, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mary-poppins commented Aug 12, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mary-poppins commented Aug 12, 2019

mary-poppins commented Aug 12, 2019

googlebot commented Sep 11, 2019

AndrewKushnir commented Sep 11, 2019

googlebot commented Sep 11, 2019

mary-poppins commented Sep 11, 2019

googlebot commented Sep 11, 2019

AndrewKushnir commented Sep 11, 2019

kara left a comment

Choose a reason for hiding this comment

kara commented Sep 11, 2019

matsko commented Sep 12, 2019

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

filipesilva commented Aug 9, 2019 •

edited

filipesilva commented Aug 9, 2019 •

edited