feat(gradle): add batch mode

docs/generated/manifests/menus.json

@@ -8128,6 +8128,23 @@
             "isExternal": false,
             "disableCollapsible": false
           },
+          {
+            "id": "executors",
+            "path": "/nx-api/gradle/executors",
+            "name": "executors",
+            "children": [
+              {
+                "id": "gradlew",
+                "path": "/nx-api/gradle/executors/gradlew",
+                "name": "gradlew",
+                "children": [],
+                "isExternal": false,
+                "disableCollapsible": false
+              }
+            ],
+            "isExternal": false,
+            "disableCollapsible": false
+          },
           {
             "id": "generators",
             "path": "/nx-api/gradle/generators",

docs/generated/manifests/nx-api.json

@@ -2294,7 +2294,17 @@
     },
     "root": "/packages/gradle",
     "source": "/packages/gradle/src",
-    "executors": {},
+    "executors": {
+      "/nx-api/gradle/executors/gradlew": {
+        "description": "gradlew.impl executor",
+        "file": "generated/packages/gradle/executors/gradlew.json",
+        "hidden": false,
+        "name": "gradlew",
+        "originalFilePath": "/packages/gradle/src/executors/gradlew/schema.json",
+        "path": "/nx-api/gradle/executors/gradlew",
+        "type": "executor"
+      }
+    },
     "generators": {
       "/nx-api/gradle/generators/init": {
         "description": "Initializes a Gradle project in the current workspace",

docs/generated/packages-metadata.json

@@ -2278,7 +2278,17 @@
         "originalFilePath": "shared/packages/gradle/gradle-plugin"
       }
     ],
-    "executors": [],
+    "executors": [
+      {
+        "description": "gradlew.impl executor",
+        "file": "generated/packages/gradle/executors/gradlew.json",
+        "hidden": false,
+        "name": "gradlew",
+        "originalFilePath": "/packages/gradle/src/executors/gradlew/schema.json",
+        "path": "gradle/executors/gradlew",
+        "type": "executor"
+      }
+    ],
     "generators": [
       {
         "description": "Initializes a Gradle project in the current workspace",

docs/generated/packages/gradle/executors/gradlew.json

@@ -0,0 +1,20 @@
+{
+  "name": "gradlew",
+  "batchImplementation": "./src/executors/gradlew/gradlew.impl#batchGradlew",
+  "implementation": "/packages/gradle/src/executors/gradlew/gradlew.impl.ts",
+  "schema": {
+    "$schema": "https://json-schema.org/schema",
+    "version": 2,
+    "title": "GradlewImpl executor",
+    "description": "The GradlewImpl executor is used to run Gradle tasks.",
+    "type": "object",
+    "properties": {},
+    "required": [],
+    "presets": []
+  },
+  "description": "gradlew.impl executor",
+  "aliases": [],
+  "hidden": false,
+  "path": "/packages/gradle/src/executors/gradlew/schema.json",
+  "type": "executor"
+}

docs/shared/reference/sitemap.md

@@ -475,6 +475,8 @@
   - [gradle](/nx-api/gradle)
     - [documents](/nx-api/gradle/documents)
       - [Overview](/nx-api/gradle/documents/overview)
+    - [executors](/nx-api/gradle/executors)
+      - [gradlew](/nx-api/gradle/executors/gradlew)
     - [generators](/nx-api/gradle/generators)
       - [init](/nx-api/gradle/generators/init)
       - [ci-workflow](/nx-api/gradle/generators/ci-workflow)

packages/gradle/.eslintrc.json

@@ -27,7 +27,12 @@
       }
     },
     {
-      "files": ["./package.json"],
+      "files": [
+        "./package.json",
+        "./generators.json",
+        "./executors.json",
+        "./migrations.json"
+      ],
       "parser": "jsonc-eslint-parser",
       "rules": {
         "@nx/nx-plugin-checks": "error"

packages/gradle/executors.json

@@ -0,0 +1,10 @@
+{
+  "executors": {
+    "gradlew": {
+      "batchImplementation": "./src/executors/gradlew/gradlew.impl#batchGradlew",
+      "implementation": "./src/executors/gradlew/gradlew.impl",
+      "schema": "./src/executors/gradlew/schema.json",
+      "description": "gradlew.impl executor"
+    }
+  }
+}

packages/gradle/package.json

@@ -39,5 +39,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "executors": "./executors.json"
 }

packages/gradle/project.json

@@ -3,6 +3,7 @@
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "sourceRoot": "packages/gradle/src",
   "projectType": "library",
+  "tags": [],
   "targets": {
     "nx-release-publish": {
       "dependsOn": ["^nx-release-publish"],
@@ -62,6 +63,5 @@
         "command": "node ./scripts/copy-readme.js gradle"
       }
     }
-  },
-  "tags": []
+  }
 }

packages/gradle/src/executors/gradlew/gradlew.impl.ts

