cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor(core): rename ngInjectorDef to ɵinj (#33151)

Browse Source 
Injector defs are not considered public API, so the property
that contains them should be prefixed with Angular's marker
for "private" ('ɵ') to discourage apps from relying on def
APIs directly.

This commit adds the prefix and shortens the name from
ngInjectorDef to inj. This is because property names
cannot be minified by Uglify without turning on property
mangling (which most apps have turned off) and are thus
size-sensitive.

PR Close #33151
This commit is contained in:
Kara Erickson
2019-10-14 15:28:01 -07:00
committed by Matias Niemelä
parent 3e14c2d02c
commit cda9248b33
25 changed files with 79 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
packages/core/src/core_render3_private_export.ts
View File

@ -230,7 +230,7 @@ export {
export {
NG_INJECTABLE_DEF as ɵNG_INJECTABLE_DEF,
NG_INJECTOR_DEF as ɵNG_INJECTOR_DEF,
NG_INJ_DEF as ɵNG_INJ_DEF,
} from './di/interface/defs';
export {

12
packages/core/src/di/interface/defs.ts
View File

@ -104,7 +104,7 @@ export interface InjectorType<T> extends Type<T> {
/**
* Opaque type whose structure is highly version dependent. Do not rely on any properties.
*/
ngInjectorDef: never;
ɵinj: never;
}
/**
@ -159,7 +159,7 @@ export const defineInjectable = ɵɵdefineInjectable;
/**
* Construct an `InjectorDef` which configures an injector.
*
* This should be assigned to a static `ngInjectorDef` field on a type, which will then be an
* This should be assigned to a static injector def (`ɵinj`) field on a type, which will then be an
* `InjectorType`.
*
* Options:
@ -223,13 +223,13 @@ export function getInheritedInjectableDef<T>(type: any): ɵɵInjectableDef<T>|nu
}
/**
* Read the `ngInjectorDef` type in a way which is immune to accidentally reading inherited value.
* Read the injector def type in a way which is immune to accidentally reading inherited value.
*
* @param type type which may have `ngInjectorDef`
* @param type type which may have an injector def (`ɵinj`)
*/
export function getInjectorDef<T>(type: any): ɵɵInjectorDef<T>|null {
return type && type.hasOwnProperty(NG_INJECTOR_DEF) ? (type as any)[NG_INJECTOR_DEF] : null;
return type && type.hasOwnProperty(NG_INJ_DEF) ? (type as any)[NG_INJ_DEF] : null;
}
export const NG_INJECTABLE_DEF = getClosureSafeProperty({ngInjectableDef: getClosureSafeProperty});
export const NG_INJECTOR_DEF = getClosureSafeProperty({ngInjectorDef: getClosureSafeProperty});
export const NG_INJ_DEF = getClosureSafeProperty({ɵinj: getClosureSafeProperty});

7
packages/core/src/di/r3_injector.ts
View File

@ -251,11 +251,11 @@ export class R3Injector {
defOrWrappedDef = resolveForwardRef(defOrWrappedDef);
if (!defOrWrappedDef) return false;
// Either the defOrWrappedDef is an InjectorType (with ngInjectorDef) or an
// Either the defOrWrappedDef is an InjectorType (with injector def) or an
// InjectorDefTypeWithProviders (aka ModuleWithProviders). Detecting either is a megamorphic
// read, so care is taken to only do the read once.
// First attempt to read the ngInjectorDef.
// First attempt to read the injector def (`ɵinj`).
let def = getInjectorDef(defOrWrappedDef);
// If that's not present, then attempt to read ngModule from the InjectorDefTypeWithProviders.
@ -416,7 +416,8 @@ function injectableDefOrInjectorDefFactory(token: Type<any>| InjectionToken<any>
return factory;
}
// If the token is an NgModule, it's also injectable but the factory is on its ngInjectorDef.
// If the token is an NgModule, it's also injectable but the factory is on its injector def
// (`ɵinj`)
const injectorDef = getInjectorDef(token);
if (injectorDef !== null) {
return injectorDef.factory;

2
packages/core/src/metadata/ng_module.ts
View File

@ -350,7 +350,7 @@ function preR3NgModuleCompile(moduleType: Type<any>, metadata?: NgModule): void
imports = [...imports, metadata.exports];
}
(moduleType as InjectorType<any>).ngInjectorDef = ɵɵdefineInjector({
(moduleType as InjectorType<any>).ɵinj = ɵɵdefineInjector({
factory: convertInjectableProviderToFactory(moduleType, {useClass: moduleType}),
providers: metadata && metadata.providers,
imports: imports,

8
packages/core/src/render3/jit/module.ts
View File

@ -8,7 +8,7 @@
import {R3InjectorMetadataFacade, getCompilerFacade} from '../../compiler/compiler_facade';
import {resolveForwardRef} from '../../di/forward_ref';
import {NG_INJECTOR_DEF} from '../../di/interface/defs';
import {NG_INJ_DEF} from '../../di/interface/defs';
import {reflectDependencies} from '../../di/jit/util';
import {Type} from '../../interface/type';
import {Component} from '../../metadata';
@ -93,7 +93,7 @@ export function compileNgModule(moduleType: Type<any>, ngModule: NgModule = {}):
}
/**
* Compiles and adds the `ɵmod` and `ngInjectorDef` properties to the module class.
* Compiles and adds the `ɵmod` and `ɵinj` properties to the module class.
*
* It's possible to compile a module via this API which will allow duplicate declarations in its
* root.
@ -135,7 +135,7 @@ export function compileNgModuleDefs(
});
let ngInjectorDef: any = null;
Object.defineProperty(moduleType, NG_INJECTOR_DEF, {
Object.defineProperty(moduleType, NG_INJ_DEF, {
get: () => {
if (ngInjectorDef === null) {
ngDevMode && verifySemanticsOfNgModuleDef(
@ -151,7 +151,7 @@ export function compileNgModuleDefs(
],
};
ngInjectorDef = getCompilerFacade().compileInjector(
angularCoreEnv, `ng:///${moduleType.name}/ngInjectorDef.js`, meta);
angularCoreEnv, `ng:///${moduleType.name}/ɵinj.js`, meta);
}
return ngInjectorDef;
},

2
packages/core/test/bundling/injection/bundle.golden_symbols.json
View File

@ -30,7 +30,7 @@
"name": "NG_INJECTABLE_DEF"
},
{
"name": "NG_INJECTOR_DEF"
"name": "NG_INJ_DEF"
},
{
"name": "NG_TEMP_TOKEN_PATH"

2
packages/core/test/bundling/injection/usage.ts
View File

@ -30,7 +30,7 @@ export class ScopedService {
}
export class DefinedInjector {
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new DefinedInjector(),
providers: [ScopedService],
});

24
packages/core/test/di/r3_injector_spec.ts
View File

@ -132,7 +132,7 @@ describe('InjectorDef-based createInjector()', () => {
class DeepModule {
constructor(eagerService: EagerService) { deepModuleCreated = true; }
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new DeepModule(ɵɵinject(EagerService)),
imports: undefined,
providers: [
@ -150,7 +150,7 @@ describe('InjectorDef-based createInjector()', () => {
}
class IntermediateModule {
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new IntermediateModule(),
imports: [DeepModule.safe()],
providers: [],
@ -160,7 +160,7 @@ describe('InjectorDef-based createInjector()', () => {
class InjectorWithDep {
constructor(readonly service: Service) {}
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new InjectorWithDep(ɵɵinject(Service)),
});
}
@ -168,7 +168,7 @@ describe('InjectorDef-based createInjector()', () => {
class ChildService extends ServiceWithDep {}
class Module {
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new Module(),
imports: [IntermediateModule],
providers: [
@ -191,7 +191,7 @@ describe('InjectorDef-based createInjector()', () => {
}
class OtherModule {
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new OtherModule(),
imports: undefined,
providers: [],
@ -199,7 +199,7 @@ describe('InjectorDef-based createInjector()', () => {
}
class ModuleWithMissingDep {
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new ModuleWithMissingDep(),
imports: undefined,
providers: [ServiceWithMissingDep],
@ -209,7 +209,7 @@ describe('InjectorDef-based createInjector()', () => {
class NotAModule {}
class ImportsNotAModule {
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new ImportsNotAModule(),
imports: [NotAModule],
providers: [],
@ -236,21 +236,21 @@ describe('InjectorDef-based createInjector()', () => {
}
class MultiProviderA {
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new MultiProviderA(),
providers: [{provide: LOCALE, multi: true, useValue: 'A'}],
});
}
class MultiProviderB {
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new MultiProviderB(),
providers: [{provide: LOCALE, multi: true, useValue: 'B'}],
});
}
class WithProvidersTest {
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new WithProvidersTest(),
imports: [
{ngModule: MultiProviderA, providers: [{provide: LOCALE, multi: true, useValue: 'C'}]},
@ -402,7 +402,7 @@ describe('InjectorDef-based createInjector()', () => {
.toThrowError('Injector has already been destroyed.');
});
it('should not crash when importing something that has no ngInjectorDef', () => {
it('should not crash when importing something that has no ɵinj', () => {
injector = createInjector(ImportsNotAModule);
expect(injector.get(ImportsNotAModule)).toBeDefined();
});
@ -419,7 +419,7 @@ describe('InjectorDef-based createInjector()', () => {
constructor(missingType: any) {}
}
class ErrorModule {
static ngInjectorDef =
static ɵinj =
ɵɵdefineInjector({factory: () => new ErrorModule(), providers: [MissingArgumentType]});
}
expect(() => createInjector(ErrorModule).get(MissingArgumentType))

2
packages/core/test/render3/component_spec.ts
View File

@ -90,7 +90,7 @@ describe('component', () => {
}
class MyModule {
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new MyModule(),
providers: [{provide: MyService, useValue: new MyService('injector')}]
});

4
packages/core/test/render3/ivy/jit_spec.ts
View File

@ -165,7 +165,7 @@ ivyEnabled && describe('render3 jit', () => {
expect(moduleDef.declarations[0]).toBe(Cmp);
});
it('compiles a module to an ngInjectorDef with the providers', () => {
it('compiles a module to an ɵinj with the providers', () => {
class Token {
static ngInjectableDef = ɵɵdefineInjectable({
token: Token,
@ -181,7 +181,7 @@ ivyEnabled && describe('render3 jit', () => {
constructor(public token: Token) {}
}
const injectorDef: ɵɵInjectorDef<Module> = (Module as any).ngInjectorDef;
const injectorDef: ɵɵInjectorDef<Module> = (Module as any).ɵinj;
const instance = injectorDef.factory();
// Since the instance was created outside of an injector using the module, the

10
packages/core/test/render3/providers_spec.ts
View File

@ -326,7 +326,7 @@ describe('providers', () => {
describe('single', () => {
class MyModule {
static ngInjectorDef = ɵɵdefineInjector(
static ɵinj = ɵɵdefineInjector(
{factory: () => new MyModule(), providers: [{provide: String, useValue: 'From module'}]});
}
@ -536,7 +536,7 @@ describe('providers', () => {
describe('multi', () => {
class MyModule {
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new MyModule(),
providers: [{provide: String, useValue: 'From module', multi: true}]
});
@ -833,7 +833,7 @@ describe('providers', () => {
it('should work with a module', () => {
class MyModule {
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new MyModule(),
providers: [{provide: String, useValue: 'From module'}]
});
@ -1126,7 +1126,7 @@ describe('providers', () => {
expect(fixture.html).toEqual('<host-cmp>foo</host-cmp>');
class MyAppModule {
static ngInjectorDef = ɵɵdefineInjector({
static ɵinj = ɵɵdefineInjector({
factory: () => new MyAppModule(),
imports: [],
providers: [
@ -1210,7 +1210,7 @@ describe('providers', () => {
describe('injection flags', () => {
class MyModule {
static ngInjectorDef = ɵɵdefineInjector(
static ɵinj = ɵɵdefineInjector(
{factory: () => new MyModule(), providers: [{provide: String, useValue: 'Module'}]});
}
it('should not fall through to ModuleInjector if flags limit the scope', () => {

2
packages/core/test/test_bed_spec.ts
View File

@ -699,7 +699,7 @@ describe('TestBed', () => {
// The providers for the module should have been restored to the original array, with
// no trace of the overridden providers.
expect((Module as any).ngInjectorDef.providers).toEqual([Token]);
expect((Module as any).ɵinj.providers).toEqual([Token]);
});
it('should clean up overridden providers on components whose modules are compiled more than once',

10
packages/core/testing/src/r3_test_bed_compiler.ts
View File

@ -7,7 +7,7 @@
*/
import {ResourceLoader} from '@angular/compiler';
import {ApplicationInitStatus, COMPILER_OPTIONS, Compiler, Component, Directive, Injector, LOCALE_ID, ModuleWithComponentFactories, ModuleWithProviders, NgModule, NgModuleFactory, NgZone, Pipe, PlatformRef, Provider, Type, ɵDEFAULT_LOCALE_ID as DEFAULT_LOCALE_ID, ɵDirectiveDef as DirectiveDef, ɵNG_COMP_DEF as NG_COMP_DEF, ɵNG_DIR_DEF as NG_DIR_DEF, ɵNG_INJECTOR_DEF as NG_INJECTOR_DEF, ɵNG_MOD_DEF as NG_MOD_DEF, ɵNG_PIPE_DEF as NG_PIPE_DEF, ɵNgModuleFactory as R3NgModuleFactory, ɵNgModuleTransitiveScopes as NgModuleTransitiveScopes, ɵNgModuleType as NgModuleType, ɵRender3ComponentFactory as ComponentFactory, ɵRender3NgModuleRef as NgModuleRef, ɵcompileComponent as compileComponent, ɵcompileDirective as compileDirective, ɵcompileNgModuleDefs as compileNgModuleDefs, ɵcompilePipe as compilePipe, ɵgetInjectableDef as getInjectableDef, ɵpatchComponentDefWithScope as patchComponentDefWithScope, ɵsetLocaleId as setLocaleId, ɵtransitiveScopesFor as transitiveScopesFor, ɵɵInjectableDef as InjectableDef} from '@angular/core';
import {ApplicationInitStatus, COMPILER_OPTIONS, Compiler, Component, Directive, Injector, LOCALE_ID, ModuleWithComponentFactories, ModuleWithProviders, NgModule, NgModuleFactory, NgZone, Pipe, PlatformRef, Provider, Type, ɵDEFAULT_LOCALE_ID as DEFAULT_LOCALE_ID, ɵDirectiveDef as DirectiveDef, ɵNG_COMP_DEF as NG_COMP_DEF, ɵNG_DIR_DEF as NG_DIR_DEF, ɵNG_INJ_DEF as NG_INJ_DEF, ɵNG_MOD_DEF as NG_MOD_DEF, ɵNG_PIPE_DEF as NG_PIPE_DEF, ɵNgModuleFactory as R3NgModuleFactory, ɵNgModuleTransitiveScopes as NgModuleTransitiveScopes, ɵNgModuleType as NgModuleType, ɵRender3ComponentFactory as ComponentFactory, ɵRender3NgModuleRef as NgModuleRef, ɵcompileComponent as compileComponent, ɵcompileDirective as compileDirective, ɵcompileNgModuleDefs as compileNgModuleDefs, ɵcompilePipe as compilePipe, ɵgetInjectableDef as getInjectableDef, ɵpatchComponentDefWithScope as patchComponentDefWithScope, ɵsetLocaleId as setLocaleId, ɵtransitiveScopesFor as transitiveScopesFor, ɵɵInjectableDef as InjectableDef} from '@angular/core';
import {ModuleRegistrationMap, getRegisteredModulesState, restoreRegisteredModulesState} from '../../src/linker/ng_module_factory_registration';
import {clearResolutionOfComponentResourcesQueue, isComponentDefPendingResolution, resolveComponentResources, restoreComponentResolutionQueue} from '../../src/metadata/resource_loading';
@ -362,7 +362,7 @@ export class R3TestBedCompiler {
}
this.moduleProvidersOverridden.add(moduleType);
const injectorDef: any = (moduleType as any)[NG_INJECTOR_DEF];
const injectorDef: any = (moduleType as any)[NG_INJ_DEF];
if (this.providerOverridesByToken.size > 0) {
// Extract the list of providers from ModuleWithProviders, so we can define the final list of
// providers that might have overrides.
@ -373,9 +373,9 @@ export class R3TestBedCompiler {
isModuleWithProviders(imported) ? imported.providers : []));
const providers = [...providersFromModules, ...injectorDef.providers];
if (this.hasProviderOverrides(providers)) {
this.maybeStoreNgDef(NG_INJECTOR_DEF, moduleType);
this.maybeStoreNgDef(NG_INJ_DEF, moduleType);
this.storeFieldOfDefOnType(moduleType, NG_INJECTOR_DEF, 'providers');
this.storeFieldOfDefOnType(moduleType, NG_INJ_DEF, 'providers');
injectorDef.providers = this.getOverriddenProviders(providers);
}
@ -410,7 +410,7 @@ export class R3TestBedCompiler {
}
// Cache the initial ngModuleDef as it will be overwritten.
this.maybeStoreNgDef(NG_MOD_DEF, ngModule);
this.maybeStoreNgDef(NG_INJECTOR_DEF, ngModule);
this.maybeStoreNgDef(NG_INJ_DEF, ngModule);
compileNgModuleDefs(ngModule as NgModuleType<any>, metadata);
}