@reventlessdev/reventless-graphql-server 1.0.0-alpha.19 → 1.0.0-alpha.190

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -55,7 +55,7 @@ Register it as a ReScript dependency in `rescript.json`:
55
55
  }
56
56
  ```
57
57
 
58
- Requires ReScript `^12.3.0` (peer dependency).
58
+ Requires ReScript `^12.3.1` (peer dependency).
59
59
 
60
60
  ## Links
61
61
 
package/package.json CHANGED
@@ -1,17 +1,17 @@
1
1
  {
2
2
  "name": "@reventlessdev/reventless-graphql-server",
3
- "version": "1.0.0-alpha.19",
3
+ "version": "1.0.0-alpha.190",
4
4
  "description": "Transport-neutral GraphQL server runtime for Reventless: schema-from-fragments, resolver registration, an HTTP + graphql-ws listener, and a subscription fan-out bridge with a pluggable PubSub backend",
5
5
  "license": "Apache-2.0",
6
6
  "dependencies": {
7
- "@reventlessdev/rescript-graphql-yoga": "1.0.0-alpha.24",
8
- "@reventlessdev/reventless-core": "3.0.0-alpha.172"
7
+ "@reventlessdev/reventless-core": "3.0.0-alpha.342",
8
+ "@reventlessdev/rescript-graphql-yoga": "1.0.0-alpha.31"
9
9
  },
10
10
  "devDependencies": {
11
- "rescript": "12.3.0"
11
+ "rescript": "12.3.1"
12
12
  },
13
13
  "peerDependencies": {
14
- "rescript": "12.3.0"
14
+ "rescript": "^12.3.1"
15
15
  },
16
16
  "publishConfig": {
17
17
  "registry": "https://registry.npmjs.org"
@@ -33,7 +33,7 @@ type diagnostics = {
33
33
  resolverMutationCount: int,
34
34
  resolverQueryCount: int,
35
35
  mismatches: array<string>,
36
- fullSdl: option<string>,
36
+ fullSdl?: string,
37
37
  serverRunning: bool,
38
38
  }
39
39
 
@@ -42,6 +42,11 @@ type t = {
42
42
  registerQueries: (~sdlFields: array<string>, ~resolvers: dict<resolverFn>) => unit,
43
43
  registerSubscriptions: (~sdlFields: array<string>, ~resolvers: dict<resolverFn>) => unit,
44
44
  registerTypes: (~sdlTypes: array<string>) => unit,
45
+ /** Resolvers for fields of an object type rather than of a root type — the
46
+ cross-table fields `@resolves` / `@resolvesMany` add to a queryable. The
47
+ SDL for those fields comes from the plugin's schema fragment, so only the
48
+ resolver map is registered here. */
49
+ registerFieldResolvers: (~typeName: string, ~resolvers: dict<resolverFn>) => unit,
45
50
  getMutationResolver: string => option<resolverFn>,
46
51
  getQueryResolver: string => option<resolverFn>,
47
52
  // `~contextFactory` is the yoga context factory — when supplied, requests
@@ -72,10 +77,35 @@ let extractFieldName = (sdlField: string): string => {
72
77
  ->String.trim
73
78
  }
74
79
 
80
+ type fetchHeaders
81
+ @new external makeHeaders: dict<string> => fetchHeaders = "Headers"
82
+
83
+ /** The initial context a yoga context factory expects, built for a WebSocket
84
+ operation: the upgrade request's headers, with what the client sent as
85
+ `connectionParams` on top (a browser cannot set headers on a WebSocket, so
86
+ that is where its `Authorization` goes). */
87
+ let wsInitialContext = (ctx: YG.wsContext): YG.initialContext => {
88
+ let headers = Dict.make()
89
+ ctx.extra.request.headers
90
+ ->Dict.toArray
91
+ ->Array.forEach(((k, v)) => headers->Dict.set(k->String.toLowerCase, v))
92
+ ctx.connectionParams
93
+ ->Option.getOr(Dict.make())
94
+ ->Dict.toArray
95
+ ->Array.forEach(((k, v)) =>
96
+ switch v {
97
+ | JSON.String(s) => headers->Dict.set(k->String.toLowerCase, s)
98
+ | _ => ()
99
+ }
100
+ )
101
+ Obj.magic({"request": {"headers": makeHeaders(headers)}, "req": ctx.extra.request})
102
+ }
103
+
75
104
  let make = (~label: string="GraphQL"): t => {
76
105
  let mutationResolvers: ref<dict<resolverFn>> = ref(Dict.make())
77
106
  let queryResolvers: ref<dict<resolverFn>> = ref(Dict.make())
78
107
  let subscriptionResolvers: ref<dict<resolverFn>> = ref(Dict.make())
108
+ let fieldResolvers: ref<dict<dict<resolverFn>>> = ref(Dict.make())
79
109
  let mutationFields: ref<array<string>> = ref([])
80
110
  let queryFields: ref<array<string>> = ref([])
81
111
  let subscriptionFields: ref<array<string>> = ref([])
@@ -85,7 +115,16 @@ let make = (~label: string="GraphQL"): t => {
85
115
  let lastFullSdl: ref<option<string>> = ref(None)
86
116
 
87
117
  let registerMutations = (~sdlFields: array<string>, ~resolvers: dict<resolverFn>) => {
88
- mutationFields.contents = mutationFields.contents->Array.concat(sdlFields)
118
+ // A mutation field has two legitimate writers: the admin base fragment
119
+ // carries the Plugin aggregate's lifecycle fields, and the aggregate
120
+ // auto-flow registers the same fields when the admin is constructed again
121
+ // for a later deploy onto the same server. buildASTSchema rejects a schema
122
+ // that defines a field twice, so keep the first SDL definition and drop
123
+ // repeats by field name — mirroring the resolver dict, where a repeat
124
+ // registration overwrites by key (last resolver wins).
125
+ let existing = Set.fromArray(mutationFields.contents->Array.map(extractFieldName))
126
+ let fresh = sdlFields->Array.filter(f => !(existing->Set.has(extractFieldName(f))))
127
+ mutationFields.contents = mutationFields.contents->Array.concat(fresh)
89
128
  resolvers->Dict.toArray->Array.forEach(((k, v)) => mutationResolvers.contents->Dict.set(k, v))
90
129
  }
91
130
 
@@ -96,9 +135,20 @@ let make = (~label: string="GraphQL"): t => {
96
135
 
97
136
  let registerSubscriptions = (~sdlFields: array<string>, ~resolvers: dict<resolverFn>) => {
98
137
  subscriptionFields.contents = subscriptionFields.contents->Array.concat(sdlFields)
99
- resolvers->Dict.toArray->Array.forEach(((k, v)) =>
100
- subscriptionResolvers.contents->Dict.set(k, v)
101
- )
138
+ resolvers
139
+ ->Dict.toArray
140
+ ->Array.forEach(((k, v)) => subscriptionResolvers.contents->Dict.set(k, v))
141
+ }
142
+
143
+ let registerFieldResolvers = (~typeName: string, ~resolvers: dict<resolverFn>) => {
144
+ let forType = switch fieldResolvers.contents->Dict.get(typeName) {
145
+ | Some(d) => d
146
+ | None =>
147
+ let d = Dict.make()
148
+ fieldResolvers.contents->Dict.set(typeName, d)
149
+ d
150
+ }
151
+ resolvers->Dict.toArray->Array.forEach(((k, v)) => forType->Dict.set(k, v))
102
152
  }
103
153
 
104
154
  // Identical type blocks dedupe: shared-type registrations (e.g. the
@@ -120,9 +170,7 @@ let make = (~label: string="GraphQL"): t => {
120
170
 
121
171
  let buildSdl = () => {
122
172
  let typesSdl =
123
- typeDefinitions.contents->Array.length > 0
124
- ? typeDefinitions.contents->Array.join("\n\n")
125
- : ""
173
+ typeDefinitions.contents->Array.length > 0 ? typeDefinitions.contents->Array.join("\n\n") : ""
126
174
  let mutations =
127
175
  mutationFields.contents->Array.length > 0
128
176
  ? mutationFields.contents->Array.join("\n")
@@ -142,9 +190,7 @@ ${mutations}
142
190
  ? `\n\ntype Subscription {\n${subscriptionFields.contents->Array.join("\n")}\n}`
143
191
  : ""
144
192
  let base =
145
- typesSdl->String.length > 0
146
- ? typesSdl ++ "\n\n" ++ queriesMutationsSdl
147
- : queriesMutationsSdl
193
+ typesSdl->String.length > 0 ? typesSdl ++ "\n\n" ++ queriesMutationsSdl : queriesMutationsSdl
148
194
  base ++ subscriptionsSdl
149
195
  }
150
196
 
@@ -164,6 +210,9 @@ ${mutations}
164
210
  if subscriptionResolvers.contents->Dict.keysToArray->Array.length > 0 {
165
211
  resolvers->Dict.set("Subscription", subscriptionResolvers.contents)
166
212
  }
213
+ fieldResolvers.contents
214
+ ->Dict.toArray
215
+ ->Array.forEach(((typeName, byField)) => resolvers->Dict.set(typeName, byField))
167
216
  let sdl = buildSdl()
168
217
  lastFullSdl.contents = Some(sdl)
169
218
  let schema = YG.createSchema({"typeDefs": sdl, "resolvers": resolvers})
@@ -173,8 +222,14 @@ ${mutations}
173
222
  // with the original Error even when the client response is masked — is never
174
223
  // swallowed), while verbose debug/info stay gated on GRAPHQL_DEBUG.
175
224
  let yogaLogging: YG.yogaLogger = {
176
- debug: a => if debug { log.debug(~comp=label, YG.logArgToString(a)) },
177
- info: a => if debug { log.info(~comp=label, YG.logArgToString(a)) },
225
+ debug: a =>
226
+ if debug {
227
+ log.debug(~comp=label, YG.logArgToString(a))
228
+ },
229
+ info: a =>
230
+ if debug {
231
+ log.info(~comp=label, YG.logArgToString(a))
232
+ },
178
233
  warn: a => log.warn(~comp=label, YG.logArgToString(a)),
179
234
  error: a => log.error(~comp=label, YG.logArgToString(a)),
180
235
  }
@@ -201,8 +256,20 @@ ${mutations}
201
256
  )
202
257
  if subscriptionResolvers.contents->Dict.keysToArray->Array.length > 0 {
203
258
  let wss = YG.newWebSocketServer({"server": server, "path": "/graphql"})
204
- YG.wsUseServer({"schema": schema}, wss)
205
- log.info(~comp=label, `graphql-ws subscriptions on ws://localhost:${port->Int.toString}/graphql`)
259
+ // A subscription is checked like a query: its context is built by the same
260
+ // factory, from the connection's headers and parameters.
261
+ switch contextFactory {
262
+ | Some(factory) =>
263
+ YG.wsUseServerWithContext(
264
+ {"schema": schema, "context": ctx => factory(wsInitialContext(ctx))},
265
+ wss,
266
+ )
267
+ | None => YG.wsUseServer({"schema": schema}, wss)
268
+ }
269
+ log.info(
270
+ ~comp=label,
271
+ `graphql-ws subscriptions on ws://localhost:${port->Int.toString}/graphql`,
272
+ )
206
273
  }
