feat(misc): add alternative implementation to calculate buildable dependencies using the task graph (nrwl#18125)

Author: leosvelperez

e2e/js/src/js.test.ts

@@ -4,7 +4,9 @@ import {
   cleanupProject,
   createFile,
   newProject,
+  readFile,
   readJson,
+  rmDist,
   runCLI,
   runCLIAsync,
   uniq,
@@ -160,4 +162,72 @@ export function ${lib}Wildcard() {
     runCLI(`build ${nonBuildable}`);
     checkFilesExist(`dist/libs/${nonBuildable}/src/index.js`);
   });
+
+  it('should build buildable libraries using the task graph and handle more scenarios than current implementation', () => {
+    const lib1 = uniq('lib1');
+    const lib2 = uniq('lib2');
+    runCLI(`generate @nx/js:lib ${lib1} --bundler=tsc --no-interactive`);
+    runCLI(`generate @nx/js:lib ${lib2} --bundler=tsc --no-interactive`);
+
+    // add dep between lib1 and lib2
+    updateFile(
+      `libs/${lib1}/src/index.ts`,
+      `export { ${lib2} } from '@${scope}/${lib2}';`
+    );
+
+    // check current implementation
+    expect(runCLI(`build ${lib1} --skip-nx-cache`)).toContain(
+      'Done compiling TypeScript files'
+    );
+    checkFilesExist(`dist/libs/${lib1}/src/index.js`);
+    checkFilesExist(`dist/libs/${lib2}/src/index.js`);
+
+    // cleanup dist
+    rmDist();
+
+    // check task graph implementation
+    expect(
+      runCLI(`build ${lib1} --skip-nx-cache`, {
+        env: { NX_BUILDABLE_LIBRARIES_TASK_GRAPH: 'true' },
+      })
+    ).toContain('Done compiling TypeScript files');
+    checkFilesExist(`dist/libs/${lib1}/src/index.js`);
+    checkFilesExist(`dist/libs/${lib2}/src/index.js`);
+
+    // change build target name of lib2 and update target dependencies
+    updateJson(`libs/${lib2}/project.json`, (json) => {
+      json.targets['my-custom-build'] = json.targets.build;
+      delete json.targets.build;
+      return json;
+    });
+    const originalNxJson = readFile('nx.json');
+    updateJson('nx.json', (json) => {
+      json.targetDefaults.build = {
+        ...json.targetDefaults.build,
+        dependsOn: [...json.targetDefaults.build.dependsOn, '^my-custom-build'],
+      };
+      return json;
+    });
+
+    // cleanup dist
+    rmDist();
+
+    // check current implementation, it doesn't support a different build target name
+    expect(() => runCLI(`build ${lib1} --skip-nx-cache`)).toThrow();
+
+    // cleanup dist
+    rmDist();
+
+    // check task graph implementation
+    expect(
+      runCLI(`build ${lib1} --skip-nx-cache`, {
+        env: { NX_BUILDABLE_LIBRARIES_TASK_GRAPH: 'true' },
+      })
+    ).toContain('Done compiling TypeScript files');
+    checkFilesExist(`dist/libs/${lib1}/src/index.js`);
+    checkFilesExist(`dist/libs/${lib2}/src/index.js`);
+
+    // restore nx.json
+    updateFile('nx.json', () => originalNxJson);
+  });
 });

packages/angular/src/executors/delegate-build/delegate-build.impl.ts

@@ -1,7 +1,7 @@
 import type { ExecutorContext } from '@nx/devkit';
 import { joinPathFragments, parseTargetString, runExecutor } from '@nx/devkit';
 import {
-  calculateProjectDependencies,
+  calculateProjectBuildableDependencies,
   checkDependentProjectsHaveBeenBuilt,
   createTmpTsConfig,
 } from '@nx/js/src/utils/buildable-libs-utils';
@@ -11,7 +11,8 @@ export async function* delegateBuildExecutor(
   options: DelegateBuildExecutorSchema,
   context: ExecutorContext
 ) {
-  const { target, dependencies } = calculateProjectDependencies(
+  const { target, dependencies } = calculateProjectBuildableDependencies(
+    context.taskGraph,
     context.projectGraph,
     context.root,
     context.projectName,

packages/angular/src/executors/ng-packagr-lite/ng-packagr-lite.impl.spec.ts

@@ -30,7 +30,7 @@ describe('NgPackagrLite executor', () => {
 
   beforeEach(async () => {
     (
-      buildableLibsUtils.calculateProjectDependencies as jest.Mock
+      buildableLibsUtils.calculateProjectBuildableDependencies as jest.Mock
     ).mockImplementation(() => ({
       target: {},
       dependencies: [],

packages/angular/src/executors/package/package.impl.spec.ts

@@ -30,7 +30,7 @@ describe('Package executor', () => {
 
   beforeEach(async () => {
     (
-      buildableLibsUtils.calculateProjectDependencies as jest.Mock
+      buildableLibsUtils.calculateProjectBuildableDependencies as jest.Mock
     ).mockImplementation(() => ({
       target: {},
       dependencies: [],

packages/angular/src/executors/package/package.impl.ts

@@ -1,7 +1,7 @@
 import type { ExecutorContext } from '@nx/devkit';
 import { eachValueFrom } from '@nx/devkit/src/utils/rxjs-for-await';
 import {
-  calculateProjectDependencies,
+  calculateProjectBuildableDependencies,
   checkDependentProjectsHaveBeenBuilt,
   createTmpTsConfig,
   DependentBuildableProjectNode,
@@ -72,7 +72,8 @@ export function createLibraryExecutor(
     context: ExecutorContext
   ) {
     const { target, dependencies, topLevelDependencies } =
-      calculateProjectDependencies(
+      calculateProjectBuildableDependencies(
+        context.taskGraph,
         context.projectGraph,
         context.root,
         context.projectName,

packages/js/src/executors/node/node.impl.ts

@@ -17,7 +17,7 @@ import * as path from 'path';
 import { join } from 'path';
 
 import { InspectType, NodeExecutorOptions } from './schema';
-import { calculateProjectDependencies } from '../../utils/buildable-libs-utils';
+import { calculateProjectBuildableDependencies } from '../../utils/buildable-libs-utils';
 import { killTree } from './lib/kill-tree';
 import { fileExists } from 'nx/src/utils/fileutils';
 import { getMainFileDirRelativeToProjectRoot } from '../../utils/get-main-file-dir';
@@ -314,7 +314,8 @@ function calculateResolveMappings(
   options: NodeExecutorOptions
 ) {
   const parsed = parseTargetString(options.buildTarget, context.projectGraph);
-  const { dependencies } = calculateProjectDependencies(
+  const { dependencies } = calculateProjectBuildableDependencies(
+    context.taskGraph,
     context.projectGraph,
     context.root,
     parsed.project,

packages/js/src/executors/tsc/lib/batch/build-task-info-per-tsconfig-map.ts

@@ -2,7 +2,7 @@ import type { ExecutorContext } from '@nx/devkit';
 import { parseTargetString } from '@nx/devkit';
 import { join, relative } from 'path';
 import { CopyAssetsHandler } from '../../../../utils/assets/copy-assets-handler';
-import { calculateProjectDependencies } from '../../../../utils/buildable-libs-utils';
+import { calculateProjectBuildableDependencies } from '../../../../utils/buildable-libs-utils';
 import type { NormalizedExecutorOptions } from '../../../../utils/schema';
 import { getTaskWithTscExecutorOptions } from '../get-task-options';
 import type { TypescriptInMemoryTsConfig } from '../typescript-compilation';
@@ -97,7 +97,8 @@ function createTaskInfo(
   const {
     target: projectGraphNode,
     dependencies: buildableProjectNodeDependencies,
-  } = calculateProjectDependencies(
+  } = calculateProjectBuildableDependencies(
+    context.taskGraph,
     context.projectGraph,
     context.root,
     context.taskGraph.tasks[taskName].target.project,