🤖 refactor: rename VS Code oRPC helpers to API

Change-Id: If3f21c66817720222e5f5adfae79ab90abc7f01f
Signed-off-by: Thomas Kosiewski <tk@coder.com>

Author: ThomasK33

vscode/src/orpc/client.ts vscode/src/api/client.tsvscode/src/orpc/client.ts renamed to vscode/src/api/client.ts

@@ -5,9 +5,9 @@ import assert from "node:assert";
 import { createClient } from "mux/common/orpc/client";
 import type { AppRouter } from "mux/node/orpc/router";
 
-export type ORPCClient = RouterClient<AppRouter>;
+export type ApiClient = RouterClient<AppRouter>;
 
-export interface VscodeOrpcClientConfig {
+export interface ApiClientConfig {
   baseUrl: string;
   authToken?: string | undefined;
 }
@@ -25,7 +25,7 @@ function normalizeBaseUrl(baseUrl: string): string {
   return parsed.toString().replace(/\/$/, "");
 }
 
-export function createVscodeORPCClient(config: VscodeOrpcClientConfig): ORPCClient {
+export function createApiClient(config: ApiClientConfig): ApiClient {
   assert(typeof config.baseUrl === "string", "baseUrl must be a string");
 
   const normalizedBaseUrl = normalizeBaseUrl(config.baseUrl);

vscode/src/orpc/connectionCheck.ts vscode/src/api/connectionCheck.tsvscode/src/orpc/connectionCheck.ts renamed to vscode/src/api/connectionCheck.ts

@@ -1,6 +1,6 @@
 import assert from "node:assert";
 
-import type { ORPCClient } from "./client";
+import type { ApiClient } from "./client";
 
 export type ServerReachabilityResult =
   | { status: "ok" }
@@ -99,14 +99,14 @@ export async function checkServerReachable(
 }
 
 export async function checkAuth(
-  client: ORPCClient,
+  client: ApiClient,
   options?: { timeoutMs?: number }
 ): Promise<AuthCheckResult> {
   const timeoutMs = options?.timeoutMs ?? 1_000;
 
   try {
     // Used both as an auth check and a basic liveness check.
-    await promiseWithTimeout(client.general.ping("vscode"), timeoutMs, "oRPC ping");
+    await promiseWithTimeout(client.general.ping("vscode"), timeoutMs, "API ping");
     return { status: "ok" };
   } catch (error) {
     if (isUnauthorizedError(error)) {

vscode/src/orpc/discovery.ts vscode/src/api/discovery.tsvscode/src/orpc/discovery.ts renamed to vscode/src/api/discovery.ts

@@ -2,26 +2,26 @@ import * as vscode from "vscode";
 
 import { formatRelativeTime } from "mux/browser/utils/ui/dateTime";
 
-import { getAllWorkspacesFromFiles, getAllWorkspacesFromOrpc, WorkspaceWithContext } from "./muxConfig";
-import { checkAuth, checkServerReachable } from "./orpc/connectionCheck";
-import { createVscodeORPCClient } from "./orpc/client";
+import { getAllWorkspacesFromFiles, getAllWorkspacesFromApi, WorkspaceWithContext } from "./muxConfig";
+import { checkAuth, checkServerReachable } from "./api/connectionCheck";
+import { createApiClient } from "./api/client";
 import {
   clearAuthTokenOverride,
   discoverServerConfig,
   getConnectionModeSetting,
   storeAuthTokenOverride,
   type ConnectionMode,
-} from "./orpc/discovery";
+} from "./api/discovery";
 import { openWorkspace } from "./workspaceOpener";
 
-let sessionPreferredMode: "orpc" | "file" | null = null;
+let sessionPreferredMode: "api" | "file" | null = null;
 let didShowFallbackPrompt = false;
 
 const ACTION_FIX_CONNECTION_CONFIG = "Fix connection config";
 const ACTION_USE_LOCAL_FILES = "Use local file access";
 const ACTION_CANCEL = "Cancel";
 
-type OrpcConnectionFailure =
+type ApiConnectionFailure =
   | { kind: "unreachable"; baseUrl: string; error: string }
   | { kind: "unauthorized"; baseUrl: string; error: string }
   | { kind: "error"; baseUrl: string; error: string };
@@ -30,7 +30,7 @@ function formatError(error: unknown): string {
   return error instanceof Error ? error.message : String(error);
 }
 
-function describeFailure(failure: OrpcConnectionFailure): string {
+function describeFailure(failure: ApiConnectionFailure): string {
   switch (failure.kind) {
     case "unreachable":
       return `mux server is not reachable at ${failure.baseUrl}`;
@@ -41,19 +41,19 @@ function describeFailure(failure: OrpcConnectionFailure): string {
   }
 }
 
-function getWarningSuffix(failure: OrpcConnectionFailure): string {
+function getWarningSuffix(failure: ApiConnectionFailure): string {
   if (failure.kind === "unauthorized") {
     return "Using local file access while mux is running can cause inconsistencies.";
   }
   return "Using local file access can cause inconsistencies.";
 }
 
-async function tryGetWorkspacesFromOrpc(
+async function tryGetWorkspacesFromApi(
   context: vscode.ExtensionContext
-): Promise<{ workspaces: WorkspaceWithContext[] } | { failure: OrpcConnectionFailure }> {
+): Promise<{ workspaces: WorkspaceWithContext[] } | { failure: ApiConnectionFailure }> {
   try {
     const discovery = await discoverServerConfig(context);
-    const client = createVscodeORPCClient({ baseUrl: discovery.baseUrl, authToken: discovery.authToken });
+    const client = createApiClient({ baseUrl: discovery.baseUrl, authToken: discovery.authToken });
 
     const reachable = await checkServerReachable(discovery.baseUrl);
     if (reachable.status !== "ok") {
@@ -86,7 +86,7 @@ async function tryGetWorkspacesFromOrpc(
       };
     }
 
-    const workspaces = await getAllWorkspacesFromOrpc(client);
+    const workspaces = await getAllWorkspacesFromApi(client);
     return { workspaces };
   } catch (error) {
     return {
@@ -109,13 +109,13 @@ async function getWorkspacesForCommand(
     return getAllWorkspacesFromFiles();
   }
 
-  const orpcResult = await tryGetWorkspacesFromOrpc(context);
-  if ("workspaces" in orpcResult) {
-    sessionPreferredMode = "orpc";
-    return orpcResult.workspaces;
+  const apiResult = await tryGetWorkspacesFromApi(context);
+  if ("workspaces" in apiResult) {
+    sessionPreferredMode = "api";
+    return apiResult.workspaces;
   }
 
-  const failure = orpcResult.failure;
+  const failure = apiResult.failure;
 
   if (modeSetting === "server-only") {
     const selection = await vscode.window.showErrorMessage(
@@ -159,9 +159,9 @@ async function getWorkspacesForCommand(
 
   await configureConnectionCommand(context);
 
-  const retry = await tryGetWorkspacesFromOrpc(context);
+  const retry = await tryGetWorkspacesFromApi(context);
   if ("workspaces" in retry) {
-    sessionPreferredMode = "orpc";
+    sessionPreferredMode = "api";
     return retry.workspaces;
   }
 

vscode/src/extension.ts

@@ -3,7 +3,7 @@ import type { FrontendWorkspaceMetadata, WorkspaceActivitySnapshot } from "mux/c
 import { type ExtensionMetadata, readExtensionMetadata } from "mux/node/utils/extensionMetadata";
 import { createRuntime } from "mux/node/runtime/runtimeFactory";
 
-import type { ORPCClient } from "./orpc/client";
+import type { ApiClient } from "./api/client";
 
 /**
  * Workspace with extension metadata for display in VS Code extension.
@@ -44,7 +44,7 @@ export async function getAllWorkspacesFromFiles(): Promise<WorkspaceWithContext[
   return enrichAndSort(workspaces, extensionMeta);
 }
 
-export async function getAllWorkspacesFromOrpc(client: ORPCClient): Promise<WorkspaceWithContext[]> {
+export async function getAllWorkspacesFromApi(client: ApiClient): Promise<WorkspaceWithContext[]> {
   const workspaces = await client.workspace.list();
   const activityById: Record<string, WorkspaceActivitySnapshot> = await client.workspace.activity.list();