gwp 0.2.1

A standalone, pure Rust gRPC wire protocol for GQL (ISO/IEC 39075)
Documentation
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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
//! Integration tests: start a real gRPC server with `MockBackend`,
//! connect with tonic clients, and verify the full round-trip.

use std::collections::HashMap;
use std::net::SocketAddr;

use gwp::proto;
use gwp::proto::gql_service_client::GqlServiceClient;
use gwp::proto::session_service_client::SessionServiceClient;
use gwp::server::mock_backend::MockBackend;
use gwp::server::{GqlServiceImpl, SessionManager, SessionServiceImpl, TransactionManager};
use gwp::status;

/// Start a server on a random port and return the address.
async fn start_server() -> SocketAddr {
    let addr: SocketAddr = "127.0.0.1:0".parse().unwrap();
    let listener = tokio::net::TcpListener::bind(addr).await.unwrap();
    let addr = listener.local_addr().unwrap();

    tokio::spawn(async move {
        let backend = std::sync::Arc::new(MockBackend::new());
        let sessions = SessionManager::new();
        let transactions = TransactionManager::new();

        let session_svc = SessionServiceImpl::new(
            std::sync::Arc::clone(&backend),
            sessions.clone(),
            transactions.clone(),
            None,
        );
        let gql_svc = GqlServiceImpl::new(backend, sessions, transactions);

        let incoming = tokio_stream::wrappers::TcpListenerStream::new(listener);

        tonic::transport::Server::builder()
            .add_service(proto::session_service_server::SessionServiceServer::new(
                session_svc,
            ))
            .add_service(proto::gql_service_server::GqlServiceServer::new(gql_svc))
            .serve_with_incoming(incoming)
            .await
            .unwrap();
    });

    // Give the server a moment to start
    tokio::time::sleep(std::time::Duration::from_millis(50)).await;
    addr
}

/// Helper to connect clients to a running server.
async fn connect(
    addr: SocketAddr,
) -> (
    SessionServiceClient<tonic::transport::Channel>,
    GqlServiceClient<tonic::transport::Channel>,
) {
    let channel = tonic::transport::Channel::from_shared(format!("http://{addr}"))
        .unwrap()
        .connect()
        .await
        .unwrap();

    let session_client = SessionServiceClient::new(channel.clone());
    let gql_client = GqlServiceClient::new(channel);

    (session_client, gql_client)
}

/// Perform a handshake and return the `session_id`.
async fn handshake(client: &mut SessionServiceClient<tonic::transport::Channel>) -> String {
    let resp = client
        .handshake(proto::HandshakeRequest {
            protocol_version: 1,
            credentials: None,
            client_info: HashMap::new(),
        })
        .await
        .unwrap()
        .into_inner();

    assert_eq!(resp.protocol_version, 1);
    assert!(!resp.session_id.is_empty());
    assert!(resp.server_info.is_some());

    let info = resp.server_info.unwrap();
    assert_eq!(info.name, "gql-wire-protocol");

    resp.session_id
}

#[tokio::test]
async fn handshake_and_close() {
    let addr = start_server().await;
    let (mut session_client, _) = connect(addr).await;

    let session_id = handshake(&mut session_client).await;

    // Close should succeed
    session_client
        .close_session(proto::CloseSessionRequest {
            session_id: session_id.clone(),
        })
        .await
        .unwrap();

    // After close, ping should fail with NOT_FOUND
    let result = session_client
        .ping(proto::PingRequest {
            session_id: session_id.clone(),
        })
        .await;
    assert!(result.is_err());
    assert_eq!(result.unwrap_err().code(), tonic::Code::NotFound);
}

#[tokio::test]
async fn ping() {
    let addr = start_server().await;
    let (mut session_client, _) = connect(addr).await;

    let session_id = handshake(&mut session_client).await;

    let pong = session_client
        .ping(proto::PingRequest {
            session_id: session_id.clone(),
        })
        .await
        .unwrap()
        .into_inner();

    assert!(pong.timestamp > 0);
}

