Skip to content
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.

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

feat(store): add createFeatureSelector migration #3214

Merged
merged 2 commits into from
Nov 3, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
54 changes: 54 additions & 0 deletions modules/store/migrations/13_0_0-beta/index.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
import { Tree } from '@angular-devkit/schematics';
import {
SchematicTestRunner,
UnitTestTree,
} from '@angular-devkit/schematics/testing';
import * as path from 'path';

describe('Store Migration 13_0_0 beta', () => {
const collectionPath = path.join(__dirname, '../migration.json');
const pkgName = 'store';

it(`should replace createFeatureSelector usages with 2 generics`, async () => {
const contents = `
import {createFeatureSelector} from '@ngrx/store'

// untouched
const featureSelector1 = createFeatureSelector('feature1');
const featureSelector2 = createFeatureSelector<Feature>(feature2);
const featureSelector3 = createFeatureSelector<State,Feature,SomethingElse>(feature3);
const featureSelector4 = createFeatureSelector<fromFeat.State>('feature4');

// modified
const featureSelector5 = createFeatureSelector<State, Feature>('feature5');
const featureSelector6 = createFeatureSelector<State,Feature>(feature6);
const featureSelector7 = createFeatureSelector<fromRoot.State, fromFeat.State>('feature7');
`;

const expected = `
import {createFeatureSelector} from '@ngrx/store'

// untouched
const featureSelector1 = createFeatureSelector('feature1');
const featureSelector2 = createFeatureSelector<Feature>(feature2);
const featureSelector3 = createFeatureSelector<State,Feature,SomethingElse>(feature3);
const featureSelector4 = createFeatureSelector<fromFeat.State>('feature4');

// modified
const featureSelector5 = createFeatureSelector< Feature>('feature5');
const featureSelector6 = createFeatureSelector<Feature>(feature6);
const featureSelector7 = createFeatureSelector< fromFeat.State>('feature7');
`;

const appTree = new UnitTestTree(Tree.empty());
appTree.create('./fixture.ts', contents);
const runner = new SchematicTestRunner('schematics', collectionPath);

const newTree = await runner
.runSchematicAsync(`ngrx-${pkgName}-migration-13-beta`, {}, appTree)
.toPromise();
const file = newTree.readContent('fixture.ts');

expect(file).toBe(expected);
});
});
55 changes: 55 additions & 0 deletions modules/store/migrations/13_0_0-beta/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import * as ts from 'typescript';
import { Rule, chain, Tree } from '@angular-devkit/schematics';
import {
visitTSSourceFiles,
RemoveChange,
commitChanges,
} from '../../schematics-core';

function updateCreateFeatureSelectorGenerics(): Rule {
return (tree: Tree) => {
visitTSSourceFiles(tree, (sourceFile) => {
const runMigration = sourceFile.statements
.filter(ts.isImportDeclaration)
.filter(
(importDeclaration) =>
importDeclaration.moduleSpecifier.getText(sourceFile) ===
"'@ngrx/store'" ||
importDeclaration.moduleSpecifier.getText(sourceFile) ===
'"@ngrx/store"'
)
.some((importDeclaration) => {
return importDeclaration.importClause?.namedBindings
?.getText(sourceFile)
.includes('createFeatureSelector');
});

if (!runMigration) return;

const changes: RemoveChange[] = [];
ts.forEachChild(sourceFile, crawl);
return commitChanges(tree, sourceFile.fileName, changes);

function crawl(node: ts.Node) {
ts.forEachChild(node, crawl);

if (!ts.isCallExpression(node)) return;
if (node.typeArguments?.length !== 2) return;
if (!ts.isIdentifier(node.expression)) return;
if (node.expression.text !== 'createFeatureSelector') return;

changes.push(
new RemoveChange(
sourceFile.fileName,
node.typeArguments[0].pos,
node.typeArguments[1].pos
)
);
}
});
};
}

export default function (): Rule {
return chain([updateCreateFeatureSelectorGenerics()]);
}
5 changes: 5 additions & 0 deletions modules/store/migrations/migration.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@
"description": "The road to v8 RC",
"version": "8-rc.1",
"factory": "./8_0_0-rc/index"
},
"ngrx-store-migration-13-beta": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on the previous migration names:

Suggested change
"ngrx-store-migration-13-beta": {
"ngrx-store-migration-04": {

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea... 😅
The name doesn't really matter (it's only important to run the schematic in the test).
I was thinking it would make more sense to follow the versions, instead of creating an own counter.

"description": "The road to v13 beta",
"version": "13-beta",
"factory": "./13_0_0-beta/index"
}
}
}