nx 19.8.0 → 19.8.1

package/src/utils/sync-generators.d.ts

@@ -18,6 +18,8 @@ export type SyncGeneratorRunSuccessResult = {
 type SerializableSimpleError = {
     message: string;
     stack: string | undefined;
+    title?: string;
+    bodyLines?: string[];
 };
 export type SyncGeneratorRunErrorResult = {
     generatorName: string;
@@ -36,16 +38,24 @@ type FlushSyncGeneratorChangesFailure = {
     generalFailure?: SerializableSimpleError;
 };
 export type FlushSyncGeneratorChangesResult = FlushSyncGeneratorChangesSuccess | FlushSyncGeneratorChangesFailure;
+export declare class SyncError extends Error {
+    title: string;
+    bodyLines?: string[];
+    constructor(title: string, bodyLines?: string[]);
+}
 export declare function getSyncGeneratorChanges(generators: string[]): Promise<SyncGeneratorRunResult[]>;
 export declare function flushSyncGeneratorChanges(results: SyncGeneratorRunResult[]): Promise<FlushSyncGeneratorChangesResult>;
-export declare function collectAllRegisteredSyncGenerators(projectGraph: ProjectGraph, nxJson: NxJsonConfiguration): Promise<string[]>;
+export declare function collectAllRegisteredSyncGenerators(projectGraph: ProjectGraph, nxJson: NxJsonConfiguration): Promise<{
+    globalGenerators: string[];
+    taskGenerators: string[];
+}>;
 export declare function runSyncGenerator(tree: Tree, generatorSpecifier: string, projects: Record<string, ProjectConfiguration>): Promise<SyncGeneratorRunResult>;
 export declare function collectEnabledTaskSyncGeneratorsFromProjectGraph(projectGraph: ProjectGraph, nxJson: NxJsonConfiguration): Set<string>;
 export declare function collectEnabledTaskSyncGeneratorsFromTaskGraph(taskGraph: TaskGraph, projectGraph: ProjectGraph, nxJson: NxJsonConfiguration): Set<string>;
 export declare function collectRegisteredGlobalSyncGenerators(nxJson?: NxJsonConfiguration<string[] | "*">): Set<string>;
 export declare function getSyncGeneratorSuccessResultsMessageLines(results: SyncGeneratorRunResult[]): string[];
-export declare function getFailedSyncGeneratorsFixMessageLines(results: SyncGeneratorRunResult[], verbose: boolean): string[];
-export declare function getFlushFailureMessageLines(result: FlushSyncGeneratorChangesFailure, verbose: boolean): string[];
+export declare function getFailedSyncGeneratorsFixMessageLines(results: SyncGeneratorRunResult[], verbose: boolean, globalGeneratorSet?: Set<string>): string[];
+export declare function getFlushFailureMessageLines(result: FlushSyncGeneratorChangesFailure, verbose: boolean, globalGeneratorSet?: Set<string>): string[];
 export declare function processSyncGeneratorResultErrors(results: SyncGeneratorRunResult[]): {
     failedGeneratorsCount: number;
     areAllResultsFailures: boolean;

package/src/utils/sync-generators.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SyncError = void 0;
 exports.getSyncGeneratorChanges = getSyncGeneratorChanges;
 exports.flushSyncGeneratorChanges = flushSyncGeneratorChanges;
 exports.collectAllRegisteredSyncGenerators = collectAllRegisteredSyncGenerators;
@@ -22,6 +23,15 @@ const project_graph_1 = require("../project-graph/project-graph");
 const workspace_context_1 = require("./workspace-context");
 const workspace_root_1 = require("./workspace-root");
 const chalk = require("chalk");
+class SyncError extends Error {
+    constructor(title, bodyLines) {
+        super(title);
+        this.title = title;
+        this.bodyLines = bodyLines;
+        this.name = this.constructor.name;
+    }
+}
+exports.SyncError = SyncError;
 async function getSyncGeneratorChanges(generators) {
     perf_hooks_1.performance.mark('get-sync-generators-changes:start');
     let results;
@@ -43,10 +53,12 @@ async function flushSyncGeneratorChanges(results) {
 }
 async function collectAllRegisteredSyncGenerators(projectGraph, nxJson) {
     if (!client_1.daemonClient.enabled()) {
-        return [
-            ...collectEnabledTaskSyncGeneratorsFromProjectGraph(projectGraph, nxJson),
-            ...collectRegisteredGlobalSyncGenerators(),
-        ];
+        return {
+            globalGenerators: [...collectRegisteredGlobalSyncGenerators()],
+            taskGenerators: [
+                ...collectEnabledTaskSyncGeneratorsFromProjectGraph(projectGraph, nxJson),
+            ],
+        };
     }
     return await client_1.daemonClient.getRegisteredSyncGenerators();
 }
@@ -75,7 +87,7 @@ async function runSyncGenerator(tree, generatorSpecifier, projects) {
     catch (e) {
         return {
             generatorName: generatorSpecifier,
-            error: { message: e.message, stack: e.stack },
+            error: toSerializableError(e),
         };
     }
 }
@@ -140,28 +152,48 @@ function getSyncGeneratorSuccessResultsMessageLines(results) {
     }
     return messageLines;
 }
-function getFailedSyncGeneratorsFixMessageLines(results, verbose) {
+function getFailedSyncGeneratorsFixMessageLines(results, verbose, globalGeneratorSet = new Set()) {
     const messageLines = [];
-    const generators = [];
+    const globalGenerators = [];
+    const taskGenerators = [];
+    let isFirst = true;
     for (const result of results) {
         if ('error' in result) {
-            messageLines.push(`The ${chalk.bold(result.generatorName)} sync generator reported the following error:
-${chalk.bold(result.error.message)}${verbose && result.error.stack ? '\n' + result.error.stack : ''}`);
-            generators.push(result.generatorName);
+            if (!isFirst) {
+                messageLines.push('');
+            }
+            isFirst = false;
+            messageLines.push(`The ${chalk.bold(result.generatorName)} sync generator reported the following error:`, '', errorToString(result.error, verbose));
+            if (globalGeneratorSet.has(result.generatorName)) {
+                globalGenerators.push(result.generatorName);
+            }
+            else {
+                taskGenerators.push(result.generatorName);
+            }
         }
     }
-    messageLines.push(...getFailedSyncGeneratorsMessageLines(generators, verbose));
+    messageLines.push(...getFailedSyncGeneratorsMessageLines(taskGenerators, globalGenerators, verbose));
     return messageLines;
 }
-function getFlushFailureMessageLines(result, verbose) {
+function getFlushFailureMessageLines(result, verbose, globalGeneratorSet = new Set()) {
     const messageLines = [];
-    const generators = [];
+    const globalGenerators = [];
+    const taskGenerators = [];
+    let isFirst = true;
     for (const failure of result.generatorFailures) {
-        messageLines.push(`The ${chalk.bold(failure.generator)} sync generator failed to apply its changes with the following error:
-${chalk.bold(failure.error.message)}${verbose && failure.error.stack ? '\n' + failure.error.stack : ''}`);
-        generators.push(failure.generator);
+        if (!isFirst) {
+            messageLines.push('');
+        }
+        isFirst = false;
+        messageLines.push(`The ${chalk.bold(failure.generator)} sync generator failed to apply its changes with the following error:`, '', errorToString(failure.error, verbose));
+        if (globalGeneratorSet.has(failure.generator)) {
+            globalGenerators.push(failure.generator);
+        }
+        else {
+            taskGenerators.push(failure.generator);
+        }
     }
-    messageLines.push(...getFailedSyncGeneratorsMessageLines(generators, verbose));
+    messageLines.push(...getFailedSyncGeneratorsMessageLines(taskGenerators, globalGenerators, verbose));
     if (result.generalFailure) {
         if (messageLines.length > 0) {
             messageLines.push('');
@@ -242,7 +274,7 @@ async function flushSyncGeneratorChangesToDisk(results) {
         catch (e) {
             generatorFailures.push({
                 generator: result.generatorName,
-                error: { message: e.message, stack: e.stack },
+                error: toSerializableError(e),
             });
         }
     }
@@ -255,25 +287,67 @@ async function flushSyncGeneratorChangesToDisk(results) {
     catch (e) {
         return {
             generatorFailures,
-            generalFailure: { message: e.message, stack: e.stack },
+            generalFailure: toSerializableError(e),
         };
     }
     return generatorFailures.length > 0
         ? { generatorFailures }
         : { success: true };
 }
-function getFailedSyncGeneratorsMessageLines(generators, verbose) {
+function getFailedSyncGeneratorsMessageLines(taskGenerators, globalGenerators, verbose) {
     const messageLines = [];
-    if (generators.length === 1) {
+    if (taskGenerators.length + globalGenerators.length === 1) {
         messageLines.push('', verbose
             ? 'Please check the error above and address the issue.'
-            : 'Please check the error above and address the issue. You can provide the `--verbose` flag to get more details.', `If needed, you can disable the failing sync generator by setting \`sync.disabledTaskSyncGenerators: ["${generators[0]}"]\` in your \`nx.json\`.`);
+            : 'Please check the error above and address the issue. You can provide the `--verbose` flag to get more details.');
+        if (taskGenerators.length === 1) {
+            messageLines.push(`If needed, you can disable the failing sync generator by setting \`sync.disabledTaskSyncGenerators: ["${taskGenerators[0]}"]\` in your \`nx.json\`.`);
+        }
+        else {
+            messageLines.push(`If needed, you can remove the failing global sync generator "${globalGenerators[0]}" from the \`sync.globalGenerators\` array in your \`nx.json\`.`);
+        }
     }
-    else if (generators.length > 1) {
-        const generatorsString = generators.map((g) => `"${g}"`).join(', ');
+    else if (taskGenerators.length + globalGenerators.length > 1) {
         messageLines.push('', verbose
             ? 'Please check the errors above and address the issues.'
-            : 'Please check the errors above and address the issues. You can provide the `--verbose` flag to get more details.', `If needed, you can disable the failing sync generators by setting \`sync.disabledTaskSyncGenerators: [${generatorsString}]\` in your \`nx.json\`.`);
+            : 'Please check the errors above and address the issues. You can provide the `--verbose` flag to get more details.');
+        if (taskGenerators.length > 0) {
+            const generatorsString = taskGenerators.map((g) => `"${g}"`).join(', ');
+            messageLines.push(`If needed, you can disable the failing task sync generators by setting \`sync.disabledTaskSyncGenerators: [${generatorsString}]\` in your \`nx.json\`.`);
+        }
+        if (globalGenerators.length > 0) {
+            const lastGenerator = globalGenerators.pop();
+            const generatorsString = globalGenerators.length > 0
+                ? `${globalGenerators
+                    .map((g) => `"${g}"`)
+                    .join(', ')} and "${lastGenerator}"`
+                : `"${lastGenerator}"`;
+            messageLines.push(`If needed, you can remove the failing global sync generators ${generatorsString} from the \`sync.globalGenerators\` array in your \`nx.json\`.`);
+        }
     }
     return messageLines;
 }
+function errorToString(error, verbose) {
+    if (error.title) {
+        let message = `  ${chalk.red(error.title)}`;
+        if (error.bodyLines?.length) {
+            message += `
+
+  ${error.bodyLines
+                .map((bodyLine) => `${bodyLine.split('\n').join('\n  ')}`)
+                .join('\n  ')}`;
+            return message;
+        }
+    }
+    return `  ${chalk.red(error.message)}${verbose && error.stack ? '\n  ' + error.stack : ''}`;
+}
+function toSerializableError(error) {
+    return error instanceof SyncError
+        ? {
+            title: error.title,
+            bodyLines: error.bodyLines,
+            message: error.message,
+            stack: error.stack,
+        }
+        : { message: error.message, stack: error.stack };
+}

package/src/utils/task-history.d.ts

@@ -12,6 +12,6 @@ export declare class TaskHistory {
 }
 /**
  * This function returns the singleton instance of TaskHistory
- * @returns singleton instance of TaskHistory
+ * @returns singleton instance of TaskHistory, null if database is disabled or WASM is not enabled
  */
-export declare function getTaskHistory(): TaskHistory;
+export declare function getTaskHistory(): TaskHistory | null;

package/src/utils/task-history.js

@@ -38,9 +38,12 @@ exports.TaskHistory = TaskHistory;
 let taskHistory;
 /**
  * This function returns the singleton instance of TaskHistory
- * @returns singleton instance of TaskHistory
+ * @returns singleton instance of TaskHistory, null if database is disabled or WASM is not enabled
  */
 function getTaskHistory() {
+    if (process.env.NX_DISABLE_DB === 'true' || !native_1.IS_WASM) {
+        return null;
+    }
     if (!taskHistory) {
         taskHistory = new TaskHistory();
     }