Extract caching logic into a separate gradle-actions-caching component (#885)

With this change, the caching functionality of `setup-gradle` and
`dependency-submission` is now provided by `gradle-actions-caching`, a
closed-source library distributed under our [Terms of
Use](https://gradle.com/legal/terms-of-use/). The rest of the action
implementation remains open source.

Using `setup-gradle` or `dependency-submission` with caching enabled
involves loading and using the `gradle-actions-caching` component,
requiring acceptance of the [Terms of
Use](https://gradle.com/legal/terms-of-use/). There are no functional
changes to caching provided by these actions: all workflows will
continue to function as before.

The non-caching aspects of action implementation remain open source. By
running these actions with caching disabled they can be used without
ever loading `gradle-actions-caching` or accepting the license terms.

Supporting the caching infrastructure in this project requires a
substantial engineering investment by Gradle Technologies, which we can
sustain thanks to Develocity, our commercial offering. Caching
technologies are a core part of the Develocity offering, and the caching
in `setup-gradle` fits squarely in that space.

This licensing change lets us continue to build advanced capabilities
that go beyond what we would offer as open source. Proper
production-ready Configuration Cache support will be the first
capability. Improving build performance for self-hosted runners will
follow.

We may introduce functionality restrictions in future updates. However,
caching functionality will remain free for public repositories.
We have a long-standing commitment to open source, as maintainers of
Gradle Build Tool, and by [sponsoring the open source
community](https://gradle.com/oss-sponsored-by-develocity/) with free
Develocity licenses. Public repositories are primarily used by open
source projects, and we remain committed to supporting them.

- Implementation of caching logic to save and restore Gradle User Home
content has been removed, replaced by the `gradle-actions-caching`
component.
- The `@actions/caching` library is still used to cache Gradle
distributions that are downloaded and provisioned by `setup-gradle`.
This PR updates to the latest version of `@actions/caching`, and removes
the patch that is no longer required.
- License notices are now displayed in documentation, logs and the
generated Job Summary.

sources/src/setup-gradle.ts

@@ -3,13 +3,12 @@ import * as exec from '@actions/exec'
 import * as fs from 'fs'
 import * as path from 'path'
 import * as os from 'os'
-import * as caches from './caching/caches'
 import * as jobSummary from './job-summary'
 import * as buildScan from './develocity/build-scan'
 
 import {loadBuildResults, markBuildResultsProcessed} from './build-results'
-import {CacheListener, generateCachingReport} from './caching/cache-reporting'
-import {DaemonController} from './daemon-controller'
+import {getCacheService} from './cache-service-loader'
+import {CacheOptions} from './cache-service'
 import {
     BuildScanConfig,
     CacheConfig,
@@ -18,11 +17,10 @@ import {
     getWorkspaceDirectory
 } from './configuration'
 import * as wrapperValidator from './wrapper-validation/wrapper-validator'
+import {initializeGradleUserHome} from './gradle-user-home'
 
 const GRADLE_SETUP_VAR = 'GRADLE_BUILD_ACTION_SETUP_COMPLETED'
-const USER_HOME = 'USER_HOME'
 const GRADLE_USER_HOME = 'GRADLE_USER_HOME'
-const CACHE_LISTENER = 'CACHE_LISTENER'
 
 export async function setup(
     cacheConfig: CacheConfig,
@@ -37,19 +35,17 @@ export async function setup(
         core.info('Gradle setup only performed on first gradle/actions step in workflow.')
         return false
     }
-    // Record setup complete: visible to all subsequent actions and prevents duplicate setup
+    // Record setup complete: visible to subsequent actions and prevents duplicate setup
     core.exportVariable(GRADLE_SETUP_VAR, true)
     // Record setup complete: visible in post-action, to control action completion
     core.saveState(GRADLE_SETUP_VAR, true)
-
-    // Save the User Home and Gradle User Home for use in the post-action step.
-    core.saveState(USER_HOME, userHome)
+    // Save the Gradle User Home for use in the post-action step.
     core.saveState(GRADLE_USER_HOME, gradleUserHome)
 
-    const cacheListener = new CacheListener()
-    await caches.restore(userHome, gradleUserHome, cacheListener, cacheConfig)
+    initializeGradleUserHome(userHome, gradleUserHome, cacheConfig.getCacheEncryptionKey())
 
-    core.saveState(CACHE_LISTENER, cacheListener.stringify())
+    const cacheService = await getCacheService(cacheConfig)
+    await cacheService.restore(gradleUserHome, cacheOptionsFrom(cacheConfig))
 
     await wrapperValidator.validateWrappers(wrapperValidationConfig, getWorkspaceDirectory(), gradleUserHome)
 
@@ -67,14 +63,9 @@ export async function complete(cacheConfig: CacheConfig, summaryConfig: SummaryC
 
     const buildResults = loadBuildResults()
 
-    const userHome = core.getState(USER_HOME)
     const gradleUserHome = core.getState(GRADLE_USER_HOME)
-    const cacheListener: CacheListener = CacheListener.rehydrate(core.getState(CACHE_LISTENER))
-
-    const daemonController = new DaemonController(buildResults)
-    await caches.save(userHome, gradleUserHome, cacheListener, daemonController, buildResults, cacheConfig)
-
-    const cachingReport = generateCachingReport(cacheListener)
+    const cacheService = await getCacheService(cacheConfig)
+    const cachingReport = await cacheService.save(gradleUserHome, buildResults, cacheOptionsFrom(cacheConfig))
     await jobSummary.generateJobSummary(buildResults, cachingReport, summaryConfig)
 
     markBuildResultsProcessed()
@@ -84,6 +75,20 @@ export async function complete(cacheConfig: CacheConfig, summaryConfig: SummaryC
     return true
 }
 
+function cacheOptionsFrom(config: CacheConfig): CacheOptions {
+    return {
+        disabled: config.isCacheDisabled(),
+        readOnly: config.isCacheReadOnly(),
+        writeOnly: config.isCacheWriteOnly(),
+        overwriteExisting: config.isCacheOverwriteExisting(),
+        strictMatch: config.isCacheStrictMatch(),
+        cleanup: config.getCacheCleanupOption(),
+        encryptionKey: config.getCacheEncryptionKey() || undefined,
+        includes: config.getCacheIncludes(),
+        excludes: config.getCacheExcludes()
+    }
+}
+
 async function determineGradleUserHome(): Promise<string> {
     const customGradleUserHome = process.env['GRADLE_USER_HOME']
     if (customGradleUserHome) {