fix(ivy): retain JIT metadata unless JIT mode is explicitly disabled (#33671)
NgModules in Ivy have a definition which contains various different bits of metadata about the module. In particular, this metadata falls into two categories: * metadata required to use the module at runtime (for bootstrapping, etc) in AOT-only applications. * metadata required to depend on the module from a JIT-compiled app. The latter metadata consists of the module's declarations, imports, and exports. To support JIT usage, this metadata must be included in the generated code, especially if that code is shipped to NPM. However, because this metadata preserves the entire NgModule graph (references to all directives and components in the app), it needs to be removed during optimization for AOT-only builds. Previously, this was done with a clever design: 1. The extra metadata was added by a function called `setNgModuleScope`. A call to this function was generated after each NgModule. 2. This function call was marked as "pure" with a comment and used `noSideEffects` internally, which causes optimizers to remove it. The effect was that in dev mode or test mode (which use JIT), no optimizer runs and the full NgModule metadata was available at runtime. But in production (presumably AOT) builds, the optimizer runs and removes the JIT- specific metadata. However, there are cases where apps that want to use JIT in production, and still make an optimized build. In this case, the JIT-specific metadata would be erroneously removed. This commit solves that problem by adding an `ngJitMode` global variable which guards all `setNgModuleScope` calls. An optimizer can be configured to statically define this global to be `false` for AOT-only builds, causing the extra metadata to be stripped. A configuration for Terser used by the CLI is provided in `tooling.ts` which sets `ngJitMode` to `false` when building AOT apps. PR Close #33671
This commit is contained in:
@ -14,7 +14,7 @@ import {OutputContext} from '../util';
|
||||
|
||||
import {R3DependencyMetadata, R3FactoryTarget, compileFactoryFunction} from './r3_factory';
|
||||
import {Identifiers as R3} from './r3_identifiers';
|
||||
import {R3Reference, convertMetaToOutput, mapToMapExpression} from './util';
|
||||
import {R3Reference, convertMetaToOutput, jitOnlyGuardedExpression, mapToMapExpression} from './util';
|
||||
|
||||
export interface R3NgModuleDef {
|
||||
expression: o.Expression;
|
||||
@ -199,13 +199,25 @@ function generateSetNgModuleScopeCall(meta: R3NgModuleMetadata): o.Statement|nul
|
||||
return null;
|
||||
}
|
||||
|
||||
// setNgModuleScope(...)
|
||||
const fnCall = new o.InvokeFunctionExpr(
|
||||
/* fn */ o.importExpr(R3.setNgModuleScope),
|
||||
/* args */[moduleType, mapToMapExpression(scopeMap)],
|
||||
/* type */ undefined,
|
||||
/* sourceSpan */ undefined,
|
||||
/* pure */ true);
|
||||
return fnCall.toStmt();
|
||||
/* args */[moduleType, mapToMapExpression(scopeMap)]);
|
||||
|
||||
// (ngJitMode guard) && setNgModuleScope(...)
|
||||
const guardedCall = jitOnlyGuardedExpression(fnCall);
|
||||
|
||||
// function() { (ngJitMode guard) && setNgModuleScope(...); }
|
||||
const iife = new o.FunctionExpr(
|
||||
/* params */[],
|
||||
/* statements */[guardedCall.toStmt()]);
|
||||
|
||||
// (function() { (ngJitMode guard) && setNgModuleScope(...); })()
|
||||
const iifeCall = new o.InvokeFunctionExpr(
|
||||
/* fn */ iife,
|
||||
/* args */[]);
|
||||
|
||||
return iifeCall.toStmt();
|
||||
}
|
||||
|
||||
export interface R3InjectorDef {
|
||||
|
@ -13,8 +13,16 @@ import {OutputContext} from '../util';
|
||||
/**
|
||||
* Convert an object map with `Expression` values into a `LiteralMapExpr`.
|
||||
*/
|
||||
export function mapToMapExpression(map: {[key: string]: o.Expression}): o.LiteralMapExpr {
|
||||
const result = Object.keys(map).map(key => ({key, value: map[key], quoted: false}));
|
||||
export function mapToMapExpression(map: {[key: string]: o.Expression | undefined}):
|
||||
o.LiteralMapExpr {
|
||||
const result = Object.keys(map).map(
|
||||
key => ({
|
||||
key,
|
||||
// The assertion here is because really TypeScript doesn't allow us to express that if the
|
||||
// key is present, it will have a value, but this is true in reality.
|
||||
value: map[key] !,
|
||||
quoted: false,
|
||||
}));
|
||||
return o.literalMap(result);
|
||||
}
|
||||
|
||||
@ -79,4 +87,14 @@ export function getSyntheticPropertyName(name: string) {
|
||||
|
||||
export function prepareSyntheticListenerFunctionName(name: string, phase: string) {
|
||||
return `animation_${name}_${phase}`;
|
||||
}
|
||||
}
|
||||
|
||||
export function jitOnlyGuardedExpression(expr: o.Expression): o.Expression {
|
||||
const ngJitMode = new o.ExternalExpr({name: 'ngJitMode', moduleName: null});
|
||||
const jitFlagNotDefined = new o.BinaryOperatorExpr(
|
||||
o.BinaryOperator.Identical, new o.TypeofExpr(ngJitMode), o.literal('undefined'));
|
||||
const jitFlagUndefinedOrTrue = new o.BinaryOperatorExpr(
|
||||
o.BinaryOperator.Or, jitFlagNotDefined, ngJitMode, /* type */ undefined,
|
||||
/* sourceSpan */ undefined, true);
|
||||
return new o.BinaryOperatorExpr(o.BinaryOperator.And, jitFlagUndefinedOrTrue, expr);
|
||||
}
|
||||
|
Reference in New Issue
Block a user