Merge pull request #107 from useblacksmith/20250714.twirp-delete

feat: migrate cache deletion to Twirp backend

Author: aadityasondhi

dist/index.js

@@ -20,33 +20,34 @@ describe("deleteCache", () => {
       ok: true,
       status: 200,
       statusText: "OK",
-      json: () => Promise.resolve({ deleted: 1 }),
+      json: () => Promise.resolve({ count: 1 }),
     } as Response);
   });
 
   const defaultParams = {
-    baseUrl: "https://api.blacksmith.sh/cache",
-    repoName: "test-repo",
+    baseUrl: "http://baseurl/",
     cacheToken: "test-token",
-    region: "eu-central",
   };
 
-  it("should send DELETE request for a specific cache key", async () => {
+  it("should send request to delete a specific cache key", async () => {
     await deleteCache({
       cacheKey: "npm-cache",
       ...defaultParams,
     });
 
     expect(mockedFetch).toHaveBeenCalledWith(
-      "https://api.blacksmith.sh/cache/caches/npm-cache",
+      "http://baseurl/twirp/github.actions.results.api.v1.CacheService/DeleteCacheEntry",
       {
-        method: "DELETE",
+        method: "POST",
         headers: {
+          "Content-Type": "application/json",
           Accept: "application/json; version=6.0-preview.1",
-          "X-GitHub-Repo-Name": "test-repo",
           Authorization: "Bearer test-token",
-          "X-Cache-Region": "eu-central",
         },
+        body: JSON.stringify({
+          key: "npm-cache",
+          prefix: false,
+        }),
       }
     );
     expect(mockedInfo).toHaveBeenCalledWith(
@@ -55,23 +56,27 @@ describe("deleteCache", () => {
     expect(mockedInfo).toHaveBeenCalledWith("Deleted 1 cache entries");
   });
 
-  it("should send DELETE request for a specific cache version", async () => {
+  it("should send request to delete a specific cache version", async () => {
     await deleteCache({
       cacheKey: "npm-cache",
       cacheVersion: "v1.0",
       ...defaultParams,
     });
 
     expect(mockedFetch).toHaveBeenCalledWith(
-      "https://api.blacksmith.sh/cache/caches/npm-cache/v1.0",
+      "http://baseurl/twirp/github.actions.results.api.v1.CacheService/DeleteCacheEntry",
       {
-        method: "DELETE",
+        method: "POST",
         headers: {
+          "Content-Type": "application/json",
           Accept: "application/json; version=6.0-preview.1",
-          "X-GitHub-Repo-Name": "test-repo",
           Authorization: "Bearer test-token",
-          "X-Cache-Region": "eu-central",
         },
+        body: JSON.stringify({
+          key: "npm-cache",
+          version: "v1.0",
+          prefix: false,
+        }),
       }
     );
     expect(mockedInfo).toHaveBeenCalledWith(
@@ -80,12 +85,12 @@ describe("deleteCache", () => {
     expect(mockedInfo).toHaveBeenCalledWith("Deleted 1 cache entries");
   });
 
-  it("should send DELETE request with prefix parameter", async () => {
+  it("should send request with prefix parameter", async () => {
     mockedFetch.mockResolvedValue({
       ok: true,
       status: 200,
       statusText: "OK",
-      json: () => Promise.resolve({ deleted: 5 }),
+      json: () => Promise.resolve({ count: 5 }),
     } as Response);
 
     await deleteCache({
@@ -95,15 +100,18 @@ describe("deleteCache", () => {
     });
 
     expect(mockedFetch).toHaveBeenCalledWith(
-      "https://api.blacksmith.sh/cache/caches/npm-?prefix",
+      "http://baseurl/twirp/github.actions.results.api.v1.CacheService/DeleteCacheEntry",
       {
-        method: "DELETE",
+        method: "POST",
         headers: {
+          "Content-Type": "application/json",
           Accept: "application/json; version=6.0-preview.1",
-          "X-GitHub-Repo-Name": "test-repo",
           Authorization: "Bearer test-token",
-          "X-Cache-Region": "eu-central",
         },
+        body: JSON.stringify({
+          key: "npm-",
+          prefix: true,
+        }),
       }
     );
     expect(mockedInfo).toHaveBeenCalledWith(
@@ -112,12 +120,12 @@ describe("deleteCache", () => {
     expect(mockedInfo).toHaveBeenCalledWith("Deleted 5 cache entries");
   });
 
-  it("should send DELETE request with empty key and prefix parameter", async () => {
+  it("should send request with empty key and prefix parameter", async () => {
     mockedFetch.mockResolvedValue({
       ok: true,
       status: 200,
       statusText: "OK",
-      json: () => Promise.resolve({ deleted: 10 }),
+      json: () => Promise.resolve({ count: 10 }),
     } as Response);
 
     await deleteCache({
@@ -127,15 +135,18 @@ describe("deleteCache", () => {
     });
 
     expect(mockedFetch).toHaveBeenCalledWith(
-      "https://api.blacksmith.sh/cache/caches/?prefix",
+      "http://baseurl/twirp/github.actions.results.api.v1.CacheService/DeleteCacheEntry",
       {
-        method: "DELETE",
+        method: "POST",
         headers: {
+          "Content-Type": "application/json",
           Accept: "application/json; version=6.0-preview.1",
-          "X-GitHub-Repo-Name": "test-repo",
           Authorization: "Bearer test-token",
-          "X-Cache-Region": "eu-central",
         },
+        body: JSON.stringify({
+          key: "",
+          prefix: true,
+        }),
       }
     );
     expect(mockedInfo).toHaveBeenCalledWith(

src/__tests__/main.test.ts

@@ -24,23 +24,20 @@ interface DeleteCacheParams {
   cacheVersion?: string;
   prefix?: boolean;
   baseUrl?: string;
-  repoName?: string;
   cacheToken?: string;
-  region?: string;
 }
 
 export async function deleteCache({
   cacheKey,
   cacheVersion,
   prefix = false,
-  baseUrl = process.env.BLACKSMITH_CACHE_URL ||
-    (process.env.PETNAME?.includes("staging")
-      ? "https://stagingapi.blacksmith.sh/cache"
-      : "https://api.blacksmith.sh/cache"),
-  repoName = process.env["GITHUB_REPO_NAME"] ?? "",
+  baseUrl = process.env.ACTIONS_RESULTS_URL ?? "",
   cacheToken = process.env["BLACKSMITH_CACHE_TOKEN"],
-  region = process.env["BLACKSMITH_REGION"] ?? "eu-central",
 }: DeleteCacheParams): Promise<void> {
+  if (!baseUrl) {
+    throw new Error("ACTIONS_RESULTS_URL not set");
+  }
+
   if (!cacheKey && !prefix) {
     throw new Error("Cache key cannot be empty unless prefix is true");
   }
@@ -51,17 +48,25 @@ export async function deleteCache({
     throw new Error("Cannot specify version when using prefix");
   }
 
-  const resource = cacheVersion ? `${cacheKey}/${cacheVersion}` : cacheKey;
-  const url = `${baseUrl}/caches/${resource}`;
+  // The baseURL always has a trailing slash, but we still add it in case it is missing.
+  if (!baseUrl.endsWith("/")) {
+    baseUrl = `${baseUrl}/`;
+  }
+  const url = `${baseUrl}twirp/github.actions.results.api.v1.CacheService/DeleteCacheEntry`;
 
-  const response = await fetchWithRetry(prefix ? `${url}?prefix` : url, {
-    method: "DELETE",
+  const response = await fetchWithRetry(url, {
+    // Twirp endpoints all use POST.
+    method: "POST",
     headers: {
+      "Content-Type": "application/json",
       Accept: "application/json; version=6.0-preview.1",
-      "X-GitHub-Repo-Name": repoName,
       Authorization: `Bearer ${cacheToken}`,
-      "X-Cache-Region": region,
     },
+    body: JSON.stringify({
+      key: cacheKey,
+      version: cacheVersion,
+      prefix,
+    }),
   });
 
   if (!response.ok && response.status !== 404) {
@@ -81,8 +86,8 @@ export async function deleteCache({
         cacheVersion ? " version" : ""
       }: ${cacheKey}${cacheVersion ? `@${cacheVersion}` : ""}`
     );
-    if (data.deleted !== undefined) {
-      info(`Deleted ${data.deleted} cache entries`);
+    if (data.count !== undefined) {
+      info(`Deleted ${data.count} cache entries`);
     }
   }
 }