qs-core 0.4.1

quic send core library
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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
use std::path::Path;

use async_compression::tokio::write::{GzipDecoder, GzipEncoder};
use bincode::{Decode, Encode};
use serde::{Deserialize, Serialize};
use thiserror::Error;
use tokio::io::AsyncWriteExt;

/// Tree structure that represents the files that
/// are being sent/received
#[derive(Debug, PartialEq, Clone, Encode, Decode, Hash)]
pub enum FileSendRecvTree {
    File {
        name: String,
        skip: u64,
        size: u64,
    },
    Dir {
        name: String,
        files: Vec<FileSendRecvTree>,
    },
}

impl FileSendRecvTree {
    /// Name of the file or directory
    pub fn name(&self) -> &str {
        match self {
            FileSendRecvTree::File { name, .. } => name,
            FileSendRecvTree::Dir { name, .. } => name,
        }
    }

    /// Size of the tree in bytes
    pub fn size(&self) -> u64 {
        match self {
            FileSendRecvTree::File { size, .. } => *size,
            FileSendRecvTree::Dir { files, .. } => files.iter().map(|f| f.size()).sum(),
        }
    }

    /// Number of bytes being partially skipped
    /// [FileRecvSendTree] does not contain fully skipped files
    pub fn skip(&self) -> u64 {
        match self {
            FileSendRecvTree::File { skip, .. } => *skip,
            FileSendRecvTree::Dir { files, .. } => files.iter().map(|f| f.skip()).sum(),
        }
    }
}

/// Tree structure that represents the files that are available
#[derive(Debug, PartialEq, Clone, Encode, Decode, Hash, Serialize, Deserialize)]
pub enum FilesAvailable {
    File {
        name: String,
        size: u64,
    },
    Dir {
        name: String,
        files: Vec<FilesAvailable>,
    },
}
/// Get the available files
pub fn get_files_available(path: &Path) -> std::io::Result<FilesAvailable> {
    if path.is_file() {
        Ok(FilesAvailable::File {
            name: path.file_name().unwrap().to_str().unwrap().to_string(),
            size: path.metadata()?.len(),
        })
    } else {
        let mut files = Vec::new();
        for entry in std::fs::read_dir(path)? {
            let entry = entry?;
            let path = entry.path();
            files.push(get_files_available(&path)?);
        }

        Ok(FilesAvailable::Dir {
            name: path.file_name().unwrap().to_str().unwrap().to_string(),
            files,
        })
    }
}

impl FilesAvailable {
    /// Name of the file or directory
    pub fn name(&self) -> &str {
        match self {
            FilesAvailable::File { name, .. } => name,
            FilesAvailable::Dir { name, .. } => name,
        }
    }

    /// Size of the tree in bytes
    pub fn size(&self) -> u64 {
        match self {
            FilesAvailable::File { size, .. } => *size,
            FilesAvailable::Dir { files, .. } => files.iter().map(|f| f.size()).sum(),
        }
    }

    /// Convert the tree to a [FileSendRecvTree]
    pub fn to_send_recv_tree(&self) -> FileSendRecvTree {
        match self {
            FilesAvailable::File { name, size } => FileSendRecvTree::File {
                name: name.to_string(),
                skip: 0,
                size: *size,
            },
            FilesAvailable::Dir { name, files } => FileSendRecvTree::Dir {
                name: name.to_string(),
                files: files.iter().map(|f| f.to_send_recv_tree()).collect(),
            },
        }
    }

