feat: Add ng update support to ngrx packages (#1053)

Also adds a `schematics-core` and `migrations` build to each package

Author: brandonroberts

.circleci/config.yml

@@ -54,23 +54,20 @@ jobs:
       # Install the dependencies from NPM, using the node and yarn binaries managed by Bazel
       - run: bazel run @yarn//:yarn
 
-      # Copy shared schematics-core into schematics/src directory
-      - run: yarn copy:schematics
-
       # Build and Test
       # Use bazel query so that we explicitly ask for all buildable targets to
       # be built even though we run `bazel test`
       # See https://github.com/bazelbuild/bazel/issues/4257
       - run: bazel query --output=label //... | xargs bazel test
 
   test:
-    <<: *run_in_ngcontainer
+    docker:
+      - image: circleci/node:latest-browsers
     steps:
       - checkout
       - restore_cache:
           key: *cache_key
       - run: yarn
-      - run: yarn copy:schematics
       - run: yarn run ci
       - run: yarn run example:build:prod
       - run: yarn run example:test --watch=false
@@ -89,7 +86,6 @@ jobs:
       - restore_cache:
           key: *cache_key
       - run: yarn
-      - run: yarn copy:schematics
       - run: yarn run build
       - run: yarn run deploy:builds
 

.gitignore

@@ -71,6 +71,6 @@ tmp
 
 example-dist/
 
-schematics-core
-!modules/schematics-core
-*.tgz
+*.tgz
+modules/*/schematics-core/testing
+!modules/schematics-core/testing

build/config.ts

@@ -9,7 +9,7 @@ export interface Config {
   scope: string;
 }
 
-const modulesDir = './modules/';
+export const modulesDir = './modules/';
 export const packages: PackageDescription[] = fs
   .readdirSync(modulesDir)
   .filter(path => {

build/copy-schematics-core.ts

@@ -0,0 +1,15 @@
+import * as tasks from './tasks';
+import { createBuilder } from './util';
+import { packages } from './config';
+
+const copySchematics = createBuilder([
+  ['Copy Schematics Core Files', tasks.copySchematicsCore],
+]);
+
+copySchematics({
+  scope: '@ngrx',
+  packages,
+}).catch(err => {
+  console.error(err);
+  process.exit(1);
+});

build/tasks.ts

@@ -1,5 +1,34 @@
-import { Config } from './config';
+import { Config, modulesDir } from './config';
 import * as util from './util';
+import * as fs from 'fs';
+import { ncp } from 'ncp';
+
+/**
+ *
+ * Copies the schematics-core package into any package that provides
+ * schematics or migrations
+ */
+export async function copySchematicsCore(config: Config) {
+  (ncp as any).limit = 1;
+  for (let pkg of util.getTopLevelPackages(config)) {
+    const packageJson = fs
+      .readFileSync(`${modulesDir}${pkg}/package.json`)
+      .toString('utf-8');
+    const pkgConfig = JSON.parse(packageJson);
+
+    if (pkgConfig.schematics || pkgConfig['ng-update'].migrations) {
+      ncp(
+        `${modulesDir}/schematics-core`,
+        `${modulesDir}/${pkg}/schematics-core`,
+        function(err: any) {
+          if (err) {
+            return console.error(err);
+          }
+        }
+      );
+    }
+  }
+}
 
 /**
  * Deploy build artifacts to repos

modules/effects/BUILD

@@ -23,6 +23,10 @@ ng_package(
         "//modules/effects/testing:package.json",
     ],
     entry_point = "modules/effects/index.js",
+    packages = [
+        "//modules/effects/migrations:npm_package",
+        "//modules/effects/schematics-core:npm_package",
+    ],
     deps = [
         ":effects",
         "//modules/effects/testing",

modules/effects/migrations/6_0_0/index.spec.ts

@@ -0,0 +1,39 @@
+import { Tree } from '@angular-devkit/schematics';
+import {
+  SchematicTestRunner,
+  UnitTestTree,
+} from '@angular-devkit/schematics/testing';
+import * as path from 'path';
+import {
+  createPackageJson,
+  packagePath,
+} from '../../../schematics-core/testing/create-package';
+import {
+  upgradeVersion,
+  versionPrefixes,
+} from '../../../schematics-core/testing/update';
+
+const collectionPath = path.join(__dirname, '../migration.json');
+
+describe('Effects Migration 6_0_0', () => {
+  let appTree;
+  const pkgName = 'effects';
+
+  versionPrefixes.forEach(prefix => {
+    it(`should install version ${prefix}6.0.0`, () => {
+      appTree = new UnitTestTree(Tree.empty());
+      const runner = new SchematicTestRunner('schematics', collectionPath);
+      const tree = createPackageJson(prefix, pkgName, appTree);
+
+      const newTree = runner.runSchematic(
+        `ngrx-${pkgName}-migration-01`,
+        {},
+        tree
+      );
+      const pkg = JSON.parse(newTree.readContent(packagePath));
+      expect(pkg.dependencies[`@ngrx/${pkgName}`]).toBe(
+        `${prefix}${upgradeVersion}`
+      );
+    });
+  });
+});

modules/effects/migrations/6_0_0/index.ts

@@ -0,0 +1,6 @@
+import { Rule } from '@angular-devkit/schematics';
+import { updatePackage } from '@ngrx/effects/schematics-core';
+
+export default function(): Rule {
+  return updatePackage('effects');
+}

modules/effects/migrations/BUILD

@@ -0,0 +1,31 @@
+package(default_visibility = ["//visibility:public"])
+
+load("//tools:defaults.bzl", "ts_library")
+load("//tools:defaults.bzl", "npm_package")
+
+ts_library(
+    name = "migrations",
+    srcs = glob(
+        [
+            "**/*.ts",
+        ],
+        exclude = [
+            "**/testing/*.ts",
+            "**/*.spec.ts",
+        ],
+    ),
+    module_name = "@ngrx/effects/migrations",
+    deps = [
+        "//modules/effects/schematics-core",
+    ],
+)
+
+npm_package(
+    name = "npm_package",
+    srcs = [
+        ":migration.json",
+    ],
+    deps = [
+        ":migrations",
+    ],
+)

