-
Notifications
You must be signed in to change notification settings - Fork 6.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(ng-update): better check for updated constructor signatures (#…
…12970) Instead of just checking the length of the constructor arguments, we now check the types of the constructor or super call. This means that we can *way* better report invalid signatures for constructor changes like for the `MatCalendar` (#9775). Just relying on the length of arguments means that *order* is being ignored. This also makes maintaining the constructor signature changes easier (there are a lot of instances for V7).
- Loading branch information
1 parent
86be1dc
commit e124418
Showing
9 changed files
with
329 additions
and
194 deletions.
There are no files selected for viewing
29 changes: 29 additions & 0 deletions
29
src/lib/schematics/update/material/data/constructor-checks.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,29 @@ | ||
| /** | ||
| * @license | ||
| * Copyright Google LLC 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 | ||
| */ | ||
|
|
||
| /** | ||
| * List of class names for which the constructor signature has been changed. The new constructor | ||
| * signature types don't need to be stored here because the signature will be determined | ||
| * automatically through type checking. | ||
| */ | ||
| export const constructorChecks = [ | ||
| // https://github.com/angular/material2/pull/9190 | ||
| 'NativeDateAdapter', | ||
|
|
||
| // https://github.com/angular/material2/pull/10319 | ||
| 'MatAutocomplete', | ||
|
|
||
| // https://github.com/angular/material2/pull/10344 | ||
| 'MatTooltip', | ||
|
|
||
| // https://github.com/angular/material2/pull/10389 | ||
| 'MatIconRegistry', | ||
|
|
||
| // https://github.com/angular/material2/pull/9775 | ||
| 'MatCalendar', | ||
| ]; |
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
81 changes: 81 additions & 0 deletions
81
src/lib/schematics/update/rules/signature-check/constructorSignatureCheckRule.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,81 @@ | ||
| /** | ||
| * @license | ||
| * Copyright Google LLC 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 {bold, green} from 'chalk'; | ||
| import {ProgramAwareRuleWalker, RuleFailure, Rules} from 'tslint'; | ||
| import * as ts from 'typescript'; | ||
| import {constructorChecks} from '../../material/data/constructor-checks'; | ||
|
|
||
| /** | ||
| * Rule that visits every TypeScript new expression or super call and checks if the parameter | ||
| * type signature is invalid and needs to be updated manually. | ||
| */ | ||
| export class Rule extends Rules.TypedRule { | ||
| applyWithProgram(sourceFile: ts.SourceFile, program: ts.Program): RuleFailure[] { | ||
| return this.applyWithWalker(new Walker(sourceFile, this.getOptions(), program)); | ||
| } | ||
| } | ||
|
|
||
| export class Walker extends ProgramAwareRuleWalker { | ||
|
|
||
| visitNewExpression(node: ts.NewExpression) { | ||
| this.checkExpressionSignature(node); | ||
| super.visitNewExpression(node); | ||
| } | ||
|
|
||
| visitCallExpression(node: ts.CallExpression) { | ||
| if (node.expression.kind === ts.SyntaxKind.SuperKeyword) { | ||
| this.checkExpressionSignature(node); | ||
| } | ||
|
|
||
| return super.visitCallExpression(node); | ||
| } | ||
|
|
||
| private getParameterTypesFromSignature(signature: ts.Signature): ts.Type[] { | ||
| return signature.getParameters() | ||
| .map(param => param.declarations[0] as ts.ParameterDeclaration) | ||
| .map(node => node.type) | ||
| .map(node => this.getTypeChecker().getTypeFromTypeNode(node)); | ||
| } | ||
|
|
||
| private checkExpressionSignature(node: ts.CallExpression | ts.NewExpression) { | ||
| const classType = this.getTypeChecker().getTypeAtLocation(node.expression); | ||
| const className = classType.symbol && classType.symbol.name; | ||
| const isNewExpression = ts.isNewExpression(node); | ||
|
|
||
| // TODO(devversion): Consider handling pass-through classes better. | ||
| // TODO(devversion): e.g. `export class CustomCalendar extends MatCalendar {}` | ||
| if (!classType || !constructorChecks.includes(className)) { | ||
| return; | ||
| } | ||
|
|
||
| const callExpressionSignature = node.arguments | ||
| .map(argument => this.getTypeChecker().getTypeAtLocation(argument)); | ||
| const classSignatures = classType.getConstructSignatures() | ||
| .map(signature => this.getParameterTypesFromSignature(signature)); | ||
|
|
||
| // TODO(devversion): we should check if the type is assignable to the signature | ||
| // TODO(devversion): blocked on https://github.com/Microsoft/TypeScript/issues/9879 | ||
| const doesMatchSignature = classSignatures.some(signature => { | ||
| return signature.every((type, index) => callExpressionSignature[index] === type) && | ||
| signature.length === callExpressionSignature.length; | ||
| }); | ||
|
|
||
| if (!doesMatchSignature) { | ||
| const expressionName = isNewExpression ? `new ${className}` : 'super'; | ||
| const signatures = classSignatures | ||
| .map(signature => signature.map(t => this.getTypeChecker().typeToString(t))) | ||
| .map(signature => `${expressionName}(${signature.join(', ')})`) | ||
| .join(' or '); | ||
|
|
||
| this.addFailureAtNode(node, `Found "${bold(className)}" constructed with ` + | ||
| `an invalid signature. Please manually update the ${bold(expressionName)} expression to ` + | ||
| `match the new signature${classSignatures.length > 1 ? 's' : ''}: ${green(signatures)}`); | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,77 +1,48 @@ | ||
| import {getSystemPath, normalize, virtualFs} from '@angular-devkit/core'; | ||
| import {getSystemPath, normalize} from '@angular-devkit/core'; | ||
| import {TempScopedNodeJsSyncHost} from '@angular-devkit/core/node/testing'; | ||
| import {SchematicTestRunner} from '@angular-devkit/schematics/testing'; | ||
| import * as virtualFs from '@angular-devkit/core/src/virtual-fs/host'; | ||
| import {readFileSync} from 'fs'; | ||
| import {runPostScheduledTasks} from '../../test-setup/post-scheduled-tasks'; | ||
| import {createTestApp, migrationCollection} from '../../test-setup/test-app'; | ||
|
|
||
| describe('test cases', () => { | ||
|
|
||
| // Module name suffix for data files of the `jasmine_node_test` Bazel rule. | ||
| const bazelModuleSuffix = 'angular_material/src/lib/schematics/update/test-cases'; | ||
|
|
||
| /** | ||
| * Name of test cases that will be used to verify that update schematics properly update | ||
| * a developers application. | ||
| */ | ||
| const testCases = [ | ||
| 'v5/attribute-selectors', | ||
| ]; | ||
|
|
||
| // Iterates through every test case directory and generates a jasmine test block that will | ||
| // verify that the update schematics properly update the test input to the expected output. | ||
| testCases.forEach(testCaseName => { | ||
|
|
||
| // Adding the test case files to the data of the `jasmine_node_test` Bazel rule does not mean | ||
| // that the files are being copied over to the Bazel bin output. Bazel just patches the NodeJS | ||
| // resolve function and maps the module paths to the original file location. Since we | ||
| // need to load the content of those test cases, we need to resolve the original file path. | ||
| const inputPath = require.resolve(`${bazelModuleSuffix}/${testCaseName}_input.ts`); | ||
| const expectedOutputPath = require | ||
| .resolve(`${bazelModuleSuffix}/${testCaseName}_expected_output.ts`); | ||
|
|
||
| it(`should apply update schematics to test case: ${testCaseName}`, () => { | ||
| const runner = new SchematicTestRunner('schematics', migrationCollection); | ||
|
|
||
| runner.runSchematic('migration-01', {}, createTestAppWithTestCase(inputPath)); | ||
|
|
||
| // Run the scheduled TSLint fix task from the update schematic. This task is responsible for | ||
| // identifying outdated code parts and performs the fixes. Since tasks won't run automatically | ||
| // within a `SchematicTestRunner`, we manually need to run the scheduled task. | ||
| return runPostScheduledTasks(runner, 'tslint-fix').toPromise().then(() => { | ||
| expect(readFileContent('projects/material/src/main.ts')) | ||
| .toBe(readFileContent(expectedOutputPath)); | ||
| }); | ||
| }); | ||
| import {createTestApp} from '../../test-setup/test-app'; | ||
|
|
||
| /** Module name suffix for data files of the `jasmine_node_test` Bazel rule. */ | ||
| const bazelModuleSuffix = 'angular_material/src/lib/schematics/update/test-cases'; | ||
|
|
||
| /** Reads the UTF8 content of the specified file. Normalizes the path and ensures that */ | ||
| export function readFileContent(filePath: string): string { | ||
| return readFileSync(filePath, 'utf8'); | ||
| } | ||
|
|
||
| /** | ||
| * Resolves the original file path of the specified file that has been to the `data` of the | ||
| * jasmine_node_test Bazel rule. | ||
| * | ||
| * Adding the test case files to the data of the `jasmine_node_test` Bazel rule does not mean | ||
| * that the files are being copied over to the Bazel bin output. Bazel just patches the NodeJS | ||
| * resolve function and maps the module paths to the original file location. | ||
| */ | ||
| export function resolveBazelDataFile(filePath: string) { | ||
| return require.resolve(`${bazelModuleSuffix}/${filePath}`); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a test app schematic tree that includes the specified test case as TypeScript | ||
| * entry point file. Also writes the app tree to a real file system location in order to be | ||
| * able to test the tslint fix rules. | ||
| */ | ||
| export function createTestAppWithTestCase(testCaseInputPath: string) { | ||
| const tempFileSystemHost = new TempScopedNodeJsSyncHost(); | ||
| const appTree = createTestApp(); | ||
|
|
||
| appTree.overwrite('/projects/material/src/main.ts', readFileContent(testCaseInputPath)); | ||
|
|
||
| // Since the TSLint fix task expects all files to be present on the real file system, we | ||
| // map every file in the app tree to a temporary location on the file system. | ||
| appTree.files.map(f => normalize(f)).forEach(f => { | ||
| tempFileSystemHost.sync.write(f, virtualFs.stringToFileBuffer(appTree.readContent(f))); | ||
| }); | ||
|
|
||
| /** Reads the UTF8 content of the specified file. Normalizes the path and ensures that */ | ||
| function readFileContent(filePath: string): string { | ||
| return readFileSync(filePath, 'utf8'); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a test app schematic tree that includes the specified test case as TypeScript | ||
| * entry point file. Also writes the app tree to a real file system location in order to be | ||
| * able to test the tslint fix rules. | ||
| */ | ||
| function createTestAppWithTestCase(testCaseInputPath: string) { | ||
| const tempFileSystemHost = new TempScopedNodeJsSyncHost(); | ||
| const appTree = createTestApp(); | ||
|
|
||
| appTree.overwrite('/projects/material/src/main.ts', readFileContent(testCaseInputPath)); | ||
|
|
||
| // Since the TSLint fix task expects all files to be present on the real file system, we | ||
| // map every file in the app tree to a temporary location on the file system. | ||
| appTree.files.map(f => normalize(f)).forEach(f => { | ||
| tempFileSystemHost.sync.write(f, virtualFs.stringToFileBuffer(appTree.readContent(f))); | ||
| }); | ||
|
|
||
| // Switch to the new temporary directory because otherwise TSLint cannot read the files. | ||
| process.chdir(getSystemPath(tempFileSystemHost.root)); | ||
|
|
||
| return appTree; | ||
| } | ||
| }); | ||
|
|
||
| // Switch to the new temporary directory because otherwise TSLint cannot read the files. | ||
| process.chdir(getSystemPath(tempFileSystemHost.root)); | ||
|
|
||
| return appTree; | ||
| } |
Oops, something went wrong.