Avoid creating new tabs on header state (#3371)

Solves #2825, an old bug where new tabs were created on every
refresh

the bug occurred when:

1. `shouldPersistHeaders` is not set to true
2. `headers` or `defaultHeaders` are provided as props
3. the user refreshes the browser

Author: acao

.changeset/sour-maps-ring.md

@@ -0,0 +1,12 @@
+---
+'@graphiql/react': patch
+'graphiql': patch
+---
+
+Solves #2825, an old bug where new tabs were created on every refresh
+
+the bug occurred when:
+
+1. `shouldPersistHeaders` is not set to true
+2. `headers` or `defaultHeaders` are provided as props
+3. the user refreshes the browser

packages/graphiql-react/src/editor/context.tsx

@@ -311,6 +311,7 @@ export function EditorContextProvider(props: EditorContextProviderProps) {
       defaultQuery: props.defaultQuery || DEFAULT_QUERY,
       defaultHeaders: props.defaultHeaders,
       storage,
+      shouldPersistHeaders,
     });
     storeTabs(tabState);
 

packages/graphiql-react/src/editor/tabs.ts

@@ -72,6 +72,7 @@ export function getDefaultTabState({
   query,
   variables,
   storage,
+  shouldPersistHeaders,
 }: {
   defaultQuery: string;
   defaultHeaders?: string;
@@ -80,15 +81,23 @@ export function getDefaultTabState({
   query: string | null;
   variables: string | null;
   storage: StorageAPI | null;
+  shouldPersistHeaders?: boolean;
 }) {
   const storedState = storage?.get(STORAGE_KEY);
   try {
     if (!storedState) {
       throw new Error('Storage for tabs is empty');
     }
     const parsed = JSON.parse(storedState);
+    // if headers are not persisted, do not derive the hash using default headers state
+    // or else you will get new tabs on every refresh
+    const headersForHash = shouldPersistHeaders ? headers : undefined;
     if (isTabsState(parsed)) {
-      const expectedHash = hashFromTabContents({ query, variables, headers });
+      const expectedHash = hashFromTabContents({
+        query,
+        variables,
+        headers: headersForHash,
+      });
       let matchingTabIndex = -1;
 
       for (let index = 0; index < parsed.tabs.length; index++) {