sendOperationHeadersInIntrospection config option, default to true (#277

) * sendOperationHeadersInIntrospection config option, default to trues * Update packages/sandbox/src/EmbeddedSandbox.ts Co-authored-by: Trevor Scheer <trevor.scheer@gmail.com> * fix this * Create twelve-hats-burn.md --------- Co-authored-by: Trevor Scheer <trevor.scheer@gmail.com>
apollographql · Sep 21, 2023 · 5cd64d9 · 5cd64d9
1 parent 7dfce71
commit 5cd64d9
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/.changeset/twelve-hats-burn.md b/.changeset/twelve-hats-burn.md
@@ -0,0 +1,5 @@
+---
+"@apollo/sandbox": minor
+---
+
+sendOperationHeadersInIntrospection config option, default to true
diff --git a/packages/sandbox/src/EmbeddedSandbox.ts b/packages/sandbox/src/EmbeddedSandbox.ts
@@ -79,6 +79,13 @@ export interface EmbeddableSandboxOptions {
    * style injection.
    */
   allowDynamicStyles?: boolean;
+  /**
+   * Defaults to true, even though our default in hosted Sandbox is false.
+   * Needed to default to true so that shipped versions particularly on Apollo Server
+   * maintain backwards compatible behavior. Pass false to exclusively pass shared headers
+   * to introspection requests.
+   */
+  sendOperationHeadersInIntrospection?: boolean;
 }
 
 type InternalEmbeddableSandboxOptions = EmbeddableSandboxOptions & {
@@ -133,6 +140,8 @@ export class EmbeddedSandbox {
       runtime: this.options.runtime,
       endpoint: this.options.initialEndpoint,
       subscriptionEndpoint: this.options.initialSubscriptionEndpoint,
+      sendOperationHeadersInIntrospection:
+        this.options.sendOperationHeadersInIntrospection ?? true,
       ...(this.options.initialState &&
       'collectionId' in this.options.initialState
         ? {