Add support for dependency caching.

- Fork relevant bits from https://github.com/actions/setup-java
- Use Node.js 16
- Adjust packaging
- Update uuid and other dependencies

Closes #11

src/cache.ts

@@ -0,0 +1,201 @@
+/**
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 GitHub, Inc. and contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * Forked from https://github.com/actions/setup-java/blob/5b36705a13905facb447b6812d613a06a07e371d/src/cache.ts
+ *
+ * @fileoverview this file provides methods handling dependency cache
+ */
+
+import {join} from 'path'
+import os from 'os'
+import * as cache from '@actions/cache'
+import * as core from '@actions/core'
+import * as glob from '@actions/glob'
+
+const STATE_CACHE_PRIMARY_KEY = 'cache-primary-key'
+const CACHE_MATCHED_KEY = 'cache-matched-key'
+const CACHE_KEY_PREFIX = 'setup-java'
+
+interface PackageManager {
+  id: 'maven' | 'gradle' | 'sbt'
+  /**
+   * Paths of the file that specify the files to cache.
+   */
+  path: string[]
+  pattern: string[]
+}
+const supportedPackageManager: PackageManager[] = [
+  {
+    id: 'maven',
+    path: [join(os.homedir(), '.m2', 'repository')],
+    // https://github.com/actions/cache/blob/0638051e9af2c23d10bb70fa9beffcad6cff9ce3/examples.md#java---maven
+    pattern: ['**/pom.xml']
+  },
+  {
+    id: 'gradle',
+    path: [
+      join(os.homedir(), '.gradle', 'caches'),
+      join(os.homedir(), '.gradle', 'wrapper')
+    ],
+    // https://github.com/actions/cache/blob/0638051e9af2c23d10bb70fa9beffcad6cff9ce3/examples.md#java---gradle
+    pattern: [
+      '**/*.gradle*',
+      '**/gradle-wrapper.properties',
+      'buildSrc/**/Versions.kt',
+      'buildSrc/**/Dependencies.kt'
+    ]
+  },
+  {
+    id: 'sbt',
+    path: [
+      join(os.homedir(), '.ivy2', 'cache'),
+      join(os.homedir(), '.sbt'),
+      getCoursierCachePath(),
+      // Some files should not be cached to avoid resolution problems.
+      // In particular the resolution of snapshots (ideological gap between maven/ivy).
+      `!${join(os.homedir(), '.sbt', '*.lock')}`,
+      `!${join(os.homedir(), '**', 'ivydata-*.properties')}`
+    ],
+    pattern: [
+      '**/*.sbt',
+      '**/project/build.properties',
+      '**/project/**.{scala,sbt}'
+    ]
+  }
+]
+
+function getCoursierCachePath(): string {
+  if (os.type() === 'Linux') return join(os.homedir(), '.cache', 'coursier')
+  if (os.type() === 'Darwin')
+    return join(os.homedir(), 'Library', 'Caches', 'Coursier')
+  return join(os.homedir(), 'AppData', 'Local', 'Coursier', 'Cache')
+}
+
+function findPackageManager(id: string): PackageManager {
+  const packageManager = supportedPackageManager.find(pm => pm.id === id)
+  if (packageManager === undefined) {
+    throw new Error(`unknown package manager specified: ${id}`)
+  }
+  return packageManager
+}
+
+/**
+ * A function that generates a cache key to use.
+ * Format of the generated key will be "${{ platform }}-${{ id }}-${{ fileHash }}"".
+ * If there is no file matched to {@link PackageManager.path}, the generated key ends with a dash (-).
+ * @see {@link https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows#matching-a-cache-key|spec of cache key}
+ */
+async function computeCacheKey(
+  packageManager: PackageManager
+): Promise<string> {
+  const hash = await glob.hashFiles(packageManager.pattern.join('\n'))
+  return `${CACHE_KEY_PREFIX}-${process.env['RUNNER_OS']}-${packageManager.id}-${hash}`
+}
+
+/**
+ * Restore the dependency cache
+ * @param id ID of the package manager, should be "maven" or "gradle"
+ */
+export async function restore(id: string): Promise<void> {
+  const packageManager = findPackageManager(id)
+  const primaryKey = await computeCacheKey(packageManager)
+
+  core.debug(`primary key is ${primaryKey}`)
+  core.saveState(STATE_CACHE_PRIMARY_KEY, primaryKey)
+  if (primaryKey.endsWith('-')) {
+    throw new Error(
+      `No file in ${process.cwd()} matched to [${
+        packageManager.pattern
+      }], make sure you have checked out the target repository`
+    )
+  }
+
+  // No "restoreKeys" is set, to start with a clear cache after dependency update (see https://github.com/actions/setup-java/issues/269)
+  const matchedKey = await cache.restoreCache(packageManager.path, primaryKey)
+  if (matchedKey) {
+    core.saveState(CACHE_MATCHED_KEY, matchedKey)
+    core.setOutput('cache-hit', matchedKey === primaryKey)
+    core.info(`Cache restored from key: ${matchedKey}`)
+  } else {
+    core.setOutput('cache-hit', false)
+    core.info(`${packageManager.id} cache is not found`)
+  }
+}
+
+/**
+ * Save the dependency cache
+ * @param id ID of the package manager, should be "maven" or "gradle"
+ */
+export async function save(id: string): Promise<void> {
+  const packageManager = findPackageManager(id)
+  const matchedKey = core.getState(CACHE_MATCHED_KEY)
+
+  // Inputs are re-evaluted before the post action, so we want the original key used for restore
+  const primaryKey = core.getState(STATE_CACHE_PRIMARY_KEY)
+
+  if (!primaryKey) {
+    core.warning('Error retrieving key from state.')
+    return
+  } else if (matchedKey === primaryKey) {
+    // no change in target directories
+    core.info(
+      `Cache hit occurred on the primary key ${primaryKey}, not saving cache.`
+    )
+    return
+  }
+  try {
+    await cache.saveCache(packageManager.path, primaryKey)
+    core.info(`Cache saved with the key: ${primaryKey}`)
+  } catch (error) {
+    if (error.name === cache.ReserveCacheError.name) {
+      core.info(error.message)
+    } else {
+      if (isProbablyGradleDaemonProblem(packageManager, error)) {
+        core.warning(
+          'Failed to save Gradle cache on Windows. If tar.exe reported "Permission denied", try to run Gradle with `--no-daemon` option. Refer to https://github.com/actions/cache/issues/454 for details.'
+        )
+      }
+      throw error
+    }
+  }
+}
+
+/**
+ * @param packageManager the specified package manager by user
+ * @param error the error thrown by the saveCache
+ * @returns true if the given error seems related to the {@link https://github.com/actions/cache/issues/454|running Gradle Daemon issue}.
+ * @see {@link https://github.com/actions/cache/issues/454#issuecomment-840493935|why --no-daemon is necessary}
+ */
+function isProbablyGradleDaemonProblem(
+  packageManager: PackageManager,
+  error: Error
+): boolean {
+  if (
+    packageManager.id !== 'gradle' ||
+    process.env['RUNNER_OS'] !== 'Windows'
+  ) {
+    return false
+  }
+  const message = error.message || ''
+  return message.startsWith('Tar failed with error: ')
+}