    /// Fully/partially remove skipped files from the tree
    /// - Returns [std::option::Option::None] if the tree is fully skipped
    /// - panics if the tree roots do not match
    pub fn remove_skipped(&self, to_skip: &FilesToSkip) -> Option<FileSendRecvTree> {
        match (self, to_skip) {
            (
                FilesAvailable::File { name, size },
                FilesToSkip::File {
                    name: skip_name,
                    skip,
                },
            ) => {
                if name == skip_name && size <= skip {
                    None
                } else {
                    Some(FileSendRecvTree::File {
                        name: name.clone(),
                        skip: *skip,
                        size: *size,
                    })
                }
            }
            (
                FilesAvailable::Dir { name, files },
                FilesToSkip::Dir {
                    name: skip_name,
                    files: skip_files,
                },
            ) => {
                if name != skip_name {
                    panic!("Tree roots do not match");
                }

                let mut remaining_files = Vec::new();
                for file in files {
                    if let Some(skip_file) = skip_files.iter().find(|sf| match (file, sf) {
                        (
                            FilesAvailable::File { name, .. },
                            FilesToSkip::File {
                                name: skip_name, ..
                            },
                        ) => name == skip_name,
                        (
                            FilesAvailable::Dir { name, .. },
                            FilesToSkip::Dir {
                                name: skip_name, ..
                            },
                        ) => name == skip_name,
                        _ => false,
                    }) {
                        if let Some(remaining) = file.remove_skipped(skip_file) {
                            remaining_files.push(remaining);
                        }
                    } else {
                        remaining_files.push(file.clone().to_send_recv_tree());
                    }
                }

                if remaining_files.is_empty() {
                    None
                } else {
                    Some(FileSendRecvTree::Dir {
                        name: name.clone(),
                        files: remaining_files,
                    })
                }
            }
            _ => panic!("Tree roots do not match"),
        }
    }

    /// Compare two trees and return the files that can be skipped.
    /// (e.g. compare local and remote files, returning those that can be skipped during transfer).
    /// it is expected that ``self`` is larger than ``local_files``
    /// # Returns
    /// - [std::option::Option::None] if no files can be skipped
    pub fn get_skippable(&self, local_files: &FilesAvailable) -> Option<FilesToSkip> {
        match (self, local_files) {
            (
                FilesAvailable::File { name, .. },
                FilesAvailable::File {
                    name: local_name,
                    size: local_size,
                },
            ) => {
                if name == local_name {
                    Some(FilesToSkip::File {
                        name: name.clone(),
                        skip: *local_size,
                    })
                } else {
                    None
                }
            }
            (
                FilesAvailable::Dir { name, files },
                FilesAvailable::Dir {
                    name: local_name,
                    files: local_files,
                },
            ) => {
                if name != local_name {
                    return None;
                }

                let mut skippable_files = Vec::new();
                for file in files {
                    if let Some(remote_file) = local_files.iter().find(|rf| match (file, rf) {
                        (
                            FilesAvailable::File { name, .. },
                            FilesAvailable::File {
                                name: local_name, ..
                            },
                        ) => name == local_name,
                        (
                            FilesAvailable::Dir { name, .. },
                            FilesAvailable::Dir {
                                name: local_name, ..
                            },
                        ) => name == local_name,
                        _ => false,
                    }) {
                        if let Some(skippable) = file.get_skippable(remote_file) {
                            skippable_files.push(skippable);
                        }
                    }
                }

                if skippable_files.is_empty() {
                    None
                } else {
                    Some(FilesToSkip::Dir {
                        name: name.clone(),
                        files: skippable_files,
                    })
                }
            }
            _ => None,
        }
    }
}

/// Tree structure that represents files that have been requested for skipping
#[derive(Debug, PartialEq, Clone, Encode, Decode, Hash)]
pub enum FilesToSkip {
    File {
        name: String,
        skip: u64,
    },
    Dir {
        name: String,
        files: Vec<FilesToSkip>,
    },
}

impl FilesToSkip {
    /// Name of the file or directory
    pub fn name(&self) -> &str {
        match self {
            FilesToSkip::File { name, .. } => name,
            FilesToSkip::Dir { name, .. } => name,
        }
    }

    /// Number of bytes being skipped
    /// This will include fully skipped files
    pub fn skip(&self) -> u64 {
        match self {
            FilesToSkip::File { skip, .. } => *skip,
            FilesToSkip::Dir { files, .. } => files.iter().map(|f| f.skip()).sum(),
        }
    }
}

pub async fn send_packet<P: Encode + std::fmt::Debug>(
    packet: P,
    conn: &iroh::endpoint::Connection,
) -> std::io::Result<()> {
    tracing::debug!("Sending packet: {:?}", packet);
    let mut send = conn.open_uni().await?;

    let data = bincode::encode_to_vec(&packet, bincode::config::standard()).unwrap();
    let compressed = compress_gzip(&data).await?;
    send.write_all(&compressed).await?;

    send.flush().await?;
    send.finish()?;

    Ok(())
}

