disk_log 1.0.0

disk_log is a **High Throughout, NonBlocking** Disk-based logger
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


static TIMEOUT: Duration = Duration::from_secs(5);


#[derive(Debug)]
pub enum SessionResult {
    Closed,
    Timeout,
    Full,
    NoResponse,
    Err(StatusResult)
}



enum WorkerState {
    Continue,
    Disconnected,
    Empty
}






struct TmpLogStruct {
    path: String,
    log: LogFile,
    current_page_index: usize
}    

#[derive(Debug)]
pub enum StatusResult {
    LogErr(LogError),
    IoError(Error),
    End
}

enum Request {

    Record(Vec<u8>),

    GetPage {
        page_index: usize, 
        dst: oneshot::Sender<Result<LogFile, StatusResult>>,
    },
}


pub struct DiskLog {
    context: Context
}

impl DiskLog {
    pub fn open (path: &str, 
                 name: &str, 
                 total_page_size: usize) -> Result<Self, LogError>  
    {
        match Context::open(path, name, total_page_size) {
            Ok(context) => {
                Ok(DiskLog {
                    context
                })        
            }
            Err(e) => {
                return Err(e)
            }
        }
        
    }

    pub fn run_service(mut self) -> Session {
        let (sx, mut rx) = mpsc::channel(1000);
        std::thread::spawn(move || {

            let mut worker_state;

            loop {

                // Block until get request
                match self.handle_recv(rx.blocking_recv()) {
                    Ok(w) => {
                        worker_state = w;
                    }
                    Err(e) => {
                        
                        // TODO: expose a metric for IO Errors, or print to stderr
                        eprintln!("{:?}", e);

                        worker_state = WorkerState::Continue;                        

                    }
                }
                
                // loop channel until empty 
                loop {

                    if let WorkerState::Continue = worker_state {
                    
                        // try_recv
                        let try_recv_result = rx.try_recv();

                        // handle_try_recv
                        match self.handle_try_recv(try_recv_result) {
                            Ok(w) => {
                                worker_state = w;
                            }
                            Err(e) => {

                                // TODO: expose a metric for IO Errors, or print to stderr
                                eprintln!("{:?}", e);

                                worker_state = WorkerState::Continue;                            
                            }
                        }

                    } else {

                        // worker_state is (Disconnect or Empty)
                        break;
                    }
                    
                }

                // Flush
                let _= self.context.log.flush();


                // if worker_state was disconnect terminate
                if let WorkerState::Disconnected = worker_state {
                    return
                }
            }
        });

        Session::new(sx)
    }
    
    fn handle_recv(&mut self, op: Option<Request>) -> Result<WorkerState, StatusResult> {
        match op {
            Some(req) => {
                match req {
                    Request::Record(mut bytes) => {
                        // Log
                        match self.context.write_to_disk(&mut bytes) {
                            Ok(_) => Ok(WorkerState::Continue),
                            Err(e) => Err(e),
                        }
                    }
                    Request::GetPage { page_index, dst } => {
                        
                        let filename = self.context.find_filename(page_index);
                        
                        // Check file exist  
                        if Path::new(&filename).is_file() {
                            // open logFile
                            match LogFile::open(filename) {
                                Ok(log) => {
                                    // send logfile
                                    let _ = dst.send(Ok(log));
                                    Ok(WorkerState::Continue)
                                }
                                Err(e) => {

                                    // LogErr is => ("Bad checksum" || "Out of bounds" || "the log is locked"
                                    let _ = dst.send(Err(StatusResult::LogErr(e)));
                                    
                                    return  Ok(WorkerState::Continue)
                                }
                            }

                        // file not found
                        } else {
                            let _ = dst.send(Err(StatusResult::End));
                            Ok(WorkerState::Continue)
                        }
                    }
                }
            }
            None => Ok(WorkerState::Disconnected)
        }
    }