src/cleanup.ts

@@ -0,0 +1,65 @@
+/**
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 GitHub, Inc. and contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * Forked from https://github.com/actions/setup-java/blob/5b36705a13905facb447b6812d613a06a07e371d/src/cleanup-java.ts
+ */
+
+import * as core from '@actions/core'
+import * as constants from './constants'
+import {isJobStatusSuccess} from './utils'
+import {save} from './cache'
+
+/**
+ * Check given input and run a save process for the specified package manager
+ * @returns Promise that will be resolved when the save process finishes
+ */
+async function saveCache(): Promise<void> {
+  const jobStatus = isJobStatusSuccess()
+  const cache = core.getInput(constants.INPUT_CACHE)
+  return jobStatus && cache ? save(cache) : Promise.resolve()
+}
+
+/**
+ * The save process is best-effort, and it should not make the workflow fail
+ * even though this process throws an error.
+ * @param promise the promise to ignore error from
+ * @returns Promise that will ignore error reported by the given promise
+ */
+async function ignoreError(promise: Promise<void>): Promise<void> {
+  try {
+    await promise
+  } catch (error) {
+    core.warning(error)
+  }
+}
+
+export async function run(): Promise<void> {
+  await ignoreError(saveCache())
+}
+
+if (require.main === module) {
+  run()
+} else {
+  // https://nodejs.org/api/modules.html#modules_accessing_the_main_module
+  core.info('the script is loaded as a module, so skipping the execution')
+}

