Add prepareHeader to graphqlrequestbasequery (reduxjs#1828)

* Add prepareHeaders to graphqlRequestBaseQuery.

* Leave current options.requestHeaders for backward compatibility.

* review

* Pass requestHeaders to stripUndefined.

Co-authored-by: Lenz Weber <lenz.weber@mayflower.de>

Author: rumurillo

packages/rtk-query-graphql-request-base-query/package.json

@@ -22,7 +22,7 @@
     "graphql-request": "^3.4.0"
   },
   "peerDependencies": {
-    "@reduxjs/toolkit": "^1.6.0",
+    "@reduxjs/toolkit": "^1.7.1",
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0"
   },
   "devDependencies": {

packages/rtk-query-graphql-request-base-query/src/GraphqlBaseQueryTypes.ts

@@ -0,0 +1,33 @@
+import type { BaseQueryApi } from '@reduxjs/toolkit/dist/query/baseQueryTypes'
+import type { GraphQLClient } from 'graphql-request'
+
+type P = Parameters<GraphQLClient['request']>
+export type Document = P[0]
+export type Variables = P[1]
+export type RequestHeaders = P[2]
+
+export type GraphqlRequestBaseQueryArgs = {
+  options:
+    | {
+        url: string
+        requestHeaders?: RequestHeaders
+      }
+    | { client: GraphQLClient }
+  prepareHeaders?: (
+    headers: Headers,
+    api: Pick<BaseQueryApi, 'getState' | 'endpoint' | 'type' | 'forced'>
+  ) => MaybePromise<Headers>
+}
+
+export type QueryReturnValue<T = unknown, E = unknown, M = unknown> =
+  | {
+      error: E
+      data?: undefined
+      meta?: M
+    }
+  | {
+      error?: undefined
+      data: T
+      meta?: M
+    }
+export type MaybePromise<T> = T | PromiseLike<T>

packages/rtk-query-graphql-request-base-query/src/index.ts

@@ -1,36 +1,54 @@
-import { BaseQueryFn } from "@reduxjs/toolkit/query/react";
-import { DocumentNode } from "graphql";
-import { GraphQLClient, ClientError } from "graphql-request";
+import { isPlainObject } from '@reduxjs/toolkit'
+import type { BaseQueryFn } from '@reduxjs/toolkit/query'
+import type { DocumentNode } from 'graphql'
+import { GraphQLClient, ClientError } from 'graphql-request'
+import type {
+  GraphqlRequestBaseQueryArgs,
+  RequestHeaders,
+} from './GraphqlBaseQueryTypes'
 
-type P = Parameters<GraphQLClient["request"]>;
-export type Document = P[0];
-export type Variables = P[1];
-export type RequestHeaders = P[2];
-
-export const graphqlRequestBaseQuery = (
-  options:
-    | { url: string; requestHeaders?: RequestHeaders }
-    | { client: GraphQLClient }
-): BaseQueryFn<
+export const graphqlRequestBaseQuery = ({
+  options,
+  prepareHeaders = (x) => x,
+}: GraphqlRequestBaseQueryArgs): BaseQueryFn<
   { document: string | DocumentNode; variables?: any },
   unknown,
-  Pick<ClientError, "name" | "message" | "stack">,
-  Partial<Pick<ClientError, "request" | "response">>
+  Pick<ClientError, 'name' | 'message' | 'stack'>,
+  Partial<Pick<ClientError, 'request' | 'response'>>
 > => {
   const client =
-    "client" in options ? options.client : new GraphQLClient(options.url);
-  if ("requestHeaders" in options) {
-    client.setHeaders(options.requestHeaders);
-  }
-  return async ({ document, variables }) => {
+    'client' in options ? options.client : new GraphQLClient(options.url)
+  const requestHeaders: RequestHeaders =
+    'requestHeaders' in options ? options.requestHeaders : {}
+
+  return async (
+    { document, variables },
+    { getState, endpoint, forced, type }
+  ) => {
     try {
-      return { data: await client.request(document, variables), meta: {} };
+      const headers = new Headers(stripUndefined(requestHeaders))
+
+      client.setHeaders(
+        await prepareHeaders(headers, { getState, endpoint, forced, type })
+      )
+      return { data: await client.request(document, variables), meta: {} }
     } catch (error) {
       if (error instanceof ClientError) {
-        const { name, message, stack, request, response } = error;
-        return { error: { name, message, stack }, meta: { request, response } };
+        const { name, message, stack, request, response } = error
+        return { error: { name, message, stack }, meta: { request, response } }
       }
-      throw error;
+      throw error
     }
-  };
-};
+  }
+}
+
+function stripUndefined(obj: any) {
+  if (!isPlainObject(obj)) {
+    return obj
+  }
+  const copy: Record<string, any> = { ...obj }
+  for (const [k, v] of Object.entries(copy)) {
+    if (typeof v === 'undefined') delete copy[k]
+  }
+  return copy
+}

yarn.lock

@@ -5580,7 +5580,7 @@ __metadata:
     microbundle: ^0.13.3
     typescript: ^4.3.4
   peerDependencies:
-    "@reduxjs/toolkit": ^1.6.0
+    "@reduxjs/toolkit": ^1.7.1
     graphql: ^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0
   languageName: unknown
   linkType: soft