feat(plugins): consolidate icon URL handling

- Remove configInput parameter from toConfigSource and toConfig - Centralize iconUrl handling in scopeConfigSourceBaseFromSource - Remove configuredIconUrlFromConfigInput utility (moved to source-core) - Simplify iconUrl handling with optional chaining trim pattern - Re-export getFaviconUrlForRemoteUrl from source-core in plugin shared modules

Saatvik Arya committed 7 months ago

Commit 9dcd6461 parent 27ebe8610 files · +32 −66Browse files

Unified · Split

10 files

packages/platform/sdk/src/plugins.ts +6 −11
packages/platform/sdk/src/runtime/sources/source-definitions.ts +2 −6
packages/platform/sdk/src/runtime/sources/source-icon.ts +2 −11
packages/platform/sdk/src/runtime/sources/source-store/config.ts +5 −2
packages/platform/sdk/src/runtime/sources/source-store/plugin-scope-config.ts +0 −9
plugins/graphql/sdk/index.ts +5 −7
plugins/graphql/shared/index.ts +1 −0
plugins/mcp/sdk/index.ts +5 −13
plugins/mcp/shared/index.ts +1 −0
plugins/openapi/sdk/index.ts +5 −7

packages/platform/sdk/src/plugins.ts+6−11

     toConfig: (input: {
       source: ExecutorSource;
       stored: TStored;
-      configSource: ExecutorScopeConfigSource | null;
     }) => TSourceConfig;
     remove?: (input: {
       source: ExecutorSource;
     toConfigSource: (input: {
       source: ExecutorSource;
       stored: TStored;
-      configInput: TConnectInput | TSourceConfig | null;
     }) => ExecutorScopeConfigSource;
     recoverStored: (input: {
       source: ExecutorSource;
   input: {
     source: ExecutorSource;
     stored: TStored;
-    configInput: TConnectInput | TSourceConfig | null;
   },
 ): Effect.Effect<void, Error, ScopeConfigStore> =>
   definition.scopeConfig
         const scopeConfigStore = yield* ScopeConfigStore;
         const loadedConfig = yield* scopeConfigStore.load();
         const projectConfig = cloneJson(loadedConfig.projectConfig ?? {});
         const sources = {
           ...projectConfig.sources,
           [input.source.id]: scopeConfig.toConfigSource({
             source: input.source,
             stored: input.stored,
-            configInput: input.configInput,
           }),
         };
       const scopeConfigStore = yield* ScopeConfigStore;
       const loadedConfig = yield* scopeConfigStore.load();
+      const iconUrl = loadedConfig.config?.sources?.[source.id]?.iconUrl;
-      return definition.source.toConfig({
+      return {
-        source,
+        ...definition.source.toConfig({ source, stored }),
-        stored,
+        ...(iconUrl ? { iconUrl } : {}),
-        configSource: loadedConfig.config?.sources?.[source.id] ?? null,
+      };
-      });
     }),
   createSource: (input) =>
     Effect.gen(function* () {
       yield* persistSourceScopeConfig(definition, {
         source,
         stored: created.stored,
-        configInput: input,
       });
       return yield* host.sources.refreshCatalog(source.id);
       yield* persistSourceScopeConfig(definition, {
         source: saved,
         stored: updated.stored,
-        configInput: input.config,
       });
       return yield* host.sources.refreshCatalog(saved.id);

packages/platform/sdk/src/runtime/sources/source-definitions.ts+2−6

     status: input.source.status,
     enabled: input.source.enabled,
     namespace: trimOrNull(input.source.namespace),
-    ...(trimOrNull(input.source.iconUrl)
+    ...(input.source.iconUrl?.trim() ? { iconUrl: input.source.iconUrl.trim() } : {}),
-      ? { iconUrl: trimOrNull(input.source.iconUrl) ?? undefined }
-      : {}),
     createdAt: input.now,
     updatedAt: input.now,
   });
     ...input.source,
     name: input.source.name.trim(),
     namespace: trimOrNull(input.source.namespace),
-    ...(trimOrNull(input.source.iconUrl)
+    ...(input.source.iconUrl?.trim() ? { iconUrl: input.source.iconUrl.trim() } : {}),
-      ? { iconUrl: trimOrNull(input.source.iconUrl) ?? undefined }
-      : {}),
     updatedAt: input.now,
   });

packages/platform/sdk/src/runtime/sources/source-icon.ts+2−11

