Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(ivy): add a runtime feature to copy cmp/dir definitions
This commit adds CopyDefinitionFeature, which supports the case where an entire decorator (@component or @directive) is inherited from parent to child. The existing inheritance feature, InheritDefinitionFeature, supports merging of parent and child definitions when both were originally present. This merges things like inputs, outputs, host bindings, etc. CopyDefinitionFeature, on the other hand, compensates for a definition that was missing entirely on the child class, by copying fields that aren't ordinarily inherited (like the template function itself). This feature is intended to only be used as part of ngcc code generation.
- Loading branch information
Showing
6 changed files
with
160 additions
and
0 deletions.
There are no files selected for viewing
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
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
67 changes: 67 additions & 0 deletions
67
packages/core/src/render3/features/copy_definition_feature.ts
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
/** | ||
* @license | ||
* Copyright Google Inc. All Rights Reserved. | ||
* | ||
* Use of this source code is governed by an MIT-style license that can be | ||
* found in the LICENSE file at https://angular.io/license | ||
*/ | ||
|
||
import {Type} from '../../interface/type'; | ||
import {ComponentDef, DirectiveDef} from '../interfaces/definition'; | ||
import {isComponentDef} from '../interfaces/type_checks'; | ||
|
||
|
||
function getSuperType(type: Type<any>): Type<any>& | ||
{ɵcmp?: ComponentDef<any>, ɵdir?: DirectiveDef<any>} { | ||
return Object.getPrototypeOf(type.prototype).constructor; | ||
} | ||
|
||
const COPY_DIRECTIVE_FIELDS: (keyof DirectiveDef<unknown>)[] = ['providersResolver']; | ||
const COPY_COMPONENT_FIELDS: Exclude<keyof ComponentDef<unknown>, keyof DirectiveDef<unknown>>[] = [ | ||
'template', | ||
'consts', | ||
'vars', | ||
'onPush', | ||
'styles', | ||
'encapsulation', | ||
'schemas', | ||
]; | ||
|
||
/** | ||
* Merges the definition from a super class to a sub class. | ||
* @param definition The definition that is a SubClass of another directive of component | ||
* | ||
* @codeGenApi | ||
*/ | ||
export function ɵɵCopyDefinitionFeature(definition: DirectiveDef<any>| ComponentDef<any>): void { | ||
let superType = getSuperType(definition.type); | ||
|
||
if (superType) { | ||
let superDef: DirectiveDef<any>|ComponentDef<any>|undefined = undefined; | ||
if (isComponentDef(definition)) { | ||
// Don't use getComponentDef/getDirectiveDef. This logic relies on inheritance. | ||
superDef = superType.ɵcmp; | ||
} else { | ||
// Don't use getComponentDef/getDirectiveDef. This logic relies on inheritance. | ||
superDef = superType.ɵdir; | ||
} | ||
|
||
if (!superDef) { | ||
// Nothing to do? | ||
return; | ||
} | ||
|
||
// Needed because `definition` fields are readonly. | ||
const defAny = (definition as any); | ||
|
||
for (const field of COPY_DIRECTIVE_FIELDS) { | ||
defAny[field] = superDef[field]; | ||
} | ||
|
||
if (isComponentDef(superDef)) { | ||
for (const field of COPY_COMPONENT_FIELDS) { | ||
defAny[field] = superDef[field]; | ||
} | ||
} | ||
} | ||
} |
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
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
86 changes: 86 additions & 0 deletions
86
packages/core/test/acceptance/copy_definition_feature_spec.ts
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
/** | ||
* @license | ||
* Copyright Google Inc. All Rights Reserved. | ||
* | ||
* Use of this source code is governed by an MIT-style license that can be | ||
* found in the LICENSE file at https://angular.io/license | ||
*/ | ||
|
||
import {Component, NgModule, ɵɵCopyDefinitionFeature as CopyDefinitionFeature, ɵɵInheritDefinitionFeature as InheritDefinitionFeature, ɵɵdefineComponent as defineComponent} from '@angular/core'; | ||
import {TestBed} from '@angular/core/testing'; | ||
import {onlyInIvy} from '@angular/private/testing'; | ||
|
||
describe('Ivy CopyDefinitionFeature', () => { | ||
onlyInIvy('this feature is not required in View Engine') | ||
.it('should copy the template function of a component definition from parent to child', | ||
() => { | ||
|
||
// It would be nice if the base component could be JIT compiled. However, this creates | ||
// a getter for ɵcmp which precludes adding a static definition of that field for the | ||
// child class. | ||
// TODO(alxhub): see if there's a cleaner way to do this. | ||
class BaseComponent { | ||
name !: string; | ||
static ɵcmp = defineComponent({ | ||
type: BaseComponent, | ||
selectors: [['some-cmp']], | ||
decls: 0, | ||
vars: 0, | ||
inputs: {name: 'name'}, | ||
template: function BaseComponent_Template(rf, ctx) { ctx.rendered = true; }, | ||
encapsulation: 2 | ||
}); | ||
static ɵfac = function BaseComponent_Factory(t: any) { | ||
return new (t || BaseComponent)(); | ||
}; | ||
|
||
rendered = false; | ||
} | ||
|
||
class ChildComponent extends BaseComponent { | ||
static ɵcmp = defineComponent({ | ||
type: ChildComponent, | ||
selectors: [['some-cmp']], | ||
features: [InheritDefinitionFeature, CopyDefinitionFeature], | ||
decls: 0, | ||
vars: 0, | ||
template: function ChildComponent_Template(rf, ctx) {}, | ||
encapsulation: 2 | ||
}); | ||
static ɵfac = function ChildComponent_Factory(t: any) { | ||
return new (t || ChildComponent)(); | ||
}; | ||
} | ||
|
||
@NgModule({ | ||
declarations: [ChildComponent], | ||
exports: [ChildComponent], | ||
}) | ||
class Module { | ||
} | ||
|
||
@Component({ | ||
selector: 'test-cmp', | ||
template: '<some-cmp name="Success!"></some-cmp>', | ||
}) | ||
class TestCmp { | ||
} | ||
|
||
TestBed.configureTestingModule({ | ||
declarations: [TestCmp], | ||
imports: [Module], | ||
}); | ||
|
||
const fixture = TestBed.createComponent(TestCmp); | ||
|
||
// The child component should have matched and been instantiated. | ||
const child = fixture.debugElement.children[0].componentInstance as ChildComponent; | ||
expect(child instanceof ChildComponent).toBe(true); | ||
|
||
// And the base class template function should've been called. | ||
expect(child.rendered).toBe(true); | ||
|
||
// The input binding should have worked. | ||
expect(child.name).toBe('Success!'); | ||
}); | ||
}); |