Discover the Blacksmith agent via BLACKSMITH_AGENT_ADDR and fall back to the local builder when unavailable

Co-authored-by: Codesmith Staging <codesmith-bot@users.noreply.github.com>

Author: piob-io

dist/index.js

@@ -3,7 +3,7 @@ import { UserInputError } from "./user-input-error";
 import axios from "axios";
 import axiosRetry from "axios-retry";
 import { create } from "@bufbuild/protobuf";
-import { Client, createClient } from "@connectrpc/connect";
+import { Client, Code, ConnectError, createClient } from "@connectrpc/connect";
 import {
   createGrpcTransport,
   Http2SessionManager,
@@ -55,10 +55,33 @@ let cachedAgentSessionManager: Http2SessionManager | undefined;
 let cachedAgentClient: Client<typeof StickyDiskService> | undefined;
 let cachedAgentBaseUrl: string | undefined;
 
+export function getAgentAddr(): string | undefined {
+  return process.env.BLACKSMITH_AGENT_ADDR || undefined;
+}
+
+// True for environments where the agent is not expected to serve sticky
+// disks (no BLACKSMITH_AGENT_ADDR, or the agent rejected the RPC as
+// unimplemented); these are not infra failures and are not reported.
+export function isAgentUnsupportedError(error: unknown): boolean {
+  if (
+    error instanceof Error &&
+    error.message.includes("BLACKSMITH_AGENT_ADDR is not set")
+  ) {
+    return true;
+  }
+  return error instanceof ConnectError && error.code === Code.Unimplemented;
+}
+
 export function createBlacksmithAgentClient(): Client<
   typeof StickyDiskService
 > {
-  const baseUrl = `http://192.168.127.1:${process.env.BLACKSMITH_STICKY_DISK_GRPC_PORT || "5557"}`;
+  const addr = getAgentAddr();
+  if (!addr) {
+    throw new Error(
+      "BLACKSMITH_AGENT_ADDR is not set; cannot dial the Blacksmith agent",
+    );
+  }
+  const baseUrl = `http://${addr}:${process.env.BLACKSMITH_STICKY_DISK_GRPC_PORT || "5557"}`;
 
   if (cachedAgentClient && cachedAgentBaseUrl === baseUrl) {
     return cachedAgentClient;
@@ -72,9 +95,7 @@ export function createBlacksmithAgentClient(): Client<
     }
   }
 
-  core.info(
-    `Creating Blacksmith agent client with port: ${process.env.BLACKSMITH_STICKY_DISK_GRPC_PORT || "5557"}`,
-  );
+  core.info(`Creating Blacksmith agent client for ${baseUrl}`);
 
   cachedAgentSessionManager = new Http2SessionManager(baseUrl);
   const transport = createGrpcTransport({

dist/index.js.map

@@ -21,6 +21,8 @@ vi.mock("./reporter", () => ({
   reportMetric: vi.fn(),
   commitStickyDisk: vi.fn(),
   reportBuild: vi.fn(),
+  getAgentAddr: vi.fn(() => process.env.BLACKSMITH_AGENT_ADDR || undefined),
+  isAgentUnsupportedError: vi.fn(() => false),
 }));
 
 vi.mock("child_process", () => ({
@@ -48,6 +50,7 @@ describe("setup_builder", () => {
     process.env.GITHUB_REPO_NAME = "test-repo";
     process.env.BLACKSMITH_REGION = "eu-central";
     process.env.BLACKSMITH_VM_ID = "test-vm-id";
+    process.env.BLACKSMITH_AGENT_ADDR = "192.168.127.1";
   });
 
   describe("getStickyDisk", () => {
@@ -101,6 +104,7 @@ describe("setup_builder", () => {
 
   describe("writeDockerContainerBuildkitdTomlFile", () => {
     it("writes a docker-container BuildKit config with the Docker mirror", async () => {
+      process.env.BLACKSMITH_AGENT_ADDR = "192.168.127.1";
       const writeFile = vi.mocked(fs.promises.writeFile);
 
       await setupBuilder.writeDockerContainerBuildkitdTomlFile(
@@ -117,6 +121,19 @@ describe("setup_builder", () => {
         "Wrote Docker container BuildKit config to local-buildkitd.toml",
       );
     });
+
+    it("omits the Docker mirror when BLACKSMITH_AGENT_ADDR is not set", async () => {
+      delete process.env.BLACKSMITH_AGENT_ADDR;
+      const writeFile = vi.mocked(fs.promises.writeFile);
+
+      await setupBuilder.writeDockerContainerBuildkitdTomlFile(
+        "local-buildkitd.toml",
+      );
+
+      const config = writeFile.mock.calls[0][1] as string;
+      expect(config).not.toContain("mirrors");
+      expect(config).not.toContain("192.168.127.1:5000");
+    });
   });
 
   describe("logBuildCacheContents", () => {

src/reporter.ts

@@ -165,13 +165,18 @@ async function getRoutableHostDns(): Promise<string[]> {
 }
 
 function getDockerMirrorRegistryConfig(): TOML.JsonMap {
+  const agentAddr = reporter.getAgentAddr();
+  if (!agentAddr) {
+    return {};
+  }
+  const mirror = `${agentAddr}:5000`;
   return {
     "docker.io": {
-      mirrors: ["http://192.168.127.1:5000"],
+      mirrors: [`http://${mirror}`],
       http: true,
       insecure: true,
     },
-    "192.168.127.1:5000": {
+    [mirror]: {
       http: true,
       insecure: true,
     },
@@ -421,12 +426,13 @@ export async function getStickyDisk(options?: {
   const client = await reporter.createBlacksmithAgentClient();
   core.info(`Created Blacksmith agent client`);
 
-  // Test connection using up endpoint
+  // Rethrow the original error so callers can classify it from the gRPC code.
   try {
     await client.up({}, { signal: options?.signal });
     core.info("Successfully connected to Blacksmith agent");
   } catch (error) {
-    throw new Error(`grpc connection test failed: ${(error as Error).message}`);
+    core.warning(`grpc connection test failed: ${(error as Error).message}`);
+    throw error;
   }
 
   const stickyDiskKey = cacheKey;
@@ -746,11 +752,14 @@ export async function setupStickyDisk(): Promise<{
     return { device, exposeId };
   } catch (error) {
     core.warning(`Error in setupStickyDisk: ${(error as Error).message}`);
-    await reporter.reportBuildPushActionFailure(
-      "STICKYDISK_SETUP",
-      error as Error,
-      "sticky disk setup",
-    );
+    // Unsupported environments are expected; don't report them as failures.
+    if (!reporter.isAgentUnsupportedError(error)) {
+      await reporter.reportBuildPushActionFailure(
+        "STICKYDISK_SETUP",
+        error as Error,
+        "sticky disk setup",
+      );
+    }
     throw error;
   }
 }