From a78114ada346fb2c639ea88fe81d0407cf5ed448 Mon Sep 17 00:00:00 2001
From: Suyeol Jeon <devxoul@gmail.com>
Date: Sat, 24 Sep 2022 23:41:14 +0900
Subject: [PATCH] Add support to persist GraphQL headers in GraphiQL (#1209)

---
 docs/settings.rst                             | 19 +++++++++++++++++++
 graphene_django/settings.py                   |  1 +
 .../static/graphene_django/graphiql.js        |  1 +
 .../templates/graphene/graphiql.html          |  1 +
 graphene_django/views.py                      |  1 +
 5 files changed, 23 insertions(+)

diff --git a/docs/settings.rst b/docs/settings.rst
index ff1c05e..1984a15 100644
--- a/docs/settings.rst
+++ b/docs/settings.rst
@@ -207,3 +207,22 @@ Default: ``True``
    GRAPHENE = {
       'GRAPHIQL_HEADER_EDITOR_ENABLED': True,
    }
+
+
+``GRAPHIQL_SHOULD_PERSIST_HEADERS``
+---------------------
+
+Set to ``True`` if you want to persist GraphiQL headers after refreshing the page.
+
+This setting is passed to ``shouldPersistHeaders`` GraphiQL options, for details refer to GraphiQLDocs_.
+
+.. _GraphiQLDocs: https://github.com/graphql/graphiql/tree/main/packages/graphiql#options
+
+
+Default: ``False``
+
+.. code:: python
+
+   GRAPHENE = {
+      'GRAPHIQL_SHOULD_PERSIST_HEADERS': False,
+   }
diff --git a/graphene_django/settings.py b/graphene_django/settings.py
index 467c6a3..0fd70a7 100644
--- a/graphene_django/settings.py
+++ b/graphene_django/settings.py
@@ -41,6 +41,7 @@ DEFAULTS = {
     # This sets headerEditorEnabled GraphiQL option, for details go to
     # https://github.com/graphql/graphiql/tree/main/packages/graphiql#options
     "GRAPHIQL_HEADER_EDITOR_ENABLED": True,
+    "GRAPHIQL_SHOULD_PERSIST_HEADERS": False,
     "ATOMIC_MUTATIONS": False,
 }
 
diff --git a/graphene_django/static/graphene_django/graphiql.js b/graphene_django/static/graphene_django/graphiql.js
index f457f65..f6be32c 100644
--- a/graphene_django/static/graphene_django/graphiql.js
+++ b/graphene_django/static/graphene_django/graphiql.js
@@ -178,6 +178,7 @@
     onEditVariables: onEditVariables,
     onEditOperationName: onEditOperationName,
     headerEditorEnabled: GRAPHENE_SETTINGS.graphiqlHeaderEditorEnabled,
+    shouldPersistHeaders: GRAPHENE_SETTINGS.graphiqlShouldPersistHeaders,
     query: parameters.query,
   };
   if (parameters.variables) {
diff --git a/graphene_django/templates/graphene/graphiql.html b/graphene_django/templates/graphene/graphiql.html
index cec4893..3685692 100644
--- a/graphene_django/templates/graphene/graphiql.html
+++ b/graphene_django/templates/graphene/graphiql.html
@@ -46,6 +46,7 @@ add "&raw" to the end of the URL within a browser.
       subscriptionPath: "{{subscription_path}}",
     {% endif %}
       graphiqlHeaderEditorEnabled: {{ graphiql_header_editor_enabled|yesno:"true,false" }},
+      graphiqlShouldPersistHeaders: {{ graphiql_should_persist_headers|yesno:"true,false" }},
     };
   </script>
   <script src="{% static 'graphene_django/graphiql.js' %}"></script>
diff --git a/graphene_django/views.py b/graphene_django/views.py
index f533f70..bf333a9 100644
--- a/graphene_django/views.py
+++ b/graphene_django/views.py
@@ -162,6 +162,7 @@ class GraphQLView(View):
                     subscription_path=self.subscription_path,
                     # GraphiQL headers tab,
                     graphiql_header_editor_enabled=graphene_settings.GRAPHIQL_HEADER_EDITOR_ENABLED,
+                    graphiql_should_persist_headers=graphene_settings.GRAPHIQL_SHOULD_PERSIST_HEADERS,
                 )
 
             if self.batch: