feat(core): support for async createNodes functions

nrwl · Nov 9, 2023 · 9fa559e · 9fa559e
1 parent ced983d
commit 9fa559e
Show file tree

Hide file tree

Showing 23 changed files with 408 additions and 210 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/FileChange.md b/docs/generated/devkit/FileChange.md
@@ -9,7 +9,7 @@ Description of a file change in the Nx virtual file system/
 - [content](../../devkit/documents/FileChange#content): Buffer
 - [options](../../devkit/documents/FileChange#options): TreeWriteOptions
 - [path](../../devkit/documents/FileChange#path): string
-- [type](../../devkit/documents/FileChange#type): &quot;DELETE&quot; | &quot;CREATE&quot; | &quot;UPDATE&quot;
+- [type](../../devkit/documents/FileChange#type): &quot;CREATE&quot; | &quot;DELETE&quot; | &quot;UPDATE&quot;
 
 ## Properties
 
@@ -39,6 +39,6 @@ Path relative to the workspace root
 
 ### type
 
-• **type**: `"DELETE"` \| `"CREATE"` \| `"UPDATE"`
+• **type**: `"CREATE"` \| `"DELETE"` \| `"UPDATE"`
 
 Type of change: 'CREATE' | 'DELETE' | 'UPDATE'
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/packages/nx/src/config/workspaces.ts b/packages/nx/src/config/workspaces.ts
@@ -3,7 +3,7 @@ import { dirname } from 'path';
 import type { NxJsonConfiguration } from './nx-json';
 import { readNxJson } from './nx-json';
 import { ProjectsConfigurations } from './workspace-json-project-json';
-import { retrieveProjectConfigurationsSync } from '../project-graph/utils/retrieve-workspace-files';
+import { retrieveProjectConfigurationsSync } from '../project-graph/utils/retrieve-workspace-files.deprecated';
 
 // TODO(v18): remove this class
 /**

diff --git a/packages/nx/src/devkit-exports.ts b/packages/nx/src/devkit-exports.ts
@@ -51,7 +51,9 @@ export type {
   NxPluginV2,
   ProjectTargetConfigurator,
   CreateNodes,
+  CreateNodesAsync,
   CreateNodesFunction,
+  CreateNodesResult,
   CreateNodesContext,
   CreateDependencies,
   CreateDependenciesContext,

diff --git a/packages/nx/src/native/index.d.ts b/packages/nx/src/native/index.d.ts
@@ -137,9 +137,9 @@ export class Watcher {
 export class WorkspaceContext {
   workspaceRoot: string
   constructor(workspaceRoot: string)
-  getWorkspaceFiles(globs: Array<string>, parseConfigurations: (arg0: Array<string>) => Promise<ConfigurationParserResult>): object | null
+  getWorkspaceFiles(globs: Array<string>, parseConfigurations: (arg0: Array<string>) => Promise<ConfigurationParserResult>): Promise<NxWorkspaceFiles>
   glob(globs: Array<string>): Array<string>
-  getProjectConfigurations(globs: Array<string>, parseConfigurations: (arg0: Array<string>) => Promise<ConfigurationParserResult>): object
+  getProjectConfigurations(globs: Array<string>, parseConfigurations: (arg0: Array<string>) => Promise<ConfigurationParserResult>): Promise<ConfigurationParserResult>
   incrementalUpdate(updatedFiles: Array<string>, deletedFiles: Array<string>): Record<string, string>
   allFileData(): Array<FileData>
 }
diff --git a/packages/nx/src/native/workspace/config_files.rs b/packages/nx/src/native/workspace/config_files.rs
@@ -1,7 +1,7 @@
 use crate::native::utils::glob::build_glob_set;
 use crate::native::utils::path::Normalize;
 use crate::native::workspace::types::ConfigurationParserResult;
-use napi::bindgen_prelude::{Object, Promise};
+use napi::bindgen_prelude::Promise;
 
 use crate::native::workspace::errors::{InternalWorkspaceErrors, WorkspaceErrors};
 use rayon::prelude::*;

diff --git a/packages/nx/src/native/workspace/context.rs b/packages/nx/src/native/workspace/context.rs
@@ -16,7 +16,6 @@ use xxhash_rust::xxh3;
 
 use crate::native::walker::nx_walker;
 use crate::native::workspace::errors::WorkspaceErrors;
-use crate::native::workspace::workspace_files::NxWorkspaceFiles;
 use crate::native::workspace::{config_files, workspace_files};
 
 use crate::native::workspace::types::ConfigurationParserResult;
@@ -147,7 +146,7 @@ impl WorkspaceContext {
         }
     }
 
-    #[napi]
+    #[napi(ts_return_type = "Promise<NxWorkspaceFiles>")]
     pub fn get_workspace_files<ConfigurationParser>(
         &self,
         env: Env,
@@ -180,7 +179,7 @@ impl WorkspaceContext {
         )
     }
 
-    #[napi]
+    #[napi(ts_return_type = "Promise<ConfigurationParserResult>")]
     pub fn get_project_configurations<ConfigurationParser>(
         &self,
         env: Env,

diff --git a/packages/nx/src/native/workspace/types.rs b/packages/nx/src/native/workspace/types.rs
@@ -1,6 +1,5 @@
 use std::collections::HashMap;
 
-use napi::JsObject;
 use serde_json::Value;
 
 #[derive(Debug, Eq, PartialEq)]

diff --git a/packages/nx/src/native/workspace/workspace_files.rs b/packages/nx/src/native/workspace/workspace_files.rs
@@ -2,15 +2,14 @@ use napi::bindgen_prelude::{Object, Promise};
 use std::collections::HashMap;
 use std::path::{Path, PathBuf};
 
-use napi::{Env, JsObject};
+use napi::Env;
 use rayon::prelude::*;
 use serde_json::Value;
 use tracing::trace;
 
 use crate::native::types::FileData;
 use crate::native::utils::path::Normalize;
 use crate::native::workspace::config_files;
-use crate::native::workspace::errors::{InternalWorkspaceErrors, WorkspaceErrors};
 use crate::native::workspace::types::{ConfigurationParserResult, FileLocation};
 
 #[napi(object)]

diff --git a/packages/nx/src/plugins/project-json/build-nodes/project-json.ts b/packages/nx/src/plugins/project-json/build-nodes/project-json.ts
@@ -3,9 +3,9 @@ import { dirname, join } from 'node:path';
 import { ProjectConfiguration } from '../../../config/workspace-json-project-json';
 import { toProjectName } from '../../../config/workspaces';
 import { readJsonFile } from '../../../utils/fileutils';
-import { NxPluginV2 } from '../../../utils/nx-plugin';
+import { CreateNodes, NxPluginV2 } from '../../../utils/nx-plugin';
 
-export const CreateProjectJsonProjectsPlugin: NxPluginV2 = {
+export const CreateProjectJsonProjectsPlugin: NxPluginV2<void, CreateNodes> = {
   name: 'nx-core-build-project-json-nodes',
   createNodes: [
     '{project.json,**/project.json}',

diff --git a/packages/nx/src/project-graph/file-utils.ts b/packages/nx/src/project-graph/file-utils.ts
@@ -14,7 +14,7 @@ import {
 } from './project-graph';
 import { toOldFormat } from '../adapter/angular-json';
 import { getIgnoreObject } from '../utils/ignore';
-import { retrieveProjectConfigurationsSync } from './utils/retrieve-workspace-files';
+import { retrieveProjectConfigurationsSync } from './utils/retrieve-workspace-files.deprecated';
 
 export interface Change {
   type: string;