    fn handle_try_recv(&mut self, res: Result<Request, TryRecvError>) -> Result<WorkerState, StatusResult> {
        match res {
            Ok(req) => {
                match req {
                    Request::Record(mut bytes) => {
                        // Log
                        match self.context.write_to_disk(&mut bytes) {
                            Ok(_) => Ok(WorkerState::Continue),
                            Err(e) => Err(e),
                        }
                    }
                    Request::GetPage { page_index, dst } => {
                        
                        let filename = self.context.find_filename(page_index);
                        
                        // Check file exist  
                        if Path::new(&filename).is_file() {
                            // open logFile
                            match LogFile::open(filename) {
                                Ok(log) => {
                                    // send logfile
                                    let _ = dst.send(Ok(log));
                                    Ok(WorkerState::Continue)
                                }
                                Err(e) => {

                                    // LogErr is => ("Bad checksum" || "Out of bounds" || "the log is locked"
                                    let _ = dst.send(Err(StatusResult::LogErr(e)));
                                    
                                    return  Ok(WorkerState::Continue)
                                }
                            }
                            
                        // file not found
                        } else {
                            let _ = dst.send(Err(StatusResult::End));
                            Ok(WorkerState::Continue)
                        }
                    }
                }
            }
            Err(e) => {
                match e {
                    TryRecvError::Empty => Ok(WorkerState::Empty),
                    TryRecvError::Disconnected => Ok(WorkerState::Disconnected)
                }
            }
        }
    }
    
    

}





struct Context {
    log: LogFile,
    path: String,

    // total_page_size is total len of query list per file.LOG  
    total_page_size: usize,

    // used_page is len of reocrd in current_file.LOG 
    used_page: usize,

    // current_page is pointer to current_page
    current_page_index: usize

}
impl Context {

    pub fn open(path: &str, 
                name: &str, 
                mut total_page_size: usize) -> Result<Self, LogError> 
    {
        // at-least 5000 Record
        total_page_size =  if total_page_size < 5000 { 5000 } else { total_page_size };
        

        let mut slog = open_last_page(path, name, total_page_size);
        
        let used_page = used_page(&mut slog.log);

        Ok(Context{
            log: slog.log,

            path: slog.path,
            
            total_page_size,

            used_page,

            // current_page is pointer to current_page and when move to new page change
            current_page_index: 1
        })
    }
 

    #[inline]
    fn write_to_disk(&mut self, bytes: &mut Vec<u8>) -> Result<(), StatusResult> {
        let sum = self.used_page + 1;

        // if page have free space 
        if sum < self.total_page_size {

            match self.log.write(bytes) {

                Ok(_) => {                    
                    self.used_page = sum;
                    Ok(())
                }
                Err(err) => {
                    return Err(StatusResult::IoError(err))
                }
            }
            
        }
        // if page with this become full
        else if sum == self.total_page_size {
            // write buffer to page
            let res = self.log.write(bytes);

            // if fail return
            if let Err(e) = res {
                return Err(StatusResult::IoError(e))
            }

            // flush to disk because move to next page
            match self.log.flush() {
                Ok(_) => {

                    // ----- move to new page -----
                    self.current_page_index += 1;

                    // create filename for new page
                    let curr_filename = filename_factory(&self.path, self.current_page_index * self.total_page_size);

                    // create new page
                    let log = match LogFile::open(&curr_filename) {
                        Ok(lf) => lf,
                        Err(err) => {
                            return Err(StatusResult::LogErr(err))
                        }
                    };

                    self.used_page = 0;
                    self.log = log;

                    Ok(())
                }
                Err(err) => {
                    return Err(StatusResult::IoError(err))
                }
            }
        }
        // if page is full
        else {

            // flush to disk because move to next page
            if let Err(e) = self.log.flush() {
                // return error
                return Err(StatusResult::IoError(e));
            }

            // ----- move to new page -----
            self.current_page_index += 1;

            // create filename for new page
            let curr_filename = filename_factory(&self.path, self.current_page_index * self.total_page_size);
            
            
            // create new page
            let log = match LogFile::open(&curr_filename) {
                Ok(lf) => lf,
                Err(err) => {
                    return Err(StatusResult::LogErr(err))
                }
            };
        
            self.log = log;       
        
            // write buffer to page
            let res = self.log.write(bytes);
            
            match res {
                Ok(_) => {
                    self.used_page = 1;
                    Ok(())
                }
                Err(err) => {
                    return Err(StatusResult::IoError(err))
                }
            } 

        }
    }


