1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
|
import asyncio
from collections.abc import AsyncGenerator
import pytest
import strawberry
from strawberry.exceptions import InvalidCustomContext
from strawberry.subscriptions import GRAPHQL_TRANSPORT_WS_PROTOCOL, GRAPHQL_WS_PROTOCOL
from strawberry.subscriptions.protocols.graphql_transport_ws import (
types as transport_ws_types,
)
from strawberry.subscriptions.protocols.graphql_ws import types as ws_types
def test_base_context():
from strawberry.fastapi import BaseContext
base_context = BaseContext()
assert base_context.request is None
assert base_context.background_tasks is None
assert base_context.response is None
def test_with_explicit_class_context_getter():
from fastapi import Depends, FastAPI
from fastapi.testclient import TestClient
from strawberry.fastapi import BaseContext, GraphQLRouter
@strawberry.type
class Query:
@strawberry.field
def abc(self, info: strawberry.Info) -> str:
assert info.context.request is not None
assert info.context.strawberry == "explicitly rocks"
assert info.context.connection_params is None
return "abc"
class CustomContext(BaseContext):
def __init__(self, rocks: str):
self.strawberry = rocks
def custom_context_dependency() -> CustomContext:
return CustomContext(rocks="explicitly rocks")
def get_context(custom_context: CustomContext = Depends(custom_context_dependency)):
return custom_context
app = FastAPI()
schema = strawberry.Schema(query=Query)
graphql_app = GraphQLRouter(schema=schema, context_getter=get_context)
app.include_router(graphql_app, prefix="/graphql")
test_client = TestClient(app)
response = test_client.post("/graphql", json={"query": "{ abc }"})
assert response.status_code == 200
assert response.json() == {"data": {"abc": "abc"}}
def test_with_implicit_class_context_getter():
from fastapi import Depends, FastAPI
from fastapi.testclient import TestClient
from strawberry.fastapi import BaseContext, GraphQLRouter
@strawberry.type
class Query:
@strawberry.field
def abc(self, info: strawberry.Info) -> str:
assert info.context.request is not None
assert info.context.strawberry == "implicitly rocks"
assert info.context.connection_params is None
return "abc"
class CustomContext(BaseContext):
def __init__(self, rocks: str = "implicitly rocks"):
super().__init__()
self.strawberry = rocks
def get_context(custom_context: CustomContext = Depends()):
return custom_context
app = FastAPI()
schema = strawberry.Schema(query=Query)
graphql_app = GraphQLRouter(schema=schema, context_getter=get_context)
app.include_router(graphql_app, prefix="/graphql")
test_client = TestClient(app)
response = test_client.post("/graphql", json={"query": "{ abc }"})
assert response.status_code == 200
assert response.json() == {"data": {"abc": "abc"}}
def test_with_dict_context_getter():
from fastapi import Depends, FastAPI
from fastapi.testclient import TestClient
from strawberry.fastapi import GraphQLRouter
@strawberry.type
class Query:
@strawberry.field
def abc(self, info: strawberry.Info) -> str:
assert info.context.get("request") is not None
assert "connection_params" not in info.context
assert info.context.get("strawberry") == "rocks"
return "abc"
def custom_context_dependency() -> str:
return "rocks"
def get_context(value: str = Depends(custom_context_dependency)) -> dict[str, str]:
return {"strawberry": value}
app = FastAPI()
schema = strawberry.Schema(query=Query)
graphql_app = GraphQLRouter(schema=schema, context_getter=get_context)
app.include_router(graphql_app, prefix="/graphql")
test_client = TestClient(app)
response = test_client.post("/graphql", json={"query": "{ abc }"})
assert response.status_code == 200
assert response.json() == {"data": {"abc": "abc"}}
def test_without_context_getter():
from fastapi import FastAPI
from fastapi.testclient import TestClient
from strawberry.fastapi import GraphQLRouter
@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"
app = FastAPI()
schema = strawberry.Schema(query=Query)
graphql_app = GraphQLRouter(schema, context_getter=None)
app.include_router(graphql_app, prefix="/graphql")
test_client = TestClient(app)
response = test_client.post("/graphql", json={"query": "{ abc }"})
assert response.status_code == 200
assert response.json() == {"data": {"abc": "abc"}}
def test_with_invalid_context_getter():
from fastapi import Depends, FastAPI
from fastapi.testclient import TestClient
from strawberry.fastapi import GraphQLRouter
@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"
def custom_context_dependency() -> str:
return "rocks"
def get_context(value: str = Depends(custom_context_dependency)) -> str:
return value
app = FastAPI()
schema = strawberry.Schema(query=Query)
graphql_app = GraphQLRouter(schema=schema, context_getter=get_context)
app.include_router(graphql_app, prefix="/graphql")
test_client = TestClient(app)
with pytest.raises(
InvalidCustomContext,
match=(
"The custom context must be either a class "
"that inherits from BaseContext or a dictionary"
),
):
test_client.post("/graphql", json={"query": "{ abc }"})
def test_class_context_injects_connection_params_over_transport_ws():
from fastapi import Depends, FastAPI
from fastapi.testclient import TestClient
from strawberry.fastapi import BaseContext, GraphQLRouter
@strawberry.type
class Query:
x: str = "hi"
@strawberry.type
class Subscription:
@strawberry.subscription
async def connection_params(
self, info: strawberry.Info, delay: float = 0
) -> AsyncGenerator[str, None]:
assert info.context.request is not None
await asyncio.sleep(delay)
yield info.context.connection_params["strawberry"]
class Context(BaseContext):
strawberry: str
def __init__(self):
self.strawberry = "rocks"
def get_context(context: Context = Depends()) -> Context:
return context
app = FastAPI()
schema = strawberry.Schema(query=Query, subscription=Subscription)
graphql_app = GraphQLRouter(schema=schema, context_getter=get_context)
app.include_router(graphql_app, prefix="/graphql")
test_client = TestClient(app)
with test_client.websocket_connect(
"/graphql", [GRAPHQL_TRANSPORT_WS_PROTOCOL]
) as ws:
ws.send_json(
transport_ws_types.ConnectionInitMessage(
{"type": "connection_init", "payload": {"strawberry": "rocks"}}
)
)
connection_ack_message: transport_ws_types.ConnectionInitMessage = (
ws.receive_json()
)
assert connection_ack_message == {"type": "connection_ack"}
ws.send_json(
transport_ws_types.SubscribeMessage(
{
"id": "sub1",
"type": "subscribe",
"payload": {"query": "subscription { connectionParams }"},
}
)
)
next_message: transport_ws_types.NextMessage = ws.receive_json()
assert next_message == {
"id": "sub1",
"type": "next",
"payload": {"data": {"connectionParams": "rocks"}},
}
ws.send_json(
transport_ws_types.CompleteMessage({"id": "sub1", "type": "complete"})
)
ws.close()
def test_class_context_injects_connection_params_over_ws():
from fastapi import Depends, FastAPI
from fastapi.testclient import TestClient
from starlette.websockets import WebSocketDisconnect
from strawberry.fastapi import BaseContext, GraphQLRouter
@strawberry.type
class Query:
x: str = "hi"
@strawberry.type
class Subscription:
@strawberry.subscription
async def connection_params(
self, info: strawberry.Info, delay: float = 0
) -> AsyncGenerator[str, None]:
assert info.context.request is not None
await asyncio.sleep(delay)
yield info.context.connection_params["strawberry"]
class Context(BaseContext):
strawberry: str
def __init__(self):
self.strawberry = "rocks"
def get_context(context: Context = Depends()) -> Context:
return context
app = FastAPI()
schema = strawberry.Schema(query=Query, subscription=Subscription)
graphql_app = GraphQLRouter(schema=schema, context_getter=get_context)
app.include_router(graphql_app, prefix="/graphql")
test_client = TestClient(app)
with test_client.websocket_connect("/graphql", [GRAPHQL_WS_PROTOCOL]) as ws:
ws.send_json(
ws_types.ConnectionInitMessage(
{
"type": "connection_init",
"payload": {"strawberry": "rocks"},
}
)
)
ws.send_json(
ws_types.StartMessage(
{
"type": "start",
"id": "demo",
"payload": {
"query": "subscription { connectionParams }",
},
}
)
)
connection_ack_message: ws_types.ConnectionAckMessage = ws.receive_json()
assert connection_ack_message["type"] == "connection_ack"
data_message: ws_types.DataMessage = ws.receive_json()
assert data_message["type"] == "data"
assert data_message["id"] == "demo"
assert data_message["payload"]["data"] == {"connectionParams": "rocks"}
ws.send_json(ws_types.StopMessage({"type": "stop", "id": "demo"}))
complete_message: ws_types.CompleteMessage = ws.receive_json()
assert complete_message["type"] == "complete"
assert complete_message["id"] == "demo"
ws.send_json(
ws_types.ConnectionTerminateMessage({"type": "connection_terminate"})
)
# make sure the websocket is disconnected now
with pytest.raises(WebSocketDisconnect):
ws.receive_json()
|