207
274
  activeServer.contents = Some(server)
208
275
  }
@@ -211,6 +278,7 @@ ${mutations}
211
278
  mutationResolvers.contents = Dict.make()
212
279
  queryResolvers.contents = Dict.make()
213
280
  subscriptionResolvers.contents = Dict.make()
281
+ fieldResolvers.contents = Dict.make()
214
282
  mutationFields.contents = []
215
283
  queryFields.contents = []
216
284
  subscriptionFields.contents = []
@@ -271,7 +339,7 @@ ${mutations}
271
339
  resolverMutationCount: mutResolverNames->Array.length,
272
340
  resolverQueryCount: queryResolverNames->Array.length,
273
341
  mismatches,
274
- fullSdl: lastFullSdl.contents,
342
+ fullSdl: ?lastFullSdl.contents,
275
343
  serverRunning: activeServer.contents->Option.isSome,
276
344
  }
277
345
  }
@@ -309,6 +377,7 @@ ${mutations}
309
377
  registerQueries,
310
378
  registerSubscriptions,
311
379
  registerTypes,
380
+ registerFieldResolvers,
312
381
  getMutationResolver,
313
382
  getQueryResolver,
314
383
  start,
@@ -19,6 +19,26 @@ function extractFieldName(sdlField) {
19
19
  return Stdlib_Option.getOr(Stdlib_Option.getOr(trimmed.split("(")[0], "").trim().split(":")[0], "").trim();
20
20
  }
