whatawhat 0.2.3

Application for monitoring user activity
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
use std::{
    future::Future,
    io::ErrorKind,
    ops::Deref,
    path::{Path, PathBuf},
};

use anyhow::Result;
use chrono::{Duration, NaiveDate};
use fs4::tokio::AsyncFileExt;
use tokio::{
    fs::File,
    io::{
        AsyncBufReadExt, AsyncRead, AsyncReadExt, AsyncSeek, AsyncSeekExt, AsyncWrite,
        AsyncWriteExt, BufReader,
    },
};
use tracing::{debug, warn};

use crate::{fs::operations::seek_line_backwards, utils::time::date_to_record_name};

use super::entities::{UsageIntervalEntity, UsageRecordEntity};

/// Interface for abstracting storage of records.
pub trait RecordStorage {
    type RecordFile: RecordFileHandle;

    /// Opens or creates a new record file that will be used for storing data.
    /// Data is supposed to be written into a file for a specific day to increase efficiency.
    fn create_or_append_record(
        &self,
        date: NaiveDate,
    ) -> impl Future<Output = Result<Self::RecordFile>>;

    /// Retrieves data from a record file for a certain day.
    fn get_data_for(
        &self,
        date: NaiveDate,
    ) -> impl Future<Output = Result<Vec<UsageIntervalEntity>>> + Send;
}

impl<T: Deref> RecordStorage for T
where
    T::Target: RecordStorage,
{
    type RecordFile = <T::Target as RecordStorage>::RecordFile;

    fn create_or_append_record(
        &self,
        date: NaiveDate,
    ) -> impl Future<Output = Result<Self::RecordFile>> {
        self.deref().create_or_append_record(date)
    }

    fn get_data_for(
        &self,
        date: NaiveDate,
    ) -> impl Future<Output = Result<Vec<UsageIntervalEntity>>> + Send {
        self.deref().get_data_for(date)
    }
}

pub trait RecordFileHandle {
    fn append(&mut self, usage_records: Vec<UsageRecordEntity>)
    -> impl Future<Output = Result<()>>;
    fn get_date(&self) -> NaiveDate;
    fn flush(&mut self) -> impl Future<Output = Result<()>>;
}

/// The main realization of [RecordStorage].
pub struct RecordStorageImpl {
    record_dir: PathBuf,
}

impl RecordStorageImpl {
    pub fn new(record_dir: PathBuf) -> Result<Self, std::io::Error> {
        std::fs::create_dir_all(&record_dir)?;

        Ok(Self { record_dir })
    }

    async fn get_all_inner(&self, path: &Path) -> Result<Vec<UsageIntervalEntity>> {
        async fn extract(path: &Path) -> std::result::Result<Vec<UsageIntervalEntity>, std::io::Error> {
            debug!("Extracting {path:?}");
            let file = File::open(path).await?;
            file.lock_shared()?;
            let buffer = BufReader::new(file);
            let mut lines = buffer.lines();
            let mut intervals = vec![];
            while let Ok(Some(v)) = lines.next_line().await {
                match serde_json::from_str::<UsageIntervalEntity>(&v) {
                    Ok(v) => intervals.push(v),
                    Err(e) => {
                        // ignore illegal values. Might happen after shutdowns
                        warn!(
                            "During parsing in path {:?} found illegal json string {}:  {e}",
                            path, &v
                        )
                    }
                }
            }

            lines.into_inner().into_inner().unlock_async().await?;

            Ok(intervals)
        }

        match extract(path).await {
            Ok(s) => Ok(s),
            Err(e) => {
                if e.kind() == ErrorKind::NotFound {
                    Ok(vec![])
                } else {
                    Err(e)?
                }
            }
        }
    }
}

impl RecordStorage for RecordStorageImpl {
    type RecordFile = UsageIntervalRecordFile<File>;

    async fn create_or_append_record(&self, date: chrono::NaiveDate) -> Result<Self::RecordFile> {
        let file_name = date_to_record_name(date);
        let path = self.record_dir.join(file_name);

        let v = File::options()
            .write(true)
            .create(true)
            .read(true)
            .truncate(false)
            .open(path)
            .await?;

        Ok(UsageIntervalRecordFile::new(v, date))
    }

