Move source auth handling into plugins

Rhys Sullivan committed 7 months ago

Commit db9b84d1 parent 02d549c15 files · +98 −125Browse files

Showing the changes to plugins/openapi (4 of 15 files). Show all

Unified · Split

4 files

plugins/openapi/react/index.tsx +36 −14
plugins/openapi/sdk/index.ts +13 −21
plugins/openapi/shared/index.ts +3 −2
plugins/openapi/shared/package.json +1 −0

   type SourceToolExplorerSearch,
   useSourcePluginNavigation,
   useSourcePluginSearch,
-} from "@executor/react/source-plugins";
+} from "@executor/react/plugins";
 import {
   openApiHttpApiExtension,
 } from "@executor/plugin-openapi-http";
   auth: config.auth,
 });
+const secretValue = (input: OpenApiConnectInput["auth"]): string =>
+  input.kind === "bearer"
+    ? JSON.stringify(input.tokenSecretRef)
+    : "";
+const authFromSecretValue = (
+  authKind: OpenApiConnectInput["auth"]["kind"],
+  value: string,
+): OpenApiConnectInput["auth"] => {
+  if (authKind === "none") {
+    return {
+      kind: "none",
+    };
+  }
+  if (!value) {
+    throw new Error("Select a secret for bearer auth.");
+  }
+  return {
+    kind: "bearer",
+    tokenSecretRef: JSON.parse(value) as OpenApiConnectInput["auth"] & { tokenSecretRef: never }["tokenSecretRef"],
+  };
+};
 const useAvailableSecrets = (
   openApiHttpClient: ReturnType<typeof getOpenApiHttpClient>,
 ) => {
     props.initialValue.auth.kind,
   );
   const [tokenSecretRef, setTokenSecretRef] = useState(
-    props.initialValue.auth.kind === "bearer"
+    secretValue(props.initialValue.auth),
-      ? props.initialValue.auth.tokenSecretRef
-      : "",
   );
   const [error, setError] = useState<string | null>(null);
   const [preview, setPreview] = useState<OpenApiPreviewResponse | null>(null);
     }
     try {
+      const auth = authFromSecretValue(authKind, tokenSecretRef);
       await submitMutation.mutateAsync({
         name: trimmedName,
         specUrl: trimmedSpecUrl,
         baseUrl: trimmedBaseUrl || null,
-        auth:
+        auth,
-          authKind === "bearer"
-            ? {
-                kind: "bearer",
-                tokenSecretRef: tokenSecretRef.trim(),
-              }
-            : {
-                kind: "none",
-              },
       });
     } catch (cause) {
       setError(cause instanceof Error ? cause.message : "Failed saving source.");
               >
                 <option value="">Select a secret</option>
                 {availableSecrets.map((secret) => (
-                  <option key={secret.id} value={secret.id}>
+                  <option
+                    key={`${secret.providerId}:${secret.id}`}
+                    value={JSON.stringify({
+                      providerId: secret.providerId,
+                      handle: secret.id,
+                    })}
+                  >
                     {secret.name || secret.id}
                   </option>
                 ))}

plugins/openapi/sdk/index.ts+13−21

   ExecutorSourceConnector,
   SourcePluginRuntime,
 } from "@executor/platform-sdk/plugins";
+import {
+  SecretMaterialResolverService,
+} from "@executor/platform-sdk/runtime";
 import {
   OpenApiConnectionAuthSchema,
   deriveOpenApiNamespace,
   }) => Effect.Effect<void, Error, never>;
 };
-export type OpenApiSecrets = {
-  resolve: (input: {
-    ref: string;
-  }) => Effect.Effect<string, Error, never>;
-};
 export type OpenApiSdk = {
   previewDocument: (
     input: OpenApiPreviewRequest,
 export type OpenApiSdkPluginOptions = {
   storage: OpenApiSourceStorage;
-  secrets?: OpenApiSecrets;
 };
 const OpenApiExecutorAddInputSchema = Schema.Struct({
 };
 const resolveBearerToken = (
-  options: OpenApiSdkPluginOptions,
   stored: OpenApiStoredSourceData,
-): Effect.Effect<string | null, Error, never> => {
+): Effect.Effect<string | null, Error, any> => {
-  if (stored.auth.kind === "none") {
+  const { auth } = stored;
+  if (auth.kind === "none") {
     return Effect.succeed(null);
   }
-  if (!options.secrets) {
+  return Effect.flatMap(SecretMaterialResolverService, (resolveSecretMaterial) =>
-    return Effect.fail(
+    resolveSecretMaterial({
-      new Error("OpenAPI bearer auth is configured, but no secret resolver is available."),
+      ref: auth.tokenSecretRef,
-    );
+    }).pipe(Effect.map((token) => token.trim()))
-  }
+  );
-  return options.secrets.resolve({
-    ref: stored.auth.tokenSecretRef,
-  }).pipe(Effect.map((token) => token.trim()));
 };
 const openApiDocumentHeaders = (input: {
         });
       }
-      const bearerToken = yield* resolveBearerToken(options, stored);
+      const bearerToken = yield* resolveBearerToken(stored);
       const fetched = yield* fetchOpenApiDocument({
         stored,
         bearerToken,
         }
       }
-      const bearerToken = yield* resolveBearerToken(options, stored);
+      const bearerToken = yield* resolveBearerToken(stored);
       if (bearerToken && bearerToken.length > 0) {
         headers.authorization = `Bearer ${bearerToken}`;
       }

plugins/openapi/shared/index.ts+3−2

 import YAML from "yaml";
 import {
+  SecretRefSchema,
   StringMapSchema,
-} from "@executor/source-core";
+} from "@executor/platform-sdk/schema";
 export const OpenApiConnectionAuthSchema = Schema.Union(
   Schema.Struct({
   }),
   Schema.Struct({
     kind: Schema.Literal("bearer"),
-    tokenSecretRef: Schema.String,
+    tokenSecretRef: SecretRefSchema,
   }),
 );

plugins/openapi/shared/package.json+1−0

@@ -12,6 +12,7 @@ · 11 unmodified lines
12	"typecheck": "bunx tsc --noEmit -p tsconfig.json"	12	"typecheck": "bunx tsc --noEmit -p tsconfig.json"
13	},	13	},
14	"dependencies": {	14	"dependencies": {
		15	"@executor/platform-sdk": "workspace:*",
15	"@executor/source-core": "workspace:*",	16	"@executor/source-core": "workspace:*",
16	"effect": "catalog:",	17	"effect": "catalog:",
17	"yaml": "^2.8.1"	18	"yaml": "^2.8.1"