github-copilot-sdk 1.0.0-beta.8

Rust SDK for programmatic control of the GitHub Copilot CLI via JSON-RPC. Technical preview, pre-1.0.
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

use github_copilot_sdk::generated::api_types::{
    RemoteEnableRequest, RemoteSessionMode, SessionsGetPersistedRemoteSteerableRequest,
};
use github_copilot_sdk::generated::session_events::{
    SessionEventType, SessionRemoteSteerableChangedData,
};

use super::support::{wait_for_event, with_e2e_context};

#[tokio::test]
async fn should_treat_remote_off_as_noop_or_implemented_error() {
    with_e2e_context(
        "rpc_remote",
        "should_treat_remote_off_as_noop_or_implemented_error",
        |ctx| {
            Box::pin(async move {
                ctx.set_default_copilot_user();
                let client = ctx.start_client().await;
                let session = client
                    .create_session(ctx.approve_all_session_config())
                    .await
                    .expect("create session");

                match session
                    .rpc()
                    .remote()
                    .enable(RemoteEnableRequest {
                        mode: Some(RemoteSessionMode::Off),
                    })
                    .await
                {
                    Ok(result) => {
                        assert!(!result.remote_steerable);
                        assert!(result.url.as_deref().unwrap_or_default().is_empty());
                    }
                    Err(err) => assert!(
                        !err.to_string()
                            .contains("Unhandled method session.remote.enable")
                    ),
                }

                session.disconnect().await.expect("disconnect session");
                client.stop().await.expect("stop client");
            })
        },
    )
    .await;
}

#[tokio::test]
async fn should_treat_remote_disable_as_noop_or_implemented_error() {
    with_e2e_context(
        "rpc_remote",
        "should_treat_remote_disable_as_noop_or_implemented_error",
        |ctx| {
            Box::pin(async move {
                ctx.set_default_copilot_user();
                let client = ctx.start_client().await;
                let session = client
                    .create_session(ctx.approve_all_session_config())
                    .await
                    .expect("create session");

                if let Err(err) = session.rpc().remote().disable().await {
                    assert!(
                        !err.to_string()
                            .contains("Unhandled method session.remote.disable")
                    );
                }

                session.disconnect().await.expect("disconnect session");
                client.stop().await.expect("stop client");
            })
        },
    )
    .await;
}

#[tokio::test]
async fn should_notify_steerable_changed_event_and_persist_flag() {
    with_e2e_context(
        "rpc_remote",
        "should_notify_steerable_changed_event_and_persist_flag",
        |ctx| {
            Box::pin(async move {
                ctx.set_default_copilot_user();
                let client = ctx.start_client().await;
                let session = client
                    .create_session(ctx.approve_all_session_config())
                    .await
                    .expect("create session");
                let changed = wait_for_event(session.subscribe(), "remote steerable changed", |event| {
                    event.parsed_type() == SessionEventType::SessionRemoteSteerableChanged
                        && event
                            .typed_data::<SessionRemoteSteerableChangedData>()
                            .is_some_and(|data| data.remote_steerable)
                });

                session
                    .rpc()
                    .remote()
                    .notify_steerable_changed(
                        github_copilot_sdk::generated::api_types::RemoteNotifySteerableChangedRequest {
                            remote_steerable: true,
                        },
                    )
                    .await
                    .expect("notify remote steerable");
                changed.await;
                let persisted = client
                    .rpc()
                    .sessions()
                    .get_persisted_remote_steerable(SessionsGetPersistedRemoteSteerableRequest {
                        session_id: session.id().clone(),
                    })
                    .await
                    .expect("persisted remote steerable");
                assert_eq!(persisted.remote_steerable, Some(true));

                session.disconnect().await.expect("disconnect session");
                client.stop().await.expect("stop client");
            })
        },
    )
    .await;
}