-
Notifications
You must be signed in to change notification settings - Fork 151
Expand file tree
/
Copy pathplugin.ts
More file actions
405 lines (362 loc) · 14.1 KB
/
Copy pathplugin.ts
File metadata and controls
405 lines (362 loc) · 14.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
import { Effect } from "effect";
import type { Layer } from "effect";
import { HttpClient } from "effect/unstable/http";
import {
IntegrationAlreadyExistsError,
IntegrationDetectionResult,
IntegrationNotFoundError,
IntegrationSlug,
definePlugin,
mergeAuthTemplates,
sha256Hex,
type AuthMethodDescriptor,
type HealthCheckSpec,
type Integration,
type IntegrationConfig,
type IntegrationRecord,
type PluginCtx,
} from "@executor-js/sdk/core";
import { describeApiKeyAuthMethod } from "@executor-js/sdk/http-auth";
import {
checkHealthOpenApi,
compileOpenApiSpec,
describeHealthCheckOpenApi,
invokeOpenApiBackedTool,
listHealthCheckCandidatesOpenApi,
makeDefaultOpenapiStore,
normalizeOpenApiAuthInputs,
openApiStoredOperationsFromCompiled,
resolveOpenApiBackedAnnotations,
resolveOpenApiBackedTools,
setHealthCheckOpenApi,
type Authentication,
type AuthenticationInput,
type OpenapiStore,
} from "@executor-js/plugin-openapi";
import {
convertGoogleDiscoveryBundleToOpenApi,
fetchGoogleDiscoveryDocument,
normalizeGoogleDiscoveryUrl,
} from "./discovery";
import { decodeGoogleIntegrationConfig, type GoogleIntegrationConfig } from "./config";
import { googleOpenApiBundlePreset } from "./presets";
/** The default health check for a Google bundle: the People API identity call
* (`people.get` with the required `resourceName`/`personFields` pinned), when
* the bundle includes the People API. People API is the canonical Google
* identity endpoint; if it isn't bundled, no default is written (the editor
* remains available). The user can adjust the identity field via the editor. */
const defaultGoogleHealthCheck = (
urls: readonly string[],
definitions: readonly {
readonly toolPath: string;
readonly operation: { readonly method: string; readonly pathTemplate: string };
}[],
): HealthCheckSpec | undefined => {
const hasPeopleApi = urls.some((url) => url.includes("/people/"));
if (!hasPeopleApi) return undefined;
const peopleGet = definitions.find(
(def) =>
def.operation.method.toLowerCase() === "get" &&
(def.toolPath === "people.people.get" ||
def.operation.pathTemplate === "/v1/{+resourceName}"),
);
return peopleGet
? {
operation: peopleGet.toolPath,
args: { resourceName: "people/me", personFields: "names,emailAddresses" },
identityField: "emailAddresses.0.value",
}
: undefined;
};
export interface GoogleBundleConfig {
readonly urls: readonly string[];
readonly slug?: string;
readonly name?: string;
readonly description?: string;
readonly baseUrl?: string;
}
export interface GoogleConfigureInput {
readonly authenticationTemplate: readonly AuthenticationInput[];
readonly mode?: "merge" | "replace";
}
export interface GoogleUpdateInput {
readonly urls?: readonly string[];
}
export interface GoogleUpdateResult {
readonly slug: IntegrationSlug;
readonly toolCount: number;
readonly addedTools: readonly string[];
readonly removedTools: readonly string[];
}
export interface GooglePluginOptions {
readonly httpClientLayer?: Layer.Layer<HttpClient.HttpClient, never, never>;
}
const DEFAULT_GOOGLE_SLUG = "google";
const fetchGoogleBundleConversion = (
urls: readonly string[],
httpClientLayer: Layer.Layer<HttpClient.HttpClient, never, never>,
) =>
Effect.forEach(
urls,
(url) =>
fetchGoogleDiscoveryDocument(url).pipe(
Effect.provide(httpClientLayer),
Effect.map((documentText) => ({ discoveryUrl: url, documentText })),
),
{ concurrency: 4 },
).pipe(Effect.flatMap((documents) => convertGoogleDiscoveryBundleToOpenApi({ documents })));
const uniqueUrls = (urls: readonly string[]): readonly string[] => [
...new Set(urls.flatMap((url) => normalizeGoogleDiscoveryUrl(url) ?? [])),
];
const describeGoogleAuthMethods = (record: IntegrationRecord): readonly AuthMethodDescriptor[] => {
const config = decodeGoogleIntegrationConfig(record.config);
if (!config) return [];
return (config.authenticationTemplate ?? []).map(
(template: Authentication): AuthMethodDescriptor => {
if (template.kind === "oauth2") {
return {
id: String(template.slug),
label: "OAuth2",
kind: "oauth",
template: String(template.slug),
oauth: {
authorizationUrl: template.authorizationUrl,
tokenUrl: template.tokenUrl,
scopes: template.scopes,
},
};
}
return describeApiKeyAuthMethod(template);
},
);
};
const describeGoogleIntegrationDisplay = (record: IntegrationRecord): { readonly url?: string } => {
const config = decodeGoogleIntegrationConfig(record.config);
return { url: config?.baseUrl ?? config?.googleDiscoveryUrls?.[0] };
};
const makeGooglePluginExtension = (
options: GooglePluginOptions | undefined,
ctx: PluginCtx<OpenapiStore>,
) => {
const httpClientLayer = options?.httpClientLayer ?? ctx.httpClientLayer;
const addBundle = (config: GoogleBundleConfig) =>
Effect.gen(function* () {
const urls = uniqueUrls(config.urls);
const conversion = yield* fetchGoogleBundleConversion(urls, httpClientLayer);
const compiled = yield* compileOpenApiSpec(conversion.specText);
const slug = IntegrationSlug.make(config.slug?.trim() || DEFAULT_GOOGLE_SLUG);
const existing = yield* ctx.core.integrations.get(slug);
if (existing) {
return yield* new IntegrationAlreadyExistsError({ slug });
}
const specHash = yield* sha256Hex(conversion.specText);
// Default the health check to the People API identity call
// (`people.get` with `resourceName=people/me`) when the bundle includes
// the People API, so connections report alive/expired + identity out of the
// box. The user can adjust the operation / identity field via the editor.
const defaultHealthCheck = defaultGoogleHealthCheck(urls, compiled.definitions);
const integrationConfig: GoogleIntegrationConfig = {
specHash,
googleDiscoveryUrls: urls,
...(config.baseUrl ? { baseUrl: config.baseUrl } : {}),
...(conversion.authenticationTemplate
? { authenticationTemplate: conversion.authenticationTemplate }
: {}),
...(defaultHealthCheck ? { healthCheck: defaultHealthCheck } : {}),
};
yield* ctx.storage.putSpec(specHash, conversion.specText);
yield* ctx.transaction(
Effect.gen(function* () {
yield* ctx.core.integrations.register({
slug,
name: config.name?.trim() || "Google",
description: config.description ?? "Google APIs",
config: integrationConfig satisfies GoogleIntegrationConfig as IntegrationConfig,
canRemove: true,
canRefresh: true,
});
yield* ctx.storage.putOperations(
String(slug),
openApiStoredOperationsFromCompiled(String(slug), compiled),
);
}),
);
return { slug, toolCount: compiled.definitions.length };
});
const updateBundle = (rawSlug: string, input?: GoogleUpdateInput) =>
Effect.gen(function* () {
const slug = IntegrationSlug.make(rawSlug);
const record = yield* ctx.core.integrations.get(slug);
const current = record ? decodeGoogleIntegrationConfig(record.config) : null;
if (!record || !current) {
return yield* new IntegrationNotFoundError({ slug });
}
const urls = uniqueUrls(input?.urls ?? current.googleDiscoveryUrls ?? []);
const conversion = yield* fetchGoogleBundleConversion(urls, httpClientLayer);
const compiled = yield* compileOpenApiSpec(conversion.specText);
const previousOperations = yield* ctx.storage.listOperations(rawSlug);
const previousNames = new Set(previousOperations.map((op) => op.toolName));
const nextNames = new Set(compiled.definitions.map((def) => def.toolPath));
const specHash = yield* sha256Hex(conversion.specText);
yield* ctx.storage.putSpec(specHash, conversion.specText);
const nextConfig: GoogleIntegrationConfig = {
...current,
specHash,
googleDiscoveryUrls: urls,
};
yield* ctx.transaction(
Effect.gen(function* () {
yield* ctx.core.integrations.update(slug, {
config: nextConfig satisfies GoogleIntegrationConfig as IntegrationConfig,
});
yield* ctx.storage.putOperations(
rawSlug,
openApiStoredOperationsFromCompiled(rawSlug, compiled),
);
}),
);
const connections = yield* ctx.connections.list({ integration: slug });
yield* Effect.forEach(
connections,
(connection) =>
ctx.connections
.refresh({
owner: connection.owner,
integration: connection.integration,
name: connection.name,
})
.pipe(Effect.catchTag("ConnectionNotFoundError", () => Effect.succeed([]))),
{ discard: true },
).pipe(Effect.catchTag("IntegrationNotFoundError", () => Effect.void));
return {
slug,
toolCount: compiled.definitions.length,
addedTools: [...nextNames].filter((name) => !previousNames.has(name)).sort(),
removedTools: [...previousNames].filter((name) => !nextNames.has(name)).sort(),
};
});
return {
addBundle,
updateBundle,
removeBundle: (slug: string) =>
ctx.transaction(
Effect.gen(function* () {
yield* ctx.storage.removeOperations(slug);
yield* ctx.core.integrations
.remove(IntegrationSlug.make(slug))
.pipe(Effect.catchTag("IntegrationRemovalNotAllowedError", () => Effect.void));
}),
),
getIntegration: (slug: string) =>
ctx.core.integrations.get(IntegrationSlug.make(slug)).pipe(
Effect.map((record) =>
record
? ({
slug: record.slug,
description: record.description,
kind: record.kind,
canRemove: record.canRemove,
canRefresh: record.canRefresh,
} as Integration)
: null,
),
),
getConfig: (slug: string) =>
ctx.core.integrations
.get(IntegrationSlug.make(slug))
.pipe(
Effect.map((record) => (record ? decodeGoogleIntegrationConfig(record.config) : null)),
),
configure: (slug: string, input: GoogleConfigureInput) =>
ctx.transaction(
Effect.gen(function* () {
const record = yield* ctx.core.integrations.get(IntegrationSlug.make(slug));
if (!record) return [] as readonly Authentication[];
const current = decodeGoogleIntegrationConfig(record.config);
if (!current) return [] as readonly Authentication[];
const incoming = normalizeOpenApiAuthInputs(input.authenticationTemplate);
const merged =
input.mode === "replace"
? incoming
: mergeAuthTemplates(current.authenticationTemplate ?? [], incoming);
const next: GoogleIntegrationConfig = {
...current,
authenticationTemplate: merged,
};
yield* ctx.core.integrations.update(IntegrationSlug.make(slug), {
config: next satisfies GoogleIntegrationConfig as IntegrationConfig,
});
return merged;
}),
),
};
};
export type GooglePluginExtension = ReturnType<typeof makeGooglePluginExtension>;
export const googlePlugin = definePlugin((options?: GooglePluginOptions) => ({
id: "google" as const,
packageName: "@executor-js/plugin-google",
integrationPresets: [googleOpenApiBundlePreset],
storage: (deps): OpenapiStore => makeDefaultOpenapiStore(deps),
extension: (ctx: PluginCtx<OpenapiStore>) => makeGooglePluginExtension(options, ctx),
describeAuthMethods: describeGoogleAuthMethods,
describeIntegrationDisplay: describeGoogleIntegrationDisplay,
resolveTools: ({ integration, config, storage }) =>
resolveOpenApiBackedTools({ integration, config, storage }),
invokeTool: ({ ctx, toolRow, credential, args }) => {
const httpClientLayer = options?.httpClientLayer ?? ctx.httpClientLayer;
return invokeOpenApiBackedTool({
ctx,
toolRow,
credential,
args,
httpClientLayer,
});
},
resolveAnnotations: ({ ctx, integration, toolRows }) =>
resolveOpenApiBackedAnnotations({
ctx,
integration: String(integration),
toolRows,
}),
// Health checks reuse the OpenAPI backing (same store + config superset). The
// People API identity call is auto-defaulted at addBundle when present, and the
// user can adjust the operation / identity field via the editor.
describeHealthCheck: describeHealthCheckOpenApi,
listHealthCheckCandidates: (input) =>
listHealthCheckCandidatesOpenApi({ ctx: input.ctx, integration: input.integration }),
setHealthCheck: (input) =>
setHealthCheckOpenApi({ ctx: input.ctx, integration: input.integration, spec: input.spec }),
checkHealth: (input) =>
checkHealthOpenApi({
ctx: input.ctx,
integration: input.integration,
credential: input.credential,
spec: input.spec,
httpClientLayer: options?.httpClientLayer ?? input.ctx.httpClientLayer,
}),
removeConnection: () => Effect.void,
detect: ({ ctx, url }) =>
Effect.gen(function* () {
const trimmed = url.trim();
const discoveryUrl = normalizeGoogleDiscoveryUrl(trimmed);
if (!trimmed || !discoveryUrl) return null;
const httpClientLayer = options?.httpClientLayer ?? ctx.httpClientLayer;
const conversion = yield* fetchGoogleDiscoveryDocument(discoveryUrl).pipe(
Effect.provide(httpClientLayer),
Effect.flatMap((documentText) =>
convertGoogleDiscoveryBundleToOpenApi({
documents: [{ discoveryUrl, documentText }],
}),
),
Effect.catch(() => Effect.succeed(null)),
);
if (!conversion) return null;
return IntegrationDetectionResult.make({
kind: "google",
confidence: "high",
endpoint: discoveryUrl,
name: conversion.title,
slug: DEFAULT_GOOGLE_SLUG,
});
}),
}));