@@ -1,18 +1,9 @@
1	import {	1	import {
2	getFaviconUrlForRemoteUrl,	2	getFaviconUrlForRemoteUrl,
		3	isRecord,
3	} from "@executor/source-core";	4	} from "@executor/source-core";
4		5
5	const trimOrNull = (value: string \| null \| undefined): string \| null => {	6	import { trimOrNull } from "./source-store/config";
6	if (value == null) {
7	return null;
8	}
9
10	const trimmed = value.trim();
11	return trimmed.length > 0 ? trimmed : null;
12	};
13
14	const isRecord = (value: unknown): value is Record<string, unknown> =>
15	typeof value === "object" && value !== null && !Array.isArray(value);
16		7
17	export const resolveSourceIconUrl = (input: {	8	export const resolveSourceIconUrl = (input: {
18	configuredIconUrl?: string \| null;	9	configuredIconUrl?: string \| null;

packages/platform/sdk/src/runtime/sources/source-store/config.ts+5−2

   ...(trimOrNull(input.source.namespace) !== trimOrNull(input.source.id)
     ? { namespace: input.source.namespace ?? undefined }
     : {}),
+  ...(input.source.iconUrl?.trim()
+    ? { iconUrl: input.source.iconUrl.trim() }
+    : {}),
   ...(input.source.enabled === false ? { enabled: false } : {}),
 });
     ...scopeConfigSourceBaseFromSource({
       source: input.source,
     }),
-    ...(trimOrNull(input.existingConfig?.iconUrl)
+    ...(input.existingConfig?.iconUrl?.trim()
-      ? { iconUrl: trimOrNull(input.existingConfig?.iconUrl) ?? undefined }
+      ? { iconUrl: input.existingConfig.iconUrl.trim() }
       : {}),
     kind: input.source.kind as ExecutorScopeConfigSource["kind"],
     ...(input.existingConfig?.config !== undefined

packages/platform/sdk/src/runtime/sources/source-store/plugin-scope-config.ts+0−9

 export const pluginScopeConfigSourceFromConfig = <TConfig>(input: {
   source: Source;
   config: TConfig;
-  iconUrl?: string | null;
 }): ExecutorScopeConfigSource => ({
   ...scopeConfigSourceBaseFromSource({
     source: input.source,
   }),
-  ...(input.iconUrl ? { iconUrl: input.iconUrl } : {}),
   kind: input.source.kind as ExecutorScopeConfigSource["kind"],
   config: cloneJson(input.config),
 });
-export const configuredIconUrlFromConfigInput = (input: unknown): string | null =>
-  input && typeof input === "object" && "iconUrl" in input
-    ? (typeof input.iconUrl === "string"
-        ? input.iconUrl.trim() || null
-        : null)
-    : null;

plugins/graphql/sdk/index.ts+5−7

 } from "@executor/platform-sdk/plugins";
 import {
   SecretMaterialResolverService,
-  configuredIconUrlFromConfigInput,
   createPluginScopeConfigEntrySchema,
   pluginScopeConfigSourceFromConfig,
   provideExecutorRuntime,
 const sourceConfigFromStored = (
   source: Source,
   stored: GraphqlStoredSourceData,
-  configSource: { iconUrl?: string } | null,
 ): GraphqlSourceConfigPayload => ({
   name: source.name,
-  ...(configSource?.iconUrl ? { iconUrl: configSource.iconUrl } : {}),
   endpoint: stored.endpoint,
   defaultHeaders: stored.defaultHeaders,
   auth: stored.auth,
             endpoint: input.endpoint,
             title: input.name,
           }),
+          ...(input.iconUrl?.trim() ? { iconUrl: input.iconUrl.trim() } : {}),
         },
         stored: storedSourceDataFromInput(input),
       }),
             endpoint: config.endpoint,
             title: config.name,
           }),
+          ...(config.iconUrl?.trim() ? { iconUrl: config.iconUrl.trim() } : {}),
         },
         stored: storedSourceDataFromInput(config),
       }),
