feat: add ability to customize debugHeaders via option proxyDebugHeaders

lib/components/grpc.ts

@@ -771,10 +771,21 @@ export default function createGrpcAction<Context extends GatewayContext>(
             'x-request-id': requestId,
             'x-gateway-version': VERSION,
         };
+
         if ('protoPath' in config) {
             debugHeaders['x-api-request-protopath'] = config.protoPath;
         }
 
+        if (typeof options.proxyDebugHeaders === 'function') {
+            Object.assign(debugHeaders, options.proxyDebugHeaders({...headers}, 'grpc'));
+        } else if (Array.isArray(options.proxyDebugHeaders)) {
+            for (const headerName of options.proxyDebugHeaders) {
+                if (headers[headerName] !== undefined) {
+                    debugHeaders[`x-gateway-${headerName}`] = headers[headerName];
+                }
+            }
+        }
+
         ctx.log('Initiating request', {debugHeaders: sanitizeDebugHeaders(debugHeaders)});
 
         const sendStats = (status: number, data: any) => {

lib/components/rest.ts

@@ -244,6 +244,16 @@ export default function createRestAction<Context extends GatewayContext>(
             debugHeaders['x-api-content-type'] = headers['content-type'];
         }
 
+        if (typeof options.proxyDebugHeaders === 'function') {
+            Object.assign(debugHeaders, options.proxyDebugHeaders({...requestHeaders}, 'rest'));
+        } else if (Array.isArray(options.proxyDebugHeaders)) {
+            for (const headerName of options.proxyDebugHeaders) {
+                if (headers[headerName] !== undefined) {
+                    debugHeaders[`x-gateway-${headerName}`] = headers[headerName];
+                }
+            }
+        }
+
         const startRequestTime = Date.now();
 
         let axiosClient = defaultAxiosClient;

lib/index.ts

@@ -104,6 +104,7 @@ function createApiAction<
                 timeout: config.timeout,
                 sendStats: config.sendStats,
                 proxyHeaders: config.proxyHeaders,
+                proxyDebugHeaders: config.proxyDebugHeaders,
                 axiosConfig: config.axiosConfig,
                 validationSchema: config.validationSchema,
                 encodePathArgs: config.encodePathArgs,
@@ -126,6 +127,7 @@ function createApiAction<
             timeout: config.timeout,
             sendStats: config.sendStats,
             proxyHeaders: config.proxyHeaders,
+            proxyDebugHeaders: config.proxyDebugHeaders,
             grpcOptions: config.grpcOptions,
             grpcRecreateService,
             getAuthHeaders: config.getAuthHeaders,

lib/models/common.ts

@@ -90,7 +90,7 @@ export type ProxyResponseHeadersFunction = (headers: Headers, type: ControllerTy
 export type ProxyResponseHeaders = string[] | ProxyResponseHeadersFunction;
 
 export type GetAuthHeadersParams<AuthArgs = Record<string, unknown>> = {
-    actionType: 'rest' | 'grpc';
+    actionType: ControllerType;
     serviceName: string;
     requestHeaders: Headers;
     authArgs: AuthArgs | undefined;
@@ -110,6 +110,7 @@ export interface GatewayApiOptions<Context extends GatewayContext> {
     grpcRecreateService?: boolean;
     axiosConfig?: AxiosRequestConfig;
     proxyHeaders?: ProxyHeaders;
+    proxyDebugHeaders?: ProxyHeaders;
     validationSchema?: object;
     encodePathArgs?: boolean;
     expectedResponseContentType?: ResponseContentType | ResponseContentType[];
@@ -440,7 +441,8 @@ export interface GatewayConfig<
     includeProtoRoots?: string[];
     caCertificatePath: string | null;
     proxyHeaders: ProxyHeaders;
-    withDebugHeaders: boolean | ((req: Req, res: Res) => boolean);
+    proxyDebugHeaders?: ProxyHeaders;
+    withDebugHeaders?: boolean | ((req: Req, res: Res) => boolean);
     validationSchema?: object;
     encodePathArgs?: boolean;
     getAuthArgs: (req: Req, res: Res) => Record<string, unknown> | undefined;