feat(core): generate new workspaces without tasks runner options (#19483

)
nrwl · Oct 11, 2023 · 05e7602 · 05e7602 · vercel · Oct 11, 2023
1 parent b8e1500
commit 05e7602
Show file tree

Hide file tree

Showing 48 changed files with 347 additions and 352 deletions.
diff --git a/docs/generated/devkit/NxJsonConfiguration.md b/docs/generated/devkit/NxJsonConfiguration.md
@@ -29,6 +29,7 @@ Nx.json configuration
 - [namedInputs](../../devkit/documents/NxJsonConfiguration#namedinputs): Object
 - [npmScope](../../devkit/documents/NxJsonConfiguration#npmscope): string
 - [nxCloudAccessToken](../../devkit/documents/NxJsonConfiguration#nxcloudaccesstoken): string
+- [nxCloudEncryptionKey](../../devkit/documents/NxJsonConfiguration#nxcloudencryptionkey): string
 - [nxCloudUrl](../../devkit/documents/NxJsonConfiguration#nxcloudurl): string
 - [parallel](../../devkit/documents/NxJsonConfiguration#parallel): number
 - [plugins](../../devkit/documents/NxJsonConfiguration#plugins): string[]
@@ -170,6 +171,14 @@ To use a different runner that accepts an access token, define it in [tasksRunne
 
 ---
 
+### nxCloudEncryptionKey
+
+• `Optional` **nxCloudEncryptionKey**: `string`
+
+Specifies the encryption key used to encrypt artifacts data before sending it to nx cloud.
+
+---
+
 ### nxCloudUrl
 
 • `Optional` **nxCloudUrl**: `string`

diff --git a/docs/generated/devkit/Workspace.md b/docs/generated/devkit/Workspace.md
@@ -27,6 +27,7 @@ use ProjectsConfigurations or NxJsonConfiguration
 - [namedInputs](../../devkit/documents/Workspace#namedinputs): Object
 - [npmScope](../../devkit/documents/Workspace#npmscope): string
 - [nxCloudAccessToken](../../devkit/documents/Workspace#nxcloudaccesstoken): string
+- [nxCloudEncryptionKey](../../devkit/documents/Workspace#nxcloudencryptionkey): string
 - [nxCloudUrl](../../devkit/documents/Workspace#nxcloudurl): string
 - [parallel](../../devkit/documents/Workspace#parallel): number
 - [plugins](../../devkit/documents/Workspace#plugins): string[]
@@ -214,6 +215,18 @@ To use a different runner that accepts an access token, define it in [tasksRunne
 
 ---
 
+### nxCloudEncryptionKey
+
+• `Optional` **nxCloudEncryptionKey**: `string`
+
+Specifies the encryption key used to encrypt artifacts data before sending it to nx cloud.
+
+#### Inherited from
+
+[NxJsonConfiguration](../../devkit/documents/NxJsonConfiguration).[nxCloudEncryptionKey](../../devkit/documents/NxJsonConfiguration#nxcloudencryptionkey)
+
+---
+
 ### nxCloudUrl
 
 • `Optional` **nxCloudUrl**: `string`

diff --git a/docs/shared/migration/from-turborepo.md b/docs/shared/migration/from-turborepo.md
@@ -157,7 +157,7 @@ For each `turbo.json` configuration property, the equivalent Nx property is list
 |                             |                                                                                                                                                                                       |
 | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `turbo run test lint build` | [`nx run-many -t test lint build`](/nx-api/nx/documents/run-many)                                                                                                                     |
-| `--cache-dir`               | Set in [`nx.json` under `tasksRunnerOptions.default.options.cacheDirectory`](/reference/nx-json#tasks-runner-options)                                                                 |
+| `--cache-dir`               | Set in [`nx.json` under `cacheDirectory`](/reference/nx-json#cache-directory)                                                                                                         |
 | `--concurrency`             | [`--parallel`](/nx-api/nx/documents/run-many#parallel)                                                                                                                                |
 | `--continue`                | [Use `--nx-bail`](/nx-api/nx/documents/run-many#nx-bail) with the inverse value                                                                                                       |
 | `--cwd`                     | Available when using the [`run-commands` executor](/nx-api/nx/executors/run-commands#cwd)                                                                                             |

diff --git a/e2e/angular-core/src/ng-add.test.ts b/e2e/angular-core/src/ng-add.test.ts
@@ -142,14 +142,6 @@ describe('convert Angular CLI workspace to an Nx workspace', () => {
       affected: {
         defaultBase: 'main',
       },
-      tasksRunnerOptions: {
-        default: {
-          options: {
-            cacheableOperations: ['build', 'test', 'e2e'],
-          },
-          runner: 'nx/tasks-runners/default',
-        },
-      },
       namedInputs: {
         default: ['{projectRoot}/**/*', 'sharedGlobals'],
         production: [
@@ -164,12 +156,15 @@ describe('convert Angular CLI workspace to an Nx workspace', () => {
         build: {
           dependsOn: ['^build'],
           inputs: ['production', '^production'],
+          cache: true,
         },
         e2e: {
           inputs: ['default', '^production'],
+          cache: true,
         },
         test: {
           inputs: ['default', '^production', '{workspaceRoot}/karma.conf.js'],
+          cache: true,
         },
       },
     });

diff --git a/e2e/nx-misc/src/nxw.test.ts b/e2e/nx-misc/src/nxw.test.ts
@@ -40,7 +40,7 @@ describe('nx wrapper / .nx installation', () => {
     );
 
     updateJson<NxJsonConfiguration>('nx.json', (json) => {
-      json.tasksRunnerOptions.default.options.cacheableOperations = ['echo'];
+      json.targetDefaults.echo = { cache: true };
       json.installation.plugins = {
         '@nx/js': getPublishedVersion(),
       };

diff --git a/e2e/nx-run/src/cache.test.ts b/e2e/nx-run/src/cache.test.ts
@@ -125,13 +125,9 @@ describe('cache', () => {
     const originalNxJson = readFile('nx.json');
     updateFile('nx.json', (c) => {
       const nxJson = JSON.parse(c);
-      nxJson.tasksRunnerOptions = {
-        default: {
-          options: {
-            cacheableOperations: [],
-          },
-        },
-      };
+      for (const key in nxJson.targetDefaults ?? {}) {
+        delete nxJson.targetDefaults[key].cache;
+      }
       return JSON.stringify(nxJson, null, 2);
     });
 
@@ -262,6 +258,7 @@ describe('cache', () => {
       c.targetDefaults = {
         test: {
           inputs: ['default', '^prod'],
+          cache: true,
         },
       };
       return c;
@@ -319,9 +316,9 @@ describe('cache', () => {
     const lib = uniq('lib');
     runCLI(`generate @nx/js:lib ${lib}`);
     updateJson(`nx.json`, (c) => {
-      c.tasksRunnerOptions.default.options.cacheableOperations.push('echo');
       c.targetDefaults = {
         echo: {
+          cache: true,
           inputs: [
             {
               env: 'NAME',

diff --git a/e2e/nx-run/src/run.test.ts b/e2e/nx-run/src/run.test.ts
@@ -24,6 +24,15 @@ describe('Nx Running Tests', () => {
   beforeAll(() => (proj = newProject()));
   afterAll(() => cleanupProject());
 
+  // Ensures that nx.json is restored to its original state after each test
+  let existingNxJson;
+  beforeEach(() => {
+    existingNxJson = readJson('nx.json');
+  });
+  afterEach(() => {
+    updateFile('nx.json', JSON.stringify(existingNxJson, null, 2));
+  });
+
   describe('running targets', () => {
     describe('(forwarding params)', () => {
       let proj = uniq('proj');
@@ -465,16 +474,14 @@ describe('Nx Running Tests', () => {
           return config;
         });
 
-        nxJson.tasksRunnerOptions.default.options.cacheableOperations = [
-          'prep',
-          'outside',
-        ];
         nxJson.targetDefaults = {
           prep: {
             outputs: ['{workspaceRoot}/one.txt'],
+            cache: true,
           },
           outside: {
             dependsOn: ['prep'],
+            cache: true,
           },
         };
         updateFile('nx.json', JSON.stringify(nxJson));

diff --git a/packages/angular/src/generators/ng-add/__snapshots__/migrate-from-angular-cli.spec.ts.snap b/packages/angular/src/generators/ng-add/__snapshots__/migrate-from-angular-cli.spec.ts.snap
@@ -101,6 +101,7 @@ exports[`workspace move to nx layout should create nx.json 1`] = `
   },
   "targetDefaults": {
     "build": {
+      "cache": true,
       "dependsOn": [
         "^build",
       ],
@@ -110,39 +111,29 @@ exports[`workspace move to nx layout should create nx.json 1`] = `
       ],
     },
     "e2e": {
+      "cache": true,
       "inputs": [
         "default",
         "^production",
       ],
     },
     "lint": {
+      "cache": true,
       "inputs": [
         "default",
         "{workspaceRoot}/.eslintrc.json",
         "{workspaceRoot}/eslint.config.js",
       ],
     },
     "test": {
+      "cache": true,
       "inputs": [
         "default",
         "^production",
         "{workspaceRoot}/karma.conf.js",
       ],
     },
   },
-  "tasksRunnerOptions": {
-    "default": {
-      "options": {
-        "cacheableOperations": [
-          "build",
-          "test",
-          "lint",
-          "e2e",
-        ],
-      },
-      "runner": "nx/tasks-runners/default",
-    },
-  },
 }
 `;
 

diff --git a/packages/angular/src/generators/ng-add/migrators/migrator.ts b/packages/angular/src/generators/ng-add/migrators/migrator.ts
@@ -97,15 +97,11 @@ export abstract class Migrator {
 
     const nxJson = readNxJson(this.tree);
 
-    Object.keys(nxJson.tasksRunnerOptions ?? {}).forEach((taskRunnerName) => {
-      const taskRunner = nxJson.tasksRunnerOptions[taskRunnerName];
-      taskRunner.options.cacheableOperations = Array.from(
-        new Set([
-          ...(taskRunner.options.cacheableOperations ?? []),
-          ...targetNames,
-        ])
-      );
-    });
+    nxJson.targetDefaults ??= {};
+    for (const target of targetNames) {
+      nxJson.targetDefaults[target] ??= {};
+      nxJson.targetDefaults[target].cache ??= true;
+    }
 
     updateNxJson(this.tree, nxJson);
   }

diff --git a/packages/angular/src/generators/ng-add/migrators/projects/app.migrator.spec.ts b/packages/angular/src/generators/ng-add/migrators/projects/app.migrator.spec.ts
@@ -1618,9 +1618,9 @@ describe('app migrator', () => {
 
       await migrator.migrate();
 
-      const { tasksRunnerOptions } = readNxJson(tree);
+      const { targetDefaults } = readNxJson(tree);
       expect(
-        tasksRunnerOptions.default.options.cacheableOperations
+        Object.keys(targetDefaults).filter((f) => targetDefaults[f].cache)
       ).toStrictEqual([
         'build',
         'lint',
@@ -1654,9 +1654,9 @@ describe('app migrator', () => {
 
       await migrator.migrate();
 
-      const { tasksRunnerOptions } = readNxJson(tree);
+      const { targetDefaults } = readNxJson(tree);
       expect(
-        tasksRunnerOptions.default.options.cacheableOperations
+        Object.keys(targetDefaults).filter((f) => targetDefaults[f].cache)
       ).toStrictEqual(['build', 'lint', 'test', 'e2e', 'myCustomTest']);
     });
   });

diff --git a/packages/angular/src/generators/ng-add/migrators/projects/lib.migrator.spec.ts b/packages/angular/src/generators/ng-add/migrators/projects/lib.migrator.spec.ts
@@ -1274,9 +1274,9 @@ describe('lib migrator', () => {
 
       await migrator.migrate();
 
-      const { tasksRunnerOptions } = readNxJson(tree);
+      const { targetDefaults } = readNxJson(tree);
       expect(
-        tasksRunnerOptions.default.options.cacheableOperations
+        Object.keys(targetDefaults).filter((f) => targetDefaults[f].cache)
       ).toStrictEqual([
         'build',
         'lint',
@@ -1304,9 +1304,9 @@ describe('lib migrator', () => {
 
       await migrator.migrate();
 
-      const { tasksRunnerOptions } = readNxJson(tree);
+      const { targetDefaults } = readNxJson(tree);
       expect(
-        tasksRunnerOptions.default.options.cacheableOperations
+        Object.keys(targetDefaults).filter((f) => targetDefaults[f].cache)
       ).toStrictEqual(['build', 'lint', 'test', 'e2e', 'myCustomTest']);
     });
   });

diff --git a/packages/angular/src/generators/ng-add/utilities/workspace.ts b/packages/angular/src/generators/ng-add/utilities/workspace.ts
@@ -52,19 +52,6 @@ export function createNxJson(
     affected: {
       defaultBase: options.defaultBase ?? deduceDefaultBase(),
     },
-    tasksRunnerOptions: {
-      default: {
-        runner: 'nx/tasks-runners/default',
-        options: {
-          cacheableOperations: [
-            'build',
-            targets.test ? 'test' : undefined,
-            targets.lint ? 'lint' : undefined,
-            targets.e2e ? 'e2e' : undefined,
-          ].filter(Boolean),
-        },
-      },
-    },
     namedInputs: {
       sharedGlobals: [],
       default: ['{projectRoot}/**/*', 'sharedGlobals'],
@@ -86,10 +73,12 @@ export function createNxJson(
       build: {
         dependsOn: ['^build'],
         inputs: ['production', '^production'],
+        cache: true,
       },
       test: targets.test
         ? {
             inputs: ['default', '^production', '{workspaceRoot}/karma.conf.js'],
+            cache: true,
           }
         : undefined,
       lint: targets.lint
@@ -99,11 +88,13 @@ export function createNxJson(
               '{workspaceRoot}/.eslintrc.json',
               '{workspaceRoot}/eslint.config.js',
             ],
+            cache: true,
           }
         : undefined,
       e2e: targets.e2e
         ? {
             inputs: ['default', '^production'],
+            cache: true,
           }
         : undefined,
     },

diff --git a/packages/angular/src/generators/setup-ssr/lib/update-project-config.ts b/packages/angular/src/generators/setup-ssr/lib/update-project-config.ts
@@ -87,6 +87,10 @@ export function updateProjectConfig(tree: Tree, schema: Schema) {
     ];
     updateNxJson(tree, nxJson);
   }
+  nxJson.targetDefaults ??= {};
+  nxJson.targetDefaults.server ??= {};
+  nxJson.targetDefaults.server.cache ??= true;
+  updateNxJson(tree, nxJson);
 }
 
 function getServerOptions(

diff --git a/packages/angular/src/generators/setup-ssr/setup-ssr.spec.ts b/packages/angular/src/generators/setup-ssr/setup-ssr.spec.ts
@@ -102,22 +102,7 @@ describe('setupSSR', () => {
       expect(packageJson.devDependencies[dep]).toEqual(version);
     }
     const nxJson = readJson<NxJsonConfiguration>(tree, 'nx.json');
-    expect(nxJson.tasksRunnerOptions).toMatchInlineSnapshot(`
-      {
-        "default": {
-          "options": {
-            "cacheableOperations": [
-              "build",
-              "lint",
-              "test",
-              "e2e",
-              "server",
-            ],
-          },
-          "runner": "nx/tasks-runners/default",
-        },
-      }
-    `);
+    expect(nxJson.targetDefaults.server.cache).toBe(true);
   });
 
   it('should use fileReplacements if they already exist', async () => {
@@ -219,22 +204,7 @@ describe('setupSSR', () => {
       expect(packageJson.devDependencies[dep]).toEqual(version);
     }
     const nxJson = readJson<NxJsonConfiguration>(tree, 'nx.json');
-    expect(nxJson.tasksRunnerOptions).toMatchInlineSnapshot(`
-      {
-        "default": {
-          "options": {
-            "cacheableOperations": [
-              "build",
-              "lint",
-              "test",
-              "e2e",
-              "server",
-            ],
-          },
-          "runner": "nx/tasks-runners/default",
-        },
-      }
-    `);
+    expect(nxJson.targetDefaults.server.cache).toEqual(true);
   });
 
   it('should add hydration correctly for NgModule apps', async () => {