@graphql-tools/executor-http 3.1.4 → 3.2.0-alpha-0d94d0b5930ac05920a55412bec7d913ccb626d1

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @graphql-tools/executor-http
 
+## 3.2.0-alpha-0d94d0b5930ac05920a55412bec7d913ccb626d1
+### Minor Changes
+
+
+
+- [#2211](https://github.com/graphql-hive/gateway/pull/2211) [`3e4187b`](https://github.com/graphql-hive/gateway/commit/3e4187b340801fee45df8df891617afcfc8b4b30) Thanks [@ardatan](https://github.com/ardatan)! - Add `exposeHTTPDetailsInExtensions` flag to get `Response` details in the result extensions.
+  
+  ```ts
+  import { buildHTTPExecutor } from '@graphql-tools/executor-http';
+  
+  const executor = buildHTTPExecutor({
+    exposeHTTPDetailsInExtensions: true,
+  });
+  ```
+  
+  Then in the result;
+  
+  ```ts
+  {
+      "data": {
+          "hello": "world"
+      },
+      "extensions": {
+          "request": {
+              "url": "http://localhost:4000/graphql",
+              "method": "POST",
+              "headers": {
+                  "content-type": "application/json"
+              },
+              "body": "{\"query\":\"{ hello }\"}"
+          },
+          "response": {
+              "status": 200,
+              "statusText": "OK",
+              "headers": {
+                  "content-type": "application/json"
+              }
+          }
+      }
+  }
+
 ## 3.1.4
 ### Patch Changes
 

package/dist/index.cjs

@@ -684,7 +684,7 @@ function buildHTTPExecutor(options) {
         return runInflightRequest();
       }
       function runInflightRequest() {
-        return promiseHelpers.handleMaybePromise(
+        const result$ = promiseHelpers.handleMaybePromise(
           () => fetchFn(
             inflightRequestOptions.url,
             {
@@ -702,15 +702,23 @@ function buildHTTPExecutor(options) {
               upstreamErrorExtensions.response ||= {};
               upstreamErrorExtensions.response.status = fetchResult.status;
               upstreamErrorExtensions.response.statusText = fetchResult.statusText;
-              Object.defineProperty(
-                upstreamErrorExtensions.response,
-                "headers",
-                {
-                  get() {
-                    return Object.fromEntries(fetchResult.headers.entries());
+              if (options?.exposeHTTPDetailsInExtensions) {
+                upstreamErrorExtensions.response.headers = Object.fromEntries(
+                  fetchResult.headers.entries()
+                );
+              } else {
+                Object.defineProperty(
+                  upstreamErrorExtensions.response,
+                  "headers",
+                  {
+                    get() {
+                      return Object.fromEntries(
+                        fetchResult.headers.entries()
+                      );
+                    }
                   }
-                }
-              );
+                );
+              }
               if (options?.retry != null && !fetchResult.status.toString().startsWith("2")) {
                 throw new Error(
                   fetchResult.statusText || `Upstream HTTP Error: ${fetchResult.status}`
@@ -794,6 +802,20 @@ function buildHTTPExecutor(options) {
           ),
           handleError
         );
+        if (options?.exposeHTTPDetailsInExtensions) {
+          return promiseHelpers.handleMaybePromise(
+            () => result$,
+            (result) => {
+              result.extensions ||= {};
+              result.extensions = Object.assign(
+                result.extensions,
+                upstreamErrorExtensions
+              );
+              return result;
+            }
+          );
+        }
+        return result$;
       }
       if (typeof inflightRequestOptions.body === "object") {
         return runInflightRequest();

package/dist/index.d.cts

@@ -92,6 +92,14 @@ interface HTTPExecutorOptions {
      * @default true
      */
     deduplicateInflightRequests?: boolean;
+    /**
+     * This option allows you to include the response detauls in the result extensions when a request fails.
+     * This can be useful for debugging and error handling purposes, as it provides additional context about the response that led to the error.
+     * However, be cautious when enabling this option, as response headers may contain sensitive information.
+     *
+     * @default false
+     */
+    exposeHTTPDetailsInExtensions?: boolean;
 }
 type HeadersConfig = Record<string, string>;
 interface InflightRequestOptions {

package/dist/index.d.ts

@@ -92,6 +92,14 @@ interface HTTPExecutorOptions {
      * @default true
      */
     deduplicateInflightRequests?: boolean;
+    /**
+     * This option allows you to include the response detauls in the result extensions when a request fails.
+     * This can be useful for debugging and error handling purposes, as it provides additional context about the response that led to the error.
+     * However, be cautious when enabling this option, as response headers may contain sensitive information.
+     *
+     * @default false
+     */
+    exposeHTTPDetailsInExtensions?: boolean;
 }
 type HeadersConfig = Record<string, string>;
 interface InflightRequestOptions {

package/dist/index.js

@@ -682,7 +682,7 @@ function buildHTTPExecutor(options) {
         return runInflightRequest();
       }
       function runInflightRequest() {
-        return handleMaybePromise(
+        const result$ = handleMaybePromise(
           () => fetchFn(
             inflightRequestOptions.url,
             {
@@ -700,15 +700,23 @@ function buildHTTPExecutor(options) {
               upstreamErrorExtensions.response ||= {};
               upstreamErrorExtensions.response.status = fetchResult.status;
               upstreamErrorExtensions.response.statusText = fetchResult.statusText;
-              Object.defineProperty(
-                upstreamErrorExtensions.response,
-                "headers",
-                {
-                  get() {
-                    return Object.fromEntries(fetchResult.headers.entries());
+              if (options?.exposeHTTPDetailsInExtensions) {
+                upstreamErrorExtensions.response.headers = Object.fromEntries(
+                  fetchResult.headers.entries()
+                );
+              } else {
+                Object.defineProperty(
+                  upstreamErrorExtensions.response,
+                  "headers",
+                  {
+                    get() {
+                      return Object.fromEntries(
+                        fetchResult.headers.entries()
+                      );
+                    }
                   }
-                }
-              );
+                );
+              }
               if (options?.retry != null && !fetchResult.status.toString().startsWith("2")) {
                 throw new Error(
                   fetchResult.statusText || `Upstream HTTP Error: ${fetchResult.status}`
@@ -792,6 +800,20 @@ function buildHTTPExecutor(options) {
           ),
           handleError
         );
+        if (options?.exposeHTTPDetailsInExtensions) {
+          return handleMaybePromise(
+            () => result$,
+            (result) => {
+              result.extensions ||= {};
+              result.extensions = Object.assign(
+                result.extensions,
+                upstreamErrorExtensions
+              );
+              return result;
+            }
+          );
+        }
+        return result$;
       }
       if (typeof inflightRequestOptions.body === "object") {
         return runInflightRequest();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/executor-http",
-  "version": "3.1.4",
+  "version": "3.2.0-alpha-0d94d0b5930ac05920a55412bec7d913ccb626d1",
   "type": "module",
   "description": "A set of utils for faster development of GraphQL tools",
   "repository": {