Cleanups and package refactoring

src/internal/shared/cacheTwirpClient.ts

@@ -0,0 +1,202 @@
+import { info, debug } from '@actions/core'
+import { getUserAgentString } from './user-agent'
+import { NetworkError, UsageError } from './errors'
+import { getRuntimeToken, getCacheServiceURL } from '../config'
+import { BearerCredentialHandler } from '@actions/http-client/lib/auth'
+import { HttpClient, HttpClientResponse, HttpCodes } from '@actions/http-client'
+import { CacheServiceClientJSON } from '../../generated/results/api/v1/cache.twirp'
+
+// The twirp http client must implement this interface
+interface Rpc {
+    request(
+        service: string,
+        method: string,
+        contentType: 'application/json' | 'application/protobuf',
+        data: object | Uint8Array
+    ): Promise<object | Uint8Array>
+}
+
+/**
+ * This class is a wrapper around the CacheServiceClientJSON class generated by Twirp.
+ * 
+ * It adds retry logic to the request method, which is not present in the generated client.
+ * 
+ * This class is used to interact with cache service v2.
+ */
+class CacheServiceClient implements Rpc {
+    private httpClient: HttpClient
+    private baseUrl: string
+    private maxAttempts = 5
+    private baseRetryIntervalMilliseconds = 3000
+    private retryMultiplier = 1.5
+
+    constructor(
+        userAgent: string,
+        maxAttempts?: number,
+        baseRetryIntervalMilliseconds?: number,
+        retryMultiplier?: number
+    ) {
+        const token = getRuntimeToken()
+        this.baseUrl = getCacheServiceURL()
+        if (maxAttempts) {
+            this.maxAttempts = maxAttempts
+        }
+        if (baseRetryIntervalMilliseconds) {
+            this.baseRetryIntervalMilliseconds = baseRetryIntervalMilliseconds
+        }
+        if (retryMultiplier) {
+            this.retryMultiplier = retryMultiplier
+        }
+
+        this.httpClient = new HttpClient(userAgent, [
+            new BearerCredentialHandler(token)
+        ])
+    }
+
+    // This function satisfies the Rpc interface. It is compatible with the JSON
+    // JSON generated client.
+    async request(
+        service: string,
+        method: string,
+        contentType: 'application/json' | 'application/protobuf',
+        data: object | Uint8Array
+    ): Promise<object | Uint8Array> {
+        const url = new URL(`/twirp/${service}/${method}`, this.baseUrl).href
+        debug(`[Request] ${method} ${url}`)
+        const headers = {
+            'Content-Type': contentType
+        }
+        try {
+            const { body } = await this.retryableRequest(async () =>
+                this.httpClient.post(url, JSON.stringify(data), headers)
+            )
+
+            return body
+        } catch (error) {
+            throw new Error(`Failed to ${method}: ${error.message}`)
+        }
+    }
+
+    async retryableRequest(
+        operation: () => Promise<HttpClientResponse>
+    ): Promise<{ response: HttpClientResponse; body: object }> {
+        let attempt = 0
+        let errorMessage = ''
+        let rawBody = ''
+        while (attempt < this.maxAttempts) {
+            let isRetryable = false
+
+            try {
+                const response = await operation()
+                const statusCode = response.message.statusCode
+                rawBody = await response.readBody()
+                debug(`[Response] - ${response.message.statusCode}`)
+                debug(`Headers: ${JSON.stringify(response.message.headers, null, 2)}`)
+                const body = JSON.parse(rawBody)
+                debug(`Body: ${JSON.stringify(body, null, 2)}`)
+                if (this.isSuccessStatusCode(statusCode)) {
+                    return { response, body }
+                }
+                isRetryable = this.isRetryableHttpStatusCode(statusCode)
+                errorMessage = `Failed request: (${statusCode}) ${response.message.statusMessage}`
+                if (body.msg) {
+                    if (UsageError.isUsageErrorMessage(body.msg)) {
+                        throw new UsageError()
+                    }
+
+                    errorMessage = `${errorMessage}: ${body.msg}`
+                }
+            } catch (error) {
+                if (error instanceof SyntaxError) {
+                    debug(`Raw Body: ${rawBody}`)
+                }
+
+                if (error instanceof UsageError) {
+                    throw error
+                }
+
+                if (NetworkError.isNetworkErrorCode(error?.code)) {
+                    throw new NetworkError(error?.code)
+                }
+
+                isRetryable = true
+                errorMessage = error.message
+            }
+
+            if (!isRetryable) {
+                throw new Error(`Received non-retryable error: ${errorMessage}`)
+            }
+
+            if (attempt + 1 === this.maxAttempts) {
+                throw new Error(
+                    `Failed to make request after ${this.maxAttempts} attempts: ${errorMessage}`
+                )
+            }
+
+            const retryTimeMilliseconds =
+                this.getExponentialRetryTimeMilliseconds(attempt)
+            info(
+                `Attempt ${attempt + 1} of ${this.maxAttempts
+                } failed with error: ${errorMessage}. Retrying request in ${retryTimeMilliseconds} ms...`
+            )
+            await this.sleep(retryTimeMilliseconds)
+            attempt++
+        }
+
+        throw new Error(`Request failed`)
+    }
+
+    isSuccessStatusCode(statusCode?: number): boolean {
+        if (!statusCode) return false
+        return statusCode >= 200 && statusCode < 300
+    }
+
+    isRetryableHttpStatusCode(statusCode?: number): boolean {
+        if (!statusCode) return false
+
+        const retryableStatusCodes = [
+            HttpCodes.BadGateway,
+            HttpCodes.GatewayTimeout,
+            HttpCodes.InternalServerError,
+            HttpCodes.ServiceUnavailable,
+            HttpCodes.TooManyRequests
+        ]
+
+        return retryableStatusCodes.includes(statusCode)
+    }
+
+    async sleep(milliseconds: number): Promise<void> {
+        return new Promise(resolve => setTimeout(resolve, milliseconds))
+    }
+
+    getExponentialRetryTimeMilliseconds(attempt: number): number {
+        if (attempt < 0) {
+            throw new Error('attempt should be a positive integer')
+        }
+
+        if (attempt === 0) {
+            return this.baseRetryIntervalMilliseconds
+        }
+
+        const minTime =
+            this.baseRetryIntervalMilliseconds * this.retryMultiplier ** attempt
+        const maxTime = minTime * this.retryMultiplier
+
+        // returns a random number between minTime and maxTime (exclusive)
+        return Math.trunc(Math.random() * (maxTime - minTime) + minTime)
+    }
+}
+
+export function internalCacheTwirpClient(options?: {
+    maxAttempts?: number
+    retryIntervalMs?: number
+    retryMultiplier?: number
+}): CacheServiceClientJSON {
+    const client = new CacheServiceClient(
+        getUserAgentString(),
+        options?.maxAttempts,
+        options?.retryIntervalMs,
+        options?.retryMultiplier
+    )
+    return new CacheServiceClientJSON(client)
+}

