feat(core): add the outputs of a task onto the task (#19561)

Co-authored-by: Jonathan Cammisuli <[email protected]>
nrwl · Oct 12, 2023 · 5740a73 · 5740a73 · vercel · Oct 12, 2023
1 parent 6f245be
commit 5740a73
Show file tree

Hide file tree

Showing 24 changed files with 558 additions and 1,092 deletions.
diff --git a/docs/generated/devkit/Task.md b/docs/generated/devkit/Task.md
@@ -11,6 +11,7 @@ A representation of the invocation of an Executor
 - [hash](../../devkit/documents/Task#hash): string
 - [hashDetails](../../devkit/documents/Task#hashdetails): Object
 - [id](../../devkit/documents/Task#id): string
+- [outputs](../../devkit/documents/Task#outputs): string[]
 - [overrides](../../devkit/documents/Task#overrides): any
 - [projectRoot](../../devkit/documents/Task#projectroot): string
 - [startTime](../../devkit/documents/Task#starttime): number
@@ -67,6 +68,14 @@ Unique ID
 
 ---
 
+### outputs
+
+• **outputs**: `string`[]
+
+The outputs the task may produce
+
+---
+
 ### overrides
 
 • **overrides**: `any`

diff --git a/docs/generated/devkit/getOutputsForTargetAndConfiguration.md b/docs/generated/devkit/getOutputsForTargetAndConfiguration.md
@@ -2,14 +2,32 @@
 
 ▸ **getOutputsForTargetAndConfiguration**(`task`, `node`): `string`[]
 
+#### Parameters
+
+| Name   | Type                                                                        |
+| :----- | :-------------------------------------------------------------------------- |
+| `task` | [`Task`](../../devkit/documents/Task)                                       |
+| `node` | [`ProjectGraphProjectNode`](../../devkit/documents/ProjectGraphProjectNode) |
+
+#### Returns
+
+`string`[]
+
+**`Deprecated`**
+
+Pass the target and overrides instead. This will be removed in v18.
+
+▸ **getOutputsForTargetAndConfiguration**(`target`, `overrides`, `node`): `string`[]
+
 Returns the list of outputs that will be cached.
 
 #### Parameters
 
-| Name   | Type                                                                        | Description                                               |
-| :----- | :-------------------------------------------------------------------------- | :-------------------------------------------------------- |
-| `task` | `Pick`<[`Task`](../../devkit/documents/Task), `"overrides"` \| `"target"`\> | target + overrides                                        |
-| `node` | [`ProjectGraphProjectNode`](../../devkit/documents/ProjectGraphProjectNode) | ProjectGraphProjectNode object that the task runs against |
+| Name        | Type                                                                                                               |
+| :---------- | :----------------------------------------------------------------------------------------------------------------- |
+| `target`    | [`Task`](../../devkit/documents/Task) \| { `configuration?`: `string` ; `project`: `string` ; `target`: `string` } |
+| `overrides` | `any`                                                                                                              |
+| `node`      | [`ProjectGraphProjectNode`](../../devkit/documents/ProjectGraphProjectNode)                                        |
 
 #### Returns
 

diff --git a/e2e/angular-core/src/config.test.ts b/e2e/angular-core/src/config.test.ts
@@ -130,7 +130,7 @@ const angularV1Json = (appName: string) => `{
         },
         "test": {
           "builder": "@nx/jest:jest",
-          "outputs": ["coverage${appName}"],
+          "outputs": ["{workspaceRoot}/coverage${appName}"],
           "options": {
             "jestConfig": "${appName}/jest.config.ts",
             "passWithNoTests": true

diff --git a/e2e/next-core/src/next-webpack.test.ts b/e2e/next-core/src/next-webpack.test.ts
@@ -84,7 +84,7 @@ describe('Next.js Webpack', () => {
     updateJson(join('apps', appName, 'project.json'), (json) => {
       json.targets.build = {
         command: 'npx next build',
-        outputs: [`apps/${appName}/.next`],
+        outputs: [`{projectRoot}/.next`],
         options: {
           cwd: `apps/${appName}`,
         },

diff --git a/e2e/nx-run/src/invoke-runner.test.ts b/e2e/nx-run/src/invoke-runner.test.ts
@@ -35,8 +35,8 @@ describe('Invoke Runner', () => {
       async function main(){
         const r = await initTasksRunner({});
 
-        await r.invoke({tasks: [{id: '${mylib}:prebuild', target: {project: '${mylib}', target: 'prebuild'}, overrides: {__overrides_unparsed__: ''}}]});
-        await r.invoke({tasks: [{id: '${mylib}:build', target: {project: '${mylib}', target: 'build'}, overrides: {__overrides_unparsed__: ''}}]});
+        await r.invoke({tasks: [{id: '${mylib}:prebuild', target: {project: '${mylib}', target: 'prebuild'}, outputs: [], overrides: {__overrides_unparsed__: ''}}]});
+        await r.invoke({tasks: [{id: '${mylib}:build', target: {project: '${mylib}', target: 'build'}, outputs: [], overrides: {__overrides_unparsed__: ''}}]});
       }
 
       main().then(q => {

diff --git a/packages/angular/src/generators/move/lib/update-ng-package.ts b/packages/angular/src/generators/move/lib/update-ng-package.ts
@@ -26,12 +26,10 @@ export function updateNgPackage(tree: Tree, schema: MoveImplOptions): void {
   );
   const outputs = getOutputsForTargetAndConfiguration(
     {
-      target: {
-        project: schema.newProjectName,
-        target: 'build',
-      },
-      overrides: {},
+      project: schema.newProjectName,
+      target: 'build',
     },
+    {},
     {
       name: schema.newProjectName,
       type: 'lib',

diff --git a/packages/js/src/utils/buildable-libs-utils.spec.ts b/packages/js/src/utils/buildable-libs-utils.spec.ts
@@ -293,26 +293,31 @@ describe('calculateDependenciesFromTaskGraph', () => {
           id: 'lib1:build',
           overrides: {},
           target: { project: 'lib1', target: 'build' },
+          outputs: [],
         },
         'lib2:build': {
           id: 'lib2:build',
           overrides: {},
           target: { project: 'lib2', target: 'build' },
+          outputs: [],
         },
         'lib2:build-base': {
           id: 'lib2:build-base',
           overrides: {},
           target: { project: 'lib2', target: 'build-base' },
+          outputs: [],
         },
         'lib3:build': {
           id: 'lib3:build',
           overrides: {},
           target: { project: 'lib3', target: 'build' },
+          outputs: [],
         },
         'lib4:build': {
           id: 'lib4:build',
           overrides: {},
           target: { project: 'lib4', target: 'build' },
+          outputs: [],
         },
       },
     };
@@ -458,41 +463,49 @@ describe('calculateDependenciesFromTaskGraph', () => {
           id: 'lib1:build',
           overrides: {},
           target: { project: 'lib1', target: 'build' },
+          outputs: [],
         },
         'lib1:build-base': {
           id: 'lib1:build-base',
           overrides: {},
           target: { project: 'lib1', target: 'build-base' },
+          outputs: [],
         },
         'lib2:build': {
           id: 'lib2:build',
           overrides: {},
           target: { project: 'lib2', target: 'build' },
+          outputs: [],
         },
         'lib2:build-base': {
           id: 'lib2:build-base',
           overrides: {},
           target: { project: 'lib2', target: 'build-base' },
+          outputs: [],
         },
         'lib3:build': {
           id: 'lib3:build',
           overrides: {},
           target: { project: 'lib3', target: 'build' },
+          outputs: [],
         },
         'lib3:build-base': {
           id: 'lib3:build-base',
           overrides: {},
           target: { project: 'lib3', target: 'build-base' },
+          outputs: [],
         },
         'lib4:build': {
           id: 'lib4:build',
           overrides: {},
           target: { project: 'lib4', target: 'build' },
+          outputs: [],
         },
         'lib4:build-base': {
           id: 'lib4:build-base',
           overrides: {},
           target: { project: 'lib4', target: 'build-base' },
+          outputs: [],
         },
       },
     };

diff --git a/packages/js/src/utils/buildable-libs-utils.ts b/packages/js/src/utils/buildable-libs-utils.ts
@@ -124,13 +124,11 @@ export function calculateProjectDependencies(
               : dep,
             outputs: getOutputsForTargetAndConfiguration(
               {
-                overrides: {},
-                target: {
-                  project: projectName,
-                  target: targetName,
-                  configuration: configurationName,
-                },
+                project: projectName,
+                target: targetName,
+                configuration: configurationName,
               },
+              {},
               depNode
             ),
             node: depNode,
@@ -260,7 +258,11 @@ export function calculateDependenciesFromTaskGraph(
       return null;
     }
 
-    let outputs = getOutputsForTargetAndConfiguration(depTask, depProjectNode);
+    let outputs = getOutputsForTargetAndConfiguration(
+      depTask.target,
+      depTask.overrides,
+      depProjectNode
+    );
 
     if (outputs.length === 0) {
       nonBuildableDependencies.push(depTask.target.project);
@@ -558,13 +560,11 @@ export function updateBuildableProjectPackageJsonDependencies(
 ) {
   const outputs = getOutputsForTargetAndConfiguration(
     {
-      overrides: {},
-      target: {
-        project: projectName,
-        target: targetName,
-        configuration: configurationName,
-      },
+      project: projectName,
+      target: targetName,
+      configuration: configurationName,
     },
+    {},
     node
   );
 
@@ -598,13 +598,11 @@ export function updateBuildableProjectPackageJsonDependencies(
         if (entry.node.type === 'lib') {
           const outputs = getOutputsForTargetAndConfiguration(
             {
-              overrides: {},
-              target: {
-                project: projectName,
-                target: targetName,
-                configuration: configurationName,
-              },
+              project: projectName,
+              target: targetName,
+              configuration: configurationName,
             },
+            {},
             entry.node
           );
 

diff --git a/packages/js/src/utils/package-json/update-package-json.ts b/packages/js/src/utils/package-json/update-package-json.ts
@@ -175,13 +175,11 @@ function addMissingDependencies(
       ) {
         const outputs = getOutputsForTargetAndConfiguration(
           {
-            overrides: {},
-            target: {
-              project: projectName,
-              target: targetName,
-              configuration: configurationName,
-            },
+            project: projectName,
+            target: targetName,
+            configuration: configurationName,
           },
+          {},
           entry.node
         );
 

diff --git a/packages/nx/src/command-line/affected/print-affected.ts b/packages/nx/src/command-line/affected/print-affected.ts
@@ -1,4 +1,4 @@
-import { getCommandAsString, getOutputs } from '../../tasks-runner/utils';
+import { getCommandAsString } from '../../tasks-runner/utils';
 import * as yargs from 'yargs';
 import type { NxArgs } from '../../utils/command-line-utils';
 import {
@@ -95,7 +95,7 @@ async function createTasks(
     target: task.target,
     hash: task.hash,
     command: getCommandAsString(execCommand, task),
-    outputs: getOutputs(projectGraph.nodes, task),
+    outputs: task.outputs,
   }));
 }
 

diff --git a/packages/nx/src/config/task-graph.ts b/packages/nx/src/config/task-graph.ts
@@ -27,6 +27,11 @@ export interface Task {
    * Overrides for the configured options of the target
    */
   overrides: any;
+
+  /**
+   * The outputs the task may produce
+   */
+  outputs: string[];
   /**
    * Root of the project the task belongs to
    */

diff --git a/packages/nx/src/hasher/__snapshots__/task-hasher.spec.ts.snap b/packages/nx/src/hasher/__snapshots__/task-hasher.spec.ts.snap
@@ -7,7 +7,7 @@ exports[`TaskHasher dependentTasksOutputFiles should depend on dependent tasks o
     "implicitDeps": {},
     "nodes": {
       "AllExternalDependencies": "3244421341483603138",
-      "ProjectConfiguration": "12802727827024321009",
+      "ProjectConfiguration": "16743571606168248002",
       "TsConfig": "8767608672024750088",
       "dist/libs/child/index.d.ts": "3244421341483603138",
       "dist/libs/grandchild/index.d.ts": "3244421341483603138",
@@ -18,7 +18,7 @@ exports[`TaskHasher dependentTasksOutputFiles should depend on dependent tasks o
     },
     "runtime": {},
   },
-  "value": "15526362704205124469",
+  "value": "14131423056691033336",
 }
 `;
 
@@ -29,7 +29,7 @@ exports[`TaskHasher dependentTasksOutputFiles should work with dependent tasks w
     "implicitDeps": {},
     "nodes": {
       "AllExternalDependencies": "3244421341483603138",
-      "ProjectConfiguration": "12802727827024321009",
+      "ProjectConfiguration": "16743571606168248002",
       "TsConfig": "8767608672024750088",
       "dist/libs/child/index.d.ts": "3244421341483603138",
       "dist/libs/grandchild/index.d.ts": "3244421341483603138",
@@ -40,7 +40,7 @@ exports[`TaskHasher dependentTasksOutputFiles should work with dependent tasks w
     },
     "runtime": {},
   },
-  "value": "15526362704205124469",
+  "value": "14131423056691033336",
 }
 `;