[codex] Clean up OpenAPI add source API (#843)

* Clean up OpenAPI add source API * Update OpenAPI add source credential UI * Address OpenAPI add source PR feedback * Document OpenAPI credential configuration plan * Fix OpenAPI add flow CI

Rhys Sullivan committed 6 months ago

Commit 529a54f1 parent 1d16b0b20 files · +1477 −467Browse files

Showing the changes to packages/plugins/openapi/src/testing (1 of 20 files). Show all

Unified · Split

packages/plugins/openapi/src/testing/index.ts+52−26

   OpenApi,
 } from "effect/unstable/httpapi";
 import { OAuthTestServer, serveTestHttpServerLayer } from "@executor-js/sdk/testing";
-import { isToolResult, type ScopeId } from "@executor-js/sdk/core";
+import { isToolResult } from "@executor-js/sdk/core";
 import type { OpenApiPluginExtension, OpenApiSpecConfig } from "../sdk/plugin";
 export class OpenApiTestServerAddressError extends Data.TaggedError(
   readonly clearRequests: Effect.Effect<void>;
 }
-export type OpenApiTestSourceOptions = Omit<OpenApiSpecConfig, "spec" | "baseUrl"> & {
+export type OpenApiTestSourceOptions = Omit<
+  OpenApiSpecConfig,
+  "spec" | "baseUrl" | "name" | "namespace"
+> & {
   readonly baseUrl?: string | null;
+  readonly name?: string;
+  readonly namespace?: string;
 };
-export type OpenApiHttpApiTestSourceOptions = Omit<OpenApiSpecConfig, "spec"> & {
+export type OpenApiHttpApiTestSourceOptions = Omit<
+  OpenApiSpecConfig,
+  "spec" | "name" | "namespace" | "baseUrl"
+> & {
+  readonly name?: string;
+  readonly namespace?: string;
+  readonly baseUrl?: string | null;
   readonly specBaseUrl?: string;
   readonly transformSpec?: (spec: Record<string, unknown>) => Record<string, unknown>;
 };
+type OpenApiHttpApiAddSpecCredentialInput =
+  | string
+  | {
+      readonly kind: "secret";
+      readonly prefix?: string;
+    };
+type OpenApiHttpApiAddSpecCredentialsInput = {
+  readonly headers?: Record<string, OpenApiHttpApiAddSpecCredentialInput>;
+  readonly queryParams?: Record<string, OpenApiHttpApiAddSpecCredentialInput>;
+};
 export type OpenApiHttpApiTestAddSpecPayloadOptions = Omit<
   OpenApiHttpApiTestSourceOptions,
-  "scope" | "credentialTargetScope"
+  "scope" | "headers" | "queryParams" | "specFetchCredentials"
-> & {
+> &
-  readonly targetScope: ScopeId;
+  OpenApiHttpApiAddSpecCredentialsInput & {
-  readonly credentialTargetScope?: ScopeId;
+    readonly specFetchCredentials?: OpenApiHttpApiAddSpecCredentialsInput;
-};
+  };
 export type OpenApiTestSourceExecutor = {
   readonly openapi: Pick<OpenApiPluginExtension, "addSpec">;
   const { baseUrl, ...rest } = options;
   return {
     ...rest,
-    spec: server.specJson,
+    spec: { kind: "blob", value: server.specJson },
+    name: rest.name ?? "Test API",
+    namespace: rest.namespace ?? "test_api",
     ...(baseUrl === null ? {} : { baseUrl: baseUrl ?? server.baseUrl }),
-  };
+  } as OpenApiSpecConfig;
 };
 export const addOpenApiTestSource = (
   api: HttpApi.Any,
   options: OpenApiHttpApiTestSourceOptions,
 ): OpenApiSpecConfig => {
-  const { specBaseUrl, transformSpec, ...config } = options;
+  const { baseUrl, specBaseUrl, transformSpec, ...config } = options;
   return {
     ...config,
-    spec: makeOpenApiTestSpecJson(api, { baseUrl: specBaseUrl, transformSpec }),
+    spec: {
-  };
+      kind: "blob",
+      value: makeOpenApiTestSpecJson(api, { baseUrl: specBaseUrl, transformSpec }),
+    },
+    name: config.name ?? "Test API",
+    namespace: config.namespace ?? "test_api",
+    ...(baseUrl === null ? {} : { baseUrl: baseUrl ?? specBaseUrl ?? "https://api.example.test" }),
+  } as OpenApiSpecConfig;
 };
 export const addOpenApiHttpApiTestSource = (
   api: HttpApi.Any,
   options: OpenApiHttpApiTestAddSpecPayloadOptions,
 ) => {
-  const { targetScope, credentialTargetScope, ...sourceOptions } = options;
+  const { ...sourceOptions } = options;
   const config = makeOpenApiHttpApiTestSourceConfig(api, {
     ...sourceOptions,
-    scope: String(targetScope),
+    scope: "unused-http-helper-scope",
-    ...(credentialTargetScope !== undefined
-      ? { credentialTargetScope: String(credentialTargetScope) }
-      : {}),
   });
   return {
-    targetScope,
     spec: config.spec,
     namespace: config.namespace,
-    ...(config.name !== undefined ? { name: config.name } : {}),
+    name: config.name,
-    ...(config.baseUrl !== undefined ? { baseUrl: config.baseUrl } : {}),
+    baseUrl: config.baseUrl,
-    ...(config.headers !== undefined ? { headers: config.headers } : {}),
+    ...(sourceOptions.headers !== undefined ? { headers: sourceOptions.headers } : {}),
-    ...(config.queryParams !== undefined ? { queryParams: config.queryParams } : {}),
+    ...(sourceOptions.queryParams !== undefined ? { queryParams: sourceOptions.queryParams } : {}),
     ...(config.oauth2 !== undefined ? { oauth2: config.oauth2 } : {}),
-    ...(credentialTargetScope !== undefined ? { credentialTargetScope } : {}),
+    ...(sourceOptions.specFetchCredentials !== undefined
-    ...(config.specFetchCredentials !== undefined
+      ? { specFetchCredentials: sourceOptions.specFetchCredentials }
-      ? { specFetchCredentials: config.specFetchCredentials }
       : {}),
   };
 };

[codex] Clean up OpenAPI add source API (#843)

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code