Merge pull request #13 from aystream/fix/api-base-url-priority

fix: profile apiBaseUrl takes priority over spec root server URL

Author: EvilFreelancer

src/cli.ts

@@ -247,7 +247,11 @@ function buildRequestUrl(profile: Profile, command: CliCommand, flags: Record<st
       }
     });
 
-  const baseUrl = (command.serverUrl ?? profile.apiBaseUrl).replace(/\/+$/, "");
+  const baseUrl = (
+    command.serverUrlOverridesProfile
+      ? command.serverUrl ?? ""
+      : profile.apiBaseUrl || command.serverUrl || ""
+  ).replace(/\/+$/, "");
   let url = baseUrl ? `${baseUrl}${pathValue}` : pathValue;
 
   const queryParts: string[] = [];

src/openapi-to-commands.ts

@@ -25,6 +25,7 @@ export interface CliCommand {
   description?: string;
   requestContentType?: string;
   serverUrl?: string;
+  serverUrlOverridesProfile?: boolean;
 }
 
 type HttpMethod = "get" | "post" | "put" | "delete" | "patch" | "head" | "options" | "trace";
@@ -185,7 +186,7 @@ export class OpenapiToCommands {
         const name = multipleMethods ? `${baseName}_${op.method}` : baseName;
         const { options, requestContentType } = this.extractOptions(op, spec);
         const description = op.operation.summary ?? op.operation.description;
-        const serverUrl = this.resolveOperationServerUrl(spec, op);
+        const resolved = this.resolveOperationServerUrl(spec, op);
 
         commands.push({
           name,
@@ -194,7 +195,8 @@ export class OpenapiToCommands {
           options,
           description,
           requestContentType,
-          serverUrl,
+          serverUrl: resolved.url,
+          serverUrlOverridesProfile: resolved.overridesProfile,
         });
       }
     }
@@ -540,23 +542,28 @@ export class OpenapiToCommands {
     };
   }
 
-  private resolveOperationServerUrl(spec: OpenapiSpecLike, op: PathOperation): string | undefined {
+  private resolveOperationServerUrl(
+    spec: OpenapiSpecLike,
+    op: PathOperation
+  ): { url?: string; overridesProfile?: boolean } {
     const rootBase = this.resolveServers(Array.isArray(spec?.servers) ? spec.servers : undefined);
+
     const operationServer = this.resolveServers(op.operation.servers, rootBase);
     if (operationServer) {
-      return operationServer;
+      return { url: operationServer, overridesProfile: true };
     }
 
     const pathServer = this.resolveServers(op.pathServers, rootBase);
     if (pathServer) {
-      return pathServer;
+      return { url: pathServer, overridesProfile: true };
     }
 
     if (rootBase) {
-      return rootBase;
+      return { url: rootBase, overridesProfile: false };
     }
 
-    return this.resolveSwagger2BaseUrl(spec);
+    const swagger2Base = this.resolveSwagger2BaseUrl(spec);
+    return swagger2Base ? { url: swagger2Base, overridesProfile: false } : {};
   }
 
   private resolveServers(rawServers?: unknown[], relativeTo?: string): string | undefined {

tests/cli.test.ts

@@ -1373,4 +1373,69 @@ describe("cli", () => {
     expect(profile?.customHeaders).toEqual({ "X-Custom-Id": "abc123", "X-Tenant": "myorg" });
     expect(profile?.commandPrefix).toBe("");
   });
+
+  it.each([
+    {
+      label: "swagger 2.0 host",
+      spec: { swagger: "2.0", host: "gitlab.com", basePath: "/api/v4", schemes: ["https"], paths: { "/version": { get: { summary: "v" } } } },
+      cmd: "version",
+    },
+    {
+      label: "openapi 3.0 root servers",
+      spec: { openapi: "3.0.0", servers: [{ url: "https://public.example.com/api" }], paths: { "/status": { get: { summary: "s" } } } },
+      cmd: "status",
+    },
+  ])("profile apiBaseUrl takes priority over $label", async ({ spec, cmd }) => {
+    const localDir = `${cwd}/.ocli`;
+    const cachePath = `${localDir}/specs/p.json`;
+    const capturedConfigs: unknown[] = [];
+    const fakeHttpClient: HttpClient = {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      request: async (config: any) => {
+        capturedConfigs.push(config);
+        return { status: 200, statusText: "OK", headers: {}, config, data: {} };
+      },
+    };
+    const { profileStore, openapiLoader } = createCliDeps(cwd, homeDir, {
+      [`${localDir}/profiles.ini`]: ["[p]", "api_base_url = https://self-hosted.example.com", `openapi_spec_cache = ${cachePath}`, ""].join("\n"),
+      [cachePath]: JSON.stringify(spec),
+      [`${localDir}/current`]: "p",
+    });
+
+    await run([cmd], { cwd, profileStore, openapiLoader, httpClient: fakeHttpClient, stdout: () => {} });
+
+    const config = capturedConfigs[0] as { url: string };
+    expect(config.url).toContain("self-hosted.example.com");
+    expect(config.url).not.toContain("gitlab.com");
+    expect(config.url).not.toContain("public.example.com");
+  });
+
+  it("path-level servers override profile apiBaseUrl", async () => {
+    const localDir = `${cwd}/.ocli`;
+    const cachePath = `${localDir}/specs/ps.json`;
+    const spec = {
+      openapi: "3.0.0",
+      servers: [{ url: "https://root.example.com" }],
+      paths: { "/data": { servers: [{ url: "https://path-override.example.com" }], get: { summary: "d" } } },
+    };
+
+    const capturedConfigs: unknown[] = [];
+    const fakeHttpClient: HttpClient = {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      request: async (config: any) => {
+        capturedConfigs.push(config);
+        return { status: 200, statusText: "OK", headers: {}, config, data: {} };
+      },
+    };
+    const { profileStore, openapiLoader } = createCliDeps(cwd, homeDir, {
+      [`${localDir}/profiles.ini`]: ["[ps]", "api_base_url = https://profile.example.com", `openapi_spec_cache = ${cachePath}`, ""].join("\n"),
+      [cachePath]: JSON.stringify(spec),
+      [`${localDir}/current`]: "ps",
+    });
+
+    await run(["data"], { cwd, profileStore, openapiLoader, httpClient: fakeHttpClient, stdout: () => {} });
+
+    const config = capturedConfigs[0] as { url: string };
+    expect(config.url).toBe("https://path-override.example.com/data");
+  });
 });