    async fn get_data_for(&self, date: chrono::NaiveDate) -> Result<Vec<UsageIntervalEntity>> {
        let file_name = date_to_record_name(date);
        let path = self.record_dir.join(file_name);
        let data = self.get_all_inner(&path).await?;
        Ok(data)
    }
}

pub struct UsageIntervalRecordFile<F> {
    file: F,
    date: NaiveDate,
}

impl<F: AsyncSeek + AsyncRead + AsyncWrite + fs4::tokio::AsyncFileExt + Unpin> RecordFileHandle
    for UsageIntervalRecordFile<F>
{
    async fn append(&mut self, usage_record: Vec<UsageRecordEntity>) -> Result<()> {
        self.append_inner(usage_record.clone()).await
    }

    fn get_date(&self) -> chrono::NaiveDate {
        self.date
    }

    async fn flush(&mut self) -> Result<()> {
        Ok(())
    }
}

impl<F: AsyncSeek + AsyncRead + AsyncWrite + fs4::tokio::AsyncFileExt + Unpin>
    UsageIntervalRecordFile<F>
{
    fn new(file: F, date: NaiveDate) -> Self {
        Self { file, date }
    }

    /// Tries to read out previous interval
    async fn extract_line_backwards(file: &mut F) -> Result<String, anyhow::Error> {
        seek_line_backwards(file, &mut vec![0; 1024]).await?;
        let mut last_line = String::new();
        file.read_to_string(&mut last_line).await?;
        Ok(last_line)
    }

    async fn append_inner(&mut self, usage_record: Vec<UsageRecordEntity>) -> Result<()> {
        // Semi-safe acquire-release for a file
        self.file.lock_exclusive()?;
        let result = Self::append_with_file(&mut self.file, usage_record).await;
        self.file.unlock_async().await?;
        result
    }

    async fn append_with_file(file: &mut F, usage_record: Vec<UsageRecordEntity>) -> Result<()> {
        // The process of appending a record is as such.
        // 1. Get last interval from the file.
        // 2. Collapse the interval with added usage_records
        // 3. Overwrite last interval with updated interval and append new intervals.

        file.seek(std::io::SeekFrom::End(0)).await?;

        let last_line = Self::extract_line_backwards(file).await?;

        file.seek(std::io::SeekFrom::Current(-(last_line.len() as i64)))
            .await?;

        file.stream_position().await?;

        let last_interval: Option<UsageIntervalEntity> = if last_line.is_empty() {
            None
        } else {
            match serde_json::from_str::<UsageIntervalEntity>(&last_line) {
                Ok(v) => Some(v),
                Err(e) => {
                    // Might happen due to shutdown cutting of the write into a file.
                    warn!("Last record was corrupted {e}");
                    None
                }
            }
        };

        let collapsed = collapse_records(last_interval, usage_record);

        let mut buffer = Vec::<u8>::new();
        for interval in collapsed {
            serde_json::to_writer(&mut buffer, &interval)?;
            buffer.push(b'\n');
        }

        file.write_all(&buffer).await?;
        file.flush().await?;
        Ok(())
    }
}

/// Value used to bridge gap between window transitions. There should be a limit, though, so that an
/// event that happened an hour ago didn't affect new events
const MAX_MERGE_DURATION: Duration = Duration::seconds(2);

/// Creates an optimal sequence of intervals.
fn collapse_records(
    last_interval: Option<UsageIntervalEntity>,
    usage_records: impl IntoIterator<Item = UsageRecordEntity>,
) -> Vec<UsageIntervalEntity> {
    let mut intervals = Vec::new();
    if let Some(last) = last_interval {
        intervals.push(last);
    }

    for record in usage_records {
        dbg!(&intervals);
        dbg!(intervals.last_mut().map(|v| v.end()), record.moment);
        match intervals.last_mut() {
            Some(interval)
                if interval.window_name == record.window_name
                    && interval.process_name == record.process_name
                    && interval.afk == record.afk
                    && record.moment - interval.end() < MAX_MERGE_DURATION =>
            {
                interval.set_end(record.moment)
            }
            Some(previous_interval)
                if record.moment - previous_interval.end() < MAX_MERGE_DURATION =>
            {
                let mut next_interval: UsageIntervalEntity = record.into();
                next_interval.start = previous_interval.end();
                intervals.push(next_interval);
            }
            Some(_) | None => {
                intervals.push(record.into());
            }
        }
    }

    intervals
}