    #[inline]
    fn find_filename(&self, page_index: usize) -> String {
        let s = filename_factory(&self.path, self.total_page_size * page_index);
        println!("{}", &s);
        s
    }

}
 

// -------------------------------------------------



use std::time::Duration;
use std::io::Error;
use std::{path::Path, fs};

use simple_wal::{LogFile, LogError};
use tokio::sync::mpsc::error::{TryRecvError, SendTimeoutError};
use tokio::sync::{oneshot, mpsc};



#[inline]
fn filename_factory(path: &str, page_pointer: usize) -> String {
    format!("{}/page-{}.LOG", &path, page_pointer)
}

// if not exist directory then is first time run, create dir and a page-1 and open it
// else open latest page exist
fn used_page(log: &mut LogFile) -> usize {

    let mut counter = 0;
    let iter = log.iter(..).unwrap();
    iter.for_each(|_| counter += 1);

    return counter
}

fn open_last_page(path: &str, name: &str, total_page_size: usize) -> TmpLogStruct {
     let path = format!("{}/{}", path, name);
     // if not exist, (First times is started_service)
     if !Path::new(&path).is_dir() {
        let curr_filename = filename_factory(&path, total_page_size);
        fs::create_dir(&path).unwrap();
        return TmpLogStruct {
            path: path,
            log: LogFile::open(&curr_filename).unwrap(),
            current_page_index: 1
        }
     }
     else {
         // -----------------------------------------
         let mut page_index = 2;
         let mut latest_page = filename_factory(&path, total_page_size); 
         loop {        

             let page_pointer = total_page_size * page_index;
             let filename = filename_factory(&path, page_pointer);
            
             if Path::new(&filename).is_file() {
                 latest_page = filename;
                 page_index += 1; 
             } 
             else {
                 // if not exist page_2
                 if page_index == 2 {
                     return TmpLogStruct {
                         path,
                         log: LogFile::open(latest_page).unwrap(),
                         current_page_index: 1
                     }
                 } 
                 else {
                     return TmpLogStruct {
                         path,
                         log: LogFile::open(latest_page).unwrap(),
                         current_page_index: (page_index - 1)
                     }
                 }
             }                
         }
     }

}




// --------------------- Client Code --------------------------


pub struct Session {
    sender: mpsc::Sender<Request>
}

impl Session {
    fn new(sender: mpsc::Sender<Request>) -> Self {
        Session { 
            sender 
        }
    }

    /// create new session
    pub fn clone(&self) -> Self {
        let sender = self.sender.clone();
        Session { 
            sender 
        }
    }

    /// checkin a resource
    pub async fn log(&self, record: Vec<u8>) -> Result<(), SessionResult> {

        let res = self.sender.send_timeout(Request::Record(record), TIMEOUT).await;
        match res {
            Ok(_) => Ok(()),
            Err(e) => {
                match e {
                    SendTimeoutError::Timeout(_) => Err(SessionResult::Timeout),
                    SendTimeoutError::Closed(_) => Err(SessionResult::Closed),
                }
            }
        }
    }   

    /// checkout a resource
    pub async fn get_page(&self, index: usize) -> Result<LogFile, SessionResult> {
        
        // create oneshot channel
        let (ask, resp) = oneshot::channel();
        
        // create a request
        let req = Request::GetPage { page_index: index, dst: ask };
        
        
        // send request with timeout (5 seconds)
        let res = self.sender.send_timeout(req, TIMEOUT).await;
           
        match res {
            // Closed
            Err(SendTimeoutError::Closed(_req)) => {
                return Err(SessionResult::Closed)
            }
            // Timeout
            Err(SendTimeoutError::Timeout(_req)) => {
                return Err(SessionResult::Timeout)
            }

            // Sending request was successful
            Ok(_) => {
                // Await for resource
                match resp.await {
                    Ok(res) => {

                        match res {
                            Ok(r) => Ok(r),
                            Err(e) => Err(SessionResult::Err(e)),
                        }
                        
                    }
                    Err(_) => {
                        return Err(SessionResult::NoResponse)
                    }
                }
            }
        }
    }

}