-
Notifications
You must be signed in to change notification settings - Fork 165
Expand file tree
/
Copy pathplugin.ts
More file actions
1113 lines (1003 loc) · 44.6 KB
/
Copy pathplugin.ts
File metadata and controls
1113 lines (1003 loc) · 44.6 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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { Effect, Match, Option, Schema } from "effect";
import type { Layer } from "effect";
import { FetchHttpClient, HttpClient } from "effect/unstable/http";
import {
authToolFailure,
AuthTemplateSlug,
definePlugin,
IntegrationAlreadyExistsError,
IntegrationDetectionResult,
IntegrationSlug,
mergeAuthTemplates,
sha256Hex,
ToolName,
ToolResult,
type AuthMethodDescriptor,
type IntegrationConfig,
type IntegrationRecord,
type PluginCtx,
type StorageFailure,
type ToolAnnotations,
type ToolDef,
} from "@executor-js/sdk/core";
import {
TOKEN_VARIABLE,
describeApiKeyAuthMethod,
describeNoneAuthMethod,
oauthBearerPlacement,
renderAuthPlacements,
requiredPlacementVariables,
type RenderedAuthPlacements,
} from "@executor-js/sdk/http-auth";
import {
introspect,
parseIntrospectionJson,
type IntrospectionResult,
type IntrospectionType,
type IntrospectionField,
type IntrospectionTypeRef,
} from "./introspect";
import { extract } from "./extract";
import {
GraphqlAuthRequiredError,
GraphqlIntrospectionError,
GraphqlInvocationError,
} from "./errors";
import { invokeWithLayer } from "./invoke";
import { graphqlPresets } from "./presets";
import { makeDefaultGraphqlStore, type GraphqlStore, type StoredOperation } from "./store";
import {
GraphqlAuthMethodInput,
decodeGraphqlIntegrationConfig,
decodeGraphqlIntegrationConfigOption,
ExtractedField,
GraphqlIntegrationConfig,
expandGraphqlAuthMethodInputs,
normalizeGraphqlAuthMethods,
OperationBinding,
type GraphqlAuthMethod,
type GraphqlOperationKind,
} from "./types";
// ---------------------------------------------------------------------------
// GraphQL error-body decoding (for invocation responses)
// ---------------------------------------------------------------------------
const GraphqlErrorBody = Schema.Struct({ message: Schema.String });
const GraphqlErrorsBody = Schema.Array(Schema.Unknown);
const decodeGraphqlErrorBody = Schema.decodeUnknownOption(GraphqlErrorBody);
const decodeGraphqlErrorsBody = Schema.decodeUnknownOption(GraphqlErrorsBody);
const decodeGraphqlErrors = (errors: unknown): readonly unknown[] | undefined =>
Option.getOrUndefined(decodeGraphqlErrorsBody(errors));
const extractGraphqlErrorMessage = (errors: readonly unknown[]): string | undefined =>
errors
.map((error) => Option.getOrUndefined(decodeGraphqlErrorBody(error))?.message)
.find((message) => message !== undefined && message.length > 0);
const GRAPHQL_PLUGIN_ID = "graphql";
// ---------------------------------------------------------------------------
// Extension input shapes
// ---------------------------------------------------------------------------
/** Register a GraphQL integration in the catalog. `endpoint` is the GraphQL URL;
* `slug` (defaulted from the endpoint) is the catalog id; `introspectionJson`
* supplies the schema when the endpoint disables live introspection; `headers`
* / `queryParams` are static and also applied to add-time introspection;
* `authenticationTemplate` declares the auth methods a connection can apply
* through. */
const GraphqlAddIntegrationInputSchema = Schema.Struct({
endpoint: Schema.String,
slug: Schema.optional(Schema.String),
name: Schema.optional(Schema.String),
introspectionJson: Schema.optional(Schema.String),
headers: Schema.optional(Schema.Record(Schema.String, Schema.String)),
queryParams: Schema.optional(Schema.Record(Schema.String, Schema.String)),
authenticationTemplate: Schema.optional(Schema.Array(GraphqlAuthMethodInput)),
});
export type GraphqlAddIntegrationInput = typeof GraphqlAddIntegrationInputSchema.Type;
const GraphqlConfigureInputSchema = Schema.Struct({
name: Schema.optional(Schema.String),
endpoint: Schema.optional(Schema.String),
headers: Schema.optional(Schema.Record(Schema.String, Schema.String)),
queryParams: Schema.optional(Schema.Record(Schema.String, Schema.String)),
authenticationTemplate: Schema.optional(Schema.Array(GraphqlAuthMethodInput)),
});
export type GraphqlConfigureInput = typeof GraphqlConfigureInputSchema.Type;
/** Input for the custom-method-create flow (HTTP `POST /graphql/integrations/
* :slug/config`). Unlike `configure` (which REPLACES the whole config for the
* generic repair path), `configureAuth` MERGE-APPENDS these methods onto the
* integration's existing `authenticationTemplate`, mirroring OpenAPI's
* `configure`. */
const GraphqlConfigureAuthInputSchema = Schema.Struct({
authenticationTemplate: Schema.Array(GraphqlAuthMethodInput),
mode: Schema.optional(Schema.Literals(["merge", "replace"])),
});
export type GraphqlConfigureAuthInput = typeof GraphqlConfigureAuthInputSchema.Type;
// ---------------------------------------------------------------------------
// Static control-tool schemas
// ---------------------------------------------------------------------------
const StaticAddIntegrationOutputSchema = Schema.Struct({
slug: Schema.String,
name: Schema.String,
});
const StaticGetIntegrationInputSchema = Schema.Struct({
slug: Schema.String,
});
const StaticGetIntegrationOutputSchema = Schema.Struct({
integration: Schema.NullOr(Schema.Unknown),
});
const StaticAddIntegrationInputStandardSchema = Schema.toStandardSchemaV1(
Schema.toStandardJSONSchemaV1(GraphqlAddIntegrationInputSchema),
);
const StaticAddIntegrationOutputStandardSchema = Schema.toStandardSchemaV1(
Schema.toStandardJSONSchemaV1(StaticAddIntegrationOutputSchema),
);
const StaticGetIntegrationInputStandardSchema = Schema.toStandardSchemaV1(
Schema.toStandardJSONSchemaV1(StaticGetIntegrationInputSchema),
);
const StaticGetIntegrationOutputStandardSchema = Schema.toStandardSchemaV1(
Schema.toStandardJSONSchemaV1(StaticGetIntegrationOutputSchema),
);
const graphqlToolFailure = (code: string, message: string, details?: unknown) =>
ToolResult.fail({
code,
message,
...(details === undefined ? {} : { details }),
});
const graphqlAuthToolFailure = (failure: GraphqlAuthRequiredError) =>
authToolFailure({
code: failure.code,
message: failure.message,
source: { id: failure.integration, scope: failure.owner },
credential: {
kind: failure.credentialKind,
...(failure.credentialLabel ? { label: failure.credentialLabel } : {}),
connectionId: failure.connection,
},
...(failure.status !== undefined ? { status: failure.status } : {}),
...(failure.details !== undefined
? {
upstream: {
...(failure.status !== undefined ? { status: failure.status } : {}),
details: failure.details,
},
}
: {}),
});
// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------
/** Match `token` as a separator-bounded run inside a URL hostname or path,
* used as a low-confidence detection hint when introspection fails. */
const urlMatchesToken = (url: URL, token: string): boolean => {
const re = new RegExp(`(?:^|[^a-z0-9])${token}(?:$|[^a-z0-9])`, "i");
return re.test(url.hostname) || re.test(url.pathname);
};
/** Derive an integration slug from an endpoint URL. */
const slugFromEndpoint = (endpoint: string): string => {
// oxlint-disable-next-line executor/no-try-catch-or-throw -- boundary: URL construction throws; this helper intentionally falls back to the stable default slug
try {
const url = new URL(endpoint);
return url.hostname.replace(/[^a-z0-9]+/gi, "_").toLowerCase();
} catch {
return "graphql";
}
};
const formatTypeRef = (ref: IntrospectionTypeRef): string =>
Match.value(ref.kind).pipe(
Match.when("NON_NULL", () => (ref.ofType ? `${formatTypeRef(ref.ofType)}!` : "Unknown!")),
Match.when("LIST", () => (ref.ofType ? `[${formatTypeRef(ref.ofType)}]` : "[Unknown]")),
Match.option,
Option.getOrElse(() => ref.name ?? "Unknown"),
);
const unwrapTypeName = (ref: IntrospectionTypeRef): string => {
if (ref.name) return ref.name;
if (ref.ofType) return unwrapTypeName(ref.ofType);
return "Unknown";
};
const buildSelectionSet = (
ref: IntrospectionTypeRef,
types: ReadonlyMap<string, IntrospectionType>,
depth: number,
seen: Set<string>,
): string => {
if (depth > 2) return "";
const leafName = unwrapTypeName(ref);
if (seen.has(leafName)) return "";
const objectType = types.get(leafName);
if (!objectType?.fields) return "";
const kind = objectType.kind;
if (kind === "SCALAR" || kind === "ENUM") return "";
seen.add(leafName);
const subFields = objectType.fields
.filter((f: IntrospectionField) => !f.name.startsWith("__"))
.slice(0, 12)
.map((f: IntrospectionField) => {
const sub = buildSelectionSet(f.type, types, depth + 1, seen);
return sub ? `${f.name} ${sub}` : f.name;
});
seen.delete(leafName);
return subFields.length > 0 ? `{ ${subFields.join(" ")} }` : "";
};
// Name every generated operation: some servers reject anonymous operations, and
// APM tooling keys traces off the operation name. Field names are already valid
// GraphQL name tokens, so the upper-cased field name is a safe operation name.
const operationNameForField = (fieldName: string): string =>
fieldName.charAt(0).toUpperCase() + fieldName.slice(1);
const buildOperationStringForField = (
kind: GraphqlOperationKind,
field: IntrospectionField,
types: ReadonlyMap<string, IntrospectionType>,
): string => {
const opType = kind === "query" ? "query" : "mutation";
const opName = operationNameForField(field.name);
const varDefs = field.args.map((arg) => {
const typeName = formatTypeRef(arg.type);
return `$${arg.name}: ${typeName}`;
});
const argPasses = field.args.map((arg) => `${arg.name}: $${arg.name}`);
const selectionSet = buildSelectionSet(field.type, types, 0, new Set());
const varDefsStr = varDefs.length > 0 ? `(${varDefs.join(", ")})` : "";
const argPassStr = argPasses.length > 0 ? `(${argPasses.join(", ")})` : "";
return `${opType} ${opName}${varDefsStr} { ${field.name}${argPassStr}${selectionSet ? ` ${selectionSet}` : ""} }`;
};
interface PreparedOperation {
readonly toolName: string;
readonly description: string;
readonly inputSchema: unknown;
readonly binding: OperationBinding;
}
const prepareOperations = (
fields: readonly ExtractedField[],
introspection: IntrospectionResult,
): readonly PreparedOperation[] => {
const typeMap = new Map<string, IntrospectionType>();
for (const t of introspection.__schema.types) {
typeMap.set(t.name, t);
}
const fieldMap = new Map<string, { kind: GraphqlOperationKind; field: IntrospectionField }>();
const schema = introspection.__schema;
for (const rootKind of ["query", "mutation"] as const) {
const typeName = rootKind === "query" ? schema.queryType?.name : schema.mutationType?.name;
if (!typeName) continue;
const rootType = typeMap.get(typeName);
if (!rootType?.fields) continue;
for (const f of rootType.fields) {
if (!f.name.startsWith("__")) {
fieldMap.set(`${rootKind}.${f.name}`, { kind: rootKind, field: f });
}
}
}
return fields.map((extracted) => {
const prefix = extracted.kind === "mutation" ? "mutation" : "query";
// A tool's name keeps its `<kind>.<field>` path (e.g. `query.hello`,
// `mutation.setGreeting`). The address grammar treats `<tool>` as the
// trailing remainder (see parseToolAddress), so the dot nests naturally.
const toolName = `${prefix}.${extracted.fieldName}`;
const description = Option.getOrElse(
extracted.description,
() => `GraphQL ${extracted.kind}: ${extracted.fieldName} -> ${extracted.returnTypeName}`,
);
const key = `${extracted.kind}.${extracted.fieldName}`;
const entry = fieldMap.get(key);
const operationString = entry
? buildOperationStringForField(entry.kind, entry.field, typeMap)
: `${extracted.kind} ${operationNameForField(extracted.fieldName)} { ${extracted.fieldName} }`;
const binding = OperationBinding.make({
kind: extracted.kind,
fieldName: extracted.fieldName,
operationString,
variableNames: extracted.arguments.map((a) => a.name),
});
return {
toolName,
description,
inputSchema: Option.getOrUndefined(extracted.inputSchema),
binding,
};
});
};
const annotationsFor = (binding: OperationBinding): ToolAnnotations => {
if (binding.kind === "mutation") {
return {
requiresApproval: true,
approvalDescription: `mutation ${binding.fieldName}`,
};
}
return {};
};
// ---------------------------------------------------------------------------
// Auth method rendering (D11) — apply the connection's resolved values through
// the method the connection references. An oauth2 method is the conventional
// bearer placement (with the method's optional header/prefix override) over
// the resolved access token; an apikey method renders its declared placements.
// ---------------------------------------------------------------------------
const renderGraphqlAuthMethod = (
method: GraphqlAuthMethod,
values: Record<string, string | null>,
): RenderedAuthPlacements => {
if (method.kind === "apikey") return renderAuthPlacements(method.placements, values);
if (method.kind === "oauth2") {
return renderAuthPlacements([oauthBearerPlacement(method.header, method.prefix)], values);
}
return { headers: {}, queryParams: {} };
};
// ---------------------------------------------------------------------------
// Introspection — produce operations from a config (live or stored JSON).
// ---------------------------------------------------------------------------
const buildToolDefs = (prepared: readonly PreparedOperation[]): readonly ToolDef[] =>
prepared.map((p) => ({
name: ToolName.make(p.toolName),
description: p.description,
inputSchema: p.inputSchema,
annotations: annotationsFor(p.binding),
}));
const toStoredOperations = (
slug: IntegrationSlug,
prepared: readonly PreparedOperation[],
): StoredOperation[] =>
prepared.map((p) => ({
toolName: p.toolName,
integration: String(slug),
binding: p.binding,
}));
/** Render an integration's static + resolved-credential auth onto introspection
* headers/query params. Connection-create / tool-generation introspection runs
* with the connection's credential (exactly how its tools are invoked), so an
* auth-required endpoint introspects successfully here rather than at add-time. */
const introspectHeadersForConnection = (
config: GraphqlIntegrationConfig,
values: Record<string, string | null>,
templateSlug: AuthTemplateSlug | null,
): RenderedAuthPlacements => {
const headers: Record<string, string> = { ...(config.headers ?? {}) };
const queryParams: Record<string, string> = { ...(config.queryParams ?? {}) };
// Render the exact method the connection references; with no slug
// (connection row not yet persisted) fall back to the first declared.
const method =
(templateSlug !== null
? config.authenticationTemplate.find(
(m: GraphqlAuthMethod) => m.slug === String(templateSlug),
)
: undefined) ?? config.authenticationTemplate[0];
if (method) {
const rendered = renderGraphqlAuthMethod(method, values);
Object.assign(headers, rendered.headers);
Object.assign(queryParams, rendered.queryParams);
}
return { headers, queryParams };
};
/** Resolve a config's introspection snapshot text from the plugin blob store
* (`introspectionHash`). Null when the integration has no snapshot (live
* introspection territory). Pre-blob rows that inlined the JSON are
* rewritten by the introspection-to-blob migrations before this code reads
* them. */
const loadIntrospectionJson = (
storage: GraphqlStore,
config: GraphqlIntegrationConfig,
): Effect.Effect<string | null, StorageFailure> =>
config.introspectionHash != null
? storage.getIntrospection(config.introspectionHash)
: Effect.succeed(null);
/** Introspect a config live or from its stored snapshot, applying connection
* auth. A non-null `introspectionJson` (loaded via `loadIntrospectionJson`)
* short-circuits the network; otherwise this introspects the endpoint with
* the rendered credential. */
const introspectForConnection = (
config: GraphqlIntegrationConfig,
introspectionJson: string | null,
values: Record<string, string | null>,
templateSlug: AuthTemplateSlug | null,
httpClientLayer: Layer.Layer<HttpClient.HttpClient>,
): Effect.Effect<IntrospectionResult, GraphqlIntrospectionError> => {
if (introspectionJson != null) {
return parseIntrospectionJson(introspectionJson);
}
const auth = introspectHeadersForConnection(config, values, templateSlug);
return introspect(
config.endpoint,
Object.keys(auth.headers).length > 0 ? auth.headers : undefined,
Object.keys(auth.queryParams).length > 0 ? auth.queryParams : undefined,
).pipe(Effect.provide(httpClientLayer));
};
/** Introspect an integration's endpoint (with this connection's credential),
* prepare its operations, persist the bindings, and return them. Invoked from
* `invokeTool` on a cache miss — i.e. when an integration was registered
* without an add-time schema and its bindings haven't been produced yet. */
const materializeOperations = (
ctx: PluginCtx<GraphqlStore>,
integration: string,
config: GraphqlIntegrationConfig,
credential: {
readonly template: AuthTemplateSlug;
readonly values: Record<string, string | null>;
},
httpClientLayer: Layer.Layer<HttpClient.HttpClient>,
): Effect.Effect<readonly StoredOperation[], GraphqlIntrospectionError | StorageFailure> =>
Effect.gen(function* () {
// Render the exact method this connection references (we have its slug
// here, unlike `resolveTools`) so an auth-required endpoint introspects.
const method = config.authenticationTemplate.find(
(m: GraphqlAuthMethod) => m.slug === String(credential.template),
);
const headers: Record<string, string> = { ...(config.headers ?? {}) };
const queryParams: Record<string, string> = {
...(config.queryParams ?? {}),
};
if (method) {
const rendered = renderGraphqlAuthMethod(method, credential.values);
Object.assign(headers, rendered.headers);
Object.assign(queryParams, rendered.queryParams);
}
const introspectionJson = yield* loadIntrospectionJson(ctx.storage, config);
const introspection =
introspectionJson != null
? yield* parseIntrospectionJson(introspectionJson)
: yield* introspect(
config.endpoint,
Object.keys(headers).length > 0 ? headers : undefined,
Object.keys(queryParams).length > 0 ? queryParams : undefined,
).pipe(Effect.provide(httpClientLayer));
const { result } = yield* extract(introspection).pipe(
Effect.catch(() =>
Effect.succeed({
result: { fields: [] as readonly ExtractedField[] },
} as {
readonly result: { readonly fields: readonly ExtractedField[] };
}),
),
);
const prepared = prepareOperations(result.fields, introspection);
const stored = toStoredOperations(IntegrationSlug.make(integration), prepared);
yield* ctx.storage.replaceOperations(integration, stored);
return stored;
});
// ---------------------------------------------------------------------------
// Declared auth methods — project the stored `authenticationTemplate` into the
// catalog's plugin-agnostic `AuthMethodDescriptor[]`. Pure/sync and tolerant of
// a malformed or foreign config blob (returns `[]`). GraphQL has no accounts
// slot of its own, so this projection is what surfaces declared + custom methods
// through the catalog's `authMethods` to the hub / Add-account flows. Exported
// for tests.
//
// none → a no-auth method carrying no credential inputs
// apikey → carried placements (headers / query params) verbatim
// oauth2 → one oauth method (no resolved endpoints; graphql renders the
// connection value as a bearer at invoke time).
// ---------------------------------------------------------------------------
export const describeGraphqlAuthMethods = (
record: IntegrationRecord,
): readonly AuthMethodDescriptor[] => {
const config = Option.getOrUndefined(decodeGraphqlIntegrationConfigOption(record.config));
if (!config) return [];
return config.authenticationTemplate.map((method: GraphqlAuthMethod): AuthMethodDescriptor => {
if (method.kind === "apikey") return describeApiKeyAuthMethod(method);
if (method.kind === "oauth2") {
return {
id: method.slug,
label: "OAuth",
kind: "oauth",
template: method.slug,
oauth: {},
};
}
return describeNoneAuthMethod(method.slug);
});
};
export const describeGraphqlIntegrationDisplay = (
record: IntegrationRecord,
): { readonly url?: string } => {
const config = Option.getOrUndefined(decodeGraphqlIntegrationConfigOption(record.config));
return { url: config?.endpoint };
};
// ---------------------------------------------------------------------------
// Plugin extension
// ---------------------------------------------------------------------------
// The extension only registers integrations (and parses any pre-supplied
// introspection JSON offline). Live introspection — the only thing that needed
// an HTTP layer — is deferred to `resolveTools` / `invokeTool`, so the extension
// no longer takes one.
const makeGraphqlExtension = (ctx: PluginCtx<GraphqlStore>) => {
const buildConfig = (input: GraphqlAddIntegrationInput): GraphqlIntegrationConfig =>
GraphqlIntegrationConfig.make({
endpoint: input.endpoint,
name: input.name?.trim() || slugFromEndpoint(input.endpoint),
...(input.headers !== undefined ? { headers: input.headers } : {}),
...(input.queryParams !== undefined ? { queryParams: input.queryParams } : {}),
authenticationTemplate: input.authenticationTemplate
? normalizeGraphqlAuthMethods(input.authenticationTemplate)
: [],
});
/** Register the integration in the catalog. Registering a source is a
* catalog statement ("we use this GraphQL endpoint now") and MUST NOT make a
* network call or require auth — exactly like MCP defers discovery. Live
* introspection (and the operation bindings it yields) is deferred to
* connection-create / tool-generation (`resolveTools`) and tool invocation
* (`invokeTool`), where a connection's credential is available.
*
* When the caller pre-supplies `introspectionJson`, the schema is already in
* hand, so we parse it offline (no network) and persist the operation
* bindings up front. */
const addIntegrationInternal = (input: GraphqlAddIntegrationInput) =>
Effect.gen(function* () {
const slug = IntegrationSlug.make(input.slug ?? slugFromEndpoint(input.endpoint));
// Block re-adding an existing slug. The core `integrations.register`
// primitive upserts (so boot re-registration is idempotent), but an
// explicit add must NOT silently clobber an existing integration's tools,
// connections, and policies. To add more auth, update the existing one.
const existing = yield* ctx.core.integrations.get(slug);
if (existing) {
return yield* new IntegrationAlreadyExistsError({ slug });
}
return yield* addIntegrationTransaction(input, slug);
});
const addIntegrationTransaction = (input: GraphqlAddIntegrationInput, slug: IntegrationSlug) =>
Effect.gen(function* () {
const baseConfig = buildConfig(input);
// No pre-supplied schema → register WITHOUT introspecting. Tools (and
// their operation bindings) are produced lazily when a connection is
// created (`resolveTools`) / a tool is first invoked (`invokeTool`),
// using that connection's credential.
if (input.introspectionJson === undefined) {
yield* ctx.transaction(
ctx.core.integrations.register({
slug,
description: baseConfig.name,
config: baseConfig,
canRemove: true,
canRefresh: true,
}),
);
return { slug: String(slug), name: baseConfig.name, toolCount: 0 };
}
// Pre-supplied introspection JSON: parse it offline (no network) and
// persist the operation bindings + snapshot so production stays offline.
const introspection = yield* parseIntrospectionJson(input.introspectionJson);
const { result } = yield* extract(introspection);
const prepared = prepareOperations(result.fields, introspection);
// Snapshot the resolved schema so tool production never needs a live
// HTTP layer (D6: tools are spec-derived and identical per connection).
// The snapshot text goes to the plugin blob store (content-addressed,
// written OUTSIDE the transaction — re-puts are idempotent and an
// aborted register leaves only an unreferenced blob), and the config
// carries only its hash.
const snapshotJson = JSON.stringify({ data: introspection });
const introspectionHash = yield* sha256Hex(snapshotJson);
const config = GraphqlIntegrationConfig.make({
...baseConfig,
introspectionHash,
});
yield* ctx.storage.putIntrospection(introspectionHash, snapshotJson);
yield* ctx.transaction(
Effect.gen(function* () {
yield* ctx.storage.replaceOperations(String(slug), toStoredOperations(slug, prepared));
yield* ctx.core.integrations.register({
slug,
description: config.name,
config,
canRemove: true,
canRefresh: true,
});
}),
);
return {
slug: String(slug),
name: config.name,
toolCount: prepared.length,
};
});
const configureIntegration = (slug: string, input: GraphqlConfigureInput) =>
Effect.gen(function* () {
const record = yield* ctx.core.integrations.get(IntegrationSlug.make(slug));
if (!record) return;
const current = Option.getOrElse(
// best-effort: re-decode the stored config, falling back to an
// endpoint-only config if it was never set.
yield* decodeGraphqlIntegrationConfig(record.config).pipe(Effect.option),
() =>
GraphqlIntegrationConfig.make({
endpoint: "",
name: record.description,
authenticationTemplate: [],
}),
);
const next = GraphqlIntegrationConfig.make({
endpoint: input.endpoint ?? current.endpoint,
name: input.name?.trim() || current.name,
...(current.introspectionHash !== undefined
? { introspectionHash: current.introspectionHash }
: {}),
...((input.headers ?? current.headers) !== undefined
? { headers: input.headers ?? current.headers }
: {}),
...((input.queryParams ?? current.queryParams) !== undefined
? { queryParams: input.queryParams ?? current.queryParams }
: {}),
authenticationTemplate: input.authenticationTemplate
? normalizeGraphqlAuthMethods(input.authenticationTemplate)
: current.authenticationTemplate,
});
yield* ctx.core.integrations.update(IntegrationSlug.make(slug), {
description: next.name,
config: next,
});
});
/** Read the integration's decoded config (or `null` when absent / malformed).
* Surfaces `authenticationTemplate` for the configure / custom-method UX. */
const getConfig = (
slug: string,
): Effect.Effect<GraphqlIntegrationConfig | null, StorageFailure> =>
ctx.core.integrations
.get(IntegrationSlug.make(slug))
.pipe(
Effect.map((record) =>
record ? Option.getOrNull(decodeGraphqlIntegrationConfigOption(record.config)) : null,
),
);
/** Merge-append custom auth methods onto the integration's existing
* `authenticationTemplate`. Returns the merged array. A no-op (returns `[]`)
* for an unknown slug or undecodable config. */
const configureAuthMethods = (
slug: string,
input: GraphqlConfigureAuthInput,
): Effect.Effect<readonly GraphqlAuthMethod[], StorageFailure> =>
ctx.transaction(
Effect.gen(function* () {
const record = yield* ctx.core.integrations.get(IntegrationSlug.make(slug));
if (!record) return [] as readonly GraphqlAuthMethod[];
const current = Option.getOrNull(decodeGraphqlIntegrationConfigOption(record.config));
if (!current) return [] as readonly GraphqlAuthMethod[];
// Replace mode declares the full set — backfill kind-based slugs.
// Merge mode appends: `mergeAuthTemplates` replaces on slug match and
// assigns fresh `custom_<id>` slugs to slug-less entries, so a custom
// method never silently displaces a declared one.
const merged =
input.mode === "replace"
? normalizeGraphqlAuthMethods(input.authenticationTemplate)
: mergeAuthTemplates(
current.authenticationTemplate,
expandGraphqlAuthMethodInputs(
input.authenticationTemplate,
) as readonly GraphqlAuthMethod[],
);
const next = GraphqlIntegrationConfig.make({
...current,
authenticationTemplate: merged,
});
yield* ctx.core.integrations.update(IntegrationSlug.make(slug), {
config: next,
});
return merged;
}),
);
return {
/** Register a GraphQL integration (introspects + persists operations). */
addIntegration: (input: GraphqlAddIntegrationInput) => addIntegrationInternal(input),
/** Read the integration's stored config. */
getIntegration: (slug: string) =>
ctx.core.integrations
.get(IntegrationSlug.make(slug))
.pipe(Effect.map((record) => (record ? record.config : null))),
/** Read the integration's decoded config (auth templates surfaced). */
getConfig,
/** Merge-append custom auth methods (custom-method-create flow). */
configureAuth: configureAuthMethods,
removeIntegration: (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));
}),
),
configure: configureIntegration,
};
};
export type GraphqlPluginExtension = ReturnType<typeof makeGraphqlExtension>;
// ---------------------------------------------------------------------------
// Plugin factory
// ---------------------------------------------------------------------------
export interface GraphqlPluginOptions {
readonly httpClientLayer?: Layer.Layer<HttpClient.HttpClient>;
}
export const graphqlPlugin = definePlugin((options?: GraphqlPluginOptions) => {
return {
id: GRAPHQL_PLUGIN_ID as "graphql",
packageName: "@executor-js/plugin-graphql",
integrationPresets: graphqlPresets.map((preset) => ({
id: preset.id,
name: preset.name,
summary: preset.summary,
url: preset.url,
endpoint: preset.endpoint,
...(preset.icon ? { icon: preset.icon } : {}),
...(preset.featured ? { featured: preset.featured } : {}),
})),
storage: (deps): GraphqlStore => makeDefaultGraphqlStore(deps),
extension: (ctx: PluginCtx<GraphqlStore>) => makeGraphqlExtension(ctx),
integrationConfigure: {
type: "graphql",
schema: GraphqlConfigureInputSchema,
configure: ({ ctx, integration, config }) =>
makeGraphqlExtension(ctx).configure(String(integration), config as GraphqlConfigureInput),
},
describeAuthMethods: describeGraphqlAuthMethods,
describeIntegrationDisplay: describeGraphqlIntegrationDisplay,
staticSources: (self: GraphqlPluginExtension) => [
{
id: "graphql",
kind: "executor",
name: "GraphQL",
tools: [
{
name: "getIntegration",
description:
"Inspect an existing GraphQL integration, including endpoint, static headers/query params, and auth templates. Use this before repairing an integration with `graphql.configure` or creating a connection.",
inputSchema: StaticGetIntegrationInputStandardSchema,
outputSchema: StaticGetIntegrationOutputStandardSchema,
handler: ({ args }) => {
const input = args as typeof StaticGetIntegrationInputSchema.Type;
return Effect.map(self.getIntegration(input.slug), (integration) =>
ToolResult.ok({ integration }),
);
},
},
{
name: "addIntegration",
description:
"Add a GraphQL endpoint to the catalog and register its operations. Introspects the endpoint (or uses provided introspection JSON). After adding, create an owner-scoped connection against the integration to materialize its per-connection tools. For API keys / bearer tokens, declare an `authenticationTemplate` and create a connection whose value is the token.",
annotations: {
requiresApproval: true,
approvalDescription: "Add a GraphQL integration",
},
inputSchema: StaticAddIntegrationInputStandardSchema,
outputSchema: StaticAddIntegrationOutputStandardSchema,
handler: ({ args }) => {
const input = args as GraphqlAddIntegrationInput;
return self.addIntegration(input).pipe(
Effect.map((result) => ToolResult.ok({ slug: result.slug, name: result.name })),
Effect.catchTags({
GraphqlIntrospectionError: ({ message }) =>
Effect.succeed(graphqlToolFailure("graphql_introspection_failed", message)),
GraphqlExtractionError: ({ message }) =>
Effect.succeed(graphqlToolFailure("graphql_extraction_failed", message)),
IntegrationAlreadyExistsError: ({ slug }: IntegrationAlreadyExistsError) =>
Effect.succeed(
graphqlToolFailure(
"integration_already_exists",
`Integration ${slug} already exists; update it instead of re-adding.`,
),
),
}),
);
},
},
],
},
],
// -----------------------------------------------------------------------
// Per-connection tool production. THIS is where a GraphQL integration is
// introspected — when a connection is created (or refreshed), with that
// connection's credential — yielding one ToolDef per operation. Registering
// the integration in the catalog makes no network call; discovery is
// deferred to here, exactly how MCP defers tool discovery to connect time.
// The introspected schema is identical across connections, so `invokeTool`
// re-derives the same operation bindings; only the credential differs.
// -----------------------------------------------------------------------
resolveTools: ({
config,
template,
storage,
getValues,
}: {
readonly config: IntegrationConfig;
readonly template: AuthTemplateSlug | null;
readonly storage: GraphqlStore;
readonly getValues: () => Effect.Effect<Record<string, string | null>, unknown>;
}) =>
Effect.gen(function* () {
const decoded = yield* decodeGraphqlIntegrationConfig(config).pipe(Effect.option);
if (Option.isNone(decoded)) return { tools: [] };
const graphqlConfig = decoded.value;
const introspectionJson = yield* loadIntrospectionJson(storage, graphqlConfig);
// Live introspection (no stored snapshot) needs the connection's
// credential inputs for auth-required endpoints; resolve them lazily.
const values =
introspectionJson == null
? yield* getValues().pipe(
Effect.catch(() => Effect.succeed({} as Record<string, string | null>)),
)
: ({} as Record<string, string | null>);
const introspection = yield* introspectForConnection(
graphqlConfig,
introspectionJson,
values,
template,
options?.httpClientLayer ?? httpClientLayerFallback,
).pipe(Effect.option);
if (Option.isNone(introspection)) return { tools: [] };
const extracted = yield* extract(introspection.value).pipe(Effect.option);
if (Option.isNone(extracted)) return { tools: [] };
const prepared = prepareOperations(extracted.value.result.fields, introspection.value);
return {
tools: buildToolDefs(prepared),
definitions: extracted.value.definitions,
};
}).pipe(Effect.catch(() => Effect.succeed({ tools: [] as readonly ToolDef[] }))),
// -----------------------------------------------------------------------
// Invoke one of a connection's tools. Look up the operation by integration
// + tool name, render the credential through the connection's auth
// template, and execute the GraphQL request.
// -----------------------------------------------------------------------
invokeTool: ({ ctx, toolRow, credential, args }) =>
Effect.gen(function* () {
const httpClientLayer = options?.httpClientLayer ?? ctx.httpClientLayer;
const integration = toolRow.integration;
const toolName = toolRow.name;
const config = yield* decodeGraphqlIntegrationConfig(credential.config).pipe(
Effect.mapError(
() =>
new GraphqlInvocationError({
message: `Invalid GraphQL integration config for "${integration}"`,
statusCode: Option.none(),
}),
),
);
// Operation bindings are produced lazily for integrations registered
// without an add-time schema (no network at catalog registration). On a
// cache miss, introspect with this connection's credential, persist the
// bindings, then resolve the requested tool — discovery/persistence are
// deferred to first use, mirroring MCP.
let op = yield* ctx.storage.getOperation(integration, toolName);
if (!op) {
op = yield* materializeOperations(
ctx,
integration,
config,
credential,
httpClientLayer,
).pipe(Effect.map((ops) => ops.find((o) => o.toolName === toolName) ?? null));
}
if (!op) {
return yield* new GraphqlInvocationError({
message: `No GraphQL operation found for tool "${integration}.${toolName}"`,
statusCode: Option.none(),
});
}
const headers: Record<string, string> = { ...(config.headers ?? {}) };
const queryParams: Record<string, string> = {
...(config.queryParams ?? {}),
};
const method = config.authenticationTemplate.find(
(m: GraphqlAuthMethod) => m.slug === String(credential.template),
);
if (method && method.kind !== "none") {
// A method with unresolved inputs fails the invocation explicitly
// instead of dialing unauthenticated. oauth2 requires the resolved
// access token (`token`); apikey requires every placement variable.
const missing = (
method.kind === "oauth2"
? [TOKEN_VARIABLE]
: requiredPlacementVariables(method.placements)
).filter((variable) => credential.values[variable] == null);
if (missing.length > 0) {
return yield* new GraphqlAuthRequiredError({
code:
method.kind === "oauth2" ? "oauth_connection_missing" : "connection_value_missing",
message:
method.kind === "oauth2"
? `Missing OAuth connection value for GraphQL integration "${integration}" (connection "${credential.connection}")`
: `Missing credential value for GraphQL integration "${integration}" (connection "${credential.connection}") for input(s): ${missing.join(", ")}`,
owner: credential.owner,
integration,
connection: String(credential.connection),
credentialKind: method.kind === "oauth2" ? "oauth" : "secret",
credentialLabel: method.kind === "oauth2" ? "OAuth sign-in" : "API key",
template: String(credential.template),
});
}
const rendered = renderGraphqlAuthMethod(method, credential.values);
Object.assign(headers, rendered.headers);
Object.assign(queryParams, rendered.queryParams);
}