@nx/gradle 23.0.0-beta.3 → 23.0.0-beta.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/gradle",
-  "version": "23.0.0-beta.3",
+  "version": "23.0.0-beta.5",
   "private": false,
   "description": "The Nx Plugin for Gradle allows Gradle tasks to be run through Nx",
   "repository": {
@@ -40,13 +40,13 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nx/devkit": "23.0.0-beta.3",
+    "@nx/devkit": "23.0.0-beta.5",
     "toml-eslint-parser": "^0.10.0",
     "tree-kill": "^1.2.2",
     "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "nx": "23.0.0-beta.3"
+    "nx": "23.0.0-beta.5"
   },
   "publishConfig": {
     "access": "public"

package/src/executors/gradle/gradle-batch.impl.d.ts

@@ -1,9 +1,12 @@
 import { ExecutorContext, ProjectGraphProjectNode, TaskGraph } from '@nx/devkit';
 import { RunCommandsOptions } from 'nx/src/executors/run-commands/run-commands.impl';
-import { BatchResults } from 'nx/src/tasks-runner/batch/batch-messages';
+import { TaskResult } from 'nx/src/config/misc-interfaces';
 import { GradleExecutorSchema } from './schema';
 export declare const batchRunnerPath: string;
-export default function gradleBatch(taskGraph: TaskGraph, inputs: Record<string, GradleExecutorSchema>, overrides: RunCommandsOptions, context: ExecutorContext): Promise<BatchResults>;
+export default function gradleBatch(taskGraph: TaskGraph, inputs: Record<string, GradleExecutorSchema>, overrides: RunCommandsOptions, context: ExecutorContext): AsyncGenerator<{
+    task: string;
+    result: TaskResult;
+}>;
 export declare function getGradlewTasksToRun(taskIds: string[], taskGraph: TaskGraph, inputs: Record<string, GradleExecutorSchema>, nodes: Record<string, ProjectGraphProjectNode>, fullTaskGraph?: TaskGraph): {
     gradlewTasksToRun: Record<string, GradleExecutorSchema>;
     excludeTasks: Set<string>;

package/src/executors/gradle/gradle-batch.impl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gradle-batch.impl.d.ts","sourceRoot":"","sources":["../../../../../../packages/gradle/src/executors/gradle/gradle-batch.impl.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAEf,uBAAuB,EACvB,SAAS,EAEV,MAAM,YAAY,CAAC;AACpB,OAAO,EAEL,kBAAkB,EACnB,MAAM,iDAAiD,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAahD,eAAO,MAAM,eAAe,QAG3B,CAAC;AAEF,wBAA8B,WAAW,CACvC,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,EAC5C,SAAS,EAAE,kBAAkB,EAC7B,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,YAAY,CAAC,CAkEvB;AAED,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,MAAM,EAAE,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,EAC5C,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,EAC9C,aAAa,GAAE,SAAqB;;;;EA0DrC"}
+{"version":3,"file":"gradle-batch.impl.d.ts","sourceRoot":"","sources":["../../../../../../packages/gradle/src/executors/gradle/gradle-batch.impl.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAEf,uBAAuB,EACvB,SAAS,EAEV,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,kBAAkB,EAAE,MAAM,iDAAiD,CAAC;AACrF,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAahD,eAAO,MAAM,eAAe,QAG3B,CAAC;AAEF,wBAA+B,WAAW,CACxC,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,EAC5C,SAAS,EAAE,kBAAkB,EAC7B,OAAO,EAAE,eAAe,GACvB,cAAc,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,CAAC,CA8EtD;AAED,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,MAAM,EAAE,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,EAC5C,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,EAC9C,aAAa,GAAE,SAAqB;;;;EA0DrC"}

package/src/executors/gradle/gradle-batch.impl.js

@@ -7,47 +7,60 @@ const devkit_1 = require("@nx/devkit");
 const exec_gradle_1 = require("../../utils/exec-gradle");
 const path_1 = require("path");
 const child_process_1 = require("child_process");
+const readline_1 = require("readline");
 const get_exclude_task_1 = require("./get-exclude-task");
 exports.batchRunnerPath = (0, path_1.join)(__dirname, '../../../batch-runner/build/libs/gradle-batch-runner-all.jar');
-async function gradleBatch(taskGraph, inputs, overrides, context) {
+async function* gradleBatch(taskGraph, inputs, overrides, context) {
+    const projectName = taskGraph.tasks[taskGraph.roots[0]]?.target?.project;
+    const projectRoot = context.projectGraph.nodes[projectName]?.data?.root ?? '';
+    const customGradleExecutableDirectory = (0, exec_gradle_1.getCustomGradleExecutableDirectoryFromPlugin)(context.nxJsonConfiguration);
+    let gradlewPath = (0, exec_gradle_1.findGradlewFile)((0, path_1.join)(projectRoot, 'project.json'), devkit_1.workspaceRoot, customGradleExecutableDirectory);
+    gradlewPath = (0, path_1.join)(context.root, gradlewPath);
+    const root = (0, path_1.dirname)(gradlewPath);
+    // set args with passed in args and overrides in command line
+    const input = inputs[taskGraph.roots[0]];
+    const args = typeof input.args === 'string'
+        ? input.args.trim().split(' ')
+        : Array.isArray(input.args)
+            ? input.args
+            : [];
+    if (overrides.__overrides_unparsed__.length) {
+        args.push(...overrides.__overrides_unparsed__);
+    }
+    const taskIds = Object.keys(taskGraph.tasks);
+    const { gradlewTasksToRun, excludeTasks, excludeTestTasks } = getGradlewTasksToRun(taskIds, taskGraph, inputs, context.projectGraph.nodes, context.taskGraph ?? taskGraph);
+    const yielded = new Set();
     try {
-        const projectName = taskGraph.tasks[taskGraph.roots[0]]?.target?.project;
-        let projectRoot = context.projectGraph.nodes[projectName]?.data?.root ?? '';
-        const customGradleExecutableDirectory = (0, exec_gradle_1.getCustomGradleExecutableDirectoryFromPlugin)(context.nxJsonConfiguration);
-        let gradlewPath = (0, exec_gradle_1.findGradlewFile)((0, path_1.join)(projectRoot, 'project.json'), devkit_1.workspaceRoot, customGradleExecutableDirectory);
-        gradlewPath = (0, path_1.join)(context.root, gradlewPath);
-        const root = (0, path_1.dirname)(gradlewPath);
-        const input = inputs[taskGraph.roots[0]];
-        let args = typeof input.args === 'string'
-            ? input.args.trim().split(' ')
-            : Array.isArray(input.args)
-                ? input.args
-                : [];
-        if (overrides.__overrides_unparsed__.length) {
-            args.push(...overrides.__overrides_unparsed__);
+        for await (const event of streamTasksInBatch(gradlewTasksToRun, excludeTasks, excludeTestTasks, args, root)) {
+            yielded.add(event.task);
+            yield event;
         }
-        const taskIds = Object.keys(taskGraph.tasks);
-        const { gradlewTasksToRun, excludeTasks, excludeTestTasks } = getGradlewTasksToRun(taskIds, taskGraph, inputs, context.projectGraph.nodes, context.taskGraph ?? taskGraph);
-        const batchResults = await runTasksInBatch(gradlewTasksToRun, excludeTasks, excludeTestTasks, args, root);
-        taskIds.forEach((taskId) => {
-            if (!batchResults[taskId]) {
-                batchResults[taskId] = {
-                    success: false,
-                    terminalOutput: `Gradlew batch failed`,
-                };
-            }
-        });
-        return batchResults;
     }
     catch (e) {
         devkit_1.output.error({
             title: `Gradlew batch failed`,
             bodyLines: [e.toString()],
         });
-        return taskGraph.roots.reduce((acc, key) => {
-            acc[key] = { success: false, terminalOutput: e.toString() };
-            return acc;
-        }, {});
+        for (const taskId of taskIds) {
+            if (!yielded.has(taskId)) {
+                yielded.add(taskId);
+                yield {
+                    task: taskId,
+                    result: { success: false, terminalOutput: e.toString() },
+                };
+            }
+        }
+        return;
+    }
+    // Any tasks the batch runner did not report on are treated as failed so Nx
+    // does not hang waiting for results.
+    for (const taskId of taskIds) {
+        if (!yielded.has(taskId)) {
+            yield {
+                task: taskId,
+                result: { success: false, terminalOutput: `Gradlew batch failed` },
+            };
+        }
     }
 }
 function getGradlewTasksToRun(taskIds, taskGraph, inputs, nodes, fullTaskGraph = taskGraph) {
@@ -88,7 +101,7 @@ function getGradlewTasksToRun(taskIds, taskGraph, inputs, nodes, fullTaskGraph =
         excludeTestTasks,
     };
 }
-async function runTasksInBatch(gradlewTasksToRun, excludeTasks, excludeTestTasks, args, root) {
+async function* streamTasksInBatch(gradlewTasksToRun, excludeTasks, excludeTestTasks, args, root) {
     const gradlewBatchStart = performance.mark(`gradlew-batch:start`);
     const debugOptions = (process.env.NX_GRADLE_BATCH_DEBUG ?? '').trim();
     const spawnArgs = [
@@ -102,30 +115,73 @@ async function runTasksInBatch(gradlewTasksToRun, excludeTasks, excludeTestTasks
         `--excludeTestTasks=${Array.from(excludeTestTasks).join(',')}`,
         ...(process.env.NX_VERBOSE_LOGGING === 'true' ? [] : ['--quiet']),
     ];
-    // Use 'inherit' for stderr so Gradle output (tee'd to System.err
-    // by TeeOutputStream) flows to the terminal in real-time.
-    // stdout is piped to capture the JSON batch results.
-    const batchResults = await new Promise((resolve, reject) => {
-        const cp = (0, child_process_1.spawn)('java', spawnArgs, {
-            cwd: devkit_1.workspaceRoot,
-            windowsHide: true,
-            env: process.env,
-            stdio: ['pipe', 'pipe', 'inherit'],
-        });
-        const chunks = [];
-        cp.stdout.on('data', (chunk) => chunks.push(chunk));
+    // stderr is inherited so Gradle output (tee'd to System.err by TeeOutputStream)
+    // and logger output flow to the terminal in real-time.
+    // stdout is piped so we can read NX_RESULT lines emitted per task.
+    const cp = (0, child_process_1.spawn)('java', spawnArgs, {
+        cwd: devkit_1.workspaceRoot,
+        windowsHide: true,
+        env: process.env,
+        stdio: ['pipe', 'pipe', 'inherit'],
+    });
+    const exit = new Promise((resolve, reject) => {
         cp.on('error', reject);
-        cp.on('close', (code) => {
-            if (code !== 0) {
-                reject(new Error(`Gradle batch runner exited with code ${code}`));
+        cp.on('close', (code) => resolve(code ?? 0));
+    });
+    const rl = (0, readline_1.createInterface)({ input: cp.stdout, crlfDelay: Infinity });
+    // Drain stdout into a queue eagerly. Yielding inside the readline loop creates
+    // back-pressure: if the consumer is slow, `yield` blocks, readline pauses, the
+    // OS pipe between Java and Node fills, and Java's NX_RESULT println blocks on
+    // a full pipe — the JVM hangs even though all task work is done.
+    const queue = [];
+    let notifyAvailable = null;
+    let readerClosed = false;
+    rl.on('line', (line) => {
+        if (!line.startsWith('NX_RESULT:'))
+            return;
+        try {
+            const data = JSON.parse(line.slice('NX_RESULT:'.length));
+            queue.push({
+                task: data.task,
+                result: {
+                    success: data.result.success ?? false,
+                    terminalOutput: data.result.terminalOutput ?? '',
+                    startTime: data.result.startTime,
+                    endTime: data.result.endTime,
+                },
+            });
+        }
+        catch (e) {
+            console.error('[Gradle Batch] Failed to parse result line:', line, e);
+            return;
+        }
+        notifyAvailable?.();
+        notifyAvailable = null;
+    });
+    rl.on('close', () => {
+        readerClosed = true;
+        notifyAvailable?.();
+        notifyAvailable = null;
+    });
+    try {
+        while (!readerClosed || queue.length > 0) {
+            if (queue.length > 0) {
+                yield queue.shift();
             }
             else {
-                resolve(Buffer.concat(chunks).toString());
+                await new Promise((resolve) => {
+                    notifyAvailable = resolve;
+                });
             }
-        });
-    });
+        }
+    }
+    finally {
+        rl.close();
+    }
+    const code = await exit;
     const gradlewBatchEnd = performance.mark(`gradlew-batch:end`);
     performance.measure(`gradlew-batch`, gradlewBatchStart.name, gradlewBatchEnd.name);
-    const gradlewBatchResults = JSON.parse(batchResults);
-    return gradlewBatchResults;
+    if (code !== 0) {
+        throw new Error(`Gradle batch runner exited with code ${code}`);
+    }
 }