src/internal/shared/errors.ts

@@ -0,0 +1,72 @@
+export class FilesNotFoundError extends Error {
+    files: string[]
+
+    constructor(files: string[] = []) {
+        let message = 'No files were found to upload'
+        if (files.length > 0) {
+            message += `: ${files.join(', ')}`
+        }
+
+        super(message)
+        this.files = files
+        this.name = 'FilesNotFoundError'
+    }
+}
+
+export class InvalidResponseError extends Error {
+    constructor(message: string) {
+        super(message)
+        this.name = 'InvalidResponseError'
+    }
+}
+
+export class CacheNotFoundError extends Error {
+    constructor(message = 'Cache not found') {
+        super(message)
+        this.name = 'CacheNotFoundError'
+    }
+}
+
+export class GHESNotSupportedError extends Error {
+    constructor(
+        message = '@actions/cache v4.1.4+, actions/cache/save@v4+ and actions/cache/restore@v4+ are not currently supported on GHES.'
+    ) {
+        super(message)
+        this.name = 'GHESNotSupportedError'
+    }
+}
+
+export class NetworkError extends Error {
+    code: string
+
+    constructor(code: string) {
+        const message = `Unable to make request: ${code}\nIf you are using self-hosted runners, please make sure your runner has access to all GitHub endpoints: https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github`
+        super(message)
+        this.code = code
+        this.name = 'NetworkError'
+    }
+
+    static isNetworkErrorCode = (code?: string): boolean => {
+        if (!code) return false
+        return [
+            'ECONNRESET',
+            'ENOTFOUND',
+            'ETIMEDOUT',
+            'ECONNREFUSED',
+            'EHOSTUNREACH'
+        ].includes(code)
+    }
+}
+
+export class UsageError extends Error {
+    constructor() {
+        const message = `Cache storage quota has been hit. Unable to upload any new cache entries. Usage is recalculated every 6-12 hours.\nMore info on storage limits: https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions#calculating-minute-and-storage-spending`
+        super(message)
+        this.name = 'UsageError'
+    }
+
+    static isUsageErrorMessage = (msg?: string): boolean => {
+        if (!msg) return false
+        return msg.includes('insufficient usage')
+    }
+}

src/internal/shared/user-agent.ts

@@ -0,0 +1,9 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports
+const packageJson = require('../../../package.json')
+
+/**
+ * Ensure that this User Agent String is used in all HTTP calls so that we can monitor telemetry between different versions of this package
+ */
+export function getUserAgentString(): string {
+    return `@actions/cache-${packageJson.version}`
+}