nx 19.7.0-canary.20240828-13170da → 19.7.0-canary.20240830-83a387a

package/src/daemon/server/sync-generators.js

@@ -4,6 +4,7 @@ exports.getCachedSyncGeneratorChanges = getCachedSyncGeneratorChanges;
 exports.flushSyncGeneratorChangesToDisk = flushSyncGeneratorChangesToDisk;
 exports.collectAndScheduleSyncGenerators = collectAndScheduleSyncGenerators;
 exports.getCachedRegisteredSyncGenerators = getCachedRegisteredSyncGenerators;
+exports._getConflictingGeneratorGroups = _getConflictingGeneratorGroups;
 const nx_json_1 = require("../../config/nx-json");
 const tree_1 = require("../../generators/tree");
 const file_hasher_1 = require("../../hasher/file-hasher");
@@ -21,10 +22,10 @@ let registeredSyncGenerators;
 let scheduledTimeoutId;
 let storedProjectGraphHash;
 let storedNxJsonHash;
+let storedDisabledTaskSyncGeneratorsHash;
 const log = (...messageParts) => {
     logger_1.serverLogger.log('[SYNC]:', ...messageParts);
 };
-// TODO(leo): check conflicts and reuse the Tree where possible
 async function getCachedSyncGeneratorChanges(generators) {
     try {
         log('get sync generators changes on demand', generators);
@@ -36,51 +37,15 @@ async function getCachedSyncGeneratorChanges(generators) {
         }
         // reset the wait time
         waitPeriod = 100;
-        let projects;
-        let errored = false;
-        const getProjectsConfigurations = async () => {
-            if (projects || errored) {
-                return projects;
-            }
-            const { projectGraph, error } = await (0, project_graph_incremental_recomputation_1.getCachedSerializedProjectGraphPromise)();
-            projects = projectGraph
-                ? (0, project_graph_1.readProjectsConfigurationFromProjectGraph)(projectGraph).projects
-                : null;
-            errored = error !== undefined;
-            return projects;
-        };
-        return (await Promise.all(generators.map(async (generator) => {
-            if (scheduledGenerators.has(generator) ||
-                !syncGeneratorsCacheResultPromises.has(generator)) {
-                // it's scheduled to run (there are pending changes to process) or
-                // it's not scheduled and there's no cached result, so run it
-                const projects = await getProjectsConfigurations();
-                if (projects) {
-                    log(generator, 'already scheduled or not cached, running it now');
-                    runGenerator(generator, projects);
-                }
-                else {
-                    log(generator, 'already scheduled or not cached, project graph errored');
-                    /**
-                     * This should never happen. This is invoked imperatively, and by
-                     * the time it is invoked, the project graph would have already
-                     * been requested. If it errored, it would have been reported and
-                     * this wouldn't have been invoked. We handle it just in case.
-                     *
-                     * Since the project graph would be reported by the relevant
-                     * handlers separately, we just ignore the error, don't cache
-                     * any result and return an empty result, the next time this is
-                     * invoked the process will repeat until it eventually recovers
-                     * when the project graph is fixed.
-                     */
-                    return Promise.resolve({ changes: [], generatorName: generator });
-                }
-            }
-            else {
-                log(generator, 'not scheduled and has cached result, returning cached result');
-            }
-            return syncGeneratorsCacheResultPromises.get(generator);
-        }))).flat();
+        const results = await getFromCacheOrRunGenerators(generators);
+        const conflicts = _getConflictingGeneratorGroups(results);
+        if (!conflicts.length) {
+            // there are no conflicts
+            return results;
+        }
+        // there are conflicts, so we need to re-run the conflicting generators
+        // using the same tree
+        return await processConflictingGenerators(conflicts, results);
     }
     catch (e) {
         console.error(e);
@@ -107,6 +72,10 @@ function collectAndScheduleSyncGenerators(projectGraph) {
     // a change imply we need to re-run all the generators
     // make sure to schedule all the collected generators
     scheduledGenerators.clear();
+    if (!registeredSyncGenerators.size) {
+        // there are no generators to run
+        return;
+    }
     for (const generator of registeredSyncGenerators) {
         scheduledGenerators.add(generator);
     }
@@ -126,7 +95,7 @@ function collectAndScheduleSyncGenerators(projectGraph) {
         }
         const { projects } = (0, project_graph_1.readProjectsConfigurationFromProjectGraph)(projectGraph);
         for (const generator of scheduledGenerators) {
-            runGenerator(generator, projects);
+            syncGeneratorsCacheResultPromises.set(generator, runGenerator(generator, projects));
         }
         await Promise.all(syncGeneratorsCacheResultPromises.values());
     }, waitPeriod);
@@ -143,17 +112,177 @@ async function getCachedRegisteredSyncGenerators() {
     }
     return [...registeredSyncGenerators];
 }
