feat(options) postgraphile: add contextOptions to allow custom jwt cl…

…aims (#3915) * add contextOptions * improve documentation * version bump to 0.20.18 * add code safety around contextOptions type * add changeset * Go --------- Co-authored-by: Arda TANRIKULU <ardatanrikulu@gmail.com>
ardatan · Apr 3, 2023 · aea1347 · aea1347
1 parent f2b0a5b
commit aea1347
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 1 deletion.
diff --git a/.changeset/afraid-boats-grow.md b/.changeset/afraid-boats-grow.md
@@ -0,0 +1,6 @@
+---
+'@graphql-mesh/postgraphile': patch
+'@graphql-mesh/types': patch
+---
+
+add contextOptions to allow customization of jwt claims
diff --git a/packages/handlers/postgraphile/src/index.ts b/packages/handlers/postgraphile/src/index.ts
@@ -129,6 +129,13 @@ export default class PostGraphileHandler implements MeshHandler {
       await this.pgCache.set(cachedIntrospection);
     }
 
+    let contextOptions = await loadFromModuleExportExpression<any>(this.config.contextOptions, {
+      cwd: this.baseDir,
+      importFn: this.importFn,
+      defaultExportName: 'default',
+    });
+    if (typeof contextOptions !== 'function') contextOptions = () => ({});
+
     return {
       schema,
       executor({
@@ -145,6 +152,7 @@ export default class PostGraphileHandler implements MeshHandler {
             queryDocumentAst: document,
             operationName,
             variables,
+            ...contextOptions(meshContext),
           },
           function withPgContextCallback(pgContext) {
             return defaultExecutor({

diff --git a/packages/handlers/postgraphile/yaml-config.graphql b/packages/handlers/postgraphile/yaml-config.graphql
@@ -38,6 +38,10 @@ type PostGraphileHandler @md {
   Enables live-query support via GraphQL subscriptions (sends updated payload any time nested collections/records change) (default: true)
   """
   live: Boolean
+  """
+  A file that exports a function which takes context as a paramter and returns postgraphile context options (e.g. "./my-function#pgSettings"). See the [postgraphile docs](https://www.graphile.org/postgraphile/usage-schema/) for more information.
+  """
+  contextOptions: Any
 }
 
 union PostgraphileExternalOptions = JSON | String
diff --git a/packages/types/src/config-schema.json b/packages/types/src/config-schema.json
@@ -2881,6 +2881,22 @@
         "live": {
           "type": "boolean",
           "description": "Enables live-query support via GraphQL subscriptions (sends updated payload any time nested collections/records change) (default: true)"
+        },
+        "contextOptions": {
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": true
+            },
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "additionalItems": true
+            }
+          ],
+          "description": "A file that exports a function which takes context as a paramter and returns postgraphile context options (e.g. \"./my-function#pgSettings\"). See the [postgraphile docs](https://www.graphile.org/postgraphile/usage-schema/) for more information."
         }
       }
     },

diff --git a/packages/types/src/config.ts b/packages/types/src/config.ts
@@ -904,6 +904,10 @@ export interface PostGraphileHandler {
    * Enables live-query support via GraphQL subscriptions (sends updated payload any time nested collections/records change) (default: true)
    */
   live?: boolean;
+  /**
+   * A file that exports a function which takes context as a paramter and returns postgraphile context options (e.g. "./my-function#pgSettings"). See the [postgraphile docs](https://www.graphile.org/postgraphile/usage-schema/) for more information.
+   */
+  contextOptions?: any;
 }
 export interface RAMLHandler {
   source: string;

diff --git a/website/src/generated-markdown/PostGraphileHandler.generated.md b/website/src/generated-markdown/PostGraphileHandler.generated.md
@@ -8,4 +8,5 @@
   * `JSON`
   * `String`
 * `subscriptions` (type: `Boolean`) - Enable GraphQL websocket transport support for subscriptions (default: true)
-* `live` (type: `Boolean`) - Enables live-query support via GraphQL subscriptions (sends updated payload any time nested collections/records change) (default: true)
+* `live` (type: `Boolean`) - Enables live-query support via GraphQL subscriptions (sends updated payload any time nested collections/records change) (default: true)
+* `contextOptions` (type: `Any`) - A file that exports a function which takes context as a paramter and returns postgraphile context options (e.g. "./my-function#pgSettings"). See the [postgraphile docs](https://www.graphile.org/postgraphile/usage-schema/) for more information.