@nx/gradle 19.2.0-beta.2 → 19.2.0-beta.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/gradle",
-  "version": "19.2.0-beta.2",
+  "version": "19.2.0-beta.4",
   "private": false,
   "description": "The Nx Plugin for Gradle allows Gradle tasks to be run through Nx",
   "repository": {
@@ -34,7 +34,7 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nx/devkit": "19.2.0-beta.2"
+    "@nx/devkit": "19.2.0-beta.4"
   },
   "publishConfig": {
     "access": "public"

package/plugin.d.ts

@@ -1,2 +1,2 @@
 export { createDependencies } from './src/plugin/dependencies';
-export { createNodes } from './src/plugin/nodes';
+export { createNodes, createNodesV2 } from './src/plugin/nodes';

package/plugin.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNodes = exports.createDependencies = void 0;
+exports.createNodesV2 = exports.createNodes = exports.createDependencies = void 0;
 var dependencies_1 = require("./src/plugin/dependencies");
 Object.defineProperty(exports, "createDependencies", { enumerable: true, get: function () { return dependencies_1.createDependencies; } });
 var nodes_1 = require("./src/plugin/nodes");
 Object.defineProperty(exports, "createNodes", { enumerable: true, get: function () { return nodes_1.createNodes; } });
+Object.defineProperty(exports, "createNodesV2", { enumerable: true, get: function () { return nodes_1.createNodesV2; } });

package/src/generators/init/init.d.ts

@@ -1,4 +1,4 @@
-import { Tree } from '@nx/devkit';
+import { GeneratorCallback, Tree } from '@nx/devkit';
 import { InitGeneratorSchema } from './schema';
-export declare function initGenerator(tree: Tree, options: InitGeneratorSchema): Promise<any>;
+export declare function initGenerator(tree: Tree, options: InitGeneratorSchema): Promise<GeneratorCallback>;
 export default initGenerator;

package/src/plugin/dependencies.js

@@ -5,7 +5,6 @@ const devkit_1 = require("@nx/devkit");
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const get_gradle_report_1 = require("../utils/get-gradle-report");
-const nodes_1 = require("./nodes");
 const createDependencies = async (_, context) => {
     const gradleFiles = findGradleFiles(context.filesToProcess);
     if (gradleFiles.length === 0) {
@@ -13,7 +12,7 @@ const createDependencies = async (_, context) => {
     }
     let dependencies = [];
     const gradleDependenciesStart = performance.mark('gradleDependencies:start');
-    const { gradleFileToGradleProjectMap, gradleProjectToProjectName, buildFileToDepsMap, } = (0, get_gradle_report_1.getGradleReport)();
+    const { gradleFileToGradleProjectMap, gradleProjectToProjectName, buildFileToDepsMap, } = (0, get_gradle_report_1.getCurrentGradleReport)();
     for (const gradleFile of gradleFiles) {
         const gradleProject = gradleFileToGradleProjectMap.get(gradleFile);
         const projectName = gradleProjectToProjectName.get(gradleProject);
@@ -24,10 +23,6 @@ const createDependencies = async (_, context) => {
     }
     const gradleDependenciesEnd = performance.mark('gradleDependencies:end');
     performance.measure('gradleDependencies', gradleDependenciesStart.name, gradleDependenciesEnd.name);
-    (0, nodes_1.writeTargetsToCache)();
-    if (dependencies.length) {
-        (0, get_gradle_report_1.invalidateGradleReportCache)();
-    }
     return dependencies;
 };
 exports.createDependencies = createDependencies;
@@ -45,7 +40,7 @@ function findGradleFiles(fileMap) {
 }
 function processGradleDependencies(depsFile, gradleProjectToProjectName, sourceProjectName, gradleFile, context) {
     const dependencies = new Set();
-    const lines = (0, node_fs_1.readFileSync)(depsFile).toString().split('\n');
+    const lines = (0, node_fs_1.readFileSync)(depsFile).toString().split(get_gradle_report_1.newLineSeparator);
     let inDeps = false;
     for (const line of lines) {
         if (line.startsWith('implementationDependenciesMetadata') ||

package/src/plugin/nodes.d.ts

@@ -1,9 +1,21 @@
-import { CreateNodes } from '@nx/devkit';
+import { CreateNodes, CreateNodesV2, ProjectConfiguration, TargetConfiguration, CreateNodesFunction } from '@nx/devkit';
+import { GradleReport } from '../utils/get-gradle-report';
 export interface GradlePluginOptions {
     testTargetName?: string;
     classesTargetName?: string;
     buildTargetName?: string;
     [taskTargetName: string]: string | undefined;
 }
-export declare function writeTargetsToCache(): void;
+type GradleTargets = Record<string, {
+    name: string;
+    targets: Record<string, TargetConfiguration>;
+    metadata: ProjectConfiguration['metadata'];
+}>;
+export declare function writeTargetsToCache(cachePath: string, results: GradleTargets): void;
+export declare const createNodesV2: CreateNodesV2<GradlePluginOptions>;
+export declare const makeCreateNodes: (gradleReport: GradleReport, targetsCache: GradleTargets) => CreateNodesFunction;
+/**
+ * @deprecated `{@link createNodesV2} is replacing this. Update your plugin to export its own `createNodesV2` function that wraps this one instead.`
+ */
 export declare const createNodes: CreateNodes<GradlePluginOptions>;
+export {};

package/src/plugin/nodes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNodes = exports.writeTargetsToCache = void 0;
+exports.createNodes = exports.makeCreateNodes = exports.createNodesV2 = exports.writeTargetsToCache = void 0;
 const devkit_1 = require("@nx/devkit");
 const calculate_hash_for_create_nodes_1 = require("@nx/devkit/src/utils/calculate-hash-for-create-nodes");
 const node_fs_1 = require("node:fs");
@@ -8,45 +8,67 @@ const node_path_1 = require("node:path");
 const cache_directory_1 = require("nx/src/utils/cache-directory");
 const exec_gradle_1 = require("../utils/exec-gradle");
 const get_gradle_report_1 = require("../utils/get-gradle-report");
+const file_hasher_1 = require("nx/src/hasher/file-hasher");
 const cacheableTaskType = new Set(['Build', 'Verification']);
 const dependsOnMap = {
     build: ['^build', 'classes'],
     test: ['classes'],
     classes: ['^classes'],
 };
-const cachePath = (0, node_path_1.join)(cache_directory_1.projectGraphCacheDirectory, 'gradle.hash');
-const targetsCache = readTargetsCache();
-function readTargetsCache() {
+function readTargetsCache(cachePath) {
     return (0, node_fs_1.existsSync)(cachePath) ? (0, devkit_1.readJsonFile)(cachePath) : {};
 }
-function writeTargetsToCache() {
-    const oldCache = readTargetsCache();
-    (0, devkit_1.writeJsonFile)(cachePath, {
-        ...oldCache,
-        ...targetsCache,
-    });
+function writeTargetsToCache(cachePath, results) {
+    (0, devkit_1.writeJsonFile)(cachePath, results);
 }
 exports.writeTargetsToCache = writeTargetsToCache;
-exports.createNodes = [
-    '**/build.{gradle.kts,gradle}',
-    (gradleFilePath, options, context) => {
-        const projectRoot = (0, node_path_1.dirname)(gradleFilePath);
-        const hash = (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options ?? {}, context);
-        targetsCache[hash] ??= createGradleProject(gradleFilePath, options, context);
-        const project = targetsCache[hash];
-        if (!project) {
-            return {};
+exports.createNodesV2 = [
+    get_gradle_report_1.gradleConfigGlob,
+    async (configFiles, options, context) => {
+        const optionsHash = (0, file_hasher_1.hashObject)(options);
+        const cachePath = (0, node_path_1.join)(cache_directory_1.projectGraphCacheDirectory, `gradle-${optionsHash}.hash`);
+        const targetsCache = readTargetsCache(cachePath);
+        (0, get_gradle_report_1.populateGradleReport)(context.workspaceRoot);
+        const gradleReport = (0, get_gradle_report_1.getCurrentGradleReport)();
+        try {
+            return await (0, devkit_1.createNodesFromFiles)((0, exports.makeCreateNodes)(gradleReport, targetsCache), configFiles, options, context);
         }
-        return {
-            projects: {
-                [projectRoot]: project,
-            },
-        };
+        finally {
+            writeTargetsToCache(cachePath, targetsCache);
+        }
+    },
+];
+const makeCreateNodes = (gradleReport, targetsCache) => (gradleFilePath, options, context) => {
+    const projectRoot = (0, node_path_1.dirname)(gradleFilePath);
+    const hash = (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options ?? {}, context);
+    targetsCache[hash] ??= createGradleProject(gradleReport, gradleFilePath, options, context);
+    const project = targetsCache[hash];
+    if (!project) {
+        return {};
+    }
+    return {
+        projects: {
+            [projectRoot]: project,
+        },
+    };
+};
+exports.makeCreateNodes = makeCreateNodes;
+/**
+ * @deprecated `{@link createNodesV2} is replacing this. Update your plugin to export its own `createNodesV2` function that wraps this one instead.`
+ */
+exports.createNodes = [
+    get_gradle_report_1.gradleConfigGlob,
+    (configFile, options, context) => {
+        devkit_1.logger.warn('`createNodes` is deprecated. Update your plugin to utilize createNodesV2 instead. In Nx 20, this will error.');
+        (0, get_gradle_report_1.populateGradleReport)(context.workspaceRoot);
+        const gradleReport = (0, get_gradle_report_1.getCurrentGradleReport)();
+        const internalCreateNodes = (0, exports.makeCreateNodes)(gradleReport, {});
+        return internalCreateNodes(configFile, options, context);
     },
 ];
-function createGradleProject(gradleFilePath, options, context) {
+function createGradleProject(gradleReport, gradleFilePath, options, context) {
     try {
-        const { gradleProjectToTasksTypeMap, gradleFileToOutputDirsMap, gradleFileToGradleProjectMap, gradleProjectToProjectName, } = (0, get_gradle_report_1.getGradleReport)();
+        const { gradleProjectToTasksTypeMap, gradleFileToOutputDirsMap, gradleFileToGradleProjectMap, gradleProjectToProjectName, } = gradleReport;
         const gradleProject = gradleFileToGradleProjectMap.get(gradleFilePath);
         const projectName = gradleProjectToProjectName.get(gradleProject);
         if (!projectName) {
@@ -88,12 +110,14 @@ function createGradleTargets(tasks, options, context, outputDirs, gradleProject)
             command: `${(0, exec_gradle_1.getGradleExecFile)()} ${gradleProject ? gradleProject + ':' : ''}${task.name}`,
             cache: cacheableTaskType.has(task.type),
             inputs: inputsMap[task.name],
-            outputs: outputs ? [outputs] : undefined,
             dependsOn: dependsOnMap[task.name],
             metadata: {
                 technologies: ['gradle'],
             },
         };
+        if (outputs) {
+            targets[targetName].outputs = [outputs];
+        }
         if (!targetGroups[task.type]) {
             targetGroups[task.type] = [];
         }

package/src/utils/get-gradle-report.d.ts

@@ -1,4 +1,5 @@
 export declare const fileSeparator: string;
+export declare const newLineSeparator: string;
 export interface GradleReport {
     gradleFileToGradleProjectMap: Map<string, string>;
     buildFileToDepsMap: Map<string, string>;
@@ -6,6 +7,7 @@ export interface GradleReport {
     gradleProjectToTasksTypeMap: Map<string, Map<string, string>>;
     gradleProjectToProjectName: Map<string, string>;
 }
-export declare function invalidateGradleReportCache(): void;
-export declare function getGradleReport(): GradleReport;
+export declare const gradleConfigGlob = "**/build.{gradle.kts,gradle}";
+export declare function getCurrentGradleReport(): GradleReport;
+export declare function populateGradleReport(workspaceRoot: string): void;
 export declare function processProjectReports(projectReportLines: string[]): GradleReport;

package/src/utils/get-gradle-report.js

@@ -1,35 +1,45 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processProjectReports = exports.getGradleReport = exports.invalidateGradleReportCache = exports.fileSeparator = void 0;
+exports.processProjectReports = exports.populateGradleReport = exports.getCurrentGradleReport = exports.gradleConfigGlob = exports.newLineSeparator = exports.fileSeparator = void 0;
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const devkit_1 = require("@nx/devkit");
 const exec_gradle_1 = require("./exec-gradle");
+const workspace_context_1 = require("nx/src/utils/workspace-context");
 exports.fileSeparator = process.platform.startsWith('win')
     ? 'file:///'
     : 'file://';
-const newLineSeparator = process.platform.startsWith('win') ? '\r\n' : '\n';
+exports.newLineSeparator = process.platform.startsWith('win')
+    ? '\r\n'
+    : '\n';
 let gradleReportCache;
-function invalidateGradleReportCache() {
-    gradleReportCache = undefined;
+let gradleCurrentConfigHash;
+exports.gradleConfigGlob = '**/build.{gradle.kts,gradle}';
+function getCurrentGradleReport() {
+    if (!gradleReportCache) {
+        throw new Error('Expected cached gradle report. Please open an issue at https://github.com/nrwl/nx/issues/new/choose');
+    }
+    return gradleReportCache;
 }
-exports.invalidateGradleReportCache = invalidateGradleReportCache;
-function getGradleReport() {
-    if (gradleReportCache) {
-        return gradleReportCache;
+exports.getCurrentGradleReport = getCurrentGradleReport;
+function populateGradleReport(workspaceRoot) {
+    const gradleConfigHash = (0, workspace_context_1.hashWithWorkspaceContext)(workspaceRoot, [
+        exports.gradleConfigGlob,
+    ]);
+    if (gradleReportCache && gradleConfigHash === gradleCurrentConfigHash) {
+        return;
     }
     const gradleProjectReportStart = performance.mark('gradleProjectReport:start');
     const projectReportLines = (0, exec_gradle_1.execGradle)(['projectReport'], {
-        cwd: devkit_1.workspaceRoot,
+        cwd: workspaceRoot,
     })
         .toString()
-        .split(newLineSeparator);
+        .split(exports.newLineSeparator);
     const gradleProjectReportEnd = performance.mark('gradleProjectReport:end');
     performance.measure('gradleProjectReport', gradleProjectReportStart.name, gradleProjectReportEnd.name);
     gradleReportCache = processProjectReports(projectReportLines);
-    return gradleReportCache;
 }
-exports.getGradleReport = getGradleReport;
+exports.populateGradleReport = populateGradleReport;
 function processProjectReports(projectReportLines) {
     /**
      * Map of Gradle File path to Gradle Project Name
@@ -75,7 +85,7 @@ function processProjectReports(projectReportLines) {
                 }
                 const [_, file] = projectReportLines[index].split(exports.fileSeparator);
                 const propertyReportLines = (0, node_fs_1.existsSync)(file)
-                    ? (0, node_fs_1.readFileSync)(file).toString().split(newLineSeparator)
+                    ? (0, node_fs_1.readFileSync)(file).toString().split(exports.newLineSeparator)
                     : [];
                 let projectName, absBuildFilePath, absBuildDirPath;
                 const outputDirMap = new Map();
@@ -117,7 +127,7 @@ function processProjectReports(projectReportLines) {
                 const [_, file] = projectReportLines[index].split(exports.fileSeparator);
                 const taskTypeMap = new Map();
                 const tasksFileLines = (0, node_fs_1.existsSync)(file)
-                    ? (0, node_fs_1.readFileSync)(file).toString().split(newLineSeparator)
+                    ? (0, node_fs_1.readFileSync)(file).toString().split(exports.newLineSeparator)
                     : [];
                 let i = 0;
                 while (i < tasksFileLines.length) {