Cleanups and package refactoring

packages/cache/src/internal/shared/cacheTwirpClient.ts

@@ -1,10 +1,10 @@
 import { info, debug } from '@actions/core'
-import { getRuntimeToken, getCacheServiceURL } from './config'
+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'
-// import {getUserAgentString} from './user-agent'
-// import {NetworkError, UsageError} from './errors'
+import { CacheServiceClientJSON } from '../../generated/results/api/v1/cache.twirp'
 
 // The twirp http client must implement this interface
 interface Rpc {
@@ -100,9 +100,9 @@ class CacheServiceClient implements Rpc {
                 isRetryable = this.isRetryableHttpStatusCode(statusCode)
                 errorMessage = `Failed request: (${statusCode}) ${response.message.statusMessage}`
                 if (body.msg) {
-                    //   if (UsageError.isUsageErrorMessage(body.msg)) {
-                    //     throw new UsageError()
-                    //   }
+                    if (UsageError.isUsageErrorMessage(body.msg)) {
+                        throw new UsageError()
+                    }
 
                     errorMessage = `${errorMessage}: ${body.msg}`
                 }
@@ -111,13 +111,13 @@ class CacheServiceClient implements Rpc {
                     debug(`Raw Body: ${rawBody}`)
                 }
 
-                // if (error instanceof UsageError) {
-                //   throw error
-                // }
+                if (error instanceof UsageError) {
+                    throw error
+                }
 
-                // if (NetworkError.isNetworkErrorCode(error?.code)) {
-                //   throw new NetworkError(error?.code)
-                // }
+                if (NetworkError.isNetworkErrorCode(error?.code)) {
+                    throw new NetworkError(error?.code)
+                }
 
                 isRetryable = true
                 errorMessage = error.message
@@ -193,7 +193,7 @@ export function internalCacheTwirpClient(options?: {
     retryMultiplier?: number
 }): CacheServiceClientJSON {
     const client = new CacheServiceClient(
-        'actions/cache',
+        getUserAgentString(),
         options?.maxAttempts,
         options?.retryIntervalMs,
         options?.retryMultiplier

packages/cache/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')
+    }
+}

packages/cache/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}`
+}