modules/effects/migrations/migration.json

@@ -0,0 +1,11 @@
+{
+  "$schema":
+    "../../../node_modules/@angular-devkit/schematics/collection-schema.json",
+  "schematics": {
+    "ngrx-effects-migration-01": {
+      "description": "The road to v6",
+      "version": "5.2",
+      "factory": "./6_0_0/index"
+    }
+  }
+}

modules/effects/package.json

@@ -18,7 +18,8 @@
     "rxjs": "RXJS_VERSION"
   },
   "ng-update": {
-    "packageGroup": "NG_UPDATE_PACKAGE_GROUP"
+    "packageGroup": "NG_UPDATE_PACKAGE_GROUP",
+    "migrations": "NG_UPDATE_MIGRATIONS"
   },
   "sideEffects": false
 }

modules/effects/schematics-core/BUILD

@@ -0,0 +1,26 @@
+package(default_visibility = ["//visibility:public"])
+
+load("//tools:defaults.bzl", "ts_library")
+load("//tools:defaults.bzl", "npm_package")
+
+ts_library(
+    name = "schematics-core",
+    srcs = glob(
+        [
+            "**/*.ts",
+        ],
+        exclude = [
+            "**/testing/**/*.ts",
+            "**/*spec.ts",
+        ],
+    ),
+    module_name = "@ngrx/effects/schematics-core",
+)
+
+npm_package(
+    name = "npm_package",
+    srcs = [],
+    deps = [
+        ":schematics-core",
+    ],
+)

modules/effects/schematics-core/index.ts

@@ -0,0 +1,72 @@
+import {
+  dasherize,
+  decamelize,
+  camelize,
+  classify,
+  underscore,
+  group,
+  capitalize,
+  featurePath,
+} from './utility/strings';
+
+export {
+  findNodes,
+  getSourceNodes,
+  getDecoratorMetadata,
+  getContentOfKeyLiteral,
+  insertAfterLastOccurrence,
+  addBootstrapToModule,
+  addDeclarationToModule,
+  addExportToModule,
+  addImportToModule,
+  addProviderToModule,
+} from './utility/ast-utils';
+
+export {
+  Host,
+  Change,
+  NoopChange,
+  InsertChange,
+  RemoveChange,
+  ReplaceChange,
+} from './utility/change';
+
+export {
+  AppConfig,
+  CliConfig,
+  getAppFromConfig,
+  getConfig,
+  getWorkspace,
+  getWorkspacePath,
+} from './utility/config';
+
+export {
+  findModule,
+  findModuleFromOptions,
+  buildRelativePath,
+  ModuleOptions,
+} from './utility/find-module';
+
+export {
+  addReducerToState,
+  addReducerToStateInferface,
+  addReducerImportToNgModule,
+  addReducerToActionReducerMap,
+  omit,
+} from './utility/ngrx-utils';
+
+export { getProjectPath } from './utility/project';
+export { insertImport } from './utility/route-utils';
+
+export const stringUtils = {
+  dasherize,
+  decamelize,
+  camelize,
+  classify,
+  underscore,
+  group,
+  capitalize,
+  featurePath,
+};
+
+export { updatePackage } from './utility/update';