Merge pull request #330 from gradle/dd/cache-cleanup

Add experimental support for cache-cleanup

.github/actions/build-dist/action.yml

@@ -7,7 +7,7 @@ runs:
       shell: bash
       run: |
         npm install
-        npm run all
+        npm run build
     - name: Upload distribution
       uses: actions/upload-artifact@v3
       with:

.github/workflow-samples/gradle-plugin/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionSha256Sum=cb87f222c5585bd46838ad4db78463a5c5f3d336e5e2b98dc7c0c586527351c2
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip
+distributionSha256Sum=f6b8596b10cce501591e92f229816aa4046424f3b24d771751b06779d58c8ec4
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

.github/workflow-samples/groovy-dsl/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionSha256Sum=cb87f222c5585bd46838ad4db78463a5c5f3d336e5e2b98dc7c0c586527351c2
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip
+distributionSha256Sum=f6b8596b10cce501591e92f229816aa4046424f3b24d771751b06779d58c8ec4
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

.github/workflow-samples/groovy-dsl/settings.gradle

@@ -1,6 +1,6 @@
 plugins {
-    id "com.gradle.enterprise" version "3.10.3"
-    id "com.gradle.common-custom-user-data-gradle-plugin" version "1.7.2"
+    id "com.gradle.enterprise" version "3.11.1"
+    id "com.gradle.common-custom-user-data-gradle-plugin" version "1.8"
 }
 
 gradleEnterprise {

.github/workflow-samples/java-toolchain/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionSha256Sum=cb87f222c5585bd46838ad4db78463a5c5f3d336e5e2b98dc7c0c586527351c2
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip
+distributionSha256Sum=f6b8596b10cce501591e92f229816aa4046424f3b24d771751b06779d58c8ec4
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

.github/workflow-samples/kotlin-dsl/build.gradle.kts

@@ -10,7 +10,7 @@ dependencies {
     api("org.apache.commons:commons-math3:3.6.1")
     implementation("com.google.guava:guava:31.1-jre")
 
-    testImplementation("org.junit.jupiter:junit-jupiter:5.8.2")
+    testImplementation("org.junit.jupiter:junit-jupiter:5.9.0")
 }
 
 tasks.test {

.github/workflow-samples/kotlin-dsl/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionSha256Sum=cb87f222c5585bd46838ad4db78463a5c5f3d336e5e2b98dc7c0c586527351c2
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip
+distributionSha256Sum=f6b8596b10cce501591e92f229816aa4046424f3b24d771751b06779d58c8ec4
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

.github/workflow-samples/kotlin-dsl/settings.gradle.kts

@@ -1,6 +1,6 @@
 plugins {
-    id("com.gradle.enterprise") version "3.10.3"
-    id("com.gradle.common-custom-user-data-gradle-plugin") version "1.7.2"
+    id("com.gradle.enterprise") version "3.11.1"
+    id("com.gradle.common-custom-user-data-gradle-plugin") version "1.8"
 }
 
 gradleEnterprise {

.github/workflow-samples/no-wrapper-gradle-5/build.gradle

@@ -1,5 +1,5 @@
 plugins {
-    id "com.gradle.build-scan" version "3.10.3" 
+    id "com.gradle.build-scan" version "3.11.1" 
 }
 
 gradleEnterprise {

.github/workflow-samples/no-wrapper/settings.gradle

@@ -1,5 +1,5 @@
 plugins {
-    id "com.gradle.enterprise" version "3.10.3"
+    id "com.gradle.enterprise" version "3.11.1"
 }
 
 gradleEnterprise {

.github/workflows/ci-full-check.yml

@@ -1,6 +1,7 @@
 name: CI-full-check
 
 on:
+  workflow_dispatch:
   pull_request:
     types:
       - assigned
@@ -9,7 +10,7 @@ on:
     branches: 
       - main
     paths:
-      - '.github/workflows/**'
+      - '.github/**'
       - 'dist/**'
 
 jobs:
@@ -18,6 +19,12 @@ jobs:
     with:
       cache-key-prefix: ${{github.run_number}}-
 
+  cache-cleanup:
+    needs: build-distribution
+    uses: ./.github/workflows/integ-test-cache-cleanup.yml
+    with:
+      cache-key-prefix: ${{github.run_number}}-
+
   caching-config:
     uses: ./.github/workflows/integ-test-action-inputs-caching.yml
     with:

.github/workflows/ci-init-script-check.yml

@@ -3,9 +3,9 @@ name: CI-init-script-check
 on:
   push:
     paths:
-      - '.github/workflows/**'
+      - '.github/workflows/ci-init-script-check.yml'
       - 'src/resources/init-scripts/**'
-      - 'test/init-script-check/**'
+      - 'test/init-scripts/**'
   workflow_dispatch:
 
 jobs:

.github/workflows/ci-quick-check.yml

@@ -1,6 +1,7 @@
 name: CI-quick-check
 
 on:
+  workflow_dispatch:
   push:
     branches-ignore: main
 
@@ -13,6 +14,16 @@ jobs:
     - name: Build and upload distribution
       uses: ./.github/actions/build-dist
 
+  run-unit-tests:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout sources
+      uses: actions/checkout@v3
+    - name: Run tests
+      run: |
+        npm install
+        npm run all
+
   action-inputs:
     needs: build-distribution
     uses: ./.github/workflows/integ-test-action-inputs.yml
@@ -20,6 +31,14 @@ jobs:
       runner-os: '["ubuntu-latest"]'
       download-dist: true
 
+  cache-cleanup:
+    needs: build-distribution
+    uses: ./.github/workflows/integ-test-cache-cleanup.yml
+    with:
+      runner-os: '["ubuntu-latest"]'
+      download-dist: true
+      cache-key-prefix: ${{github.run_number}}- # Requires a fresh cache entry each run
+
   caching-config:
     needs: build-distribution
     uses: ./.github/workflows/integ-test-action-inputs-caching.yml

.github/workflows/integ-test-cache-cleanup.yml

@@ -0,0 +1,86 @@
+name: Test cache cleanup
+
+on:
+  workflow_call:
+    inputs:
+      cache-key-prefix:
+        type: string
+      runner-os:
+        type: string
+        default: '["ubuntu-latest", "windows-latest", "macos-latest"]'
+      download-dist:
+        type: boolean
+        default: false
+
+env:
+  DOWNLOAD_DIST: ${{ inputs.download-dist }}
+  GRADLE_BUILD_ACTION_CACHE_KEY_PREFIX: integ-test-cache-cleanup-${{ inputs.cache-key-prefix }}
+  GRADLE_BUILD_ACTION_CACHE_DEBUG_ENABLED: true
+
+jobs:
+  full-build:
+    strategy:
+      matrix:
+        os: ${{fromJSON(inputs.runner-os)}}
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout sources
+      uses: actions/checkout@v3
+    - name: Download distribution if required
+      uses: ./.github/actions/download-dist
+    - name: Setup Gradle
+      uses: ./
+      with:
+        cache-read-only: false # For testing, allow writing cache entries on non-default branches
+    - name: Build with 3.1
+      working-directory: test/jest/resources/cache-cleanup
+      run: gradle --no-daemon --build-cache -Dcommons-math3.version=3.1 build
+
+  # Second build will use the cache from the first build, but cleanup should remove unused artifacts
+  assemble-build:
+    needs: full-build
+    strategy:
+      matrix:
+        os: ${{fromJSON(inputs.runner-os)}}
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout sources
+      uses: actions/checkout@v3
+    - name: Download distribution if required
+      uses: ./.github/actions/download-dist
+    - name: Setup Gradle
+      uses: ./
+      with:
+        cache-read-only: false
+        gradle-home-cache-cleanup: true
+    - name: Build with 3.1.1
+      working-directory: test/jest/resources/cache-cleanup
+      run: gradle --no-daemon --build-cache -Dcommons-math3.version=3.1.1 build
+
+  check-clean-cache:
+    needs: assemble-build
+    strategy:
+      matrix:
+        os: ${{fromJSON(inputs.runner-os)}}
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout sources
+      uses: actions/checkout@v3
+    - name: Download distribution if required
+      uses: ./.github/actions/download-dist
+    - name: Setup Gradle
+      uses: ./
+      with:
+        cache-read-only: true
+    - name: Report Gradle User Home
+      run: du -hc ~/.gradle/caches/modules-2
+    - name: Verify cleaned cache
+      run: |
+        if [ ! -e ~/.gradle/caches/modules-2/files-2.1/org.apache.commons/commons-math3/3.1.1 ]; then
+          echo "::error ::Should find commons-math3 3.1.1 in cache"
+          exit 1
+        fi
+        if [ -e ~/.gradle/caches/modules-2/files-2.1/org.apache.commons/commons-math3/3.1 ]; then
+          echo "::error ::Should NOT find commons-math3 3.1 in cache"
+          exit 1
+        fi

.github/workflows/integ-test-execution.yml

@@ -51,12 +51,12 @@ jobs:
       with:
         gradle-executable: .github/workflow-samples/groovy-dsl/gradlew${{ matrix.script-suffix }}
         build-root-directory: .github/workflow-samples/no-wrapper
-        arguments: help -DgradleVersionCheck=7.5
+        arguments: help
 
   gradle-versions:
     strategy:
       matrix:
-        gradle: [7.3, 6.9, 5.6.4, 4.10.3, 3.5.1]
+        gradle: [7.5.1, 6.9.2, 5.6.4, 4.10.3, 3.5.1]
         os: ${{fromJSON(inputs.runner-os)}}
         include:
           - gradle: 5.6.4

README.md

@@ -371,6 +371,8 @@ jobs:
 
 ## Support for GitHub Enterprise Server (GHES)
 
-You can use the `gradle-build-action` on GitHub Enterprise Server, with some important limitations:
-- Support for GitHub Actions cache was introduced in GHES v3.5. Workflows using `gradle-build-action` on an earlier version of GHES will not benefit from save/restore of Gradle User Home.
+You can use the `gradle-build-action` on GitHub Enterprise Server, and benefit from the improved integration with Gradle. Depending on the version of GHES you are running, certain features may be limited:
+- Build scan links are captured and displayed in the GitHub Actions UI
+- Easily run your build with different versions of Gradle
+- Save/restore of Gradle User Home (requires GHES v3.5+ : GitHub Actions cache was introduced in GHES 3.5)
 - Support for GitHub Actions Job Summary is not yet available in any version of GHES. Instead of producing a Job Summary, the build-results summary and caching report will be written to the workflow log, as part of the post-action step.

action.yml

@@ -18,7 +18,7 @@ inputs:
       When 'true', existing entries will be read from the cache but no entries will be written.
       By default this value is 'false' for workflows on the GitHub default branch and 'true' for workflows on other branches.
     required: false
-    default: ${{ github.ref_name != github.event.repository.default_branch }}
+    default: ${{ github.event.repository != null && github.ref_name != github.event.repository.default_branch }}
 
   cache-write-only:
     description: |
@@ -70,6 +70,10 @@ inputs:
     description: Used to uniquely identify the current job invocation. Defaults to the matrix values for this job; this should not be overridden by users (INTERNAL).
     required: false
     default: ${{ toJSON(matrix) }}
+  gradle-home-cache-cleanup:
+    description: When 'true', the action will attempt to remove any stale/unused entries from the Gradle User Home prior to saving to the GitHub Actions cache.
+    required: false
+    default: false
 
 outputs:
   build-scan-url:

package.json

@@ -8,10 +8,11 @@
     "format": "prettier --write **/*.ts",
     "format-check": "prettier --check **/*.ts",
     "lint": "eslint src/**/*.ts",
-    "build": "ncc build src/main.ts --out dist/main --source-map && ncc build src/post.ts --out dist/post --source-map",
+    "compile": "ncc build src/main.ts --out dist/main --source-map && ncc build src/post.ts --out dist/post --source-map",
     "test": "jest",
     "check": "npm run format && npm run lint",
-    "all": "npm run format && npm run lint && npm run build && npm test"
+    "build": "npm run check && npm run compile",
+    "all": "npm run build && npm test"
   },
   "repository": {
     "type": "git",
@@ -25,8 +26,8 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "3.0.0",
-    "@actions/core": "1.9.0",
+    "@actions/cache": "3.0.4",
+    "@actions/core": "1.9.1",
     "@actions/exec": "1.1.1",
     "@actions/github": "5.0.3",
     "@actions/glob": "0.3.0",
@@ -35,19 +36,19 @@
     "string-argv": "0.3.1"
   },
   "devDependencies": {
-    "@types/jest": "28.1.4",
+    "@types/jest": "28.1.7",
     "@types/node": "16.11.21",
     "@types/unzipper": "0.10.5",
-    "@typescript-eslint/parser": "5.30.6",
+    "@typescript-eslint/parser": "5.33.1",
     "@vercel/ncc": "0.34.0",
-    "eslint": "8.19.0",
-    "eslint-plugin-github": "4.3.6",
-    "eslint-plugin-jest": "26.5.3",
-    "jest": "28.1.2",
+    "eslint": "8.22.0",
+    "eslint-plugin-github": "4.3.7",
+    "eslint-plugin-jest": "26.8.3",
+    "jest": "28.1.3",
     "js-yaml": "4.1.0",
     "patch-package": "6.4.7",
     "prettier": "2.7.1",
-    "ts-jest": "28.0.5",
+    "ts-jest": "28.0.8",
     "typescript": "4.7.4"
   }
 }

patches/@actions+cache+3.0.4.patch

@@ -26,10 +26,10 @@ index 16b20f7..aea77ba 100644
 +    constructor(key: string, size?: number);
 +}
 diff --git a/node_modules/@actions/cache/lib/cache.js b/node_modules/@actions/cache/lib/cache.js
-index 4dc5e88..2141dd5 100644
+index 4dc5e88..92d99d5 100644
 --- a/node_modules/@actions/cache/lib/cache.js
 +++ b/node_modules/@actions/cache/lib/cache.js
-@@ -95,16 +95,18 @@ function restoreCache(paths, primaryKey, restoreKeys, options) {
+@@ -95,26 +95,18 @@ function restoreCache(paths, primaryKey, restoreKeys, options) {
              }
              archivePath = path.join(yield utils.createTempDirectory(), utils.getCacheFileName(compressionMethod));
              core.debug(`Archive Path: ${archivePath}`);
@@ -45,11 +45,21 @@ index 4dc5e88..2141dd5 100644
              yield tar_1.extractTar(archivePath, compressionMethod);
              core.info('Cache restored successfully');
 -            return cacheEntry.cacheKey;
+-        }
+-        catch (error) {
+-            const typedError = error;
+-            if (typedError.name === ValidationError.name) {
+-                throw error;
+-            }
+-            else {
+-                // Supress all non-validation cache related errors because caching should be optional
+-                core.warning(`Failed to restore: ${error.message}`);
+-            }
 +            return restoredEntry;
          }
-         catch (error) {
-             const typedError = error;
-@@ -153,6 +155,7 @@ function saveCache(paths, key, options) {
+         finally {
+             // Try to delete the archive to save space
+@@ -153,6 +145,7 @@ function saveCache(paths, key, options) {
          const archiveFolder = yield utils.createTempDirectory();
          const archivePath = path.join(archiveFolder, utils.getCacheFileName(compressionMethod));
          core.debug(`Archive Path: ${archivePath}`);
@@ -57,7 +67,7 @@ index 4dc5e88..2141dd5 100644
          try {
              yield tar_1.createTar(archiveFolder, cachePaths, compressionMethod);
              if (core.isDebug()) {
-@@ -160,6 +163,7 @@ function saveCache(paths, key, options) {
+@@ -160,6 +153,7 @@ function saveCache(paths, key, options) {
              }
              const fileSizeLimit = 10 * 1024 * 1024 * 1024; // 10GB per repo limit
              const archiveFileSize = utils.getArchiveFileSizeInBytes(archivePath);
@@ -65,7 +75,26 @@ index 4dc5e88..2141dd5 100644
              core.debug(`File Size: ${archiveFileSize}`);
              // For GHES, this check will take place in ReserveCache API with enterprise file size limit
              if (archiveFileSize > fileSizeLimit && !utils.isGhes()) {
-@@ -203,8 +207,15 @@ function saveCache(paths, key, options) {
+@@ -182,18 +176,6 @@ function saveCache(paths, key, options) {
+             core.debug(`Saving Cache (ID: ${cacheId})`);
+             yield cacheHttpClient.saveCache(cacheId, archivePath, options);
+         }
+-        catch (error) {
+-            const typedError = error;
+-            if (typedError.name === ValidationError.name) {
+-                throw error;
+-            }
+-            else if (typedError.name === ReserveCacheError.name) {
+-                core.info(`Failed to save: ${typedError.message}`);
+-            }
+-            else {
+-                core.warning(`Failed to save: ${typedError.message}`);
+-            }
+-        }
+         finally {
+             // Try to delete the archive to save space
+             try {
+@@ -203,8 +185,15 @@ function saveCache(paths, key, options) {
                  core.debug(`Failed to delete archive: ${error}`);
              }
          }

src/cache-base.ts

@@ -101,9 +101,9 @@ export class GradleStateCache {
 
             for (const entryListener of listener.cacheEntries) {
                 if (entryListener === gradleHomeEntryListener) {
-                    entryListener.markUnsaved('cache key not changed')
+                    entryListener.markNotSaved('cache key not changed')
                 } else {
-                    entryListener.markUnsaved(`referencing '${this.cacheDescription}' cache entry not saved`)
+                    entryListener.markNotSaved(`referencing '${this.cacheDescription}' cache entry not saved`)
                 }
             }
             return

src/cache-cleaner.ts

@@ -0,0 +1,59 @@
+import * as exec from '@actions/exec'
+import fs from 'fs'
+import path from 'path'
+
+export class CacheCleaner {
+    private readonly gradleUserHome: string
+    private readonly tmpDir: string
+
+    constructor(gradleUserHome: string, tmpDir: string) {
+        this.gradleUserHome = gradleUserHome
+        this.tmpDir = tmpDir
+    }
+
+    async prepare(): Promise<void> {
+        // Reset the file-access journal so that files appear not to have been used recently
+        fs.rmSync(path.resolve(this.gradleUserHome, 'caches/journal-1'), {recursive: true, force: true})
+        fs.mkdirSync(path.resolve(this.gradleUserHome, 'caches/journal-1'), {recursive: true})
+        fs.writeFileSync(
+            path.resolve(this.gradleUserHome, 'caches/journal-1/file-access.properties'),
+            'inceptionTimestamp=0'
+        )
+
+        // Set the modification time of all files to the past: this timestamp is used when there is no matching entry in the journal
+        await this.ageAllFiles()
+
+        // Touch all 'gc' files so that cache cleanup won't run immediately.
+        await this.touchAllFiles('gc.properties')
+    }
+
+    async forceCleanup(): Promise<void> {
+        // Age all 'gc' files so that cache cleanup will run immediately.
+        await this.ageAllFiles('gc.properties')
+
+        // Run a dummy Gradle build to trigger cache cleanup
+        const cleanupProjectDir = path.resolve(this.tmpDir, 'dummy-cleanup-project')
+        fs.mkdirSync(cleanupProjectDir, {recursive: true})
+        fs.writeFileSync(
+            path.resolve(cleanupProjectDir, 'settings.gradle'),
+            'rootProject.name = "dummy-cleanup-project"'
+        )
+        fs.writeFileSync(path.resolve(cleanupProjectDir, 'build.gradle'), 'task("noop") {}')
+
+        await exec.exec(`gradle -g ${this.gradleUserHome} --no-daemon --build-cache --no-scan --quiet noop`, [], {
+            cwd: cleanupProjectDir
+        })
+    }
+
+    private async ageAllFiles(fileName = '*'): Promise<void> {
+        await exec.exec(
+            'find',
+            [this.gradleUserHome, '-name', fileName, '-exec', 'touch', '-m', '-d', '1970-01-01', '{}', '+'],
+            {}
+        )
+    }
+
+    private async touchAllFiles(fileName = '*'): Promise<void> {
+        await exec.exec('find', [this.gradleUserHome, '-name', fileName, '-exec', 'touch', '-m', '{}', '+'], {})
+    }
+}

src/cache-extract-entries.ts

@@ -150,8 +150,7 @@ abstract class AbstractEntryExtractor {
 
             // Find all matching files for this cache entry definition
             const globber = await glob.create(pattern, {
-                implicitDescendants: false,
-                followSymbolicLinks: false
+                implicitDescendants: false
             })
             const matchingFiles = await globber.glob()
 
@@ -213,7 +212,7 @@ abstract class AbstractEntryExtractor {
 
         if (previouslyRestoredKey === cacheKey) {
             cacheDebug(`No change to previously restored ${artifactType}. Not saving.`)
-            entryListener.markUnsaved('contents unchanged')
+            entryListener.markNotSaved('contents unchanged')
         } else {
             core.info(`Caching ${artifactType} with path '${pattern}' and cache key: ${cacheKey}`)
             await saveCache([pattern], cacheKey, entryListener)
@@ -308,8 +307,7 @@ export class GradleHomeEntryExtractor extends AbstractEntryExtractor {
     private async deleteWrapperZips(): Promise<void> {
         const wrapperZips = path.resolve(this.gradleUserHome, 'wrapper/dists/*/*/*.zip')
         const globber = await glob.create(wrapperZips, {
-            implicitDescendants: false,
-            followSymbolicLinks: false
+            implicitDescendants: false
         })
 
         for (const wrapperZip of await globber.glob()) {

src/cache-reporting.ts

@@ -62,11 +62,11 @@ export class CacheEntryListener {
     requestedRestoreKeys: string[] | undefined
     restoredKey: string | undefined
     restoredSize: number | undefined
+    notRestored: string | undefined
 
     savedKey: string | undefined
     savedSize: number | undefined
-
-    unsaved: string | undefined
+    notSaved: string | undefined
 
     constructor(entryName: string) {
         this.entryName = entryName
@@ -88,6 +88,11 @@ export class CacheEntryListener {
         return this
     }
 
+    markNotRestored(message: string): CacheEntryListener {
+        this.notRestored = message
+        return this
+    }
+
     markSaved(key: string, size: number | undefined): CacheEntryListener {
         this.savedKey = key
         this.savedSize = size
@@ -100,8 +105,8 @@ export class CacheEntryListener {
         return this
     }
 
-    markUnsaved(message: string): CacheEntryListener {
-        this.unsaved = message
+    markNotSaved(message: string): CacheEntryListener {
+        this.notSaved = message
         return this
     }
 }
@@ -166,9 +171,15 @@ function renderEntryDetails(listener: CacheListener): string {
 }
 
 function getRestoredMessage(entry: CacheEntryListener, cacheWriteOnly: boolean): string {
+    if (entry.notRestored) {
+        return `(Entry not restored: ${entry.notRestored})`
+    }
     if (cacheWriteOnly) {
         return '(Entry not restored: cache is write-only)'
     }
+    if (entry.requestedKey === undefined) {
+        return '(Entry not restored: not requested)'
+    }
     if (entry.restoredKey === undefined) {
         return '(Entry not restored: no match found)'
     }
@@ -179,8 +190,8 @@ function getRestoredMessage(entry: CacheEntryListener, cacheWriteOnly: boolean):
 }
 
 function getSavedMessage(entry: CacheEntryListener, cacheReadOnly: boolean): string {
-    if (entry.unsaved) {
-        return `(Entry not saved: ${entry.unsaved})`
+    if (entry.notSaved) {
+        return `(Entry not saved: ${entry.notSaved})`
     }
     if (entry.savedKey === undefined) {
         if (cacheReadOnly) {
@@ -198,7 +209,7 @@ function getCount(
     cacheEntries: CacheEntryListener[],
     predicate: (value: CacheEntryListener) => number | undefined
 ): number {
-    return cacheEntries.filter(e => predicate(e) !== undefined).length
+    return cacheEntries.filter(e => predicate(e)).length
 }
 
 function getSize(

src/cache-utils.ts

@@ -16,6 +16,7 @@ const CACHE_DISABLED_PARAMETER = 'cache-disabled'
 const CACHE_READONLY_PARAMETER = 'cache-read-only'
 const CACHE_WRITEONLY_PARAMETER = 'cache-write-only'
 const STRICT_CACHE_MATCH_PARAMETER = 'gradle-home-cache-strict-match'
+const CACHE_CLEANUP_ENABLED_PARAMETER = 'gradle-home-cache-cleanup'
 const CACHE_DEBUG_VAR = 'GRADLE_BUILD_ACTION_CACHE_DEBUG_ENABLED'
 
 const CACHE_KEY_PREFIX_VAR = 'GRADLE_BUILD_ACTION_CACHE_KEY_PREFIX'
@@ -24,6 +25,9 @@ const CACHE_KEY_JOB_VAR = 'GRADLE_BUILD_ACTION_CACHE_KEY_JOB'
 const CACHE_KEY_JOB_INSTANCE_VAR = 'GRADLE_BUILD_ACTION_CACHE_KEY_JOB_INSTANCE'
 const CACHE_KEY_JOB_EXECUTION_VAR = 'GRADLE_BUILD_ACTION_CACHE_KEY_JOB_EXECUTION'
 
+const SEGMENT_DOWNLOAD_TIMEOUT_VAR = 'SEGMENT_DOWNLOAD_TIMEOUT_MINS'
+const SEGMENT_DOWNLOAD_TIMEOUT_DEFAULT = 10 * 60 * 1000 // 10 minutes
+
 export function isCacheDisabled(): boolean {
     if (!cache.isFeatureAvailable()) {
         return true
@@ -43,6 +47,10 @@ export function isCacheDebuggingEnabled(): boolean {
     return process.env[CACHE_DEBUG_VAR] ? true : false
 }
 
+export function isCacheCleanupEnabled(): boolean {
+    return core.getBooleanInput(CACHE_CLEANUP_ENABLED_PARAMETER)
+}
+
 /**
  * Represents a key used to restore a cache entry.
  * The Github Actions cache will first try for an exact match on the key.
@@ -148,12 +156,17 @@ export async function restoreCache(
 ): Promise<cache.CacheEntry | undefined> {
     listener.markRequested(cacheKey, cacheRestoreKeys)
     try {
-        const restoredEntry = await cache.restoreCache(cachePath, cacheKey, cacheRestoreKeys)
+        // Only override the read timeout if the SEGMENT_DOWNLOAD_TIMEOUT_MINS env var has NOT been set
+        const cacheRestoreOptions = process.env[SEGMENT_DOWNLOAD_TIMEOUT_VAR]
+            ? {}
+            : {segmentTimeoutInMs: SEGMENT_DOWNLOAD_TIMEOUT_DEFAULT}
+        const restoredEntry = await cache.restoreCache(cachePath, cacheKey, cacheRestoreKeys, cacheRestoreOptions)
         if (restoredEntry !== undefined) {
             listener.markRestored(restoredEntry.key, restoredEntry.size)
         }
         return restoredEntry
     } catch (error) {
+        listener.markNotRestored((error as Error).message)
         handleCacheFailure(error, `Failed to restore ${cacheKey}`)
         return undefined
     }
@@ -166,6 +179,8 @@ export async function saveCache(cachePath: string[], cacheKey: string, listener:
     } catch (error) {
         if (error instanceof cache.ReserveCacheError) {
             listener.markAlreadyExists(cacheKey)
+        } else {
+            listener.markNotSaved((error as Error).message)
         }
         handleCacheFailure(error, `Failed to save cache entry with path '${cachePath}' and key: ${cacheKey}`)
     }

src/caches.ts

@@ -1,8 +1,9 @@
 import * as core from '@actions/core'
-import {isCacheDisabled, isCacheReadOnly, isCacheWriteOnly} from './cache-utils'
+import {isCacheCleanupEnabled, isCacheDisabled, isCacheReadOnly, isCacheWriteOnly} from './cache-utils'
 import {CacheListener} from './cache-reporting'
 import {DaemonController} from './daemon-controller'
 import {GradleStateCache} from './cache-base'
+import {CacheCleaner} from './cache-cleaner'
 
 const CACHE_RESTORED_VAR = 'GRADLE_BUILD_ACTION_CACHE_RESTORED'
 
@@ -44,6 +45,12 @@ export async function restore(gradleUserHome: string, cacheListener: CacheListen
     await core.group('Restore Gradle state from cache', async () => {
         await gradleStateCache.restore(cacheListener)
     })
+
+    if (isCacheCleanupEnabled() && !isCacheReadOnly()) {
+        core.info('Preparing cache for cleanup.')
+        const cacheCleaner = new CacheCleaner(gradleUserHome, process.env['RUNNER_TEMP']!)
+        await cacheCleaner.prepare()
+    }
 }
 
 export async function save(
@@ -69,6 +76,12 @@ export async function save(
 
     await daemonController.stopAllDaemons()
 
+    if (isCacheCleanupEnabled()) {
+        core.info('Forcing cache cleanup.')
+        const cacheCleaner = new CacheCleaner(gradleUserHome, process.env['RUNNER_TEMP']!)
+        await cacheCleaner.forceCleanup()
+    }
+
     await core.group('Caching Gradle state', async () => {
         return new GradleStateCache(gradleUserHome).save(cacheListener)
     })

test/jest/cache-cleanup.test.ts

@@ -0,0 +1,87 @@
+import * as exec from '@actions/exec'
+import fs from 'fs'
+import path from 'path'
+import {CacheCleaner} from '../../src/cache-cleaner'
+
+jest.setTimeout(120000)
+
+test('will cleanup unused dependency jars and build-cache entries', async () => {
+    const projectRoot = prepareTestProject()
+    const gradleUserHome = path.resolve(projectRoot, 'HOME')
+    const tmpDir = path.resolve(projectRoot, 'tmp')
+    const cacheCleaner = new CacheCleaner(gradleUserHome, tmpDir)
+
+    await runGradleBuild(projectRoot, 'build', '3.1')
+    
+    await cacheCleaner.prepare()
+
+    await runGradleBuild(projectRoot, 'build', '3.1.1')
+
+    const commonsMath31 = path.resolve(gradleUserHome, "caches/modules-2/files-2.1/org.apache.commons/commons-math3/3.1")
+    const commonsMath311 = path.resolve(gradleUserHome, "caches/modules-2/files-2.1/org.apache.commons/commons-math3/3.1.1")
+    const buildCacheDir = path.resolve(gradleUserHome, "caches/build-cache-1")
+
+    expect(fs.existsSync(commonsMath31)).toBe(true)
+    expect(fs.existsSync(commonsMath311)).toBe(true)
+    expect(fs.readdirSync(buildCacheDir).length).toBe(4)
+
+    await cacheCleaner.forceCleanup()
+
+    expect(fs.existsSync(commonsMath31)).toBe(false)
+    expect(fs.existsSync(commonsMath311)).toBe(true)
+    expect(fs.readdirSync(buildCacheDir).length).toBe(3)
+})
+
+test('will cleanup unused gradle versions', async () => {
+    const projectRoot = prepareTestProject()
+    const gradleUserHome = path.resolve(projectRoot, 'HOME')
+    const tmpDir = path.resolve(projectRoot, 'tmp')
+    const cacheCleaner = new CacheCleaner(gradleUserHome, tmpDir)
+
+    // Initialize HOME with 2 different Gradle versions
+    await runGradleWrapperBuild(projectRoot, 'build')
+    await runGradleBuild(projectRoot, 'build')
+    
+    await cacheCleaner.prepare()
+
+    // Run with only one of these versions
+    await runGradleBuild(projectRoot, 'build')
+
+    const gradle733 = path.resolve(gradleUserHome, "caches/7.3.3")
+    const wrapper733 = path.resolve(gradleUserHome, "wrapper/dists/gradle-7.3.3-bin")
+    const gradleCurrent = path.resolve(gradleUserHome, "caches/7.5.1")
+
+    expect(fs.existsSync(gradle733)).toBe(true)
+    expect(fs.existsSync(wrapper733)).toBe(true)
+    expect(fs.existsSync(gradleCurrent)).toBe(true)
+
+    await cacheCleaner.forceCleanup()
+
+    expect(fs.existsSync(gradle733)).toBe(false)
+    expect(fs.existsSync(wrapper733)).toBe(false)
+    expect(fs.existsSync(gradleCurrent)).toBe(true)
+})
+
+async function runGradleBuild(projectRoot: string, args: string, version: string = '3.1'): Promise<void> {
+    const status31 = await exec.exec(`gradle -g HOME --no-daemon --build-cache -Dcommons-math3.version=${version} ${args}`, [], {
+        cwd: projectRoot
+    })
+    console.log(`Gradle User Home initialized with commons-math3.version=${version} ${args}`)
+}
+
+async function runGradleWrapperBuild(projectRoot: string, args: string, version: string = '3.1'): Promise<void> {
+    const status31 = await exec.exec(`./gradlew -g HOME --no-daemon --build-cache -Dcommons-math3.version=${version} ${args}`, [], {
+        cwd: projectRoot
+    })
+    console.log(`Gradle User Home initialized with commons-math3.version=${version} ${args}`)
+}
+
+function prepareTestProject(): string {
+    const projectRoot = 'test/jest/resources/cache-cleanup'
+    fs.rmSync(path.resolve(projectRoot, 'HOME'), { recursive: true, force: true })
+    fs.rmSync(path.resolve(projectRoot, 'tmp'), { recursive: true, force: true })
+    fs.rmSync(path.resolve(projectRoot, 'build'), { recursive: true, force: true })
+    fs.rmSync(path.resolve(projectRoot, '.gradle'), { recursive: true, force: true })
+    return projectRoot
+}
+

test/jest/resources/cache-cleanup/.gitattributes

@@ -0,0 +1,6 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# These are explicitly windows files and should use crlf
+*.bat           text eol=crlf
+

test/jest/resources/cache-cleanup/.gitignore

@@ -0,0 +1,8 @@
+# Ignore Gradle project-specific cache directory
+.gradle
+
+# Ignore Gradle build output directory
+build
+
+HOME
+tmp

test/jest/resources/cache-cleanup/build.gradle

@@ -0,0 +1,11 @@
+plugins {
+    id 'java-library'
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    api "org.apache.commons:commons-math3:${System.properties['commons-math3.version']}"
+}

test/jest/resources/cache-cleanup/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

test/jest/resources/cache-cleanup/gradlew

@@ -0,0 +1,234 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+#
+#   Gradle start up script for POSIX generated by Gradle.
+#
+#   Important for running:
+#
+#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+#       noncompliant, but you have some other compliant shell such as ksh or
+#       bash, then to run this script, type that shell name before the whole
+#       command line, like:
+#
+#           ksh Gradle
+#
+#       Busybox and similar reduced shells will NOT work, because this script
+#       requires all of these POSIX shell features:
+#         * functions;
+#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
+#
+#   Important for patching:
+#
+#   (2) This script targets any POSIX shell, so it avoids extensions provided
+#       by Bash, Ksh, etc; in particular arrays are avoided.
+#
+#       The "traditional" practice of packing multiple parameters into a
+#       space-separated string is a well documented source of bugs and security
+#       problems, so this is (mostly) avoided, by progressively accumulating
+#       options in "$@", and eventually passing that to Java.
+#
+#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+#       see the in-line comments for details.
+#
+#       There are tweaks for specific operating systems such as AIX, CygWin,
+#       Darwin, MinGW, and NonStop.
+#
+#   (3) This script is generated from the Groovy template
+#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       within the Gradle project.
+#
+#       You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
+    [ -h "$app_path" ]
+do
+    ls=$( ls -ld "$app_path" )
+    link=${ls#*' -> '}
+    case $link in             #(
+      /*)   app_path=$link ;; #(
+      *)    app_path=$APP_HOME$link ;;
+    esac
+done
+
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+
+APP_NAME="Gradle"
+APP_BASE_NAME=${0##*/}
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+    echo "$*"
+} >&2
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in                #(
+  CYGWIN* )         cygwin=true  ;; #(
+  Darwin* )         darwin=true  ;; #(
+  MSYS* | MINGW* )  msys=true    ;; #(
+  NONSTOP* )        nonstop=true ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD=$JAVA_HOME/jre/sh/java
+    else
+        JAVACMD=$JAVA_HOME/bin/java
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD=java
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+    case $MAX_FD in #(
+      max*)
+        MAX_FD=$( ulimit -H -n ) ||
+            warn "Could not query maximum file descriptor limit"
+    esac
+    case $MAX_FD in  #(
+      '' | soft) :;; #(
+      *)
+        ulimit -n "$MAX_FD" ||
+            warn "Could not set maximum file descriptor limit to $MAX_FD"
+    esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+#   * args from the command line
+#   * the main class name
+#   * -classpath
+#   * -D...appname settings
+#   * --module-path (only if needed)
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+    JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    for arg do
+        if
+            case $arg in                                #(
+              -*)   false ;;                            # don't mess with options #(
+              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
+                    [ -e "$t" ] ;;                      #(
+              *)    false ;;
+            esac
+        then
+            arg=$( cygpath --path --ignore --mixed "$arg" )
+        fi
+        # Roll the args list around exactly as many times as the number of
+        # args, so each arg winds up back in the position where it started, but
+        # possibly modified.
+        #
+        # NB: a `for` loop captures its iteration list before it begins, so
+        # changing the positional parameters here affects neither the number of
+        # iterations, nor the values presented in `arg`.
+        shift                   # remove old arg
+        set -- "$@" "$arg"      # push replacement arg
+    done
+fi
+
+# Collect all arguments for the java command;
+#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
+#     shell script including quotes and variable substitutions, so put them in
+#     double quotes to make sure that they get re-expanded; and
+#   * put everything else in single quotes, so that it's not re-expanded.
+
+set -- \
+        "-Dorg.gradle.appname=$APP_BASE_NAME" \
+        -classpath "$CLASSPATH" \
+        org.gradle.wrapper.GradleWrapperMain \
+        "$@"
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+#   set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+        xargs -n1 |
+        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+        tr '\n' ' '
+    )" '"$@"'
+
+exec "$JAVACMD" "$@"

test/jest/resources/cache-cleanup/gradlew.bat

@@ -0,0 +1,89 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

test/jest/resources/cache-cleanup/settings.gradle

@@ -0,0 +1 @@
+rootProject.name = 'unused-dependencies'

test/jest/resources/cache-cleanup/src/main/java/unused/dependencies/Library.java

@@ -0,0 +1,10 @@
+/*
+ * This Java source file was generated by the Gradle 'init' task.
+ */
+package unused.dependencies;
+
+public class Library {
+    public boolean someLibraryMethod() {
+        return true;
+    }
+}