{{ message }}
Repository navigation
Expand file tree
/
Copy pathtest_canvas.py
More file actions
371 lines (318 loc) · 11.8 KB
/
Copy pathtest_canvas.py
File metadata and controls
371 lines (318 loc) · 11.8 KB
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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
"""Unit tests for the canvas SDK surface."""
from __future__ import annotations
from datetime import UTC, datetime
from typing import Any, cast
from uuid import uuid4
import pytest
from copilot._jsonrpc import JsonRpcError
from copilot.canvas import (
CanvasAction,
CanvasDeclaration,
CanvasError,
CanvasHandler,
CanvasProviderIdentity,
ExtensionInfo,
OpenCanvasInstance,
)
from copilot.rpc import (
CanvasProviderCloseRequest,
CanvasProviderInvokeActionRequest,
CanvasProviderOpenRequest,
CanvasProviderOpenResult,
)
from copilot.session import CopilotSession
from copilot.session_events import (
SessionCanvasClosedData,
SessionCanvasOpenedData,
SessionEvent,
SessionEventType,
)
def test_canvas_declaration_serializes_camelcase_and_drops_optional():
decl = CanvasDeclaration(
id="my-canvas",
display_name="My Canvas",
description="Does the thing",
)
assert decl.to_dict() == {
"id": "my-canvas",
"displayName": "My Canvas",
"description": "Does the thing",
}
def test_canvas_declaration_serializes_input_schema_and_actions():
action = CanvasAction(
name="refresh",
description="Refresh the canvas",
)
decl = CanvasDeclaration(
id="c",
display_name="C",
description="D",
input_schema={"type": "object"},
actions=[action],
)
payload = decl.to_dict()
assert payload["inputSchema"] == {"type": "object"}
assert payload["actions"] == [action.to_dict()]
def test_extension_info_serializes():
info = ExtensionInfo(source="github-app", name="my-ext")
assert info.to_dict() == {"source": "github-app", "name": "my-ext"}
def test_canvas_provider_identity_serializes():
provider = CanvasProviderIdentity(id="app:builtin:window-1", name="Built-in")
assert provider.to_dict() == {"id": "app:builtin:window-1", "name": "Built-in"}
def test_canvas_provider_identity_drops_optional_name():
provider = CanvasProviderIdentity(id="app:builtin:window-1")
assert provider.to_dict() == {"id": "app:builtin:window-1"}
def test_canvas_open_response_drops_none_fields():
assert CanvasProviderOpenResult().to_dict() == {}
assert CanvasProviderOpenResult(url="https://x", status="ok").to_dict() == {
"url": "https://x",
"status": "ok",
}
def test_canvas_error_envelope_and_factories():
err = CanvasError("oops", "something broke")
assert err.code == "oops"
assert err.message == "something broke"
assert err.to_envelope() == {"code": "oops", "message": "something broke"}
no_handler = CanvasError.no_handler()
assert no_handler.code == "canvas_action_no_handler"
unset = CanvasError.handler_unset()
assert unset.code == "canvas_handler_unset"
async def test_default_canvas_handler_on_action_raises_no_handler():
class StubHandler(CanvasHandler):
async def on_open(self, ctx: CanvasProviderOpenRequest) -> CanvasProviderOpenResult:
return CanvasProviderOpenResult()
handler = StubHandler()
ctx = CanvasProviderInvokeActionRequest(
session_id="s",
extension_id="e",
canvas_id="c",
instance_id="i",
action_name="any",
input=None,
)
with pytest.raises(CanvasError) as excinfo:
await handler.on_action(ctx)
assert excinfo.value.code == "canvas_action_no_handler"
async def test_register_canvas_handler_wires_generated_canvas_adapter():
class Handler(CanvasHandler):
def __init__(self) -> None:
self.open_calls: list[CanvasProviderOpenRequest] = []
self.close_calls: list[CanvasProviderCloseRequest] = []
self.action_calls: list[CanvasProviderInvokeActionRequest] = []
async def on_open(self, ctx: CanvasProviderOpenRequest) -> CanvasProviderOpenResult:
self.open_calls.append(ctx)
return CanvasProviderOpenResult(
url="https://canvas.example", title="Hi", status="ready"
)
async def on_close(self, ctx: CanvasProviderCloseRequest) -> None:
self.close_calls.append(ctx)
async def on_action(self, ctx: CanvasProviderInvokeActionRequest) -> Any:
self.action_calls.append(ctx)
return {"echo": ctx.input}
session = CopilotSession("sess-1", client=None)
handler = Handler()
session._register_canvas_handler(handler)
adapter = session._client_session_apis.canvas
assert adapter is not None
assert session._get_canvas_handler() is handler
open_request = CanvasProviderOpenRequest(
canvas_id="c",
extension_id="ext",
instance_id="i",
session_id="sess-1",
input={"q": 1},
)
open_result = await adapter.open(open_request)
assert open_result.to_dict() == {
"url": "https://canvas.example",
"title": "Hi",
"status": "ready",
}
assert handler.open_calls == [open_request]
close_request = CanvasProviderCloseRequest(
canvas_id="c",
extension_id="ext",
instance_id="i",
session_id="sess-1",
)
await adapter.close(close_request)
assert handler.close_calls == [close_request]
action_request = CanvasProviderInvokeActionRequest(
action_name="refresh",
canvas_id="c",
extension_id="ext",
instance_id="i",
session_id="sess-1",
input={"value": 1},
)
action_result = await adapter.invoke(action_request)
assert action_result == {"echo": {"value": 1}}
assert handler.action_calls == [action_request]
async def test_canvas_adapter_translates_canvas_error_to_jsonrpc_error():
class Handler(CanvasHandler):
async def on_open(self, ctx: CanvasProviderOpenRequest) -> CanvasProviderOpenResult:
raise CanvasError("bad", "fail")
session = CopilotSession("sess-1", client=None)
session._register_canvas_handler(Handler())
adapter = cast(Any, session._client_session_apis.canvas)
with pytest.raises(JsonRpcError) as excinfo:
await adapter.open(
CanvasProviderOpenRequest(
canvas_id="c",
extension_id="ext",
instance_id="i",
session_id="sess-1",
)
)
assert excinfo.value.code == -32603
assert excinfo.value.message == "fail"
assert excinfo.value.data == {"code": "bad", "message": "fail"}
def test_register_canvas_handler_can_clear_generated_handler():
session = CopilotSession("sess-1", client=None)
session._register_canvas_handler(None)
assert session._client_session_apis.canvas is None
def test_set_open_canvases_round_trip():
inst = OpenCanvasInstance(
canvas_id="c",
extension_id="e",
instance_id="i",
)
session = CopilotSession("sess-1", client=None)
session._set_open_canvases([inst])
assert session.open_canvases == [inst]
def test_session_canvas_opened_updates_open_canvases(caplog: pytest.LogCaptureFixture):
session = CopilotSession("sess-1", client=None)
session._dispatch_event(
SessionEvent(
data=SessionCanvasOpenedData(
canvas_id="",
extension_id="project:counter",
instance_id="missing-canvas-id",
),
id=uuid4(),
timestamp=datetime.now(UTC),
type=SessionEventType.SESSION_CANVAS_OPENED,
)
)
session._dispatch_event(
SessionEvent(
data=SessionCanvasOpenedData(
canvas_id="counter",
extension_id="project:counter",
extension_name="Counter Provider",
instance_id="counter-1",
input={"seed": 1},
status="ready",
title="Counter",
url="https://example.test/counter",
),
id=uuid4(),
timestamp=datetime.now(UTC),
type=SessionEventType.SESSION_CANVAS_OPENED,
)
)
session._dispatch_event(
SessionEvent(
data=SessionCanvasOpenedData(
canvas_id="logs",
extension_id="project:logs",
instance_id="logs-1",
title="Logs",
),
id=uuid4(),
timestamp=datetime.now(UTC),
type=SessionEventType.SESSION_CANVAS_OPENED,
)
)
assert "failed to deserialize session.canvas.opened payload" in caplog.text
assert [canvas.instance_id for canvas in session.open_canvases] == [
"counter-1",
"logs-1",
]
session._dispatch_event(
SessionEvent(
data=SessionCanvasOpenedData(
canvas_id="counter",
extension_id="project:counter",
extension_name="Counter Provider",
instance_id="counter-1",
input={"seed": 2},
status="reconnected",
title="Counter Updated",
url="https://example.test/counter-updated",
),
id=uuid4(),
timestamp=datetime.now(UTC),
type=SessionEventType.SESSION_CANVAS_OPENED,
)
)
open_canvases = session.open_canvases
assert len(open_canvases) == 2
assert open_canvases[0].instance_id == "counter-1"
assert open_canvases[0].title == "Counter Updated"
assert open_canvases[0].status == "reconnected"
assert open_canvases[0].url == "https://example.test/counter-updated"
assert open_canvases[0].input == {"seed": 2}
assert open_canvases[1].instance_id == "logs-1"
def test_session_canvas_closed_removes_open_canvases(caplog: pytest.LogCaptureFixture):
session = CopilotSession("sess-1", client=None)
for canvas_id, instance_id in (("counter", "counter-1"), ("logs", "logs-1")):
session._dispatch_event(
SessionEvent(
data=SessionCanvasOpenedData(
canvas_id=canvas_id,
extension_id=f"project:{canvas_id}",
instance_id=instance_id,
),
id=uuid4(),
timestamp=datetime.now(UTC),
type=SessionEventType.SESSION_CANVAS_OPENED,
)
)
assert [canvas.instance_id for canvas in session.open_canvases] == [
"counter-1",
"logs-1",
]
# Closing one instance removes it; the other remains.
session._dispatch_event(
SessionEvent(
data=SessionCanvasClosedData(
canvas_id="counter",
extension_id="project:counter",
instance_id="counter-1",
),
id=uuid4(),
timestamp=datetime.now(UTC),
type=SessionEventType.SESSION_CANVAS_CLOSED,
)
)
assert [canvas.instance_id for canvas in session.open_canvases] == ["logs-1"]
# Closing an absent instance is a no-op (idempotent).
session._dispatch_event(
SessionEvent(
data=SessionCanvasClosedData(
canvas_id="counter",
extension_id="project:counter",
instance_id="counter-1",
),
id=uuid4(),
timestamp=datetime.now(UTC),
type=SessionEventType.SESSION_CANVAS_CLOSED,
)
)
assert [canvas.instance_id for canvas in session.open_canvases] == ["logs-1"]
# A closed event with an empty instance_id warns and leaves the snapshot intact.
session._dispatch_event(
SessionEvent(
data=SessionCanvasClosedData(
canvas_id="logs",
extension_id="project:logs",
instance_id="",
),
id=uuid4(),
timestamp=datetime.now(UTC),
type=SessionEventType.SESSION_CANVAS_CLOSED,
)
)
assert "failed to deserialize session.canvas.closed payload" in caplog.text
assert [canvas.instance_id for canvas in session.open_canvases] == ["logs-1"]
You can’t perform that action at this time.