#[derive(Debug, Error)]
pub enum PacketRecvError {
    #[error("io error: {0}")]
    IoError(#[from] std::io::Error),
    #[error("encode error: {0}")]
    EncodeError(#[from] bincode::error::DecodeError),
    #[error("connection error: {0}")]
    Connection(#[from] iroh::endpoint::ConnectionError),
    #[error("read error {0}")]
    Read(#[from] iroh::endpoint::ReadError),
}

pub async fn receive_packet<P: Decode<()> + std::fmt::Debug>(
    conn: &iroh::endpoint::Connection,
) -> Result<P, PacketRecvError> {
    let mut recv = conn.accept_uni().await?;
    let mut buf = Vec::new();

    loop {
        let mut data = vec![0; 1024];
        if let Some(n) = recv.read(&mut data).await? {
            buf.extend_from_slice(&data[..n]);
            continue;
        }

        break;
    }

    let decompressed = decompress_gzip(&buf).await?;

    let packet = bincode::decode_from_slice(&decompressed, bincode::config::standard())?.0;

    tracing::debug!("Received packet: {:?}", packet);

    Ok(packet)
}

async fn compress_gzip(data: &[u8]) -> std::io::Result<Vec<u8>> {
    let mut out = Vec::new();
    let mut encoder = GzipEncoder::new(&mut out);
    encoder.write_all(data).await?;
    encoder.shutdown().await?;

    Ok(out)
}

async fn decompress_gzip(data: &[u8]) -> std::io::Result<Vec<u8>> {
    let mut out = Vec::new();
    let mut decoder = GzipDecoder::new(&mut out);
    decoder.write_all(data).await?;
    decoder.shutdown().await?;

    Ok(out)
}

#[cfg(test)]
mod tests {
    use super::*;
    use pretty_assertions::assert_eq;

    #[tokio::test]
    async fn test_compression() {
        let data = b"hellllllllllllllllllllllllo world";
        let compressed = compress_gzip(data).await.unwrap();
        let decompressed = decompress_gzip(&compressed).await.unwrap();

        assert!(compressed.len() < data.len());
        assert_eq!(data, &decompressed[..]);
    }

    #[test]
    fn test_file_trees() {
        let files_offered = FilesAvailable::Dir {
            name: "root".to_string(),
            files: vec![
                FilesAvailable::File {
                    name: "file1".to_string(),
                    size: 10,
                },
                FilesAvailable::Dir {
                    name: "dir1".to_string(),
                    files: vec![
                        FilesAvailable::File {
                            name: "file2".to_string(),
                            size: 20,
                        },
                        FilesAvailable::File {
                            name: "file3".to_string(),
                            size: 30,
                        },
                    ],
                },
            ],
        };

        let already_installed = FilesAvailable::Dir {
            name: "root".to_string(),
            files: vec![
                FilesAvailable::File {
                    name: "file1".to_string(),
                    size: 10,
                },
                FilesAvailable::Dir {
                    name: "dir1".to_string(),
                    files: vec![FilesAvailable::File {
                        name: "file2".to_string(),
                        size: 15,
                    }],
                },
            ],
        };

        let to_skip = files_offered.get_skippable(&already_installed).unwrap();
        assert_eq!(
            to_skip,
            FilesToSkip::Dir {
                name: "root".to_string(),
                files: vec![
                    FilesToSkip::File {
                        name: "file1".to_string(),
                        skip: 10
                    },
                    FilesToSkip::Dir {
                        name: "dir1".to_string(),
                        files: vec![FilesToSkip::File {
                            name: "file2".to_string(),
                            skip: 15
                        }],
                    },
                ],
            }
        );

        let new_tree_expected = FileSendRecvTree::Dir {
            name: "root".to_string(),
            files: vec![FileSendRecvTree::Dir {
                name: "dir1".to_string(),
                files: vec![
                    FileSendRecvTree::File {
                        name: "file2".to_string(),
                        skip: 15,
                        size: 20,
                    },
                    FileSendRecvTree::File {
                        name: "file3".to_string(),
                        skip: 0,
                        size: 30,
                    },
                ],
            }],
        };

        let new_tree = files_offered.remove_skipped(&to_skip).unwrap();
        assert_eq!(new_tree, new_tree_expected);
    }

    #[test]
    fn test_no_files_to_skip() {
        let offered = FilesAvailable::Dir {
            name: "root".to_string(),
            files: vec![
                FilesAvailable::File {
                    name: "file1".to_string(),
                    size: 10,
                },
                FilesAvailable::Dir {
                    name: "dir1".to_string(),
                    files: vec![
                        FilesAvailable::File {
                            name: "file2".to_string(),
                            size: 20,
                        },
                        FilesAvailable::File {
                            name: "file3".to_string(),
                            size: 30,
                        },
                    ],
                },
            ],
        };

        let installed = FilesAvailable::Dir {
            name: "root".to_string(),
            files: vec![],
        };

        let to_skip = offered.get_skippable(&installed);
        assert_eq!(to_skip, None);
    }

    #[test]
    fn larger_directory() {
        let offered = FilesAvailable::Dir {
            name: "root".to_string(),
            files: vec![
                FilesAvailable::File {
                    name: "file1".to_string(),
                    size: 10,
                },
                FilesAvailable::Dir {
                    name: "dir1".to_string(),
                    files: vec![
                        FilesAvailable::File {
                            name: "file2".to_string(),
                            size: 20,
                        },
                        FilesAvailable::File {
                            name: "file3".to_string(),
                            size: 30,
                        },
                        FilesAvailable::Dir {
                            name: "dir2".to_string(),
                            files: vec![FilesAvailable::File {
                                name: "file4".to_string(),
                                size: 40,
                            }],
                        },
                    ],
                },
                FilesAvailable::Dir {
                    name: "dir3".to_string(),
                    files: vec![FilesAvailable::File {
                        name: "file5".to_string(),
                        size: 50,
                    }],
                },
            ],
        };

        let installed = FilesAvailable::Dir {
            name: "root".to_string(),
            files: vec![
                FilesAvailable::File {
                    name: "file1".to_string(),
                    size: 10,
                },
                FilesAvailable::Dir {
                    name: "dir1".to_string(),
                    files: vec![
                        FilesAvailable::File {
                            name: "file2".to_string(),
                            size: 5,
                        },
                        FilesAvailable::Dir {
                            name: "dir2".to_string(),
                            files: vec![],
                        },
                    ],
                },
            ],
        };

        let to_skip = offered.get_skippable(&installed).unwrap();
        assert_eq!(
            to_skip,
            FilesToSkip::Dir {
                name: "root".to_string(),
                files: vec![
                    FilesToSkip::File {
                        name: "file1".to_string(),
                        skip: 10
                    },
                    FilesToSkip::Dir {
                        name: "dir1".to_string(),
                        files: vec![
                            FilesToSkip::File {
                                name: "file2".to_string(),
                                skip: 5
                            },
                            // FilesToSkip::Dir {
                            //     name: "dir2".to_string(),
                            //     files: vec![],
                            // },
                        ],
                    }
                ]
            }
        );

        let new_tree = offered.remove_skipped(&to_skip).unwrap();
        let new_tree_expected = FileSendRecvTree::Dir {
            name: "root".to_string(),
            files: vec![
                FileSendRecvTree::Dir {
                    name: "dir1".to_string(),
                    files: vec![
                        FileSendRecvTree::File {
                            name: "file2".to_string(),
                            skip: 5,
                            size: 20,
                        },
                        FileSendRecvTree::File {
                            name: "file3".to_string(),
                            skip: 0,
                            size: 30,
                        },
                        FileSendRecvTree::Dir {
                            name: "dir2".to_string(),
                            files: vec![FileSendRecvTree::File {
                                name: "file4".to_string(),
                                skip: 0,
                                size: 40,
                            }],
                        },
                    ],
                },
                FileSendRecvTree::Dir {
                    name: "dir3".to_string(),
                    files: vec![FileSendRecvTree::File {
                        name: "file5".to_string(),
                        skip: 0,
                        size: 50,
                    }],
                },
            ],
        };

        assert_eq!(new_tree, new_tree_expected);
    }
}