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
use std::convert::TryInto;
use std::net::IpAddr;

use bytes::*;
use failure::Error;
use tokio::io::BufStream;
use tokio::net::TcpStream;
use tokio::prelude::*;

use bolt_proto::Message;

const PREAMBLE: [u8; 4] = [0x60, 0x60, 0xB0, 0x17];
const SUPPORTED_VERSIONS: [u32; 4] = [1, 0, 0, 0];

pub struct Client {
    pub(crate) stream: BufStream<TcpStream>,
    pub(crate) version: u8,
}

impl Client {
    pub async fn new(host: IpAddr, port: usize) -> Result<Self, Error> {
        let mut client = Client {
            stream: BufStream::new(TcpStream::connect(format!("{}:{}", host, port)).await?),
            version: 0,
        };
        client.version = client.handshake().await? as u8;
        Ok(client)
    }

    pub async fn handshake(&mut self) -> Result<u32, Error> {
        let mut allowed_versions = BytesMut::with_capacity(16);
        SUPPORTED_VERSIONS
            .iter()
            .for_each(|&v| allowed_versions.put_u32(v));
        self.stream.write(&PREAMBLE).await?;
        self.stream.write_buf(&mut allowed_versions).await?;
        self.stream.flush().await?;
        Ok(self.stream.read_u32().await?)
    }

    pub async fn read_message(&mut self) -> Result<Message, Error> {
        Message::from_stream(&mut self.stream).await
    }

