Let gradle handle resolving included builds!

This should handle included builds that are deeper than root-level and also handle included builds that are inserted by scripts (expo!)

Signed-off-by: Roland Asmann <[email protected]>

Author: malice00

.github/workflows/repotests.yml

@@ -631,7 +631,6 @@ jobs:
           COCOA_PODSPEC_REPLACEMENTS: "/([\\s\\S]+)/=require File.join(File.dirname(`node --print \"require.resolve('expo/package.json')\"`), \"scripts/autolinking\")<NEWLINE>require File.join(File.dirname(`node --print \"require.resolve('react-native/package.json')\"`), \"scripts/react_native_pods\")<NEWLINE>$1"
           COCOA_RESOLVE_FROM_NODE_EXCLUSION_DIRS: sdks,third-party-podspecs
           GRADLE_ARGS_DEPENDENCIES: "--configuration releaseRuntimeClasspath"
-          GRADLE_INCLUDED_BUILDS: :gradle-plugin
           GRADLE_SKIP_MODULES: root
         shell: bash
       - name: repotests expo not mac
@@ -650,7 +649,6 @@ jobs:
           COCOA_FULL_SCAN: false
           COCOA_RESOLVE_FROM_NODE_EXCLUSION_DIRS: sdks,third-party-podspecs
           GRADLE_ARGS_DEPENDENCIES: "--configuration releaseRuntimeClasspath"
-          GRADLE_INCLUDED_BUILDS: :gradle-plugin
           GRADLE_SKIP_MODULES: root
         shell: bash
       - name: repotests cocoapods

data/helpers/init.gradle

@@ -0,0 +1,5 @@
+gradle.taskGraph.whenReady {
+    gradle.includedBuilds.each { includedBuild ->
+        println "<CDXGEN:includedBuild>:${includedBuild.name}"
+    }
+}

lib/cli/index.js

@@ -33,8 +33,6 @@ import {
   listFiles,
 } from "../helpers/envcontext.js";
 import { thoughtLog } from "../helpers/logger.js";
-
-import { analyzeBuildSettings } from "../helpers/package_specific/gradleutils.js";
 import {
   CARGO_CMD,
   CLJ_CMD,
@@ -226,6 +224,14 @@ if (process.env.GRADLE_USER_HOME) {
   );
 }
 
+// Construct path to gradle init script
+const GRADLE_INIT_SCRIPT = resolve(
+  dirNameStr,
+  "data",
+  "helpers",
+  "init.gradle",
+);
+
 // Construct sbt cache directory
 const SBT_CACHE_DIR =
   process.env.SBT_CACHE_DIR || join(homedir(), ".ivy2", "cache");