+async function getFromCacheOrRunGenerators(generators) {
+    let projects;
+    let errored = false;
+    const getProjectsConfigurations = async () => {
+        if (projects || errored) {
+            return projects;
+        }
+        const { projectGraph, error } = await (0, project_graph_incremental_recomputation_1.getCachedSerializedProjectGraphPromise)();
+        projects = projectGraph
+            ? (0, project_graph_1.readProjectsConfigurationFromProjectGraph)(projectGraph).projects
+            : null;
+        errored = error !== undefined;
+        return projects;
+    };
+    return (await Promise.all(generators.map(async (generator) => {
+        if (scheduledGenerators.has(generator) ||
+            !syncGeneratorsCacheResultPromises.has(generator)) {
+            // it's scheduled to run (there are pending changes to process) or
+            // it's not scheduled and there's no cached result, so run it
+            const projects = await getProjectsConfigurations();
+            if (projects) {
+                log(generator, 'already scheduled or not cached, running it now');
+                syncGeneratorsCacheResultPromises.set(generator, runGenerator(generator, projects));
+            }
+            else {
+                log(generator, 'already scheduled or not cached, project graph errored');
+                /**
+                 * This should never happen. This is invoked imperatively, and by
+                 * the time it is invoked, the project graph would have already
+                 * been requested. If it errored, it would have been reported and
+                 * this wouldn't have been invoked. We handle it just in case.
+                 *
+                 * Since the project graph would be reported by the relevant
+                 * handlers separately, we just ignore the error, don't cache
+                 * any result and return an empty result, the next time this is
+                 * invoked the process will repeat until it eventually recovers
+                 * when the project graph is fixed.
+                 */
+                return Promise.resolve({ changes: [], generatorName: generator });
+            }
+        }
+        else {
+            log(generator, 'not scheduled and has cached result, returning cached result');
+        }
+        return syncGeneratorsCacheResultPromises.get(generator);
+    }))).flat();
+}
+async function runConflictingGenerators(tree, generators) {
+    const { projectGraph } = await (0, project_graph_incremental_recomputation_1.getCachedSerializedProjectGraphPromise)();
+    const projects = projectGraph
+        ? (0, project_graph_1.readProjectsConfigurationFromProjectGraph)(projectGraph).projects
+        : null;
+    if (!projects) {
+        /**
+         * This should never happen. This is invoked imperatively, and by
+         * the time it is invoked, the project graph would have already
+         * been requested. If it errored, it would have been reported and
+         * this wouldn't have been invoked. We handle it just in case.
+         *
+         * Since the project graph would be reported by the relevant
+         * handlers separately, we just ignore the error.
+         */
+        return generators.map((generator) => ({
+            changes: [],
+            generatorName: generator,
+        }));
+    }
+    // we need to run conflicting generators sequentially because they use the same tree
+    const results = [];
+    for (const generator of generators) {
+        log(generator, 'running it now');
+        results.push(await runGenerator(generator, projects, tree));
+    }
+    return results;
+}
+async function processConflictingGenerators(conflicts, initialResults) {
+    const conflictRunResults = (await Promise.all(conflicts.map((generators) => {
+        const [firstGenerator, ...generatorsToRun] = generators;
+        // it must exists because the conflicts were identified from the initial results
+        const firstGeneratorResult = initialResults.find((r) => r.generatorName === firstGenerator);
+        const tree = new tree_1.FsTree(workspace_root_1.workspaceRoot, false, `running sync generators ${generators.join(',')}`);
+        // pre-apply the changes from the first generator to avoid running it
+        for (const change of firstGeneratorResult.changes) {
+            if (change.type === 'CREATE' || change.type === 'UPDATE') {
+                tree.write(change.path, change.content, change.options);
+            }
+            else if (change.type === 'DELETE') {
+                tree.delete(change.path);
+            }
+        }
+        /**
+         * We don't cache the results of conflicting generators because they
+         * use the same tree, so some files might contain results from multiple
+         * generators and we don't have guarantees that the same combination of
+         * generators will run together.
+         */
+        return runConflictingGenerators(tree, generatorsToRun);
+    }))).flat();
+    /**
+     * The order of the results from the re-run generators is important because
+     * the last result from a group of conflicting generators will contain the
+     * changes from the previous conflicting generators. So, instead of replacing
+     * in-place the initial results, we first add the results from the re-run
+     * generators, and then add the initial results that were not from a
+     * conflicting generator.
+     */
+    const results = [...conflictRunResults];
+    for (const result of initialResults) {
+        if (conflictRunResults.every((r) => r.generatorName !== result.generatorName)) {
+            // this result is not from a conflicting generator, so we add it to the
+            // results
+            results.push(result);
+        }
+    }
+    return results;
+}
+/**
+ * @internal
+ */
+function _getConflictingGeneratorGroups(results) {
+    const changedFileToGeneratorMap = new Map();
+    for (const result of results) {
+        for (const change of result.changes) {
+            if (!changedFileToGeneratorMap.has(change.path)) {
+                changedFileToGeneratorMap.set(change.path, new Set());
+            }
+            changedFileToGeneratorMap.get(change.path).add(result.generatorName);
+        }
+    }
+    const conflicts = [];
+    for (const generatorSet of changedFileToGeneratorMap.values()) {
+        if (generatorSet.size === 1) {
+            // no conflicts
+            continue;
+        }
+        if (conflicts.length === 0) {
+            // there are no conflicts yet, so we just add the first group
+            conflicts.push(new Set(generatorSet));
+            continue;
+        }
+        // identify if any of the current generator sets intersect with any of the
+        // existing conflict groups
+        const generatorsArray = Array.from(generatorSet);
+        const existingConflictGroup = conflicts.find((group) => generatorsArray.some((generator) => group.has(generator)));
+        if (existingConflictGroup) {
+            // there's an intersecting group, so we merge the two
+            for (const generator of generatorsArray) {
+                existingConflictGroup.add(generator);
+            }
+        }
+        else {
+            // there's no intersecting group, so we create a new one
+            conflicts.push(new Set(generatorsArray));
+        }
+    }
+    return conflicts.map((group) => Array.from(group));
+}
 function collectAllRegisteredSyncGenerators(projectGraph) {
+    const nxJson = (0, nx_json_1.readNxJson)();
     const projectGraphHash = hashProjectGraph(projectGraph);
-    if (storedProjectGraphHash !== projectGraphHash) {
+    const disabledTaskSyncGeneratorsHash = (0, file_hasher_1.hashArray)(nxJson.sync?.disabledTaskSyncGenerators?.sort() ?? []);
+    if (projectGraphHash !== storedProjectGraphHash ||
+        disabledTaskSyncGeneratorsHash !== storedDisabledTaskSyncGeneratorsHash) {
         storedProjectGraphHash = projectGraphHash;
+        storedDisabledTaskSyncGeneratorsHash = disabledTaskSyncGeneratorsHash;
         registeredTaskSyncGenerators =
-            (0, sync_generators_1.collectRegisteredTaskSyncGenerators)(projectGraph);
+            (0, sync_generators_1.collectEnabledTaskSyncGeneratorsFromProjectGraph)(projectGraph, nxJson);
     }
     else {
         log('project graph hash is the same, not collecting task sync generators');
     }
-    const nxJson = (0, nx_json_1.readNxJson)();
     const nxJsonHash = (0, file_hasher_1.hashArray)(nxJson.sync?.globalGenerators?.sort() ?? []);
     if (storedNxJsonHash !== nxJsonHash) {
         storedNxJsonHash = nxJsonHash;
@@ -183,16 +312,15 @@ function collectAllRegisteredSyncGenerators(projectGraph) {
         }
     }
 }
-function runGenerator(generator, projects) {
+function runGenerator(generator, projects, tree) {
     log('running scheduled generator', generator);
     // remove it from the scheduled set
     scheduledGenerators.delete(generator);
-    const tree = new tree_1.FsTree(workspace_root_1.workspaceRoot, false, `running sync generator ${generator}`);
-    // run the generator and cache the result
-    syncGeneratorsCacheResultPromises.set(generator, (0, sync_generators_1.runSyncGenerator)(tree, generator, projects).then((result) => {
+    tree ??= new tree_1.FsTree(workspace_root_1.workspaceRoot, false, `running sync generator ${generator}`);
+    return (0, sync_generators_1.runSyncGenerator)(tree, generator, projects).then((result) => {
         log(generator, 'changes:', result.changes.map((c) => c.path).join(', '));
         return result;
-    }));
+    });
 }
 function hashProjectGraph(projectGraph) {
     const stringifiedProjects = Object.entries(projectGraph.nodes)

package/src/nx-cloud/generators/connect-to-nx-cloud/connect-to-nx-cloud.d.ts

@@ -7,7 +7,8 @@ export interface ConnectToNxCloudOptions {
     hideFormatLogs?: boolean;
     github?: boolean;
     directory?: string;
+    generateToken?: boolean;
 }
-export declare function connectToNxCloud(tree: Tree, schema: ConnectToNxCloudOptions, nxJson?: NxJsonConfiguration<string[] | "*">): Promise<string>;
+export declare function connectToNxCloud(tree: Tree, schema: ConnectToNxCloudOptions, nxJson?: NxJsonConfiguration<string[] | "*">): Promise<string | null>;
 declare function connectToNxCloudGenerator(tree: Tree, options: ConnectToNxCloudOptions): Promise<void>;
 export default connectToNxCloudGenerator;

package/src/nx-cloud/generators/connect-to-nx-cloud/connect-to-nx-cloud.js

@@ -42,18 +42,6 @@ function getNxInitDate() {
         return null;
     }
 }
-async function createNxCloudWorkspaceV1(workspaceName, installationSource, nxInitDate) {
-    const apiUrl = (0, get_cloud_options_1.getCloudUrl)();
-    const response = await require('axios').post(`${apiUrl}/nx-cloud/create-org-and-workspace`, {
-        workspaceName,
-        installationSource,
-        nxInitDate,
-    });
-    if (response.data.message) {
-        throw new Error(response.data.message);
-    }
-    return response.data;
-}
 async function createNxCloudWorkspaceV2(workspaceName, installationSource, nxInitDate) {
     const apiUrl = (0, get_cloud_options_1.getCloudUrl)();
     const response = await require('axios').post(`${apiUrl}/nx-cloud/v2/create-org-and-workspace`, {
@@ -81,19 +69,6 @@ async function printSuccessMessage(token, installationSource, usesGithub) {
     });
     return connectCloudUrl;
 }
-function addNxCloudOptionsToNxJson(tree, token, directory = '') {
-    const nxJsonPath = (0, path_1.join)(directory, 'nx.json');
-    if (tree.exists(nxJsonPath)) {
-        (0, json_1.updateJson)(tree, (0, path_1.join)(directory, 'nx.json'), (nxJson) => {
-            const overrideUrl = process.env.NX_CLOUD_API || process.env.NRWL_API;
-            if (overrideUrl) {
-                nxJson.nxCloudUrl = overrideUrl;
-            }
-            nxJson.nxCloudAccessToken = token;
-            return nxJson;
-        });
-    }
-}
 function addNxCloudIdToNxJson(tree, nxCloudId, directory = '') {
     const nxJsonPath = (0, path_1.join)(directory, 'nx.json');
     if (tree.exists(nxJsonPath)) {
@@ -113,31 +88,22 @@ async function connectToNxCloud(tree, schema, nxJson = (0, nx_json_1.readNxJson)
         printCloudConnectionDisabledMessage();
         return null;
     }
-    else {
-        const usesGithub = schema.github ?? (await (0, url_shorten_1.repoUsesGithub)(schema.github));
-        let responseFromCreateNxCloudWorkspaceV1;
-        let responseFromCreateNxCloudWorkspaceV2;
-        // do NOT create Nx Cloud token (createNxCloudWorkspace)
-        // if user is using github and is running nx-connect
-        if (!(usesGithub && schema.installationSource === 'nx-connect')) {
-            if (process.env.NX_ENABLE_LOGIN === 'true') {
-                responseFromCreateNxCloudWorkspaceV2 = await createNxCloudWorkspaceV2(getRootPackageName(tree), schema.installationSource, getNxInitDate());
-                addNxCloudIdToNxJson(tree, responseFromCreateNxCloudWorkspaceV2?.nxCloudId, schema.directory);
-                await (0, format_changed_files_with_prettier_if_available_1.formatChangedFilesWithPrettierIfAvailable)(tree, {
-                    silent: schema.hideFormatLogs,
-                });
-                return responseFromCreateNxCloudWorkspaceV2.nxCloudId;
-            }
-            else {
-                responseFromCreateNxCloudWorkspaceV1 = await createNxCloudWorkspaceV1(getRootPackageName(tree), schema.installationSource, getNxInitDate());
-                addNxCloudOptionsToNxJson(tree, responseFromCreateNxCloudWorkspaceV1?.token, schema.directory);
-                await (0, format_changed_files_with_prettier_if_available_1.formatChangedFilesWithPrettierIfAvailable)(tree, {
-                    silent: schema.hideFormatLogs,
-                });
-                return responseFromCreateNxCloudWorkspaceV1.token;
-            }
-        }
-    }
+    const isGitHubDetected = schema.github ?? (await (0, url_shorten_1.repoUsesGithub)(schema.github));
+    let responseFromCreateNxCloudWorkspaceV2;
+    /**
+     * Do not create an Nx Cloud token if the user is using GitHub and
+     * is running `nx-connect` AND `token` is undefined (override)
+     */
+    if (!schema.generateToken &&
+        isGitHubDetected &&
+        schema.installationSource === 'nx-connect')
+        return null;
+    responseFromCreateNxCloudWorkspaceV2 = await createNxCloudWorkspaceV2(getRootPackageName(tree), schema.installationSource, getNxInitDate());
+    addNxCloudIdToNxJson(tree, responseFromCreateNxCloudWorkspaceV2?.nxCloudId, schema.directory);
+    await (0, format_changed_files_with_prettier_if_available_1.formatChangedFilesWithPrettierIfAvailable)(tree, {
+        silent: schema.hideFormatLogs,
+    });
+    return responseFromCreateNxCloudWorkspaceV2.nxCloudId;
 }
 async function connectToNxCloudGenerator(tree, options) {
     await connectToNxCloud(tree, options);

package/src/nx-cloud/generators/connect-to-nx-cloud/schema.json

@@ -21,6 +21,10 @@
       "description": "Hide formatting logs",
       "x-priority": "internal"
     },
+    "generateToken": {
+      "type": "boolean",
+      "description": "Explicitly asks for a token to be created, do not override existing tokens from Nx Cloud"
+    },
     "github": {
       "type": "boolean",
       "description": "If the user will be using GitHub as their git hosting provider",

package/src/nx-cloud/update-manager.d.ts

@@ -11,7 +11,7 @@ export interface NxCloudClient {
     configureLightClientRequire: () => (paths: string[]) => void;
     commands: Record<string, () => Promise<void>>;
     nxCloudTasksRunner: TasksRunner<CloudTaskRunnerOptions>;
-    remoteCache: RemoteCacheV2;
+    getRemoteCache: () => RemoteCacheV2;
 }
 export declare function verifyOrUpdateNxCloudClient(options: CloudTaskRunnerOptions): Promise<{
     nxCloudClient: NxCloudClient;

package/src/plugins/js/project-graph/build-dependencies/target-project-locator.js

@@ -18,6 +18,13 @@ const defaultNpmResolutionCache = new Map();
 const builtInModuleSet = new Set([
     ...node_module_1.builtinModules,
     ...node_module_1.builtinModules.map((x) => `node:${x}`),
+    // These are missing in the builtinModules list
+    // See: https://github.com/nodejs/node/issues/42785
+    // TODO(v20): We should be safe to use `isBuiltin` function instead of keep the set here (https://nodejs.org/api/module.html#moduleisbuiltinmodulename)
+    'test',
+    'node:test',
+    'node:sea',
+    'node:sqlite',
 ]);
 function isBuiltinModuleImport(importExpr) {
     const packageName = (0, get_package_name_from_import_path_1.getPackageNameFromImportPath)(importExpr);
@@ -265,7 +272,7 @@ class TargetProjectLocator {
             // Resolve the main entry point of the package
             const pathOfFileInPackage = packageJsonPath ?? (0, resolve_relative_to_dir_1.resolveRelativeToDir)(packageName, relativeToDir);
             let dir = (0, node_path_1.dirname)(pathOfFileInPackage);
-            while (dir !== (0, node_path_1.parse)(dir).root) {
+            while (dir !== (0, node_path_1.dirname)(dir)) {
                 const packageJsonPath = (0, node_path_1.join)(dir, 'package.json');
                 try {
                     const parsedPackageJson = (0, fileutils_1.readJsonFile)(packageJsonPath);

package/src/tasks-runner/cache.js

@@ -81,8 +81,8 @@ class DbCache {
         if ((0, nx_cloud_utils_1.isNxCloudUsed)(nxJson)) {
             const options = (0, get_cloud_options_1.getCloudOptions)();
             const { nxCloudClient } = await (0, update_manager_1.verifyOrUpdateNxCloudClient)(options);
-            if (nxCloudClient.remoteCache) {
-                return nxCloudClient.remoteCache;
+            if (nxCloudClient.getRemoteCache) {
+                return nxCloudClient.getRemoteCache();
             }
             else {
                 // old nx cloud instance

package/src/tasks-runner/run-command.js

@@ -121,16 +121,7 @@ async function runCommand(projectsToRun, currentProjectGraph, { nxJson }, nxArgs
 async function ensureWorkspaceIsInSyncAndGetGraphs(projectGraph, nxJson, projectNames, nxArgs, overrides, extraTargetDependencies, extraOptions) {
     let taskGraph = createTaskGraphAndRunValidations(projectGraph, extraTargetDependencies ?? {}, projectNames, nxArgs, overrides, extraOptions);
     // collect unique syncGenerators from the tasks
-    const uniqueSyncGenerators = new Set();
-    for (const { target } of Object.values(taskGraph.tasks)) {
-        const { syncGenerators } = projectGraph.nodes[target.project].data.targets[target.target];
-        if (!syncGenerators) {
-            continue;
-        }
-        for (const generator of syncGenerators) {
-            uniqueSyncGenerators.add(generator);
-        }
-    }
+    const uniqueSyncGenerators = (0, sync_generators_1.collectEnabledTaskSyncGeneratorsFromTaskGraph)(taskGraph, projectGraph, nxJson);
     if (!uniqueSyncGenerators.size) {
         // There are no sync generators registered in the tasks to run
         return { projectGraph, taskGraph };

package/src/utils/git-utils.d.ts

@@ -1,6 +1,6 @@
-import { ExecSyncOptions } from 'child_process';
-export declare function cloneFromUpstream(url: string, destination: string, { originName }?: {
+export declare function cloneFromUpstream(url: string, destination: string, { originName, depth }?: {
     originName: string;
+    depth?: number;
 }): Promise<GitRepository>;
 export declare class GitRepository {
     private directory;
@@ -8,12 +8,10 @@ export declare class GitRepository {
     constructor(directory: string);
     getGitRootPath(cwd: string): string;
     addFetchRemote(remoteName: string, branch: string): Promise<string>;
-    private execAsync;
     showStat(): Promise<string>;
     listBranches(): Promise<string[]>;
     getGitFiles(path: string): Promise<string[]>;
     reset(ref: string): Promise<string>;
-    squashLastTwoCommits(): Promise<string>;
     mergeUnrelatedHistories(ref: string, message: string): Promise<string>;
     fetch(remote: string, ref?: string): Promise<string>;
     checkout(branch: string, opts: {
@@ -25,14 +23,13 @@ export declare class GitRepository {
     commit(message: string): Promise<string>;
     amendCommit(): Promise<string>;
     deleteGitRemote(name: string): Promise<string>;
-    deleteBranch(branch: string): Promise<string>;
     addGitRemote(name: string, url: string): Promise<string>;
+    hasFilterRepoInstalled(): Promise<boolean>;
+    filterRepo(subdirectory: string): Promise<string>;
+    filterBranch(subdirectory: string, branchName: string): Promise<string>;
+    private execAsync;
+    private quotePath;
 }
-/**
- * This is used by the squash editor script to update the rebase file.
- */
-export declare function updateRebaseFile(contents: string): string;
-export declare function fetchGitRemote(name: string, branch: string, execOptions: ExecSyncOptions): string | Buffer;
 /**
  * This is currently duplicated in Nx Console. Please let @MaxKless know if you make changes here.
  */