    pub async fn send_message(&mut self, message: Message) -> Result<(), Error> {
        let chunks: Vec<Bytes> = message.try_into()?;
        for mut chunk in chunks {
            self.stream.write_buf(&mut chunk).await?;
        }
        self.stream.flush().await?;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;
    use std::convert::TryFrom;
    use std::iter::FromIterator;

    use bolt_proto::message::*;
    use bolt_proto::Value;

    use super::*;

    async fn new_client() -> Result<Client, Error> {
        Client::new("127.0.0.1".parse().unwrap(), 7687).await
    }

    async fn init_client(credentials: &str) -> Result<Client, Error> {
        let mut client = new_client().await?;
        assert!(client
            .send_message(Message::from(Init::new(
                "bolt-client/X.Y.Z".to_string(),
                HashMap::from_iter(vec![
                    (String::from("scheme"), Value::from("basic")),
                    (String::from("principal"), Value::from("neo4j")),
                    (String::from("credentials"), Value::from(credentials)),
                ]),
            )))
            .await
            .is_ok());
        Ok(client)
    }

    async fn get_initialized_client() -> Result<Client, Error> {
        let mut client = init_client("test").await?;
        let success = client.read_message().await?;
        assert!(Success::try_from(success).is_ok());
        Ok(client)
    }

    async fn send_invalid_message(client: &mut Client) {
        let invalid_msg = Message::from(Run::new("".to_string(), HashMap::new()));
        assert!(client.send_message(invalid_msg).await.is_ok());
    }

    async fn send_valid_message(client: &mut Client) {
        let valid_msg = Message::from(Run::new("RETURN 1 as n;".to_string(), HashMap::new()));
        assert!(client.send_message(valid_msg).await.is_ok());
    }

    #[tokio::test]
    async fn handshake() {
        let client = new_client().await.unwrap();
        assert_eq!(client.version, 1);
    }

    #[tokio::test]
    async fn init_success() {
        let mut client = init_client("test").await.unwrap();
        let response = client.read_message().await.unwrap();
        assert!(Success::try_from(response).is_ok());
    }

    #[tokio::test]
    async fn init_failure() {
        let mut client = init_client("invalid!").await.unwrap();
        let response = client.read_message().await.unwrap();
        assert!(Failure::try_from(response).is_ok());
    }

    #[tokio::test]
    async fn ack_failure() {
        let mut client = get_initialized_client().await.unwrap();

        send_invalid_message(&mut client).await;
        let failure = Failure::try_from(client.read_message().await.unwrap());
        assert!(failure.is_ok());
        client.send_message(Message::AckFailure).await.unwrap();
        send_valid_message(&mut client).await;
        let response = client.read_message().await.unwrap();
        assert!(Success::try_from(response).is_ok());
    }

    #[tokio::test]
    async fn ack_failure_after_ignored() {
        let mut client = get_initialized_client().await.unwrap();

        send_invalid_message(&mut client).await;
        let failure = Failure::try_from(client.read_message().await.unwrap());
        assert!(failure.is_ok());

        send_valid_message(&mut client).await;
        let response = client.read_message().await.unwrap();
        assert!(match response {
            Message::Ignored => true,
            _ => false,
        });

        client.send_message(Message::AckFailure).await.unwrap();
        send_valid_message(&mut client).await;
        let response = client.read_message().await.unwrap();
        assert!(Success::try_from(response).is_ok());
    }

    #[tokio::test]
    async fn run() {
        let mut client = get_initialized_client().await.unwrap();
        let run_msg = Message::from(Run::new("RETURN -1 as n;".to_string(), HashMap::new()));
        assert!(client.send_message(run_msg).await.is_ok());
        let response = client.read_message().await.unwrap();
        assert!(Success::try_from(response).is_ok());
    }

    #[tokio::test]
    async fn run_and_pull() {
        let mut client = get_initialized_client().await.unwrap();
        let run_msg = Message::from(Run::new("RETURN 3458376 as n;".to_string(), HashMap::new()));
        assert!(client.send_message(run_msg).await.is_ok());
        let response = client.read_message().await.unwrap();
        assert!(Success::try_from(response).is_ok());

        assert!(client.send_message(Message::PullAll).await.is_ok());
        let response = client.read_message().await.unwrap();
        let record = Record::try_from(response).unwrap();
        assert_eq!(record.fields(), &vec![Value::from(3458376)]);

        // After PullAll is finished, the server sends a Success message
        let response = client.read_message().await.unwrap();
        assert!(Success::try_from(response).is_ok());
    }

    #[tokio::test]
    async fn discard_all_failure() {
        let mut client = get_initialized_client().await.unwrap();
        assert!(client.send_message(Message::DiscardAll).await.is_ok());
        let response = client.read_message().await.unwrap();
        assert!(Failure::try_from(response).is_ok());
    }

    #[tokio::test]
    async fn discard_all() {
        let mut client = get_initialized_client().await.unwrap();
        let run_msg = Message::from(Run::new("RETURN 3 as n;".to_string(), HashMap::new()));
        assert!(client.send_message(run_msg).await.is_ok());
        let response = client.read_message().await.unwrap();
        assert!(Success::try_from(response).is_ok());

        assert!(client.send_message(Message::DiscardAll).await.is_ok());
        let response = client.read_message().await.unwrap();
        assert!(Success::try_from(response).is_ok());
    }

    #[tokio::test]
    async fn discard_all_and_pull() {
        let mut client = get_initialized_client().await.unwrap();
        let run_msg = Message::from(Run::new("RETURN 3 as n;".to_string(), HashMap::new()));
        assert!(client.send_message(run_msg).await.is_ok());
        let response = client.read_message().await.unwrap();
        assert!(Success::try_from(response).is_ok());

        assert!(client.send_message(Message::DiscardAll).await.is_ok());
        let response = client.read_message().await.unwrap();
        assert!(Success::try_from(response).is_ok());

        assert!(client.send_message(Message::PullAll).await.is_ok());
        let response = client.read_message().await.unwrap();
        assert!(Failure::try_from(response).is_ok());
    }

    #[tokio::test]
    async fn reset() {
        let mut client = get_initialized_client().await.unwrap();
        let run_msg = Message::from(Run::new("Syntax error!;".to_string(), HashMap::new()));
        assert!(client.send_message(run_msg).await.is_ok());
        let response = client.read_message().await.unwrap();
        assert!(Failure::try_from(response).is_ok());

        send_valid_message(&mut client).await;
        let response = client.read_message().await.unwrap();
        assert!(match response {
            Message::Ignored => true,
            _ => false,
        });

        assert!(client.send_message(Message::Reset).await.is_ok());
        let response = client.read_message().await.unwrap();
        assert!(Success::try_from(response).is_ok());

        send_valid_message(&mut client).await;
        let response = client.read_message().await.unwrap();
        assert!(Success::try_from(response).is_ok());
    }

    #[tokio::test]
    async fn ignored() {
        let mut client = get_initialized_client().await.unwrap();
        send_invalid_message(&mut client).await;
        let failure = Failure::try_from(client.read_message().await.unwrap());
        assert!(failure.is_ok());
        send_valid_message(&mut client).await;

        let ignored = client.read_message().await.unwrap();
        assert!(match ignored {
            Message::Ignored => true,
            _ => false,
        });
    }
}