#[cfg(test)]
mod tests {
    use std::io::Write;

    use anyhow::Result;
    use chrono::{Duration, NaiveDate, NaiveDateTime, NaiveTime, TimeZone, Utc};
    use tempfile::{tempdir, tempfile};
    use tokio::io::{AsyncReadExt, AsyncSeekExt};

    use crate::daemon::storage::{
        entities::{UsageIntervalEntity, UsageRecordEntity},
        record_storage::{RecordFileHandle, RecordStorage, RecordStorageImpl, collapse_records},
    };

    use super::UsageIntervalRecordFile;

    const TEST_START_DATE: NaiveDateTime =
        NaiveDateTime::new(NaiveDate::from_ymd_opt(2018, 7, 4).unwrap(), NaiveTime::MIN);

    #[tokio::test]
    async fn test_appender_basic() -> Result<()> {
        let file = tokio::fs::File::from_std(tempfile().unwrap());

        let mut usage = UsageIntervalRecordFile::new(file, Utc::now().date_naive());
        usage
            .append_inner(vec![UsageRecordEntity {
                window_name: "initial".into(),
                process_name: "initial".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE),
                afk: false,
            }])
            .await?;

        usage
            .append_inner(vec![UsageRecordEntity {
                window_name: "window".into(),
                process_name: "process".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE) + Duration::seconds(1),
                afk: true,
            }])
            .await?;

        usage
            .append_inner(vec![UsageRecordEntity {
                window_name: "third".into(),
                process_name: "process".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE) + Duration::seconds(2),
                afk: true,
            }])
            .await?;

        usage
            .append_inner(vec![UsageRecordEntity {
                window_name: "third".into(),
                process_name: "process".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE) + Duration::seconds(3),
                afk: true,
            }])
            .await?;

        usage.file.rewind().await?;
        let mut s = String::new();
        usage.file.read_to_string(&mut s).await?;
        assert_eq!(s.lines().count(), 3);
        Ok(())
    }

    #[tokio::test]
    async fn test_appender_overwrite() -> Result<()> {
        let mut previous = serde_json::to_string(&UsageIntervalEntity {
            window_name: "initial".into(),
            process_name: "initial".into(),
            start: Utc::now() - Duration::seconds(2),
            duration: Duration::seconds(1),
            afk: false,
        })?;

        previous.push('\n');

        previous += &serde_json::to_string(&UsageIntervalEntity {
            window_name: "window".into(),
            process_name: "process".into(),
            start: Utc::now() - Duration::seconds(2),
            duration: Duration::seconds(1),
            afk: true,
        })?;
        previous += "\n";

        let mut file = tempfile().unwrap();
        file.write_all(previous.as_bytes())?;
        let mut file = tokio::fs::File::from_std(file);
        file.seek(std::io::SeekFrom::End(0)).await?;

        let mut usage = UsageIntervalRecordFile::new(file, Utc::now().date_naive());

        usage
            .append_inner(vec![UsageRecordEntity {
                window_name: "window".into(),
                process_name: "process".into(),
                moment: Utc::now(),
                afk: true,
            }])
            .await?;

        usage.file.rewind().await?;
        let mut s = String::new();
        usage.file.read_to_string(&mut s).await?;
        assert_eq!(s.lines().count(), 2);
        Ok(())
    }

    #[tokio::test]
    async fn test_record_storage_basic() -> Result<()> {
        let dir = tempdir()?;
        let storage = RecordStorageImpl::new(dir.path().to_owned())?;
        let mut record_file = storage.create_or_append_record(TEST_START_DATE.date()).await?;
        let records = [
            UsageRecordEntity {
                window_name: "test".into(),
                process_name: "test process".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE),
                afk: false,
            },
            UsageRecordEntity {
                window_name: "test 2".into(),
                process_name: "test process 2".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE),
                afk: false,
            },
        ];
        record_file.append_inner(vec![records[0].clone()]).await?;

        record_file.append_inner(vec![records[1].clone()]).await?;

        record_file.flush().await?;

        let values = storage.get_data_for(TEST_START_DATE.into()).await?;

        assert_eq!(
            values,
            vec![records[0].clone().into(), records[1].clone().into()]
        );

        Ok(())
    }

    #[tokio::test]
    async fn test_record_storage_appending() -> Result<()> {
        let dir = tempdir()?;
        let storage = RecordStorageImpl::new(dir.path().to_owned())?;
        let mut record = storage.create_or_append_record(TEST_START_DATE.date()).await?;
        let records = [
            UsageRecordEntity {
                window_name: "test".into(),
                process_name: "test process".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE),
                afk: false,
            },
            UsageRecordEntity {
                window_name: "test 2".into(),
                process_name: "test process 2".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE) + Duration::seconds(1),
                afk: false,
            },
            UsageRecordEntity {
                window_name: "test 2".into(),
                process_name: "test process 2".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE) + Duration::seconds(2),
                afk: false,
            },
        ];
        record.append_inner(vec![records[0].clone()]).await?;

        record.append_inner(vec![records[1].clone()]).await?;

        record.append_inner(vec![records[2].clone()]).await?;

        record.flush().await?;

        let stored = storage.get_data_for(TEST_START_DATE.into()).await?;

        let collapsed = collapse_records(None, records.clone());

        assert_eq!(stored, collapsed);

        Ok(())
    }

    #[tokio::test]
    async fn test_record_collapsing_basic() -> Result<()> {
        let records = [
            UsageRecordEntity {
                window_name: "test".into(),
                process_name: "test process".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE),
                afk: false,
            },
            UsageRecordEntity {
                window_name: "test".into(),
                process_name: "test process".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE) + Duration::seconds(1),
                afk: false,
            },
            UsageRecordEntity {
                window_name: "test 2".into(),
                process_name: "test process 2".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE) + Duration::seconds(5),
                afk: false,
            },
        ];
        let values = collapse_records(None, records.clone());

        assert_eq!(values.len(), 2);
        assert_eq!(
            values[0],
            UsageIntervalEntity::from(records[0].clone()).with_duration(Duration::seconds(1)),
        );
        assert_eq!(
            values[1],
            UsageIntervalEntity::from(records[2].clone())
                .with_start(records[2].moment)
                .with_duration(Duration::seconds(0))
        );

        Ok(())
    }

    #[tokio::test]
    async fn test_record_collapsing_long_time_between_cutooff() -> Result<()> {
        let interval = UsageIntervalEntity {
            window_name: "test".into(),
            process_name: "test process".into(),
            start: Utc.from_utc_datetime(&TEST_START_DATE),
            duration: Duration::seconds(10),
            afk: false,
        };

        let records = [UsageRecordEntity {
            window_name: "test".into(),
            process_name: "test process".into(),
            moment: Utc.from_utc_datetime(&TEST_START_DATE) + Duration::seconds(15),
            afk: false,
        }];

        let values = collapse_records(Some(interval.clone()), records.clone());

        assert_eq!(values[0], interval.with_duration(Duration::seconds(10)),);
        assert_eq!(
            values[1],
            UsageIntervalEntity::from(records[0].clone())
                .with_start(records[0].moment)
                .with_duration(Duration::seconds(0))
        );

        Ok(())
    }

    #[tokio::test]
    async fn test_record_collapsing_long_time_between_different_processes_cutooff() -> Result<()> {
        let records = [
            UsageRecordEntity {
                window_name: "previous".into(),
                process_name: "previous process".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE),
                afk: false,
            },
            UsageRecordEntity {
                window_name: "test 2".into(),
                process_name: "test process 2".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE) + Duration::seconds(3),
                afk: false,
            },
            UsageRecordEntity {
                window_name: "test 2".into(),
                process_name: "test process 2".into(),
                moment: Utc.from_utc_datetime(&TEST_START_DATE) + Duration::seconds(4),
                afk: false,
            },
        ];
        let values = collapse_records(None, records.clone());

        assert_eq!(values.len(), 2);

        assert_eq!(
            values[0],
            UsageIntervalEntity::from(records[0].clone())
                .with_start(records[0].moment)
                .with_duration(Duration::seconds(0))
        );
        assert_eq!(
            values[1],
            UsageIntervalEntity::from(records[1].clone())
                .with_start(records[1].moment)
                .with_duration(Duration::seconds(1))
        );

        Ok(())
    }
}