21
21
 
22
+ function wsInitialContext(ctx) {
23
+ let headers = {};
24
+ Object.entries(ctx.extra.request.headers).forEach(param => {
25
+ headers[param[0].toLowerCase()] = param[1];
26
+ });
27
+ Object.entries(Stdlib_Option.getOr(ctx.connectionParams, {})).forEach(param => {
28
+ let v = param[1];
29
+ if (typeof v !== "string") {
30
+ return;
31
+ }
32
+ headers[param[0].toLowerCase()] = v;
33
+ });
34
+ return {
35
+ request: {
36
+ headers: new Headers(headers)
37
+ },
38
+ req: ctx.extra.request
39
+ };
40
+ }
41
+
22
42
  function make(labelOpt) {
23
43
  let label = labelOpt !== undefined ? labelOpt : "GraphQL";
24
44
  let mutationResolvers = {
@@ -30,6 +50,9 @@ function make(labelOpt) {
30
50
  let subscriptionResolvers = {
31
51
  contents: {}
32
52
  };
53
+ let fieldResolvers = {
54
+ contents: {}
55
+ };
33
56
  let mutationFields = {
34
57
  contents: []
35
58
  };
@@ -52,7 +75,9 @@ function make(labelOpt) {
52
75
  contents: undefined
53
76
  };
54
77
  let registerMutations = (sdlFields, resolvers) => {
55
- mutationFields.contents = mutationFields.contents.concat(sdlFields);
78
+ let existing = new Set(mutationFields.contents.map(extractFieldName));
79
+ let fresh = sdlFields.filter(f => !existing.has(extractFieldName(f)));
80
+ mutationFields.contents = mutationFields.contents.concat(fresh);
56
81
  Object.entries(resolvers).forEach(param => {
57
82
  mutationResolvers.contents[param[0]] = param[1];
58
83
  });
@@ -69,6 +94,20 @@ function make(labelOpt) {
69
94
  subscriptionResolvers.contents[param[0]] = param[1];
70
95
  });
71
96
  };
97
+ let registerFieldResolvers = (typeName, resolvers) => {
98
+ let d = fieldResolvers.contents[typeName];
99
+ let forType;
100
+ if (d !== undefined) {
101
+ forType = d;
102
+ } else {
103
+ let d$1 = {};
104
+ fieldResolvers.contents[typeName] = d$1;
105
+ forType = d$1;
106
+ }
107
+ Object.entries(resolvers).forEach(param => {
108
+ forType[param[0]] = param[1];
109
+ });
110
+ };
72
111
  let registerTypes = sdlTypes => {
73
112
  sdlTypes.forEach(t => {
74
113
  if (!typeDefinitions.contents.includes(t)) {
@@ -110,6 +149,9 @@ type Mutation {
110
149
  if (Object.keys(subscriptionResolvers.contents).length !== 0) {
111
150
  resolvers["Subscription"] = subscriptionResolvers.contents;
112
151
  }
152
+ Object.entries(fieldResolvers.contents).forEach(param => {
153
+ resolvers[param[0]] = param[1];
154
+ });
113
155
  let sdl = buildSdl();
114
156
  lastFullSdl.contents = sdl;
115
157
  let schema = GraphqlYoga$1.createSchema({
@@ -154,9 +196,16 @@ type Mutation {
154
196
  server: server,
155
197
  path: "/graphql"
156
198
  });
157
- Ws$1.useServer({
158
- schema: schema
159
- }, wss);
199
+ if (contextFactory !== undefined) {
200
+ Ws$1.useServer({
201
+ schema: schema,
202
+ context: ctx => contextFactory(wsInitialContext(ctx))
203
+ }, wss);
204
+ } else {
205
+ Ws$1.useServer({
206
+ schema: schema
207
+ }, wss);
208
+ }
160
209
  log.info(label, undefined, `graphql-ws subscriptions on ws://localhost:` + port.toString() + `/graphql`);
161
210
  }
162
211
  activeServer.contents = Primitive_option.some(server);
@@ -165,6 +214,7 @@ type Mutation {
165
214
  mutationResolvers.contents = {};
166
215
  queryResolvers.contents = {};
167
216
  subscriptionResolvers.contents = {};
217
+ fieldResolvers.contents = {};
168
218
  mutationFields.contents = [];
169
219
  queryFields.contents = [];
170
220
  subscriptionFields.contents = [];
@@ -256,6 +306,7 @@ type Mutation {
256
306
  registerQueries: registerQueries,
257
307
  registerSubscriptions: registerSubscriptions,
258
308
  registerTypes: registerTypes,
309
+ registerFieldResolvers: registerFieldResolvers,
259
310
  getMutationResolver: getMutationResolver,
260
311
  getQueryResolver: getQueryResolver,
261
312
  start: start,
@@ -276,6 +327,7 @@ export {
276
327
  log,
277
328
  debug,
278
329
  extractFieldName,
330
+ wsInitialContext,
279
331
  make,
280
332
  }
281
333
  /* log Not a pure module */
@@ -33,8 +33,7 @@ let sourceBTopic = (returnTypeName: string) => `on${returnTypeName}_stateChanged
33
33
 
34
34
  let makeFieldResolver = (~pubSub: YG.pubSub, topic: string): YG.resolverFn => {
35
35
  Obj.magic({
36
- "subscribe": (_root: JSON.t, _args: JSON.t, _ctx: JSON.t) =>
37
- pubSub->YG.pubSubSubscribe(topic),
36
+ "subscribe": (_root: JSON.t, _args: JSON.t, _ctx: JSON.t) => pubSub->YG.pubSubSubscribe(topic),
38
37
  "resolve": (payload: JSON.t) => payload,
39
38
  })
40
39
  }