fix: deprecate starlite integration. closes #3359

.gitignore

@@ -1,6 +1,3 @@
-.DS_Store
-
-
 # Created by https://www.gitignore.io/api/macos,linux,python,windows
 # Edit at https://www.gitignore.io/?templates=macos,linux,python,windows
 

RELEASE.md

@@ -0,0 +1,17 @@
+Release type: patch
+
+**Deprecations:** This release deprecates the `Starlite` integration in favour of the `LiteStar` integration.
+Refer to the [LiteStar](./litestar.md) integration for more information.
+LiteStar is a [renamed](https://litestar.dev/about/organization.html#litestar-and-starlite) and upgraded version of Starlite.
+
+Before:
+
+```python
+from strawberry.starlite import make_graphql_controller
+```
+
+After:
+
+```python
+from strawberry.litestar import make_graphql_controller
+```

docs/integrations/starlite.md

@@ -4,6 +4,16 @@ title: Starlite
 
 # Starlite
 
+## Deprecation Notice
+
+This integration has been deprecated in favor of the `Litestar` integration.
+Refer to the [Litestar](./litestar.md) integration for more information.
+Litestar is a
+[renamed](https://litestar.dev/about/organization.html#litestar-and-starlite)
+and upgraded version of Starlite.
+
+## How to use
+
 Strawberry comes with an integration for
 [Starlite](https://starliteproject.dev/) by providing a
 `make_graphql_controller` function that can be used to create a GraphQL

strawberry/starlite/controller.py

@@ -6,6 +6,7 @@
 from dataclasses import dataclass
 from datetime import timedelta
 from typing import TYPE_CHECKING, Any, Dict, Mapping, Optional, Tuple, Union, cast
+from typing_extensions import deprecated
 
 from starlite import (
     BackgroundTasks,
@@ -118,6 +119,10 @@ async def get_root_value(self) -> Any:
         return await self._get_root_value()
 
 
+@deprecated(
+    "The `starlite` integration is deprecated in favor of `litestar` integration",
+    stacklevel=2,
+)
 class StarliteRequestAdapter(AsyncHTTPRequestAdapter):
     def __init__(self, request: Request[Any, Any]) -> None:
         self.request = request
@@ -153,6 +158,10 @@ def __init__(self) -> None:
         self.response: Optional[Response] = None
 
 
+@deprecated(
+    "The `starlite` integration is deprecated in favor of `litestar` integration",
+    stacklevel=2,
+)
 def make_graphql_controller(
     schema: BaseSchema,
     path: str = "",

tests/starlite/test_context.py

@@ -1,5 +1,7 @@
 from typing import Dict
 
+import pytest
+
 import strawberry
 
 try:
@@ -181,3 +183,20 @@
 
     assert response.json() == {"data": {"something": "foo"}}
     assert task_complete
+
+
+def test_starlite_usage_triggers_deprecation_warning():
+    @strawberry.type
+    class Query:
+        @strawberry.field
+        def abc(self, info: strawberry.Info) -> str:
+            assert info.context.get("request") is not None
+            assert info.context.get("strawberry") is None
+            return "abc"
+
+    schema = strawberry.Schema(query=Query)
+
+    with pytest.deprecated_call(
+        match="The `starlite` integration is deprecated in favor of `litestar` integration"
+    ):
+        make_graphql_controller(path="/graphql", schema=schema, context_getter=None)