src/constants.ts

@@ -1,5 +1,15 @@
 import * as otypes from '@octokit/types'
 
+export const INPUT_VERSION = 'version'
+export const INPUT_GDS_TOKEN = 'gds-token'
+export const INPUT_JAVA_VERSION = 'java-version'
+export const INPUT_COMPONENTS = 'components'
+export const INPUT_GITHUB_TOKEN = 'github-token'
+export const INPUT_SET_JAVA_HOME = 'set-java-home'
+export const INPUT_CACHE = 'cache'
+export const INPUT_NI_MUSL = 'native-image-musl'
+export const INPUT_JOB_STATUS = 'job-status'
+
 export const IS_LINUX = process.platform === 'linux'
 export const IS_MACOS = process.platform === 'darwin'
 export const IS_WINDOWS = process.platform === 'win32'

src/gds.ts

@@ -11,7 +11,7 @@ import {IncomingHttpHeaders} from 'http'
 import {RetryHelper} from '@actions/tool-cache/lib/retry-helper'
 import {calculateSHA256} from './utils'
 import {ok} from 'assert'
-import uuidV4 from 'uuid/v4'
+import {v4 as uuidv4} from 'uuid'
 
 interface GDSArtifactsResponse {
   readonly items: GDSArtifact[]
@@ -130,7 +130,7 @@ async function downloadTool(
   userAgent: string,
   headers?: IHeaders
 ): Promise<string> {
-  const dest = path.join(getTempDirectory(), uuidV4())
+  const dest = path.join(getTempDirectory(), uuidv4())
   await io.mkdirP(path.dirname(dest))
   core.debug(`Downloading ${url}`)
   core.debug(`Destination ${dest}`)

src/main.ts

@@ -1,7 +1,9 @@
 import * as c from './constants'
 import * as core from '@actions/core'
 import * as graalvm from './graalvm'
+import {isFeatureAvailable as isCacheAvailable} from '@actions/cache'
 import {join} from 'path'
+import {restore} from './cache'
 import {setUpDependencies} from './dependencies'
 import {setUpGUComponents} from './gu'
 import {setUpMandrel} from './mandrel'
@@ -10,14 +12,15 @@ import {setUpWindowsEnvironment} from './msvc'
 
 async function run(): Promise<void> {
   try {
-    const graalvmVersion = core.getInput('version', {required: true})
-    const gdsToken = core.getInput('gds-token')
-    const javaVersion = core.getInput('java-version', {required: true})
-    const componentsString: string = core.getInput('components')
+    const graalvmVersion = core.getInput(c.INPUT_VERSION, {required: true})
+    const gdsToken = core.getInput(c.INPUT_GDS_TOKEN)
+    const javaVersion = core.getInput(c.INPUT_JAVA_VERSION, {required: true})
+    const componentsString: string = core.getInput(c.INPUT_COMPONENTS)
     const components: string[] =
       componentsString.length > 0 ? componentsString.split(',') : []
-    const setJavaHome = core.getInput('set-java-home') === 'true'
-    const enableNativeImageMusl = core.getInput('native-image-musl') === 'true'
+    const setJavaHome = core.getInput(c.INPUT_SET_JAVA_HOME) === 'true'
+    const cache = core.getInput(c.INPUT_CACHE)
+    const enableNativeImageMusl = core.getInput(c.INPUT_NI_MUSL) === 'true'
 
     if (c.IS_WINDOWS) {
       setUpWindowsEnvironment()
@@ -67,6 +70,10 @@ async function run(): Promise<void> {
         await setUpGUComponents(gdsToken, graalVMHome, components)
       }
     }
+
+    if (cache && isCacheAvailable()) {
+      await restore(cache)
+    }
   } catch (error) {
     if (error instanceof Error) core.setFailed(error.message)
   }

src/utils.ts

@@ -112,3 +112,7 @@ function toSemVer(version: string): string {
   const patch = parts.length > 2 ? parts.slice(2).join('-') : '0'
   return `${major}.${minor}.${patch}`
 }
+
+export function isJobStatusSuccess(): boolean {
+  return core.getInput(c.INPUT_JOB_STATUS) === 'success'
+}