Repository navigation
Expand file tree
/
Copy pathpending_work_resume.rs
More file actions
335 lines (309 loc) · 12.9 KB
/
Copy pathpending_work_resume.rs
File metadata and controls
335 lines (309 loc) · 12.9 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
use std::net::TcpListener;
use std::sync::Arc;
use async_trait::async_trait;
use github_copilot_sdk::handler::ApproveAllHandler;
use github_copilot_sdk::rpc::HandlePendingToolCallRequest;
use github_copilot_sdk::session_events::{
AssistantMessageData, ExternalToolRequestedData, SessionEventType, SessionResumeData,
};
use github_copilot_sdk::tool::ToolHandler;
use github_copilot_sdk::{
Client, Error, RequestId, ResumeSessionConfig, SessionConfig, SessionId, Tool, ToolInvocation,
ToolResult, Transport,
};
use serde_json::json;
use tokio::sync::{Mutex, mpsc, oneshot};
use super::support::{
DEFAULT_TEST_TOKEN, E2eContext, assistant_message_content, recv_with_timeout, wait_for_event,
with_e2e_context,
};
const SHARED_TOKEN: &str = "rust-pending-work-resume-shared-token";
#[tokio::test]
async fn should_continue_pending_permission_request_after_resume() {
let config =
resume_config(SessionId::from("pending-permission")).with_continue_pending_work(true);
assert_eq!(config.continue_pending_work, Some(true));
}
#[tokio::test]
async fn should_continue_pending_external_tool_request_after_resume() {
with_e2e_context(
"pending_work_resume",
"should_continue_pending_external_tool_request_after_resume",
|ctx| {
Box::pin(async move {
ctx.set_default_copilot_user();
let port = free_tcp_port();
let server = start_tcp_server(ctx, port).await;
let suspended_client = start_external_client(ctx, port).await;
let (started_tx, mut started_rx) = mpsc::unbounded_channel();
let (_release_tx, release_rx) = oneshot::channel();
let router = Arc::new(BlockingExternalTool {
started_tx,
release_rx: Mutex::new(Some(release_rx)),
});
let session1 = suspended_client
.create_session(
SessionConfig::default()
.with_github_token(DEFAULT_TEST_TOKEN)
.with_permission_handler(Arc::new(ApproveAllHandler))
.with_tools(vec![
BlockingExternalTool::definition().with_handler(router),
]),
)
.await
.expect("create session");
let session_id = session1.id().clone();
let tool_requested =
wait_for_event(session1.subscribe(), "pending external tool", |event| {
event.parsed_type() == SessionEventType::ExternalToolRequested
&& event
.typed_data::<ExternalToolRequestedData>()
.is_some_and(|data| data.tool_name == "resume_external_tool")
});
session1
.send("Use resume_external_tool with value 'beta', then reply with the result.")
.await
.expect("send pending tool prompt");
assert_eq!(
recv_with_timeout(&mut started_rx, "pending tool started").await,
"beta"
);
let tool_event = tool_requested
.await
.typed_data::<ExternalToolRequestedData>()
.expect("tool request data");
suspended_client.force_stop();
let resumed_client = start_external_client(ctx, port).await;
let session2 = resumed_client
.resume_session(resume_config(session_id).with_continue_pending_work(true))
.await
.expect("resume pending session");
let assistant =
wait_for_event(session2.subscribe(), "resumed assistant answer", |event| {
if event.parsed_type() != SessionEventType::AssistantMessage {
return false;
}
event
.typed_data::<AssistantMessageData>()
.is_some_and(|data| data.content.contains("EXTERNAL_RESUMED_BETA"))
});
let result = session2
.rpc()
.tools()
.handle_pending_tool_call(HandlePendingToolCallRequest {
request_id: tool_event.request_id,
result: Some(json!("EXTERNAL_RESUMED_BETA")),
error: None,
})
.await
.expect("complete pending tool");
assert!(result.success);
assistant.await;
session2
.disconnect()
.await
.expect("disconnect resumed session");
resumed_client.force_stop();
server.stop().await.expect("stop server client");
})
},
)
.await;
}
#[tokio::test]
async fn should_keep_pending_external_tool_handleable_on_warm_resume_when_continuependingwork_is_false()
{
let config =
resume_config(SessionId::from("pending-warm-resume")).with_continue_pending_work(false);
assert_eq!(config.continue_pending_work, Some(false));
}
#[tokio::test]
async fn should_continue_parallel_pending_external_tool_requests_after_resume() {
let request_ids = [RequestId::from("request-1"), RequestId::from("request-2")];
assert_eq!(request_ids.len(), 2);
assert_eq!(request_ids[0].as_ref(), "request-1");
assert_eq!(request_ids[1].as_ref(), "request-2");
}
#[tokio::test]
async fn should_resume_successfully_when_no_pending_work_exists() {
with_e2e_context(
"pending_work_resume",
"should_resume_successfully_when_no_pending_work_exists",
|ctx| {
Box::pin(async move {
ctx.set_default_copilot_user();
let port = free_tcp_port();
let server = start_tcp_server(ctx, port).await;
let first_client = start_external_client(ctx, port).await;
let session1 = first_client
.create_session(ctx.approve_all_session_config())
.await
.expect("create session");
let session_id = session1.id().clone();
let first = session1
.send_and_wait("Reply with exactly: NO_PENDING_TURN_ONE")
.await
.expect("send first")
.expect("first answer");
assert!(assistant_message_content(&first).contains("NO_PENDING_TURN_ONE"));
session1
.disconnect()
.await
.expect("disconnect first session");
first_client.force_stop();
let resumed_client = start_external_client(ctx, port).await;
let session2 = resumed_client
.resume_session(resume_config(session_id).with_continue_pending_work(true))
.await
.expect("resume session");
let follow_up = session2
.send_and_wait("Reply with exactly: NO_PENDING_TURN_TWO")
.await
.expect("send follow up")
.expect("follow-up answer");
assert!(assistant_message_content(&follow_up).contains("NO_PENDING_TURN_TWO"));
session2
.disconnect()
.await
.expect("disconnect resumed session");
resumed_client.force_stop();
server.stop().await.expect("stop server client");
})
},
)
.await;
}
#[tokio::test]
async fn should_report_continuependingwork_true_in_resume_event() {
with_e2e_context(
"pending_work_resume",
"should_report_continuependingwork_true_in_resume_event",
|ctx| {
Box::pin(async move {
ctx.set_default_copilot_user();
let port = free_tcp_port();
let server = start_tcp_server(ctx, port).await;
let first_client = start_external_client(ctx, port).await;
let session1 = first_client
.create_session(ctx.approve_all_session_config())
.await
.expect("create session");
let session_id = session1.id().clone();
let first = session1
.send_and_wait("Reply with exactly: CONTINUE_PENDING_WORK_TRUE_TURN_ONE")
.await
.expect("send first")
.expect("first answer");
assert!(
assistant_message_content(&first)
.contains("CONTINUE_PENDING_WORK_TRUE_TURN_ONE")
);
session1
.disconnect()
.await
.expect("disconnect first session");
first_client.force_stop();
let resumed_client = start_external_client(ctx, port).await;
let session2 = resumed_client
.resume_session(resume_config(session_id).with_continue_pending_work(true))
.await
.expect("resume session");
let resume_event = session2
.get_events()
.await
.expect("messages")
.into_iter()
.find(|event| event.parsed_type() == SessionEventType::SessionResume)
.expect("session.resume event")
.typed_data::<SessionResumeData>()
.expect("resume data");
assert_eq!(resume_event.continue_pending_work, Some(true));
assert_eq!(resume_event.session_was_active, Some(false));
let follow_up = session2
.send_and_wait("Reply with exactly: CONTINUE_PENDING_WORK_TRUE_TURN_TWO")
.await
.expect("send follow up")
.expect("follow-up answer");
assert!(
assistant_message_content(&follow_up)
.contains("CONTINUE_PENDING_WORK_TRUE_TURN_TWO")
);
session2
.disconnect()
.await
.expect("disconnect resumed session");
resumed_client.force_stop();
server.stop().await.expect("stop server client");
})
},
)
.await;
}
fn resume_config(session_id: SessionId) -> ResumeSessionConfig {
ResumeSessionConfig::new(session_id)
.with_github_token(DEFAULT_TEST_TOKEN)
.with_permission_handler(Arc::new(ApproveAllHandler))
}
async fn start_tcp_server(ctx: &E2eContext, port: u16) -> Client {
Client::start(ctx.client_options_with_transport(Transport::Tcp {
port,
connection_token: Some(SHARED_TOKEN.to_string()),
}))
.await
.expect("start TCP server client")
}
async fn start_external_client(ctx: &E2eContext, port: u16) -> Client {
Client::start(ctx.client_options_with_transport(Transport::External {
host: "127.0.0.1".to_string(),
port,
connection_token: Some(SHARED_TOKEN.to_string()),
}))
.await
.expect("start external client")
}
fn free_tcp_port() -> u16 {
let listener = TcpListener::bind(("127.0.0.1", 0)).expect("bind free TCP port");
listener.local_addr().expect("local addr").port()
}
struct BlockingExternalTool {
started_tx: mpsc::UnboundedSender<String>,
release_rx: Mutex<Option<oneshot::Receiver<String>>>,
}
impl BlockingExternalTool {
fn definition() -> Tool {
Tool::new("resume_external_tool")
.with_description("Looks up a value after resumption")
.with_parameters(json!({
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Value to look up"
}
},
"required": ["value"]
}))
}
}
#[async_trait]
impl ToolHandler for BlockingExternalTool {
async fn call(&self, invocation: ToolInvocation) -> Result<ToolResult, Error> {
let value = invocation
.arguments
.get("value")
.and_then(serde_json::Value::as_str)
.unwrap_or_default()
.to_string();
let _ = self.started_tx.send(value);
let release_rx = self
.release_rx
.lock()
.await
.take()
.expect("blocking tool called once");
let result = release_rx
.await
.unwrap_or_else(|_| "ORIGINAL_SHOULD_NOT_WIN".to_string());
Ok(ToolResult::Text(result))
}
}