Centralize OpenAPI test spec rendering

Author: RhysSullivan

apps/cloud/src/services/sources-api.node.test.ts

@@ -15,7 +15,10 @@ import {
   makeGreetingGraphqlSchema,
 } from "@executor-js/plugin-graphql/testing";
 import { makeGreetingMcpServer, serveMcpServer } from "@executor-js/plugin-mcp/testing";
-import { serveOpenApiEchoTestServer } from "@executor-js/plugin-openapi/testing";
+import {
+  makeOpenApiTestSpecJson,
+  serveOpenApiEchoTestServer,
+} from "@executor-js/plugin-openapi/testing";
 
 import { asOrg, asUser, testUserOrgScopeId } from "./__test-harness__/api-harness";
 
@@ -30,7 +33,7 @@ const MinimalSourceApi = HttpApi.make("sourcesApiTest")
   .add(PingGroup)
   .annotateMerge(OpenApi.annotations({ title: "Sources API Test", version: "1.0.0" }));
 
-const MINIMAL_OPENAPI_SPEC = JSON.stringify(OpenApi.fromApi(MinimalSourceApi));
+const MINIMAL_OPENAPI_SPEC = makeOpenApiTestSpecJson(MinimalSourceApi);
 
 // The Cloudflare OpenAPI spec is the biggest real spec we care about:
 // 16MB, 2700+ operations, thousands of shared schemas. Exercising

apps/cloud/src/services/sources-refresh.node.test.ts

@@ -9,7 +9,10 @@ import { Effect, Schema } from "effect";
 import { HttpApi, HttpApiEndpoint, HttpApiGroup, OpenApi } from "effect/unstable/httpapi";
 
 import { ScopeId } from "@executor-js/sdk";
-import { serveMutableOpenApiSpecTestServer } from "@executor-js/plugin-openapi/testing";
+import {
+  makeOpenApiTestSpecJson,
+  serveMutableOpenApiSpecTestServer,
+} from "@executor-js/plugin-openapi/testing";
 
 import { asOrg } from "./__test-harness__/api-harness";
 
@@ -26,7 +29,7 @@ const refreshApi = (version: "1.0.0" | "2.0.0") =>
     .add(version === "1.0.0" ? RefreshGroupV1 : RefreshGroupV2)
     .annotateMerge(OpenApi.annotations({ title: "Refresh Fixture", version }));
 