@@ -0,0 +1,67 @@
+import { ExecutorContext, TaskGraph } from '@nx/devkit';
+import runCommandsImpl, {
+  RunCommandsOptions,
+} from 'nx/src/executors/run-commands/run-commands.impl';
+import { BatchResults } from 'nx/src/tasks-runner/batch/batch-messages';
+
+const MAX_PROJECTS_IN_BATCH = 10;
+
+export async function graldewExecutor(
+  options: RunCommandsOptions,
+  context: ExecutorContext
+): Promise<{ success: boolean }> {
+  const results = await runCommandsImpl(options, context);
+  return { success: results.success };
+}
+
+export default graldewExecutor;
+
+export async function batchGradlew(
+  taskGraph: TaskGraph,
+  inputs: Record<string, RunCommandsOptions>,
+  overrides: RunCommandsOptions,
+  context: ExecutorContext
+): Promise<BatchResults> {
+  const regex = /[./\\]*gradlew[\w.-]*/;
+
+  let gradlewCommand: string | undefined;
+  const roots = taskGraph.roots.slice(0, MAX_PROJECTS_IN_BATCH);
+  const tasksRan = [];
+  const results: BatchResults = {};
+
+  const gradlewTasks = roots.flatMap((task) => {
+    const gradlewTask = inputs[task].command;
+    if (typeof gradlewTask !== 'string') return [];
+
+    const match = gradlewTask.match(regex);
+    if (!match) return [];
+    results[task] = { success: false, terminalOutput: '' };
+
+    tasksRan.push(task);
+
+    gradlewCommand = match[0]; // Store the first found gradlewCommand
+    return gradlewTask.replace(gradlewCommand, '').trim();
+  });
+
+  const startTime = Date.now();
+  const { success, terminalOutput } = await runCommandsImpl(
+    {
+      command: `${gradlewCommand} ${gradlewTasks.join(' ')} --parallel`,
+      __unparsed__: [],
+      ...(overrides ?? {}),
+    },
+    context
+  );
+  const endTime = Date.now();
+
+  tasksRan.forEach((task) => {
+    results[task] = {
+      success,
+      terminalOutput,
+      startTime,
+      endTime,
+    };
+  });
+
+  return results;
+}

packages/gradle/src/executors/gradlew/schema.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "version": 2,
+  "title": "GradlewImpl executor",
+  "description": "The GradlewImpl executor is used to run Gradle tasks.",
+  "type": "object",
+  "properties": {},
+  "required": []
+}

packages/gradle/src/plugin/utils/__snapshots__/create-ci-targets.spec.ts.snap

@@ -1668,13 +1668,6 @@ exports[`create ci targets replaceTargetNameWithOptions should replace test in d
         "gradle",
       ],
     },
-    "options": {
-      "__unparsed__": [],
-      "args": [
-        "--exclude-task",
-        "test",
-      ],
-    },
     "parallelism": false,
   },
   "test-ci--LinkedList2Test": {
@@ -1698,13 +1691,6 @@ exports[`create ci targets replaceTargetNameWithOptions should replace test in d
         "gradle",
       ],
     },
-    "options": {
-      "__unparsed__": [],
-      "args": [
-        "--exclude-task",
-        "test",
-      ],
-    },
     "outputs": [
       "{projectRoot}/build/test-results/test/binary",
       "{projectRoot}/build/reports/tests/test",
@@ -1733,13 +1719,6 @@ exports[`create ci targets replaceTargetNameWithOptions should replace test in d
         "gradle",
       ],
     },
-    "options": {
-      "__unparsed__": [],
-      "args": [
-        "--exclude-task",
-        "test",
-      ],
-    },
     "outputs": [
       "{projectRoot}/build/test-results/test/binary",
       "{projectRoot}/build/reports/tests/test",

packages/gradle/src/plugin/utils/create-ci-targets.ts

@@ -16,24 +16,7 @@ export function replaceTargetNameWithOptions(
   // rename target name if it is provided
   Object.entries(targets).forEach(([taskName, target]) => {
     let targetName = options?.[`${taskName}TargetName`] as string;
-    if (taskName.startsWith('ci')) {
-      if (options.ciTargetName) {
-        targetName = taskName.replace('ci', options.ciTargetName);
-        targetsWithReplacedName[targetName] = target;
-        if (targetName === options.ciTargetName) {
-          target.metadata.nonAtomizedTarget = options.testTargetName;
-          target.dependsOn.forEach((dep) => {
-            if (typeof dep !== 'string' && dep.target.startsWith('ci')) {
-              dep.target = dep.target.replace('ci', options.ciTargetName);
-            }
-          });
-        }
-      }
-    } else if (targetName) {
-      targetsWithReplacedName[targetName] = target;
-    } else {
-      targetsWithReplacedName[taskName] = target;
-    }
+
     // if is it CI, replace target test with ci in dependsOn and exclude test in each command
     if (
       isCI() &&
@@ -68,6 +51,44 @@ export function replaceTargetNameWithOptions(
         target.options.args = ['--exclude-task', 'test'];
       }
     }
+
+    // change executor to gradlew if it is batch mode
+    if (
+      process.env.NX_BATCH_MODE === 'true' &&
+      target.command?.includes('gradlew')
+    ) {
+      target = {
+        executor: '@nx/gradle:gradlew',
+        options: {
+          ...target,
+          __unparsed__: [],
+        },
+        dependsOn: [...(target.dependsOn ?? [])],
+        metadata: { ...target.metadata },
+        inputs: target.inputs,
+        outputs: target.outputs,
+        cache: true,
+      };
+    }
+
+    if (taskName.startsWith('ci')) {
+      if (options.ciTargetName) {
+        targetName = taskName.replace('ci', options.ciTargetName);
+        targetsWithReplacedName[targetName] = target;
+        if (targetName === options.ciTargetName) {
+          target.metadata.nonAtomizedTarget = options.testTargetName;
+          target.dependsOn.forEach((dep) => {
+            if (typeof dep !== 'string' && dep.target.startsWith('ci')) {
+              dep.target = dep.target.replace('ci', options.ciTargetName);
+            }
+          });
+        }
+      }
+    } else if (targetName) {
+      targetsWithReplacedName[targetName] = target;
+    } else {
+      targetsWithReplacedName[taskName] = target;
+    }
   });
   return targetsWithReplacedName;
 }