#[tokio::test]
async fn configure_and_reset() {
    let addr = start_server().await;
    let (mut session_client, _) = connect(addr).await;

    let session_id = handshake(&mut session_client).await;

    // Configure graph
    session_client
        .configure(proto::ConfigureRequest {
            session_id: session_id.clone(),
            property: Some(proto::configure_request::Property::Graph(
                "my_graph".to_owned(),
            )),
        })
        .await
        .unwrap();

    // Reset
    session_client
        .reset(proto::ResetRequest {
            session_id: session_id.clone(),
            target: proto::ResetTarget::ResetAll.into(),
        })
        .await
        .unwrap();
}

#[tokio::test]
async fn execute_query_streaming() {
    let addr = start_server().await;
    let (mut session_client, mut gql_client) = connect(addr).await;

    let session_id = handshake(&mut session_client).await;

    let mut stream = gql_client
        .execute(proto::ExecuteRequest {
            session_id: session_id.clone(),
            statement: "MATCH (p:Person) RETURN p.name, p.age".to_owned(),
            parameters: HashMap::new(),
            transaction_id: None,
        })
        .await
        .unwrap()
        .into_inner();

    // Frame 1: header
    let msg = stream.message().await.unwrap().unwrap();
    let header = match msg.frame {
        Some(proto::execute_response::Frame::Header(h)) => h,
        other => panic!("expected header, got {other:?}"),
    };
    assert_eq!(header.result_type(), proto::ResultType::BindingTable);
    assert_eq!(header.columns.len(), 2);
    assert_eq!(header.columns[0].name, "name");
    assert_eq!(header.columns[1].name, "age");

    // Frame 2: row batch
    let msg = stream.message().await.unwrap().unwrap();
    let batch = match msg.frame {
        Some(proto::execute_response::Frame::RowBatch(b)) => b,
        other => panic!("expected row batch, got {other:?}"),
    };
    assert_eq!(batch.rows.len(), 2);

    // Frame 3: summary
    let msg = stream.message().await.unwrap().unwrap();
    let summary = match msg.frame {
        Some(proto::execute_response::Frame::Summary(s)) => s,
        other => panic!("expected summary, got {other:?}"),
    };
    let code = &summary.status.as_ref().unwrap().code;
    assert!(status::is_success(code));

    // Stream should end
    assert!(stream.message().await.unwrap().is_none());
}

#[tokio::test]
async fn execute_ddl() {
    let addr = start_server().await;
    let (mut session_client, mut gql_client) = connect(addr).await;

    let session_id = handshake(&mut session_client).await;

    let mut stream = gql_client
        .execute(proto::ExecuteRequest {
            session_id: session_id.clone(),
            statement: "CREATE GRAPH my_graph".to_owned(),
            parameters: HashMap::new(),
            transaction_id: None,
        })
        .await
        .unwrap()
        .into_inner();

    // Header with OMITTED type
    let msg = stream.message().await.unwrap().unwrap();
    let header = match msg.frame {
        Some(proto::execute_response::Frame::Header(h)) => h,
        other => panic!("expected header, got {other:?}"),
    };
    assert_eq!(header.result_type(), proto::ResultType::Omitted);

    // Summary
    let msg = stream.message().await.unwrap().unwrap();
    let summary = match msg.frame {
        Some(proto::execute_response::Frame::Summary(s)) => s,
        other => panic!("expected summary, got {other:?}"),
    };
    assert_eq!(
        summary.status.as_ref().unwrap().code,
        status::OMITTED_RESULT
    );
}

#[tokio::test]
async fn execute_error() {
    let addr = start_server().await;
    let (mut session_client, mut gql_client) = connect(addr).await;

    let session_id = handshake(&mut session_client).await;

    let mut stream = gql_client
        .execute(proto::ExecuteRequest {
            session_id: session_id.clone(),
            statement: "ERROR this should fail".to_owned(),
            parameters: HashMap::new(),
            transaction_id: None,
        })
        .await
        .unwrap()
        .into_inner();

    // Error should come as a summary with GQLSTATUS, not a gRPC error
    let msg = stream.message().await.unwrap().unwrap();
    let summary = match msg.frame {
        Some(proto::execute_response::Frame::Summary(s)) => s,
        other => panic!("expected summary, got {other:?}"),
    };
    let code = &summary.status.as_ref().unwrap().code;
    assert!(status::is_exception(code));
    assert_eq!(code, status::INVALID_SYNTAX);
}