-const specV1 = JSON.stringify(OpenApi.fromApi(refreshApi("1.0.0")));
+const specV1 = makeOpenApiTestSpecJson(refreshApi("1.0.0"));
 
 describe("sources.refresh (HTTP)", () => {
   it.effect("addSpec from URL → canRefresh:true; refresh re-fetches and updates tools", () =>

apps/cloud/src/services/tenant-isolation.node.test.ts

@@ -7,6 +7,7 @@ import { Effect, Result, Schema } from "effect";
 import { HttpApi, HttpApiEndpoint, HttpApiGroup, OpenApi } from "effect/unstable/httpapi";
 
 import { ConnectionId, ScopeId, SecretId } from "@executor-js/sdk";
+import { makeOpenApiTestSpecJson } from "@executor-js/plugin-openapi/testing";
 
 import { asOrg } from "./__test-harness__/api-harness";
 
@@ -18,7 +19,7 @@ const TenantIsolationApi = HttpApi.make("tenantIsolationTest")
   .add(PingGroup)
   .annotateMerge(OpenApi.annotations({ title: "Tenant Test API", version: "1.0.0" }));
 
-const MINIMAL_OPENAPI_SPEC = JSON.stringify(OpenApi.fromApi(TenantIsolationApi));
+const MINIMAL_OPENAPI_SPEC = makeOpenApiTestSpecJson(TenantIsolationApi);
 
 describe("tenant isolation (HTTP)", () => {
   it.effect("write requests cannot target another org scope", () =>

packages/plugins/openapi/src/sdk/plugin.test.ts

@@ -1,12 +1,6 @@
 import { describe, expect, it } from "@effect/vitest";
 import { Effect, Predicate, Schema } from "effect";
-import {
-  HttpApi,
-  HttpApiBuilder,
-  HttpApiEndpoint,
-  HttpApiGroup,
-  OpenApi,
-} from "effect/unstable/httpapi";
+import { HttpApi, HttpApiBuilder, HttpApiEndpoint, HttpApiGroup } from "effect/unstable/httpapi";
 import { FetchHttpClient, HttpServerRequest, HttpServerResponse } from "effect/unstable/http";
 
 import {
@@ -27,7 +21,11 @@ import type { ConfigFileSink } from "@executor-js/config";
 const TEST_SCOPE = "test-scope";
 import { openApiPlugin } from "./plugin";
 import { ConfiguredHeaderBinding, OAuth2SourceConfig, OpenApiSourceBindingInput } from "./types";
-import { addOpenApiTestSource, serveOpenApiHttpApiTestServer } from "../testing";
+import {
+  addOpenApiTestSource,
+  makeOpenApiTestSpecJson,
+  serveOpenApiHttpApiTestServer,
+} from "../testing";
 
 const autoApprove: InvokeOptions = { onElicitation: "accept-all" };
 
@@ -94,8 +92,7 @@ const ItemsGroup = HttpApiGroup.make("items")
 
 const TestApi = HttpApi.make("testApi").add(ItemsGroup);
 
-const spec = OpenApi.fromApi(TestApi);
-const specJson = JSON.stringify(spec);
+const specJson = makeOpenApiTestSpecJson(TestApi);
 
 // ---------------------------------------------------------------------------
 // Implement handlers

packages/plugins/openapi/src/sdk/upstream-failures.test.ts

@@ -34,6 +34,7 @@ import {
 import { makeTestConfig } from "@executor-js/sdk/testing";
 import {
   makeOpenApiTestSourceConfig,
+  makeOpenApiTestSpecJson,
   type OpenApiTestServerShape,
   serveOpenApiHttpApiTestServer,
 } from "../testing";
@@ -126,7 +127,7 @@ const FailureApi = HttpApi.make("failuresTest")
   .add(ThingsGroup)
   .annotateMerge(OpenApi.annotations({ title: "FailuresTest", version: "1.0.0" }));
 
-const makeSpec = () => JSON.stringify(OpenApi.fromApi(FailureApi));
+const makeSpec = () => makeOpenApiTestSpecJson(FailureApi);
 
 const buildExecutor = (baseUrl: string) =>
   Effect.gen(function* () {

packages/plugins/openapi/src/testing/index.ts

@@ -87,6 +87,23 @@ export type OpenApiTestSourceExecutor = {
   readonly openapi: Pick<OpenApiPluginExtension, "addSpec">;
 };
 
+export interface OpenApiTestSpecOptions {
+  readonly baseUrl?: string;
+  readonly transformSpec?: (spec: Record<string, unknown>) => Record<string, unknown>;
+}
+
+export const makeOpenApiTestSpecJson = (
+  api: HttpApi.Any,
+  options: OpenApiTestSpecOptions = {},
+): string => {
+  const annotations = OpenApi.annotations({
+    ...(options.baseUrl !== undefined ? { servers: [{ url: options.baseUrl }] } : {}),
+    transform: options.transformSpec,
+  });
+  const annotated = (api as HttpApi.AnyWithProps).annotateMerge(annotations);
+  return JSON.stringify(OpenApi.fromApi(annotated));
+};
+
 export const makeOpenApiTestSourceConfig = (
   server: OpenApiTestServerShape,
   options: OpenApiTestSourceOptions,
@@ -152,15 +169,7 @@ const openApiSpecJsonFromHttpApi = (
   transformSpec?: (spec: Record<string, unknown>) => Record<string, unknown>,
 ): Effect.Effect<string, OpenApiTestServerSpecError> =>
   Effect.try({
-    try: () => {
-      const annotated = (api as HttpApi.AnyWithProps).annotateMerge(
-        OpenApi.annotations({
-          servers: [{ url: baseUrl }],
-          transform: transformSpec,
-        }),
-      );
-      return JSON.stringify(OpenApi.fromApi(annotated));
-    },
+    try: () => makeOpenApiTestSpecJson(api, { baseUrl, transformSpec }),
     catch: (cause) => new OpenApiTestServerSpecError({ cause }),
   });