Skip to content

fix(mdc-migration): migrate components selectively bug #26427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 28, 2023
Merged

fix(mdc-migration): migrate components selectively bug #26427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/material/schematics/ng-generate/mdc-migration/rules/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,3 +203,5 @@ export const PERMANENT_MIGRATORS: ComponentMigrator[] = [
styles: new TypographyHierarchyStylesMigrator(),
},
];

export const CORE_COMPONENTS = ['option', 'optgroup'];
15 changes: 13 additions & 2 deletions src/material/schematics/ng-generate/mdc-migration/rules/ts-migration/runtime-migration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

import {Migration, getPropertyNameText} from '@angular/cdk/schematics';
import {SchematicContext} from '@angular-devkit/schematics';
import {ComponentMigrator, LEGACY_MODULES} from '../index';
import {ComponentMigrator, CORE_COMPONENTS, LEGACY_MODULES} from '../index';
import * as ts from 'typescript';
import {ThemingStylesMigration} from '../theming-styles';
import {TemplateMigration} from '../template-migration';
Expand Down Expand Up @@ -65,6 +65,16 @@ export class RuntimeCodeMigration extends Migration<ComponentMigrator[], Schemat
});
}

private _importPathHasComponentToMigrate(importTextPath: string): boolean {
const lastImportName = importTextPath.split('/').slice(-1)[0];
return !!this.upgradeData.find(componentMigrator => {
return (
lastImportName.includes(componentMigrator.component) ||
(lastImportName === 'legacy-core' && CORE_COMPONENTS.includes(componentMigrator.component))
);
});
}

/** Finds the imported symbols in a file that need to be migrated. */
private _findImportsToMigrate(sourceFile: ts.SourceFile) {
const importSpecifiersToNewNames = new Map<ts.ImportSpecifier, string>();
Expand All @@ -77,7 +87,8 @@ export class RuntimeCodeMigration extends Migration<ComponentMigrator[], Schemat
ts.isStringLiteral(statement.moduleSpecifier) &&
statement.importClause?.namedBindings &&
ts.isNamedImports(statement.importClause.namedBindings) &&
LEGACY_MODULES.has(statement.moduleSpecifier.text)
LEGACY_MODULES.has(statement.moduleSpecifier.text) &&
this._importPathHasComponentToMigrate(statement.moduleSpecifier.text)
) {
statement.importClause.namedBindings.elements.forEach(element => {
const oldName = (element.propertyName || element.name).text;
Expand Down
72 changes: 72 additions & 0 deletions ...material/schematics/ng-generate/mdc-migration/rules/ts-migration/runtime-migrator.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,78 @@ describe('runtime code migration', () => {
);
});

it('should not replace imports from non selected components', async () => {
declareLibrarySymbols('legacy-button', 'export declare class MatLegacyButtonModule {};');
declareLibrarySymbols('legacy-checkbox', 'export declare class MatLegacyCheckboxModule {};');

await runMigrationTest(
`
import {NgModule} from '@angular/core';
import {MatLegacyButtonModule} from '@angular/material/legacy-button';
import {MatLegacyCheckboxModule} from '@angular/material/legacy-checkbox';

@NgModule({imports: [MatLegacyButtonModule, MatLegacyCheckboxModule]})
export class AppModule {}
`,
`
import {NgModule} from '@angular/core';
import {MatButtonModule} from '@angular/material/button';
import {MatLegacyCheckboxModule} from '@angular/material/legacy-checkbox';

@NgModule({imports: [MatButtonModule, MatLegacyCheckboxModule]})
export class AppModule {}
`,
);
});

it('should migrate legacy-core symbols when option or optgroup is choosen for migration', async () => {
declareLibrarySymbols('legacy-select', 'export declare class MatLegacySelectModule {};');

async function runMigrationSelectTest(oldFileContent: string, newFileContent: string) {
cliAppTree.overwrite(APP_MODULE_FILE, oldFileContent);
const tree = await migrateComponents(['select'], runner, cliAppTree);
expect(tree.readContent(APP_MODULE_FILE)).toBe(newFileContent);
}

await runMigrationSelectTest(
`
import {NgModule} from '@angular/core';
import {MatLegacySelectModule as MatSelectModule} from '@angular/material/legacy-select';
import {MatLegacyOptionModule as MatOptionModule, LEGACY_VERSION as VERSION} from '@angular/material/legacy-core';

@NgModule({imports: [MatSelectModule, MatOptionModule]})
export class AppModule {}
`,
`
import {NgModule} from '@angular/core';
import {MatSelectModule} from '@angular/material/select';
import {MatOptionModule, VERSION} from '@angular/material/core';

@NgModule({imports: [MatSelectModule, MatOptionModule]})
export class AppModule {}
`,
);
});

it('should not migrate legacy-core symbols when option or optgroup are not choosen for migration', async () => {
await runMigrationTest(
`
import {NgModule} from '@angular/core';
import {MatLegacyOptionModule as MatOptionModule, LEGACY_VERSION as VERSION} from '@angular/material/legacy-core';

@NgModule({imports: [MatOptionModule]})
export class AppModule {}
`,
`
import {NgModule} from '@angular/core';
import {MatLegacyOptionModule as MatOptionModule, LEGACY_VERSION as VERSION} from '@angular/material/legacy-core';

@NgModule({imports: [MatOptionModule]})
export class AppModule {}
`,
);
});

it('should migrate styles for a component', async () => {
await runMigrationTest(
`
Expand Down