@@ -1959,59 +1965,50 @@ export async function createJavaBom(path, options) {
       options,
     )
   ) {
-    let rootProjects = [null];
     let allProjectsStr = [];
-    let rootGradleModule = {};
-    let includedProjectsFound = false;
     if (process.env.GRADLE_INCLUDED_BUILDS) {
       // Automatically add the colon prefix
-      const includedBuilds = process.env.GRADLE_INCLUDED_BUILDS.split(",").map(
-        (b) => (!b.startsWith(":") ? `:${b}` : b),
+      allProjectsStr = process.env.GRADLE_INCLUDED_BUILDS.split(",").map((b) =>
+        !b.startsWith(":") ? `:${b}` : b,
       );
-      rootProjects = rootProjects.concat(includedBuilds);
-      includedProjectsFound = true;
-    } else {
-      // Automatically detect included builds
-      // Only from the root path for now
-      for (const abuildFile of [
-        join(gradleRootPath, "build.gradle"),
-        join(gradleRootPath, "build.gradle.kts"),
-        join(gradleRootPath, "settings.gradle"),
-        join(gradleRootPath, "settings.gradle.kts"),
-      ]) {
-        if (!safeExistsSync(abuildFile)) {
-          continue;
+    }
+    let parallelPropTaskOut = executeParallelGradleProperties(
+      gradleRootPath,
+      [null],
+      process.env.GRADLE_INCLUDED_BUILDS
+        ? []
+        : ["--init-script", GRADLE_INIT_SCRIPT],
+    );
+    if (!process.env.GRADLE_INCLUDED_BUILDS) {
+      const outputLines = parallelPropTaskOut.split("\n");
+      for (const [i, line] of outputLines.entries()) {
+        if (line.startsWith("Root project '")) {
+          break;
         }
-        const buildSettings = analyzeBuildSettings(abuildFile);
-        if (buildSettings?.includedBuilds?.length) {
-          for (const aib of buildSettings.includedBuilds) {
-            if (!rootProjects.includes(aib)) {
-              rootProjects.push(aib);
-              includedProjectsFound = true;
-            }
+        if (line.startsWith("<CDXGEN:includedBuild>")) {
+          const includedBuild = line.split(">");
+          if (!allProjectsStr.includes(includedBuild[1].trim())) {
+            allProjectsStr.push(includedBuild[1].trim());
           }
-          break;
         }
       }
     }
-    if (includedProjectsFound) {
+    if (allProjectsStr.length > 0) {
       thoughtLog(
-        `Wait, this gradle project uses composite builds. I must carefully process these ${rootProjects.length} projects including the root.`,
+        `Wait, this gradle project uses composite builds. I must carefully process these ${allProjectsStr.length} projects, in addition to the root.`,
       );
       if (DEBUG_MODE) {
-        console.log(
-          `Additional root projects: ${rootProjects.join(" ").trim()}.`,
-        );
+        console.log(`Composite builds: ${allProjectsStr.join(" ").trim()}.`);
       }
+      parallelPropTaskOut = parallelPropTaskOut.concat(
+        "\n",
+        executeParallelGradleProperties(gradleRootPath, allProjectsStr),
+      );
+      allProjectsStr = [];
     }
-    const parallelPropTaskOut = executeParallelGradleProperties(
-      gradleRootPath,
-      rootProjects,
-    );
     const splitPropTaskOut = splitOutputByGradleProjects(parallelPropTaskOut, [
       "properties",
     ]);
-
     for (const [key, propTaskOut] of splitPropTaskOut.entries()) {
       const retMap = parseGradleProperties(propTaskOut);
       const rootProject = retMap.rootProject;
@@ -2020,26 +2017,18 @@ export async function createJavaBom(path, options) {
           rootProject,
           retMap.metadata,
         );
+        if (!key.startsWith(":")) {
+          parentComponent = rootComponent;
+        }
         gradleModules.set(key, rootComponent);
-        if (!rootProjects.includes(key)) {
-          if (rootGradleModule.name) {
-            if (DEBUG_MODE) {
-              console.log(
-                `Received new root component: ${rootComponent.name} with key ${key}. Please verify the value used for included builds. Using the name ${rootGradleModule.name}.`,
-              );
-            }
-          } else {
-            rootGradleModule = rootComponent;
-          }
-        } else if (!allProjectsAddedPurls.includes(rootComponent["purl"])) {
+        if (!allProjectsAddedPurls.includes(rootComponent["purl"])) {
           allProjects.push(rootComponent);
           rootDependsOn.add(rootComponent["bom-ref"]);
           allProjectsAddedPurls.push(rootComponent["purl"]);
         }
         allProjectsStr = allProjectsStr.concat(retMap.projects);
       }
     }
-    parentComponent = rootGradleModule;
     // Get the sub-project properties and set the root dependencies
     if (allProjectsStr?.length) {
       const modulesToSkip = process.env.GRADLE_SKIP_MODULES

lib/helpers/package_specific/gradleutils.js

@@ -3998,13 +3998,20 @@ export function parseGradleProperties(rawOutput, gradleModuleName = null) {
  *
  * @param {string} dir Directory to execute the command
  * @param {array} allProjectsStr List of all sub-projects (including the preceding `:`)
+ * @param {array} extraArgs List of extra arguments to use when calling gradle
  *
  * @returns {string} The combined output for all subprojects of the Gradle properties task
  */
-export function executeParallelGradleProperties(dir, allProjectsStr) {
+export function executeParallelGradleProperties(
+  dir,
+  allProjectsStr,
+  extraArgs = [],
+) {
   const gradleCmd = getGradleCommand(dir, null);
   const gradleArgs = buildGradleCommandArguments(
-    process.env.GRADLE_ARGS ? process.env.GRADLE_ARGS.split(" ") : [],
+    extraArgs.concat(
+      process.env.GRADLE_ARGS ? process.env.GRADLE_ARGS.split(" ") : [],
+    ),
     allProjectsStr.map((project) =>
       project ? `${project}:properties` : "properties",
     ),

lib/helpers/package_specific/gradleutils.test.js

@@ -34,6 +34,10 @@
     {
       "name": "Adam Setch",
       "url": "https://github.com/setchy"
+    },
+    {
+      "name": "Roland Asmann",
+      "url": "https://github.com/malice00"
     }
   ],
   "type": "module",
@@ -54,7 +58,7 @@
     "cdx-verify": "bin/verify.js"
   },
   "scripts": {
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --inject-globals false lib/managers/docker.test.js lib/helpers/package_specific/gradleutils.test.js lib/helpers/utils.test.js lib/helpers/display.test.js lib/stages/postgen/postgen.test.js lib/evinser/swiftsem.test.js",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --inject-globals false lib/managers/docker.test.js lib/helpers/utils.test.js lib/helpers/display.test.js lib/stages/postgen/postgen.test.js lib/evinser/swiftsem.test.js",
     "watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch --inject-globals false",
     "lint:check": "biome check",
     "lint": "biome check --fix",