fix(core): do not error when ngDevMode is undeclared
#39415
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In production mode, the `ngDevMode` global may not have been declared.
This is typically not a problem, as optimizers should have removed all
usages of the `ngDevMode` variables. This does however require the
bundler/optimizer to have been configured in a certain way, as to allow
for `ngDevMode` guarded code to be removed.
As an example, Terser can be configured to remove the `ngDevMode`
guarded code using the following configuration:
```js
const terserOptions = {
// ...
compress: {
// ...
global_defs: require('@angular/compiler-cli').GLOBAL_DEFS_FOR_TERSER,
}
}
```
(Taken from angular#31595 (comment))
If this is not done, however, the bundle should still work (albeit with
larger code size due to missed tree-shaking opportunities). This commit
adds a check for whether `ngDevMode` has been declared, as it is a
top-level statement that executes before `ngDevMode` has been initialized.
Fixes angular#31595
JoostK
added
type: bug/fix
freq1: low
area: core
petebacondarwin
approved these changes
Oct 25, 2020
crisbeto
reviewed
Oct 25, 2020
| @@ -38,7 +38,7 @@ export {Sanitizer} from './sanitization/sanitizer'; | |||
| export * from './codegen_private_exports'; | |||
|
|
|||
| import {global} from './util/global'; | |||
| if (ngDevMode) { | |||
| if (typeof ngDevMode !== 'undefined' && ngDevMode) { | |||
There was a problem hiding this comment.
Drive-by observation: the typeof check is something that can easily be missed. Maybe we can add a custom lint rule to check for it?
There was a problem hiding this comment.
I agree this is indeed error-prone and easy to regress in some way or another. There are however plenty of bare reads of ngDevMode in places that can depend on initNgDevMode to have been executed. A potential lint rule would therefore likely have to only consider top-level statements or something like that, which would also make it not entirely fool proof.
atscott
approved these changes
Oct 26, 2020
alxhub
pushed a commit
that referenced
this pull request
Oct 27, 2020
In production mode, the `ngDevMode` global may not have been declared.
This is typically not a problem, as optimizers should have removed all
usages of the `ngDevMode` variables. This does however require the
bundler/optimizer to have been configured in a certain way, as to allow
for `ngDevMode` guarded code to be removed.
As an example, Terser can be configured to remove the `ngDevMode`
guarded code using the following configuration:
```js
const terserOptions = {
// ...
compress: {
// ...
global_defs: require('@angular/compiler-cli').GLOBAL_DEFS_FOR_TERSER,
}
}
```
(Taken from #31595 (comment))
If this is not done, however, the bundle should still work (albeit with
larger code size due to missed tree-shaking opportunities). This commit
adds a check for whether `ngDevMode` has been declared, as it is a
top-level statement that executes before `ngDevMode` has been initialized.
Fixes #31595
PR Close #39415
alxhub
pushed a commit
that referenced
this pull request
Oct 27, 2020
In production mode, the `ngDevMode` global may not have been declared.
This is typically not a problem, as optimizers should have removed all
usages of the `ngDevMode` variables. This does however require the
bundler/optimizer to have been configured in a certain way, as to allow
for `ngDevMode` guarded code to be removed.
As an example, Terser can be configured to remove the `ngDevMode`
guarded code using the following configuration:
```js
const terserOptions = {
// ...
compress: {
// ...
global_defs: require('@angular/compiler-cli').GLOBAL_DEFS_FOR_TERSER,
}
}
```
(Taken from #31595 (comment))
If this is not done, however, the bundle should still work (albeit with
larger code size due to missed tree-shaking opportunities). This commit
adds a check for whether `ngDevMode` has been declared, as it is a
top-level statement that executes before `ngDevMode` has been initialized.
Fixes #31595
PR Close #39415
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In production mode, the
ngDevModeglobal may not have been declared.This is typically not a problem, as optimizers should have removed all
usages of the
ngDevModevariables. This does however require thebundler/optimizer to have been configured in a certain way, as to allow
for
ngDevModeguarded code to be removed.As an example, Terser can be configured to remove the
ngDevModeguarded code using the following configuration:
(Taken from #31595 (comment))
If this is not done, however, the bundle should still work (albeit with
larger code size due to missed tree-shaking opportunities). This commit
adds a check for whether
ngDevModehas been declared, as it is atop-level statement that executes before
ngDevModehas been initialized.Fixes #31595