feat(core): accept various task runner options from root of nx.json

nrwl · Sep 27, 2023 · 3dc9366 · 3dc9366
1 parent 8d767ed
commit 3dc9366
Show file tree

Hide file tree

Showing 16 changed files with 305 additions and 44 deletions.
diff --git a/docs/generated/devkit/NxJsonConfiguration.md b/docs/generated/devkit/NxJsonConfiguration.md
@@ -18,7 +18,9 @@ Nx.json configuration
 
 ### Properties
 
+- [accessToken](../../devkit/documents/NxJsonConfiguration#accesstoken): string
 - [affected](../../devkit/documents/NxJsonConfiguration#affected): NxAffectedConfig
+- [cacheDirectory](../../devkit/documents/NxJsonConfiguration#cachedirectory): string
 - [cli](../../devkit/documents/NxJsonConfiguration#cli): Object
 - [defaultProject](../../devkit/documents/NxJsonConfiguration#defaultproject): string
 - [extends](../../devkit/documents/NxJsonConfiguration#extends): string
@@ -27,15 +29,26 @@ Nx.json configuration
 - [installation](../../devkit/documents/NxJsonConfiguration#installation): NxInstallationConfiguration
 - [namedInputs](../../devkit/documents/NxJsonConfiguration#namedinputs): Object
 - [npmScope](../../devkit/documents/NxJsonConfiguration#npmscope): string
+- [parallel](../../devkit/documents/NxJsonConfiguration#parallel): number
 - [plugins](../../devkit/documents/NxJsonConfiguration#plugins): string[]
 - [pluginsConfig](../../devkit/documents/NxJsonConfiguration#pluginsconfig): Record&lt;string, unknown&gt;
 - [release](../../devkit/documents/NxJsonConfiguration#release): NxReleaseConfiguration
 - [targetDefaults](../../devkit/documents/NxJsonConfiguration#targetdefaults): TargetDefaults
 - [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions): Object
+- [useDaemonProcess](../../devkit/documents/NxJsonConfiguration#usedaemonprocess): boolean
 - [workspaceLayout](../../devkit/documents/NxJsonConfiguration#workspacelayout): Object
 
 ## Properties
 
+### accessToken
+
+• `Optional` **accessToken**: `string`
+
+If specified Nx will use nx-cloud by default with the given token.
+To use a different runner that accepts an access token, define it in [tasksRunnerOptions](../../devkit/documents/Workspace#tasksrunneroptions)
+
+---
+
 ### affected
 
 • `Optional` **affected**: [`NxAffectedConfig`](../../devkit/documents/NxAffectedConfig)
@@ -44,6 +57,14 @@ Default options for `nx affected`
 
 ---
 
+### cacheDirectory
+
+• `Optional` **cacheDirectory**: `string`
+
+Changes the default location of the cache directory.
+
+---
+
 ### cli
 
 • `Optional` **cli**: `Object`
@@ -148,6 +169,14 @@ NPM Scope that the workspace uses
 
 ---
 
+### parallel
+
+• `Optional` **parallel**: `number`
+
+Specifies how many tasks are ran in parallel by Nx for the default tasks runner.
+
+---
+
 ### plugins
 
 • `Optional` **plugins**: `string`[]
@@ -192,6 +221,14 @@ Available Task Runners
 
 ---
 
+### useDaemonProcess
+
+• `Optional` **useDaemonProcess**: `boolean`
+
+Allows turning the daemon off if set to false explicitly.
+
+---
+
 ### workspaceLayout
 
 • `Optional` **workspaceLayout**: `Object`

diff --git a/docs/generated/devkit/TargetConfiguration.md b/docs/generated/devkit/TargetConfiguration.md
@@ -12,6 +12,7 @@ Target's configuration
 
 ### Properties
 
+- [cache](../../devkit/documents/TargetConfiguration#cache): boolean
 - [command](../../devkit/documents/TargetConfiguration#command): string
 - [configurations](../../devkit/documents/TargetConfiguration#configurations): Object
 - [defaultConfiguration](../../devkit/documents/TargetConfiguration#defaultconfiguration): string
@@ -23,6 +24,15 @@ Target's configuration
 
 ## Properties
 
+### cache
+
+• `Optional` **cache**: `boolean`
+
+Determines if Nx is able to cache a given target.
+Currently only supported in `targetDefaults`.
+
+---
+
 ### command
 
 • `Optional` **command**: `string`

diff --git a/docs/generated/devkit/Task.md b/docs/generated/devkit/Task.md
@@ -6,6 +6,7 @@ A representation of the invocation of an Executor
 
 ### Properties
 
+- [cache](../../devkit/documents/Task#cache): boolean
 - [endTime](../../devkit/documents/Task#endtime): number
 - [hash](../../devkit/documents/Task#hash): string
 - [hashDetails](../../devkit/documents/Task#hashdetails): Object
@@ -17,6 +18,14 @@ A representation of the invocation of an Executor
 
 ## Properties
 
+### cache
+
+• `Optional` **cache**: `boolean`
+
+Determines if a given task should be cacheable.
+
+---
+
 ### endTime
 
 • `Optional` **endTime**: `number`

diff --git a/docs/generated/devkit/Workspace.md b/docs/generated/devkit/Workspace.md
@@ -16,7 +16,9 @@ use ProjectsConfigurations or NxJsonConfiguration
 
 ### Properties
 
+- [accessToken](../../devkit/documents/Workspace#accesstoken): string
 - [affected](../../devkit/documents/Workspace#affected): NxAffectedConfig
+- [cacheDirectory](../../devkit/documents/Workspace#cachedirectory): string
 - [cli](../../devkit/documents/Workspace#cli): Object
 - [defaultProject](../../devkit/documents/Workspace#defaultproject): string
 - [extends](../../devkit/documents/Workspace#extends): string
@@ -25,17 +27,32 @@ use ProjectsConfigurations or NxJsonConfiguration
 - [installation](../../devkit/documents/Workspace#installation): NxInstallationConfiguration
 - [namedInputs](../../devkit/documents/Workspace#namedinputs): Object
 - [npmScope](../../devkit/documents/Workspace#npmscope): string
+- [parallel](../../devkit/documents/Workspace#parallel): number
 - [plugins](../../devkit/documents/Workspace#plugins): string[]
 - [pluginsConfig](../../devkit/documents/Workspace#pluginsconfig): Record&lt;string, unknown&gt;
 - [projects](../../devkit/documents/Workspace#projects): Record&lt;string, ProjectConfiguration&gt;
 - [release](../../devkit/documents/Workspace#release): NxReleaseConfiguration
 - [targetDefaults](../../devkit/documents/Workspace#targetdefaults): TargetDefaults
 - [tasksRunnerOptions](../../devkit/documents/Workspace#tasksrunneroptions): Object
+- [useDaemonProcess](../../devkit/documents/Workspace#usedaemonprocess): boolean
 - [version](../../devkit/documents/Workspace#version): number
 - [workspaceLayout](../../devkit/documents/Workspace#workspacelayout): Object
 
 ## Properties
 
+### accessToken
+
+• `Optional` **accessToken**: `string`
+
+If specified Nx will use nx-cloud by default with the given token.
+To use a different runner that accepts an access token, define it in [tasksRunnerOptions](../../devkit/documents/Workspace#tasksrunneroptions)
+
+#### Inherited from
+
+[NxJsonConfiguration](../../devkit/documents/NxJsonConfiguration).[accessToken](../../devkit/documents/NxJsonConfiguration#accesstoken)
+
+---
+
 ### affected
 
 • `Optional` **affected**: [`NxAffectedConfig`](../../devkit/documents/NxAffectedConfig)
@@ -48,6 +65,18 @@ Default options for `nx affected`
 
 ---
 
+### cacheDirectory
+
+• `Optional` **cacheDirectory**: `string`
+
+Changes the default location of the cache directory.
+
+#### Inherited from
+
+[NxJsonConfiguration](../../devkit/documents/NxJsonConfiguration).[cacheDirectory](../../devkit/documents/NxJsonConfiguration#cachedirectory)
+
+---
+
 ### cli
 
 • `Optional` **cli**: `Object`
@@ -184,6 +213,18 @@ NPM Scope that the workspace uses
 
 ---
 
+### parallel
+
+• `Optional` **parallel**: `number`
+
+Specifies how many tasks are ran in parallel by Nx for the default tasks runner.
+
+#### Inherited from
+
+[NxJsonConfiguration](../../devkit/documents/NxJsonConfiguration).[parallel](../../devkit/documents/NxJsonConfiguration#parallel)
+
+---
+
 ### plugins
 
 • `Optional` **plugins**: `string`[]
@@ -260,6 +301,18 @@ Available Task Runners
 
 ---
 
+### useDaemonProcess
+
+• `Optional` **useDaemonProcess**: `boolean`
+
+Allows turning the daemon off if set to false explicitly.
+
+#### Inherited from
+
+[NxJsonConfiguration](../../devkit/documents/NxJsonConfiguration).[useDaemonProcess](../../devkit/documents/NxJsonConfiguration#usedaemonprocess)
+
+---
+
 ### version
 
 • **version**: `number`

diff --git a/packages/nx/src/config/nx-json.ts b/packages/nx/src/config/nx-json.ts
@@ -191,6 +191,27 @@ export interface NxJsonConfiguration<T = '*' | string[]> {
    * **ALPHA**: Configuration for `nx release` (versioning and publishing of applications and libraries)
    */
   release?: NxReleaseConfiguration;
+
+  /**
+   * If specified Nx will use nx-cloud by default with the given token.
+   * To use a different runner that accepts an access token, define it in {@link tasksRunnerOptions}
+   */
+  accessToken?: string;
+
+  /**
+   * Specifies how many tasks are ran in parallel by Nx for the default tasks runner.
+   */
+  parallel?: number;
+
+  /**
+   * Changes the default location of the cache directory.
+   */
+  cacheDirectory?: string;
+
+  /**
+   * Allows turning the daemon off if set to false explicitly.
+   */
+  useDaemonProcess?: boolean;
 }
 
 export function readNxJson(root: string = workspaceRoot): NxJsonConfiguration {

diff --git a/packages/nx/src/config/task-graph.ts b/packages/nx/src/config/task-graph.ts
@@ -66,6 +66,11 @@ export interface Task {
    * Unix timestamp of when a Batch Task ends
    **/
   endTime?: number;
+
+  /**
+   * Determines if a given task should be cacheable.
+   */
+  cache?: boolean;
 }
 
 /**

diff --git a/packages/nx/src/config/workspace-json-project-json.ts b/packages/nx/src/config/workspace-json-project-json.ts
@@ -181,4 +181,10 @@ export interface TargetConfiguration<T = any> {
    * A default named configuration to use when a target configuration is not provided.
    */
   defaultConfiguration?: string;
+
+  /**
+   * Determines if Nx is able to cache a given target.
+   * Currently only supported in `targetDefaults`.
+   */
+  cache?: boolean;
 }
diff --git a/packages/nx/src/daemon/client/client.ts b/packages/nx/src/daemon/client/client.ts
@@ -65,6 +65,7 @@ export class DaemonClient {
   enabled() {
     if (this._enabled === undefined) {
       const useDaemonProcessOption =
+        this.nxJson.useDaemonProcess ??
         this.nxJson.tasksRunnerOptions?.['default']?.options?.useDaemonProcess;
       const env = process.env.NX_DAEMON;
 

diff --git a/packages/nx/src/generators/utils/deprecated.ts b/packages/nx/src/generators/utils/deprecated.ts
@@ -40,6 +40,10 @@ export function updateWorkspaceConfiguration(
     extends: ext,
     installation,
     release,
+    accessToken,
+    cacheDirectory,
+    parallel,
+    useDaemonProcess,
   } = workspaceConfig;
 
   const nxJson: Required<NxJsonConfiguration> = {
@@ -58,6 +62,10 @@ export function updateWorkspaceConfiguration(
     extends: ext,
     installation,
     release,
+    accessToken,
+    cacheDirectory,
+    parallel,
+    useDaemonProcess,
   };
 
   updateNxJson(tree, nxJson);

diff --git a/packages/nx/src/tasks-runner/create-task-graph.ts b/packages/nx/src/tasks-runner/create-task-graph.ts
@@ -334,6 +334,7 @@ export class ProcessTasks {
       target: qualifiedTarget,
       projectRoot: project.data.root,
       overrides: interpolateOverrides(overrides, project.name, project.data),
+      cache: project.data.targets[target].cache,
     };
   }
 

diff --git a/packages/nx/src/tasks-runner/run-command.spec.ts b/packages/nx/src/tasks-runner/run-command.spec.ts
@@ -1,6 +1,7 @@
 import { TasksRunner } from './tasks-runner';
 import { getRunner } from './run-command';
 import { NxJsonConfiguration } from '../config/nx-json';
+import { join } from 'path';
 
 describe('getRunner', () => {
   let nxJson: NxJsonConfiguration;
@@ -73,4 +74,54 @@ describe('getRunner', () => {
 
     expect(tasksRunner).toEqual(mockRunner);
   });
+
+  it('uses default runner when no tasksRunnerOptions are present', () => {
+    jest.mock(join(__dirname, './default-tasks-runner.ts'), () => mockRunner);
+
+    const { tasksRunner } = getRunner({}, {});
+
+    expect(tasksRunner).toEqual(mockRunner);
+  });
+
+  it('uses nx-cloud when no tasksRunnerOptions are present and accessToken is specified', () => {
+    jest.mock('nx-cloud', () => mockRunner);
+
+    const { tasksRunner } = getRunner(
+      {},
+      {
+        accessToken: 'XXXX-XXX-XXXX',
+      }
+    );
+
+    expect(tasksRunner).toEqual(mockRunner);
+  });
+
+  it('reads options from base properties if no runner options provided', () => {
+    jest.mock(join(__dirname, './default-tasks-runner.ts'), () => mockRunner);
+
+    const { runnerOptions } = getRunner(
+      {},
+      {
+        cacheDirectory: '.nx/cache',
+        parallel: 3,
+        useDaemonProcess: false,
+        targetDefaults: {
+          build: {
+            cache: true,
+          },
+        },
+      }
+    );
+
+    expect(runnerOptions).toMatchInlineSnapshot(`
+      {
+        "cacheDirectory": ".nx/cache",
+        "cacheableOperations": [
+          "build",
+        ],
+        "parallel": 3,
+        "useDaemonProcess": false,
+      }
+    `);
+  });
 });