-      toConfig: ({ source, stored, configSource }) =>
+      toConfig: ({ source, stored }) =>
-        sourceConfigFromStored(source, normalizeStoredSourceData(stored), configSource),
+        sourceConfigFromStored(source, normalizeStoredSourceData(stored)),
     },
     scopeConfig: {
-      toConfigSource: ({ source, stored, configInput }) =>
+      toConfigSource: ({ source, stored }) =>
         pluginScopeConfigSourceFromConfig({
           source,
           config: normalizeStoredSourceData(stored),
-          iconUrl: configuredIconUrlFromConfigInput(configInput),
         }),
       recoverStored: ({ config, loadedConfig }) =>
         graphqlStoredSourceDataFromLocalConfig({

plugins/graphql/shared/index.ts+1−0

@@ -11,6 +11,7 @@ import { · 10 unmodified lines
11		11
12	export { getFaviconUrlForRemoteUrl } from "@executor/source-core";	12	export { getFaviconUrlForRemoteUrl } from "@executor/source-core";
13		13
		14
14	export const GraphqlConnectionAuthSchema = Schema.Union(	15	export const GraphqlConnectionAuthSchema = Schema.Union(
15	Schema.Struct({	16	Schema.Struct({
16	kind: Schema.Literal("none"),	17	kind: Schema.Literal("none"),

plugins/mcp/sdk/index.ts+5−13

   defineExecutorSourcePlugin,
 } from "@executor/platform-sdk/plugins";
 import {
-  configuredIconUrlFromConfigInput,
   createPluginScopeConfigEntrySchema,
   pluginScopeConfigSourceFromConfig,
   SecretMaterialDeleterService,
 const sourceConfigFromStored = (
   source: Source,
   stored: McpStoredSourceData,
-  configSource: { iconUrl?: string } | null,
 ): McpSourceConfigPayload => ({
   name: source.name,
-  ...(configSource?.iconUrl ? { iconUrl: configSource.iconUrl } : {}),
   endpoint: stored.endpoint,
   transport: stored.transport,
   queryParams: stored.queryParams,
             endpoint: input.endpoint,
             command: input.command,
           }),
-          ...(input.iconUrl && input.iconUrl.trim().length > 0
+          ...(input.iconUrl?.trim() ? { iconUrl: input.iconUrl.trim() } : {}),
-            ? { iconUrl: input.iconUrl.trim() }
-            : {}),
         },
         stored: Effect.runSync(normalizeStoredSourceData(input)),
       }),
               endpoint: stored.endpoint,
               command: stored.command,
             }),
-            ...(config.iconUrl && config.iconUrl.trim().length > 0
+            ...(config.iconUrl?.trim() ? { iconUrl: config.iconUrl.trim() } : {}),
-              ? { iconUrl: config.iconUrl.trim() }
-              : { iconUrl: undefined }),
           },
           stored,
         };
       },
-      toConfig: ({ source, stored, configSource }) =>
+      toConfig: ({ source, stored }) =>
-        sourceConfigFromStored(source, stored, configSource),
+        sourceConfigFromStored(source, stored),
       remove: ({ stored }) =>
         Effect.gen(function* () {
           if (stored?.auth.kind === "oauth2") {
         }),
     },
     scopeConfig: {
-      toConfigSource: ({ source, stored, configInput }) =>
+      toConfigSource: ({ source, stored }) =>
         pluginScopeConfigSourceFromConfig({
           source,
           config: stored,
-          iconUrl: configuredIconUrlFromConfigInput(configInput),
         }),
       recoverStored: ({ config }) =>
         mcpStoredSourceDataFromLocalConfig(config),

plugins/mcp/shared/index.ts+1−0

@@ -16,6 +16,7 @@ import { · 15 unmodified lines
16		16
17	export { getFaviconUrlForRemoteUrl } from "@executor/source-core";	17	export { getFaviconUrlForRemoteUrl } from "@executor/source-core";
18		18
		19
19	export const McpConnectionAuthSchema = Schema.Union(	20	export const McpConnectionAuthSchema = Schema.Union(
20	Schema.Struct({	21	Schema.Struct({
21	kind: Schema.Literal("none"),	22	kind: Schema.Literal("none"),

plugins/openapi/sdk/index.ts+5−7

   defineExecutorSourcePlugin,
 } from "@executor/platform-sdk/plugins";
 import {
-  configuredIconUrlFromConfigInput,
   createPluginScopeConfigEntrySchema,
   pluginScopeConfigSourceFromConfig,
   SecretMaterialResolverService,
 const configFromStoredSourceData = (
   source: Source,
   stored: OpenApiStoredSourceData,
-  configSource: { iconUrl?: string } | null,
 ): OpenApiSourceConfigPayload => ({
   name: source.name,
-  ...(configSource?.iconUrl ? { iconUrl: configSource.iconUrl } : {}),
   specUrl: stored.specUrl,
   baseUrl: stored.baseUrl,
   auth: stored.auth,
             specUrl: input.specUrl,
             title: input.name,
           }),
+          ...(input.iconUrl?.trim() ? { iconUrl: input.iconUrl.trim() } : {}),
         },
         stored: createStoredSourceData(input),
       }),
             specUrl: config.specUrl,
             title: config.name,
           }),
+          ...(config.iconUrl?.trim() ? { iconUrl: config.iconUrl.trim() } : {}),
         },
         stored: createStoredSourceData(config),
       }),
-      toConfig: ({ source, stored, configSource }) =>
+      toConfig: ({ source, stored }) =>
-        configFromStoredSourceData(source, normalizeStoredSourceData(stored), configSource),
+        configFromStoredSourceData(source, normalizeStoredSourceData(stored)),
     },
     scopeConfig: {
-      toConfigSource: ({ source, stored, configInput }) =>
+      toConfigSource: ({ source, stored }) =>
         pluginScopeConfigSourceFromConfig({
           source,
           config: {
             auth: stored.auth,
             defaultHeaders: stored.defaultHeaders,
           },
-          iconUrl: configuredIconUrlFromConfigInput(configInput),
         }),
       recoverStored: ({ config, loadedConfig }) =>
         openApiStoredSourceDataFromLocalConfig({