Merge pull request #302 from gradle/fix-config-cache

Fix save/restore of configuration-cache

README.md

@@ -195,7 +195,7 @@ By default, this action aims to cache any and all reusable state that may be spe
 The state that is cached includes:
 - Any distributions downloaded to satisfy a `gradle-version` parameter ;
 - A subset of the Gradle User Home directory, including downloaded dependencies, wrapper distributions, and the local build cache ;
-- Any [configuration-cache](https://docs.gradle.org/nightly/userguide/configuration_cache.html) data stored in the project `.gradle` directory.
+- Any [configuration-cache](https://docs.gradle.org/nightly/userguide/configuration_cache.html) data stored in the project `.gradle` directory. (Only supported for Gradle 7 or higher.)
 
 To reduce the space required for caching, this action makes a best effort to reduce duplication in cache entries.
 

dist/main/index.js

@@ -64965,7 +64965,11 @@ class GradleStateCache {
     initializeGradleUserHome(gradleUserHome, initScriptsDir) {
         const propertiesFile = path_1.default.resolve(gradleUserHome, 'gradle.properties');
         fs_1.default.appendFileSync(propertiesFile, 'org.gradle.daemon=false');
-        const initScriptFilenames = ['build-result-capture.init.gradle', 'project-root-capture.init.gradle'];
+        const initScriptFilenames = [
+            'build-result-capture.init.gradle',
+            'project-root-capture.init.gradle',
+            'project-root-capture.plugin.groovy'
+        ];
         for (const initScriptFilename of initScriptFilenames) {
             const initScriptContent = this.readResourceAsString(initScriptFilename);
             const initScriptPath = path_1.default.resolve(initScriptsDir, initScriptFilename);

dist/post/index.js

@@ -64016,7 +64016,11 @@ class GradleStateCache {
     initializeGradleUserHome(gradleUserHome, initScriptsDir) {
         const propertiesFile = path_1.default.resolve(gradleUserHome, 'gradle.properties');
         fs_1.default.appendFileSync(propertiesFile, 'org.gradle.daemon=false');
-        const initScriptFilenames = ['build-result-capture.init.gradle', 'project-root-capture.init.gradle'];
+        const initScriptFilenames = [
+            'build-result-capture.init.gradle',
+            'project-root-capture.init.gradle',
+            'project-root-capture.plugin.groovy'
+        ];
         for (const initScriptFilename of initScriptFilenames) {
             const initScriptContent = this.readResourceAsString(initScriptFilename);
             const initScriptPath = path_1.default.resolve(initScriptsDir, initScriptFilename);

src/cache-base.ts

@@ -170,7 +170,11 @@ export class GradleStateCache {
         const propertiesFile = path.resolve(gradleUserHome, 'gradle.properties')
         fs.appendFileSync(propertiesFile, 'org.gradle.daemon=false')
 
-        const initScriptFilenames = ['build-result-capture.init.gradle', 'project-root-capture.init.gradle']
+        const initScriptFilenames = [
+            'build-result-capture.init.gradle',
+            'project-root-capture.init.gradle',
+            'project-root-capture.plugin.groovy'
+        ]
         for (const initScriptFilename of initScriptFilenames) {
             const initScriptContent = this.readResourceAsString(initScriptFilename)
             const initScriptPath = path.resolve(initScriptsDir, initScriptFilename)
@@ -179,7 +183,7 @@ export class GradleStateCache {
     }
 
     private readResourceAsString(resource: string): string {
-        // Resolving relative to __dirname will force the compiler to inline the content in the distribution
+        // Resolving relative to __dirname will allow node to find the resource at runtime
         const absolutePath = path.resolve(__dirname, '..', '..', 'src', 'resources', resource)
         return fs.readFileSync(absolutePath, 'utf8')
     }

src/resources/build-result-capture.init.gradle

@@ -27,7 +27,10 @@ if (isTopLevelBuild) {
 
 def registerCallbacks(buildScanExtension, rootProjectName) {
     buildScanExtension.with {
+        def requestedTasks = gradle.startParameter.taskNames.join(" ")
+        def gradleVersion = GradleVersion.current().version
         def buildFailed = false
+
         buildFinished { result ->
             buildFailed = (result.failure != null)
         }
@@ -38,8 +41,6 @@ def registerCallbacks(buildScanExtension, rootProjectName) {
             
             def buildResultsFile = new File(buildResultsDir, System.getenv("GITHUB_ACTION") + System.currentTimeMillis() + ".json")
 
-            def requestedTasks = gradle.startParameter.taskNames.join(" ")
-            def gradleVersion = GradleVersion.current().version
             def buildScanUri = buildScan.buildScanUri.toASCIIString()
             def buildResults = [
                 rootProject: rootProjectName, 

src/resources/project-root-capture.init.gradle

@@ -1,12 +1,10 @@
-// Capture the build root directory for each executed Gradle build.
+import org.gradle.util.GradleVersion
+
 // Only run against root build. Do not run against included builds.
 def isTopLevelBuild = gradle.getParent() == null
-if (isTopLevelBuild) {
+// Only record configuration-cache entries for Gradle 7+
-    settingsEvaluated { settings ->
+def isAtLeastGradle7 = GradleVersion.current() >= GradleVersion.version('7.0')
-        def projectRootEntry = settings.rootDir.absolutePath + '\n'
+
-        def projectRootList = new File(settings.gradle.gradleUserHomeDir, "project-roots.txt")
+if (isTopLevelBuild && isAtLeastGradle7) {   
-        if (!projectRootList.exists() || !projectRootList.text.contains(projectRootEntry)) {
+    apply from: 'project-root-capture.plugin.groovy'
-            projectRootList << projectRootEntry
+}
-        }
-    }
-}

src/resources/project-root-capture.plugin.groovy

@@ -0,0 +1,40 @@
+
+/*
+ * Capture the build root directory for each executed Gradle build.
+ * This is used to save/restore configuration-cache files, so:
+ * - The implementation only makes sense if it's config-cache compatible
+ * - We only need to support Gradle 7+
+ */
+
+import org.gradle.tooling.events.*
+
+settingsEvaluated { settings ->
+    def rootDir = settings.rootDir.absolutePath
+    def rootListLocation = new File(settings.gradle.gradleUserHomeDir, "project-roots.txt").absolutePath
+
+    def projectTracker = gradle.sharedServices.registerIfAbsent("gradle-build-action-projectRootTracker", ProjectTracker, { spec ->
+        spec.getParameters().getRootDir().set(rootDir);
+        spec.getParameters().getRootListLocation().set(rootListLocation);
+    })
+
+    gradle.services.get(BuildEventsListenerRegistry).onTaskCompletion(projectTracker)
+}
+
+abstract class ProjectTracker implements BuildService<ProjectTracker.Params>, OperationCompletionListener, AutoCloseable {
+    interface Params extends BuildServiceParameters {
+        Property<String> getRootDir();
+        Property<String> getRootListLocation();
+    }
+
+    public void onFinish(FinishEvent finishEvent) {}
+
+    @Override
+    public void close() {
+        def rootDir = getParameters().getRootDir().get()
+        def rootDirEntry = rootDir + '\n'
+        def rootListFile = new File(getParameters().getRootListLocation().get())
+        if (!rootListFile.exists() || !rootListFile.text.contains(rootDirEntry)) {
+            rootListFile << rootDirEntry
+        }
+    }
+}