#[tokio::test]
async fn transaction_lifecycle() {
    let addr = start_server().await;
    let (mut session_client, mut gql_client) = connect(addr).await;

    let session_id = handshake(&mut session_client).await;

    // Begin
    let begin_resp = gql_client
        .begin_transaction(proto::BeginRequest {
            session_id: session_id.clone(),
            mode: proto::TransactionMode::ReadWrite.into(),
        })
        .await
        .unwrap()
        .into_inner();

    assert!(!begin_resp.transaction_id.is_empty());
    assert!(status::is_success(
        &begin_resp.status.as_ref().unwrap().code
    ));

    let tx_id = begin_resp.transaction_id;

    // Execute within transaction
    let mut stream = gql_client
        .execute(proto::ExecuteRequest {
            session_id: session_id.clone(),
            statement: "INSERT (:Person {name: 'Carol'})".to_owned(),
            parameters: HashMap::new(),
            transaction_id: Some(tx_id.clone()),
        })
        .await
        .unwrap()
        .into_inner();

    // Consume the stream
    while let Some(_msg) = stream.message().await.unwrap() {}

    // Commit
    let commit_resp = gql_client
        .commit(proto::CommitRequest {
            session_id: session_id.clone(),
            transaction_id: tx_id.clone(),
        })
        .await
        .unwrap()
        .into_inner();

    assert!(status::is_success(
        &commit_resp.status.as_ref().unwrap().code
    ));
}

#[tokio::test]
async fn transaction_rollback() {
    let addr = start_server().await;
    let (mut session_client, mut gql_client) = connect(addr).await;

    let session_id = handshake(&mut session_client).await;

    // Begin
    let begin_resp = gql_client
        .begin_transaction(proto::BeginRequest {
            session_id: session_id.clone(),
            mode: proto::TransactionMode::ReadWrite.into(),
        })
        .await
        .unwrap()
        .into_inner();

    let tx_id = begin_resp.transaction_id;

    // Rollback
    let rollback_resp = gql_client
        .rollback(proto::RollbackRequest {
            session_id: session_id.clone(),
            transaction_id: tx_id.clone(),
        })
        .await
        .unwrap()
        .into_inner();

    assert!(status::is_success(
        &rollback_resp.status.as_ref().unwrap().code
    ));
}

#[tokio::test]
async fn double_begin_returns_gqlstatus_error() {
    let addr = start_server().await;
    let (mut session_client, mut gql_client) = connect(addr).await;

    let session_id = handshake(&mut session_client).await;

    // First begin
    gql_client
        .begin_transaction(proto::BeginRequest {
            session_id: session_id.clone(),
            mode: proto::TransactionMode::ReadWrite.into(),
        })
        .await
        .unwrap();

    // Second begin should return GQLSTATUS error, not gRPC error
    let begin2 = gql_client
        .begin_transaction(proto::BeginRequest {
            session_id: session_id.clone(),
            mode: proto::TransactionMode::ReadOnly.into(),
        })
        .await
        .unwrap()
        .into_inner();

    assert!(begin2.transaction_id.is_empty());
    assert!(status::is_exception(&begin2.status.as_ref().unwrap().code));
}

#[tokio::test]
async fn invalid_session_returns_grpc_not_found() {
    let addr = start_server().await;
    let (_, mut gql_client) = connect(addr).await;

    let result = gql_client
        .execute(proto::ExecuteRequest {
            session_id: "nonexistent".to_owned(),
            statement: "MATCH (n) RETURN n".to_owned(),
            parameters: HashMap::new(),
            transaction_id: None,
        })
        .await;

    assert!(result.is_err());
    assert_eq!(result.unwrap_err().code(), tonic::Code::NotFound);
}