refactor(core): clean up support for ES2015 constructor delegation (#30368)

This commit moves the delegated constructor detection to a helper
function and also adds more test coverage.

The original code for this came from https://github.com/angular/angular/pull/24156
thanks to @ts2do.

Closes #24156
Closes #27267

// FW-1310

PR Close #30368
This commit is contained in:
Pete Bacon Darwin 2018-05-27 20:50:37 -05:00 committed by Alex Rickabaugh
parent 9abf114fbb
commit b68850215a
2 changed files with 37 additions and 21 deletions

View File

@ -26,6 +26,19 @@ export const INHERITED_CLASS_WITH_CTOR =
export const INHERITED_CLASS_WITH_DELEGATE_CTOR =
/^class\s+[A-Za-z\d$_]*\s*extends\s+[^{]+{[\s\S]*constructor\s*\(\)\s*{\s+super\(\.\.\.arguments\)/;
/**
* Determine whether a stringified type is a class which delegates its constructor
* to its parent.
*
* This is not trivial since compiled code can actually contain a constructor function
* even if the original source code did not. For instance, when the child class contains
* an initialized instance property.
*/
export function isDelegateCtor(typeStr: string): boolean {
return DELEGATE_CTOR.test(typeStr) || INHERITED_CLASS_WITH_DELEGATE_CTOR.test(typeStr) ||
(INHERITED_CLASS.test(typeStr) && !INHERITED_CLASS_WITH_CTOR.test(typeStr));
}
export class ReflectionCapabilities implements PlatformReflectionCapabilities {
private _reflect: any;
@ -72,8 +85,7 @@ export class ReflectionCapabilities implements PlatformReflectionCapabilities {
// This also helps to work around for https://github.com/Microsoft/TypeScript/issues/12439
// that sets 'design:paramtypes' to []
// if a class inherits from another class but has no ctor declared itself.
if (DELEGATE_CTOR.exec(typeStr) || INHERITED_CLASS_WITH_DELEGATE_CTOR.exec(typeStr) ||
(INHERITED_CLASS.exec(typeStr) && !INHERITED_CLASS_WITH_CTOR.exec(typeStr))) {
if (isDelegateCtor(typeStr)) {
return null;
}

View File

@ -7,7 +7,7 @@
*/
import {Reflector} from '@angular/core/src/reflection/reflection';
import {DELEGATE_CTOR, INHERITED_CLASS, INHERITED_CLASS_WITH_CTOR, ReflectionCapabilities} from '@angular/core/src/reflection/reflection_capabilities';
import {ReflectionCapabilities, isDelegateCtor} from '@angular/core/src/reflection/reflection_capabilities';
import {makeDecorator, makeParamDecorator, makePropDecorator} from '@angular/core/src/util/decorators';
import {global} from '@angular/core/src/util/global';
@ -165,8 +165,10 @@ class TestObj {
});
});
describe('ctor inheritance detection', () => {
it('should use the right regex', () => {
describe('isDelegateCtor', () => {
it('should support ES5 compiled classes', () => {
// These classes will be compiled to ES5 code so their stringified form
// below will contain ES5 constructor functions rather than native classes.
class Parent {}
class ChildNoCtor extends Parent {}
@ -177,9 +179,9 @@ class TestObj {
private x = 10;
}
expect(DELEGATE_CTOR.exec(ChildNoCtor.toString())).toBeTruthy();
expect(DELEGATE_CTOR.exec(ChildNoCtorPrivateProps.toString())).toBeTruthy();
expect(DELEGATE_CTOR.exec(ChildWithCtor.toString())).toBeFalsy();
expect(isDelegateCtor(ChildNoCtor.toString())).toBe(true);
expect(isDelegateCtor(ChildNoCtorPrivateProps.toString())).toBe(true);
expect(isDelegateCtor(ChildWithCtor.toString())).toBe(false);
});
it('should not throw when no prototype on type', () => {
@ -190,6 +192,9 @@ class TestObj {
});
it('should support native class', () => {
// These classes are defined as strings unlike the tests above because otherwise
// the compiler (of these tests) will convert them to ES5 constructor function
// style classes.
const ChildNoCtor = `class ChildNoCtor extends Parent {}\n`;
const ChildWithCtor = `class ChildWithCtor extends Parent {\n` +
` constructor() { super(); }` +
@ -199,24 +204,23 @@ class TestObj {
` constructor() { super(); }` +
`}\n`;
const ChildNoCtorPrivateProps = `class ChildNoCtorPrivateProps extends Parent {\n` +
` private x = 10;\n` +
` constructor() {\n` +
// Note that the instance property causes a pass-through constructor to be synthesized
` super(...arguments);\n` +
` this.x = 10;\n` +
` }\n` +
`}\n`;
const checkNoOwnMetadata = (str: string) =>
INHERITED_CLASS.exec(str) && !INHERITED_CLASS_WITH_CTOR.exec(str);
expect(checkNoOwnMetadata(ChildNoCtor)).toBeTruthy();
expect(checkNoOwnMetadata(ChildNoCtorPrivateProps)).toBeTruthy();
expect(checkNoOwnMetadata(ChildWithCtor)).toBeFalsy();
expect(checkNoOwnMetadata(ChildNoCtorComplexBase)).toBeTruthy();
expect(checkNoOwnMetadata(ChildWithCtorComplexBase)).toBeFalsy();
expect(isDelegateCtor(ChildNoCtor)).toBe(true);
expect(isDelegateCtor(ChildNoCtorPrivateProps)).toBe(true);
expect(isDelegateCtor(ChildWithCtor)).toBe(false);
expect(isDelegateCtor(ChildNoCtorComplexBase)).toBe(true);
expect(isDelegateCtor(ChildWithCtorComplexBase)).toBe(false);
});
it('should properly handle all class forms', () => {
const ctor = (str: string) => expect(INHERITED_CLASS.exec(str)).toBeTruthy() &&
expect(INHERITED_CLASS_WITH_CTOR.exec(str)).toBeTruthy();
const noCtor = (str: string) => expect(INHERITED_CLASS.exec(str)).toBeTruthy() &&
expect(INHERITED_CLASS_WITH_CTOR.exec(str)).toBeFalsy();
const ctor = (str: string) => expect(isDelegateCtor(str)).toBe(false);
const noCtor = (str: string) => expect(isDelegateCtor(str)).toBe(true);
ctor(`class Bar extends Foo {constructor(){}}`);
ctor(`class Bar extends Foo { constructor ( ) {} }`);