v3.1.0 (#62)

Author: github-actions[bot]

.github/workflows/ci-cd.yml

@@ -4,6 +4,9 @@ on:
   workflow_dispatch:
   push:
     branches: '**'
+  pull_request:
+    branches:
+      - dev
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -41,7 +44,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        storage-driver: [filesystem, memory, s3]
+        storage-driver: [filesystem, memory, s3, gcs]
         db-driver: [postgres, mysql, sqlite]
     steps:
       - name: pnpm install
@@ -50,6 +53,7 @@ jobs:
       - run: VITEST_DB_DRIVER=${{ matrix.db-driver }} VITEST_STORAGE_DRIVER=${{ matrix.storage-driver }} pnpm run test:run
 
   deploy:
+    if: github.event.ref == 'refs/heads/dev'
     name: 🚀 Build and push
     permissions:
       packages: write

Dockerfile

@@ -9,6 +9,7 @@ RUN corepack enable
 RUN corepack prepare pnpm@latest-9 --activate
 
 COPY package.json pnpm-lock.yaml .npmrc ./
+COPY patches patches
 
 RUN --mount=type=cache,target=/root/.local/share/pnpm/store pnpm fetch --prod
 

docs/content/1.getting-started/2.storage-drivers.md

@@ -5,4 +5,5 @@ description: A list of storage drivers available for the GitHub Actions Cache Se
 
 - [File System](/storage-drivers/filesystem)
 - [S3 / MinIO](/storage-drivers/s3)
+- [GCS](/storage-drivers/gcs)
 - [Memory](/storage-drivers/memory)

docs/content/2.storage-drivers/gcs.md

@@ -0,0 +1,60 @@
+---
+title: Google Cloud Storage
+description: This storage driver stores the cache in a GCS bucket.
+---
+
+Driver: `gcs`
+
+This storage driver stores the cache in a GCS bucket.
+
+## Configuration
+
+### `docker-compose` GCS bucket
+
+```yaml [docker-compose.yml]
+version: '3.9'
+
+services:
+  cache-server:
+    image: ghcr.io/falcondev-oss/github-actions-cache-server:latest
+    ports:
+      - '3000:3000'
+    environment:
+      URL_ACCESS_TOKEN: random_token
+      API_BASE_URL: http://localhost:3000
+
+      STORAGE_DRIVER: gcs
+      STORAGE_GCS_BUCKET: gh-actions-cache
+      # Optional, not required if running in GCP
+      STORAGE_GCS_SERVICE_ACCOUNT_KEY: /gcp/config/application_default_credentials.json
+    volumes:
+      - cache-data:/app/.data
+
+      # Use host's application default credentials
+      - $HOME/.config/gcloud:/gcp/config:ro
+
+volumes:
+  cache-data:
+```
+
+### Environment Variables
+
+Don't forget to set the `STORAGE_DRIVER` environment variable to `gcs` to use the GCS storage driver.
+
+#### `STORAGE_GCS_BUCKET`
+
+Example: `gh-actions-cache`
+
+The name of the GCS bucket used for storage.
+
+#### `STORAGE_GCS_SERVICE_ACCOUNT_KEY`
+
+Example: `/config/auth/serviceaccount.json`
+
+Path to the service account key used for authentication. If not set, [Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials) is used.
+
+#### `STORAGE_GCS_ENDPOINT`
+
+Example: `http://localhost:9000`
+
+The API endpoint for GCS.

lib/db/index.ts

@@ -19,7 +19,9 @@ export interface CacheKeysTable {
   accessed_at: string
 }
 
-async function initializeDatabase() {
+let db: Kysely<Database>
+
+export async function initializeDatabase() {
   const driverName = ENV.DB_DRIVER
   const driverSetup = getDatabaseDriver(driverName)
   if (!driverSetup) {
@@ -31,7 +33,7 @@ async function initializeDatabase() {
 
   const driver = await driverSetup()
 
-  const db = new Kysely<Database>({
+  db = new Kysely<Database>({
     dialect: driver,
   })
 
@@ -52,12 +54,8 @@ async function initializeDatabase() {
   }
   logger.debug('Migration results', results)
   logger.success('Database migrated')
-
-  return db
 }
 
-const db = await initializeDatabase()
-
 /**
  * @see https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#matching-a-cache-key
  */

lib/env.ts

@@ -3,7 +3,7 @@ import { z } from 'zod'
 const envSchema = z.object({
   URL_ACCESS_TOKEN: z.string().min(1),
   CLEANUP_OLDER_THAN_DAYS: z.coerce.number().int().min(0).default(90),
-  API_BASE_URL: z.string().min(1),
+  API_BASE_URL: z.string().url(),
   STORAGE_DRIVER: z.string().toLowerCase().default('filesystem'),
   DB_DRIVER: z.string().toLowerCase().default('sqlite'),
   TEMP_DIR: z.string().min(1).default('/tmp'),

lib/storage/index.ts

@@ -20,7 +20,9 @@ await fs.mkdir(bufferDir, {
   recursive: true,
 })
 
-async function initializeStorageDriver() {
+let storageAdapter: StorageAdapter
+
+export async function initializeStorageAdapter() {
   try {
     const driverName = ENV.STORAGE_DRIVER
     const driverSetup = getStorageDriver(driverName)
@@ -38,7 +40,7 @@ async function initializeStorageDriver() {
     const commitLocks = new Set<number>()
     const uploadChunkLocks = new Map<string, Promise<any>>()
 
-    return <StorageAdapter>{
+    storageAdapter = {
       async reserveCache(key, version, cacheSize) {
         logger.debug('Reserve: Reserving cache for', key, version, cacheSize ?? '[no cache size]')
         const bufferKey = `${key}:${version}`
@@ -199,4 +201,6 @@ async function initializeStorageDriver() {
   }
 }
 
-export const storageAdapter = await initializeStorageDriver()
+export function useStorageAdapter() {
+  return storageAdapter
+}

package.json

@@ -1,7 +1,7 @@
 {
   "name": "github-actions-cache-server",
   "type": "module",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "private": true,
   "packageManager": "pnpm@9.1.3",
   "engines": {
@@ -24,11 +24,13 @@
     "extends": "gh:falcondev-it/configs/changelogithub"
   },
   "dependencies": {
+    "@google-cloud/storage": "^7.12.1",
     "@types/better-sqlite3": "^7.6.11",
     "@types/pg": "^8.11.6",
     "better-sqlite3": "^11.1.2",
     "consola": "^3.2.3",
     "croner": "^8.1.0",
+    "execa": "^9.3.1",
     "h3": "^1.12.0",
     "kysely": "^0.27.4",
     "minio": "^8.0.1",
@@ -65,5 +67,10 @@
     "ts-pattern": "^5.2.0",
     "vitest": "^2.0.4",
     "wait-on": "^8.0.0"
+  },
+  "pnpm": {
+    "patchedDependencies": {
+      "nitropack@2.9.7": "patches/nitropack@2.9.7.patch"
+    }
   }
 }

patches/nitropack@2.9.7.patch

@@ -0,0 +1,41 @@
+diff --git a/dist/runtime/app.mjs b/dist/runtime/app.mjs
+index 6e968f59e719851b0fc166bc02a30e41ebbb8e63..10d19fed1cf71f82d912be1210dc9ec906fe9d6f 100644
+--- a/dist/runtime/app.mjs
++++ b/dist/runtime/app.mjs
+@@ -22,7 +22,7 @@ import { nitroAsyncContext } from "./context.mjs";
+ import { plugins } from "#internal/nitro/virtual/plugins";
+ import errorHandler from "#internal/nitro/virtual/error-handler";
+ import { handlers } from "#internal/nitro/virtual/server-handlers";
+-function createNitroApp() {
++async function createNitroApp() {
+   const config = useRuntimeConfig();
+   const hooks = createHooks();
+   const captureError = (error, context = {}) => {
+@@ -140,7 +140,7 @@ function createNitroApp() {
+   };
+   for (const plugin of plugins) {
+     try {
+-      plugin(app);
++      await plugin(app);
+     } catch (err) {
+       captureError(err, { tags: ["plugin"] });
+       throw err;
+@@ -148,5 +148,5 @@ function createNitroApp() {
+   }
+   return app;
+ }
+-export const nitroApp = createNitroApp();
++export const nitroApp = await createNitroApp();
+ export const useNitroApp = () => nitroApp;
+diff --git a/dist/runtime/plugin.d.ts b/dist/runtime/plugin.d.ts
+index a83e51dc732331862e8eac011e97ae784ee525b8..7907875fe883e837e9305acccdd4cd55a1bf3353 100644
+--- a/dist/runtime/plugin.d.ts
++++ b/dist/runtime/plugin.d.ts
+@@ -1,6 +1,6 @@
+ import type { NitroApp } from "./app";
+ export interface NitroAppPlugin {
+-    (nitro: NitroApp): void;
++    (nitro: NitroApp): Promise<void> | void;
+ }
+ export declare function defineNitroPlugin(def: NitroAppPlugin): NitroAppPlugin;
+ export declare const nitroPlugin: typeof defineNitroPlugin;

plugins/cleanup.ts

@@ -1,9 +1,10 @@
 import { colorize } from 'consola/utils'
 import { Cron } from 'croner'
 
+import { useStorageAdapter } from '~/lib/storage'
+
 import { ENV } from '@/lib/env'
 import { logger } from '@/lib/logger'
-import { storageAdapter } from '@/lib/storage'
 
 export default defineNitroPlugin(() => {
   if (ENV.CLEANUP_OLDER_THAN_DAYS === 0) return
@@ -14,6 +15,6 @@ export default defineNitroPlugin(() => {
     `Cleaning up cache entries older than ${colorize('blue', `${ENV.CLEANUP_OLDER_THAN_DAYS}d`)} with schedule ${colorize('blue', job.getPattern() ?? '')}${nextRun ? ` (next run: ${nextRun.toLocaleString()})` : ''}`,
   )
   job.schedule(async () => {
-    await storageAdapter.pruneCaches(ENV.CLEANUP_OLDER_THAN_DAYS)
+    await useStorageAdapter().pruneCaches(ENV.CLEANUP_OLDER_THAN_DAYS)
   })
 })