Deprecate Chalice's render_graphiql parameter by adding a warning

RELEASE.md

@@ -0,0 +1,5 @@
+Release type: patch
+
+With this release in Chalice's `GraphQLView` the parameter `render_graphiql` is now
+deprecated and has been replaced with `graphiql`. It will be removed in releases of
+Strawberry made after 2022-07-13.

docs/integrations/chalice.md

@@ -41,7 +41,7 @@ class Mutation:
 
 
 schema = strawberry.Schema(query=Query, mutation=Mutation)
-view = GraphQLView(schema=schema, render_graphiql=True)
+view = GraphQLView(schema=schema, graphiql=True)
 
 
 @app.route("/graphql", methods=["GET", "POST"], content_types=["application/json"])

strawberry/chalice/views.py

@@ -1,4 +1,6 @@
+import warnings
 from http import HTTPStatus
+from typing import Optional
 
 from chalice.app import BadRequestError, CaseInsensitiveMapping, Request, Response
 from strawberry.chalice.graphiql import render_graphiql_page
@@ -8,9 +10,22 @@
 
 
 class GraphQLView:
-    def __init__(self, schema: BaseSchema, render_graphiql: bool = True):
+    def __init__(
+        self,
+        schema: BaseSchema,
+        graphiql: bool = True,
+        render_graphiql: Optional[bool] = None,
+    ):
         self._schema = schema
-        self.graphiql = render_graphiql
+        self.graphiql = graphiql
+
+        if render_graphiql is not None:
+            warnings.warn(
+                "`render_graphiql` is deprecated and it will stop working in releases "
+                "of strawberry made after 2022-07-13. Use `graphiql` instead",
+                DeprecationWarning,
+            )
+            self.graphiql = render_graphiql
 
     @staticmethod
     def render_graphiql() -> str:

tests/chalice/app.py

@@ -22,7 +22,7 @@ def echo(self, string_to_echo: str) -> str:
 
 
 schema = strawberry.Schema(query=Query, mutation=Mutation)
-view = GraphQLView(schema=schema, render_graphiql=True)
+view = GraphQLView(schema=schema, graphiql=True)
 
 
 @app.route("/")
@@ -35,3 +35,15 @@ def handle_graphql():
     request: Request = app.current_request
     result = view.execute_request(request)
     return result
+
+
+deprecated_graphiql_view = GraphQLView(schema=schema, render_graphiql=True)
+
+
+@app.route(
+    "/deprecated-graphql", methods=["GET", "POST"], content_types=["application/json"]
+)
+def handle_deprecated_graphql():
+    request: Request = app.current_request
+    result = deprecated_graphiql_view.execute_request(request)
+    return result

tests/chalice/test_views.py

@@ -4,8 +4,9 @@
 import pytest
 
 from chalice.test import Client, HTTPResponse
+from strawberry.chalice.views import GraphQLView
 
-from .app import app
+from .app import app, schema
 
 
 def test_chalice_server_index_route_returns():
@@ -94,3 +95,21 @@ def test_graphiql_query_with_no_request_body():
         response = client.http.post("/graphql", headers=headers, body="")
         assert response.status_code == HTTPStatus.OK
         assert response_is_of_error_type(response)
+
+
+def test_deprecated_render_graphiql():
+    with Client(app) as client:
+        headers = {"Accept": "application/json"}
+        response = client.http.get("/deprecated-graphql", headers=headers)
+        assert response.status_code == HTTPStatus.OK
+        assert response_is_of_error_type(response)
+
+
+def test_using_deprecated_render_graphiql_raise_warning():
+    with pytest.deprecated_call() as record:
+        GraphQLView(schema=schema, render_graphiql=True)
+
+    assert record[0].message.args == [
+        "`render_graphiql` is deprecated and it will stop working in releases "
+        "of strawberry made after 2022-07-13. Use `graphiql` instead",
+    ]