feat(core): move plugins apis to support async create nodes

nrwl · Nov 13, 2023 · 2a2ec8e · 2a2ec8e
1 parent b13c137
commit 2a2ec8e
Show file tree

Hide file tree

Showing 42 changed files with 530 additions and 420 deletions.
diff --git a/docs/generated/devkit/CreateNodesAsync.md b/docs/generated/devkit/CreateNodesAsync.md
@@ -0,0 +1,9 @@
+# Type alias: CreateNodesAsync<T\>
+
+Ƭ **CreateNodesAsync**<`T`\>: readonly [projectFilePattern: string, createNodesFunction: CreateNodesFunctionAsync<T\>]
+
+#### Type parameters
+
+| Name | Type      |
+| :--- | :-------- |
+| `T`  | `unknown` |
diff --git a/docs/generated/devkit/CreateNodesFunction.md b/docs/generated/devkit/CreateNodesFunction.md
@@ -1,6 +1,6 @@
 # Type alias: CreateNodesFunction<T\>
 
-Ƭ **CreateNodesFunction**<`T`\>: (`projectConfigurationFile`: `string`, `options`: `T` \| `undefined`, `context`: [`CreateNodesContext`](../../devkit/documents/CreateNodesContext)) => { `externalNodes?`: `Record`<`string`, [`ProjectGraphExternalNode`](../../devkit/documents/ProjectGraphExternalNode)\> ; `projects?`: `Record`<`string`, `Optional`<[`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration), `"root"`\>\> }
+Ƭ **CreateNodesFunction**<`T`\>: (`projectConfigurationFile`: `string`, `options`: `T` \| `undefined`, `context`: [`CreateNodesContext`](../../devkit/documents/CreateNodesContext)) => [`CreateNodesResult`](../../devkit/documents/CreateNodesResult)
 
 #### Type parameters
 
@@ -10,7 +10,7 @@
 
 #### Type declaration
 
-▸ (`projectConfigurationFile`, `options`, `context`): `Object`
+▸ (`projectConfigurationFile`, `options`, `context`): [`CreateNodesResult`](../../devkit/documents/CreateNodesResult)
 
 A function which parses a configuration file into a set of nodes.
 Used for creating nodes for the [ProjectGraph](../../devkit/documents/ProjectGraph)
@@ -25,9 +25,4 @@ Used for creating nodes for the [ProjectGraph](../../devkit/documents/ProjectGra
 
 ##### Returns
 
-`Object`
-
-| Name             | Type                                                                                                              | Description                                                                                                |
-| :--------------- | :---------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------- |
-| `externalNodes?` | `Record`<`string`, [`ProjectGraphExternalNode`](../../devkit/documents/ProjectGraphExternalNode)\>                | A map of external node name -> external node. External nodes do not have a root, so the key is their name. |
-| `projects?`      | `Record`<`string`, `Optional`<[`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration), `"root"`\>\> | A map of project root -> project configuration                                                             |
+[`CreateNodesResult`](../../devkit/documents/CreateNodesResult)
diff --git a/docs/generated/devkit/CreateNodesResult.md b/docs/generated/devkit/CreateNodesResult.md
@@ -0,0 +1,24 @@
+# Interface: CreateNodesResult
+
+## Table of contents
+
+### Properties
+
+- [externalNodes](../../devkit/documents/CreateNodesResult#externalnodes): Record&lt;string, ProjectGraphExternalNode&gt;
+- [projects](../../devkit/documents/CreateNodesResult#projects): Record&lt;string, Optional&lt;ProjectConfiguration, &quot;root&quot;&gt;&gt;
+
+## Properties
+
+### externalNodes
+
+• `Optional` **externalNodes**: `Record`<`string`, [`ProjectGraphExternalNode`](../../devkit/documents/ProjectGraphExternalNode)\>
+
+A map of external node name -> external node. External nodes do not have a root, so the key is their name.
+
+---
+
+### projects
+
+• `Optional` **projects**: `Record`<`string`, `Optional`<[`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration), `"root"`\>\>
+
+A map of project root -> project configuration
diff --git a/docs/generated/devkit/NxPluginV2.md b/docs/generated/devkit/NxPluginV2.md
@@ -1,19 +1,20 @@
-# Type alias: NxPluginV2<T\>
+# Type alias: NxPluginV2<TOptions, TCreateNodes\>
 
-Ƭ **NxPluginV2**<`T`\>: `Object`
+Ƭ **NxPluginV2**<`TOptions`, `TCreateNodes`\>: `Object`
 
 A plugin for Nx which creates nodes and dependencies for the [ProjectGraph](../../devkit/documents/ProjectGraph)
 
 #### Type parameters
 
-| Name | Type      |
-| :--- | :-------- |
-| `T`  | `unknown` |
+| Name           | Type                                                                                                                                                                                                                                                                                                    |
+| :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `TOptions`     | `unknown`                                                                                                                                                                                                                                                                                               |
+| `TCreateNodes` | extends [`CreateNodes`](../../devkit/documents/CreateNodes)<`TOptions`\> \| [`CreateNodesAsync`](../../devkit/documents/CreateNodesAsync)<`TOptions`\> = [`CreateNodes`](../../devkit/documents/CreateNodes)<`TOptions`\> \| [`CreateNodesAsync`](../../devkit/documents/CreateNodesAsync)<`TOptions`\> |
 
 #### Type declaration
 
-| Name                  | Type                                                                    | Description                                                                                                                                   |
-| :-------------------- | :---------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- |
-| `createDependencies?` | [`CreateDependencies`](../../devkit/documents/CreateDependencies)<`T`\> | Provides a function to analyze files to create dependencies for the [ProjectGraph](../../devkit/documents/ProjectGraph)                       |
-| `createNodes?`        | [`CreateNodes`](../../devkit/documents/CreateNodes)<`T`\>               | Provides a file pattern and function that retrieves configuration info from those files. e.g. { '\*_/_.csproj': buildProjectsFromCsProjFile } |
-| `name`                | `string`                                                                | -                                                                                                                                             |
+| Name                  | Type                                                                           | Description                                                                                                                                   |
+| :-------------------- | :----------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- |
+| `createDependencies?` | [`CreateDependencies`](../../devkit/documents/CreateDependencies)<`TOptions`\> | Provides a function to analyze files to create dependencies for the [ProjectGraph](../../devkit/documents/ProjectGraph)                       |
+| `createNodes?`        | `TCreateNodes`                                                                 | Provides a file pattern and function that retrieves configuration info from those files. e.g. { '\*_/_.csproj': buildProjectsFromCsProjFile } |
+| `name`                | `string`                                                                       | -                                                                                                                                             |
diff --git a/docs/generated/devkit/README.md b/docs/generated/devkit/README.md
@@ -25,6 +25,7 @@ It only uses language primitives and immutable objects
 
 - [CreateDependenciesContext](../../devkit/documents/CreateDependenciesContext)
 - [CreateNodesContext](../../devkit/documents/CreateNodesContext)
+- [CreateNodesResult](../../devkit/documents/CreateNodesResult)
 - [DefaultTasksRunnerOptions](../../devkit/documents/DefaultTasksRunnerOptions)
 - [ExecutorContext](../../devkit/documents/ExecutorContext)
 - [ExecutorsJson](../../devkit/documents/ExecutorsJson)
@@ -64,6 +65,7 @@ It only uses language primitives and immutable objects
 
 - [CreateDependencies](../../devkit/documents/CreateDependencies)
 - [CreateNodes](../../devkit/documents/CreateNodes)
+- [CreateNodesAsync](../../devkit/documents/CreateNodesAsync)
 - [CreateNodesFunction](../../devkit/documents/CreateNodesFunction)
 - [CustomHasher](../../devkit/documents/CustomHasher)
 - [DynamicDependency](../../devkit/documents/DynamicDependency)

diff --git a/docs/generated/packages/devkit/documents/nx_devkit.md b/docs/generated/packages/devkit/documents/nx_devkit.md
@@ -25,6 +25,7 @@ It only uses language primitives and immutable objects
 
 - [CreateDependenciesContext](../../devkit/documents/CreateDependenciesContext)
 - [CreateNodesContext](../../devkit/documents/CreateNodesContext)
+- [CreateNodesResult](../../devkit/documents/CreateNodesResult)
 - [DefaultTasksRunnerOptions](../../devkit/documents/DefaultTasksRunnerOptions)
 - [ExecutorContext](../../devkit/documents/ExecutorContext)
 - [ExecutorsJson](../../devkit/documents/ExecutorsJson)
@@ -64,6 +65,7 @@ It only uses language primitives and immutable objects
 
 - [CreateDependencies](../../devkit/documents/CreateDependencies)
 - [CreateNodes](../../devkit/documents/CreateNodes)
+- [CreateNodesAsync](../../devkit/documents/CreateNodesAsync)
 - [CreateNodesFunction](../../devkit/documents/CreateNodesFunction)
 - [CustomHasher](../../devkit/documents/CustomHasher)
 - [DynamicDependency](../../devkit/documents/DynamicDependency)

diff --git a/...es/angular/src/builders/module-federation-dev-server/module-federation-dev-server.impl.ts b/...es/angular/src/builders/module-federation-dev-server/module-federation-dev-server.impl.ts
@@ -203,7 +203,8 @@ function startDevRemotes(
     const { schema } = getExecutorInformation(
       collection,
       executor,
-      workspaceRoot
+      workspaceRoot,
+      workspaceProjects
     );
     if (
       (options.verbose && schema.additionalProperties) ||
@@ -223,6 +224,7 @@ function startDevRemotes(
         target: 'serve',
         configuration: context.target.configuration,
         runOptions,
+        projects: workspaceProjects,
       },
       options.verbose
     ).then((obs) => {
@@ -279,8 +281,7 @@ export function executeModuleFederationDevServerBuilder(
           configurationName: context.target.configuration,
           cwd: context.currentDirectory,
           isVerbose: options.verbose,
-          projectsConfigurations:
-            readProjectsConfigurationFromProjectGraph(projectGraph),
+          projectsConfigurations: { projects: workspaceProjects, version: 2 },
           nxJsonConfiguration: readNxJson(),
         }
       )

diff --git a/packages/angular/src/builders/module-federation-dev-ssr/module-federation-dev-ssr.impl.ts b/packages/angular/src/builders/module-federation-dev-ssr/module-federation-dev-ssr.impl.ts
@@ -98,7 +98,8 @@ export function executeModuleFederationDevSSRBuilder(
       const { schema } = getExecutorInformation(
         collection,
         executor,
-        workspaceRoot
+        workspaceRoot,
+        workspaceProjects
       );
 
       if (schema.additionalProperties || 'verbose' in schema.properties) {
@@ -141,6 +142,7 @@ export function executeModuleFederationDevSSRBuilder(
             target,
             configuration: context.target.configuration,
             runOptions,
+            projects: workspaceProjects,
           },
           options.verbose
         ).then((obs) =>

diff --git a/packages/cypress/src/utils/start-dev-server.ts b/packages/cypress/src/utils/start-dev-server.ts
@@ -194,7 +194,8 @@ ${e.message || e}`);
     const { schema } = getExecutorInformation(
       collection,
       executor,
-      context.root
+      context.root,
+      context.projectsConfigurations.projects
     );
 
     // NOTE: schema won't have a default since readTargetOptions would have

diff --git a/packages/devkit/src/executors/read-target-options.ts b/packages/devkit/src/executors/read-target-options.ts
@@ -38,7 +38,12 @@ export function readTargetOptions<T = any>(
   const ws = new Workspaces(context.root);
   const [nodeModule, executorName] = targetConfiguration.executor.split(':');
   const { schema } = getExecutorInformation
-    ? getExecutorInformation(nodeModule, executorName, context.root)
+    ? getExecutorInformation(
+        nodeModule,
+        executorName,
+        context.root,
+        context.projectsConfigurations?.projects ?? context.workspace.projects
+      )
     : // TODO(v18): remove readExecutor. This is to be backwards compatible with Nx 16.5 and below.
       (ws as any).readExecutor(nodeModule, executorName);
 

diff --git a/packages/nx/src/adapter/ngcli-adapter.ts b/packages/nx/src/adapter/ngcli-adapter.ts
@@ -35,7 +35,10 @@ import {
   getProjects,
   updateProjectConfiguration,
 } from '../generators/utils/project-configuration';
-import { createProjectGraphAsync } from '../project-graph/project-graph';
+import {
+  createProjectGraphAsync,
+  readProjectsConfigurationFromProjectGraph,
+} from '../project-graph/project-graph';
 import { readJsonFile } from '../utils/fileutils';
 import { getNxRequirePaths } from '../utils/installation-directory';
 import { parseJson } from '../utils/json';
@@ -79,7 +82,8 @@ export async function createBuilderContext(
   );
   const architectHost = await getWrappedWorkspaceNodeModulesArchitectHost(
     workspace,
-    context.root
+    context.root,
+    context.projectsConfigurations.projects
   );
 
   const registry = new schema.CoreSchemaRegistry();
@@ -156,6 +160,7 @@ export async function scheduleTarget(
     target: string;
     configuration: string;
     runOptions: any;
+    projects: Record<string, ProjectConfiguration>;
   },
   verbose: boolean
 ): Promise<Observable<import('@angular-devkit/architect').BuilderOutput>> {
@@ -177,7 +182,8 @@ export async function scheduleTarget(
 
   const architectHost = await getWrappedWorkspaceNodeModulesArchitectHost(
     workspace,
-    root
+    root,
+    opts.projects
   );
   const architect: Architect = new Architect(architectHost, registry);
   const run = await architect.scheduleTarget(
@@ -204,7 +210,8 @@ export async function scheduleTarget(
 }
 
 function createNodeModulesEngineHost(
-  resolvePaths: string[]
+  resolvePaths: string[],
+  projects: Record<string, ProjectConfiguration>
 ): import('@angular-devkit/schematics/tools').NodeModulesEngineHost {
   const NodeModulesEngineHost = require('@angular-devkit/schematics/tools')
     .NodeModulesEngineHost as typeof import('@angular-devkit/schematics/tools').NodeModulesEngineHost;
@@ -226,7 +233,7 @@ function createNodeModulesEngineHost(
         const {
           json: { generators, schematics },
           path: packageJsonPath,
-        } = readPluginPackageJson(name, paths);
+        } = readPluginPackageJson(name, projects, paths);
 
         if (!schematics && !generators) {
           throw new Error(
@@ -255,7 +262,8 @@ function createNodeModulesEngineHost(
 function createWorkflow(
   fsHost: virtualFs.Host<Stats>,
   root: string,
-  opts: any
+  opts: any,
+  projects: Record<string, ProjectConfiguration>
 ): import('@angular-devkit/schematics/tools').NodeWorkflow {
   const NodeWorkflow: typeof import('@angular-devkit/schematics/tools').NodeWorkflow =
     require('@angular-devkit/schematics/tools').NodeWorkflow;
@@ -269,7 +277,7 @@ function createWorkflow(
     ),
     resolvePaths: [process.cwd(), root],
     engineHostCreator: (options) =>
-      createNodeModulesEngineHost(options.resolvePaths),
+      createNodeModulesEngineHost(options.resolvePaths, projects),
   });
   workflow.registry.addPostTransform(schema.transforms.addUndefinedDefaults);
   workflow.engineHost.registerOptionsTransform(
@@ -676,6 +684,7 @@ function findMatchingFileChange(host: Tree, path: Path) {
 export async function generate(
   root: string,
   opts: GenerateOptions,
+  projects: Record<string, ProjectConfiguration>,
   verbose: boolean
 ) {
   const logger = getLogger(verbose);
@@ -687,7 +696,7 @@ export async function generate(
       `ng-cli generator: ${opts.collectionName}:${opts.generatorName}`
     )
   );
-  const workflow = createWorkflow(fsHost, root, opts);
+  const workflow = createWorkflow(fsHost, root, opts, projects);
   const collection = getCollection(workflow, opts.collectionName);
   const schematic = collection.createSchematic(opts.generatorName, true);
   return (
@@ -769,6 +778,7 @@ export async function runMigration(
   root: string,
   packageName: string,
   migrationName: string,
+  projects: Record<string, ProjectConfiguration>,
   isVerbose: boolean
 ) {
   const logger = getLogger(isVerbose);
@@ -780,7 +790,7 @@ export async function runMigration(
       `ng-cli migration: ${packageName}:${migrationName}`
     )
   );
-  const workflow = createWorkflow(fsHost, root, {});
+  const workflow = createWorkflow(fsHost, root, {}, projects);
   const collection = resolveMigrationsCollection(packageName);
 
   const record = { loggingQueue: [] as string[], error: false };
@@ -889,6 +899,9 @@ export function wrapAngularDevkitSchematic(
   require('./compat');
 
   return async (host: Tree, generatorOptions: { [k: string]: any }) => {
+    const graph = await createProjectGraphAsync();
+    const { projects } = readProjectsConfigurationFromProjectGraph(graph);
+
     if (
       mockedSchematics &&
       mockedSchematics[`${collectionName}:${generatorName}`]
@@ -950,7 +963,7 @@ export function wrapAngularDevkitSchematic(
       defaults: false,
       quiet: false,
     };
-    const workflow = createWorkflow(fsHost, host.root, options);
+    const workflow = createWorkflow(fsHost, host.root, options, projects);
 
     // used for testing
     if (collectionResolutionOverrides) {
@@ -1053,14 +1066,19 @@ function saveProjectsConfigurationsInWrappedSchematic(
 
 async function getWrappedWorkspaceNodeModulesArchitectHost(
   workspace: workspaces.WorkspaceDefinition,
-  root: string
+  root: string,
+  projects: Record<string, ProjectConfiguration>
 ) {
   const {
     WorkspaceNodeModulesArchitectHost: AngularWorkspaceNodeModulesArchitectHost,
   } = await import('@angular-devkit/architect/node');
 
   class WrappedWorkspaceNodeModulesArchitectHost extends AngularWorkspaceNodeModulesArchitectHost {
-    constructor(private workspace, private root) {
+    constructor(
+      private workspace,
+      private root: string,
+      private projects: Record<string, ProjectConfiguration>
+    ) {
       super(workspace, root);
     }
 
@@ -1090,6 +1108,7 @@ async function getWrappedWorkspaceNodeModulesArchitectHost(
       const { json: packageJson, path: packageJsonPath } =
         readPluginPackageJson(
           nodeModule,
+          this.projects,
           this.root ? [this.root, __dirname] : [__dirname]
         );
       const executorsFile = packageJson.executors ?? packageJson.builders;
@@ -1170,5 +1189,9 @@ async function getWrappedWorkspaceNodeModulesArchitectHost(
     }
   }
 
-  return new WrappedWorkspaceNodeModulesArchitectHost(workspace, root);
+  return new WrappedWorkspaceNodeModulesArchitectHost(
+    workspace,
+    root,
+    projects
+  );
 }