rememberthemilk 0.4.11

Client library for the Remember The Milk todo list service.
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
//! Local caching of Remember The Milk entries.

use std::path::Path;

use chrono::{Local, Utc};
use sqlx::{
    migrate::{MigrateDatabase as _, MigrateError},
    Sqlite, SqlitePool,
};
type JsonValue = serde_json::Value;

use crate::{RTMList, RTMLists, RTMTasks, RTMTimeline, RTMTransaction, Task, TaskSeries, API};

mod filter;

/// Cache errors
#[derive(thiserror::Error, Debug)]
pub enum CacheError {
    /// Database error
    #[error("Database error")]
    DbOpenError(#[from] sqlx::Error),
    /// Database migration error
    #[error("Database migration error")]
    DbMigrateError(#[from] MigrateError),
    /// Path conversion error
    #[error("File path error")]
    PathError,
    /// Other error
    #[error("Other error")]
    OtherError(#[from] anyhow::Error),
    /// Error parsing response
    #[error("Error parsing RTM response")]
    ParseError(&'static str),
}

/// Task cache result type.
pub type Result<T> = std::result::Result<T, CacheError>;

/// A cache instance
#[derive(Clone)]
pub struct TaskCache {
    pool: SqlitePool,
    api: API,
}

impl TaskCache {
    /// Open or create a new task cache.
    pub async fn new(db_path: &Path, api: API) -> Result<Self> {
        log::info!("Opening db at {db_path:?}");
        let Some(db_name) = db_path.as_os_str().to_str() else {
            return Err(CacheError::PathError);
        };
        if !Sqlite::database_exists(db_name).await? {
            Sqlite::create_database(db_name).await?;
        }

        let pool = SqlitePool::connect(db_name).await?;
        sqlx::migrate!().run(&pool).await?;
        Ok(TaskCache { pool, api })
    }

    /// WIP get all tasks
    pub async fn sync(&self) -> Result<()> {
        let last_sync: Option<chrono::DateTime<Utc>> =
            match sqlx::query_as::<_, (chrono::DateTime<Utc>,)>(
                "SELECT last_sync FROM task_meta WHERE id = 1",
            )
            .fetch_one(&self.pool)
            .await
            .map(|(d,)| d)
            {
                Ok(d) => Some(d),
                Err(sqlx::Error::RowNotFound) => None,
                Err(e) => {
                    return Err(e.into());
                }
            };

        log::info!("last_sync: {last_sync:?}");
        let new_last_sync = Utc::now();
        let mut tasks = self.api.get_tasks_filtered_sync_json("", last_sync).await?;

        let mut tx = self.pool.begin().await?;
        let lists = tasks.get_mut("list");
        if let Some(JsonValue::Array(values)) = lists {
            for list in values {
                let list_id = list.get("id").unwrap().as_str().unwrap().to_string();
                if let Some(JsonValue::Array(taskseries)) = list.get_mut("taskseries") {
                    for ts in taskseries {
                        let taskseries_id = ts.get("id").unwrap().as_str().unwrap().to_string();
                        // Extract the task to put it into the separate table.
                        let task = ts.get_mut("task").map(|t| t.take());
                        sqlx::query(
                            "INSERT INTO taskseries(list_id, taskseries_id, data)
                            VALUES(?1, ?2, jsonb(?3))
                            ON CONFLICT DO UPDATE SET data = jsonb(?3);
                        ",
                        )
                        .bind(&list_id)
                        .bind(&taskseries_id)
                        .bind(ts.to_string())
                        .execute(&mut *tx)
                        .await?;

                        if let Some(JsonValue::Array(tasks)) = task {
                            for t in tasks {
                                let task_id = t.get("id").unwrap().as_str().unwrap();
                                sqlx::query(
                                    "INSERT INTO tasks(list_id, taskseries_id, task_id, data)
                                    VALUES(?1, ?2, ?3, jsonb(?4))
                                    ON CONFLICT DO UPDATE SET data = jsonb(?4);
                                ",
                                )
                                .bind(&list_id)
                                .bind(&taskseries_id)
                                .bind(task_id)
                                .bind(t.to_string())
                                .execute(&mut *tx)
                                .await?;
                            }
                        }
                    }
                }
                if let Some(JsonValue::Array(deleted)) = list.get("deleted") {
                    log::info!("List has {} deleted entries", deleted.len());
                    for entry in deleted {
                        log::debug!("Deleted entry: {entry}");
                        if let Some(ts) = entry.get("taskseries") {
                            log::debug!("Deleted ts: {ts}");
                            let taskseries_id = ts.get("id").unwrap().as_str().unwrap().to_string();
                            if let Some(JsonValue::Array(tasks)) = ts.get("task") {
                                for t in tasks {
                                    log::debug!("Deleted task: {t}");
                                    let task_id = t.get("id").unwrap().as_str().unwrap();
                                    log::info!("Deleting task {list_id}/{taskseries_id}/{task_id}");
                                    sqlx::query(
                                        "UPDATE tasks
                                         SET deleted=true
                                         WHERE list_id=? AND taskseries_id=? AND task_id=?;
                            ",
                                    )
                                    .bind(&list_id)
                                    .bind(&taskseries_id)
                                    .bind(task_id)
                                    .execute(&mut *tx)
                                    .await?;
                                }
                            }
                        }
                    }
                }
            }
        }

        // Now get the lists
        let lists = self.api.get_lists().await?;
        for list in lists {
            sqlx::query(
                "INSERT INTO lists(list_id, name)
                    VALUES(?1, ?2)
                    ON CONFLICT DO UPDATE SET name = ?2;
                    ",
            )
            .bind(&list.id)
            .bind(&list.name)
            .execute(&mut *tx)
            .await?;
        }
        tx.commit().await?;

        sqlx::query(
            "INSERT INTO task_meta(id, last_sync)
            VALUES(1, ?1)
            ON CONFLICT(id) DO UPDATE SET
              last_sync=?1
            ",
        )
        .bind(new_last_sync)
        .execute(&self.pool)
        .await?;
        log::info!("Updated last_sync to {new_last_sync:?}");

        Ok(())
    }

    /// Return tasks from the cache matching the filter.
    pub async fn get_tasks_filtered(
        &self,
        filt: &str,
    ) -> std::result::Result<RTMTasks, crate::Error> {
        let mut filter_clause = String::new();
        let mut filter_binds = Vec::new();
        if !filt.is_empty() {
            let filter = filter::parse_filter(filt)?;
            let mut context = filter::FilterContext {
                now: Local::now(),
                ..Default::default()
            };
            let lists = self.get_lists().await?;
            for list in lists {
                context.lists_name_to_id.insert(list.name, list.id);
            }
            let (clause, binds) = filter.to_sqlite_where_clause(&context)?;
            filter_clause = clause;
            filter_binds = binds;

            log::info!("Filter clause: {filter_clause}");
        }

        #[derive(sqlx::FromRow)]
        struct Data {
            list_id: String,
            ts_data: String,
            t_data: String,
        }

        let query_str = format!(
            r#"SELECT ts.list_id, json(ts.data) as ts_data, json(t.data) as t_data
             FROM taskseries ts, tasks t
             USING (list_id, taskseries_id)
             WHERE
                t.deleted != TRUE AND
                {filter_clause};
                "#
        );
        let mut query = sqlx::query_as(&query_str);
        for bind in filter_binds {
            query = query.bind(bind);
        }
        let data: Vec<Data> = query.fetch_all(&self.pool).await?;
        let mut result = RTMTasks {
            rev: Default::default(),
            list: Vec::new(),
        };
        for item in data {
            let mut list = RTMLists {
                id: item.list_id,
                taskseries: None,
            };
            let mut ts_json: serde_json::Value = serde_json::from_str(&item.ts_data).unwrap();
            let t_json: serde_json::Value =
                vec![serde_json::from_str::<serde_json::Value>(&item.t_data).unwrap()].into();
            ts_json
                .as_object_mut()
                .unwrap()
                .insert("task".to_string(), t_json);
            let ts: TaskSeries = serde_json::from_value(ts_json).unwrap();
            list.taskseries = Some(vec![ts]);
            result.list.push(list);
        }
        Ok(result)
    }

    /// Return tasks which are children of a given task
    pub async fn get_task_children(
        &self,
        parent_id: &str,
    ) -> std::result::Result<RTMTasks, crate::Error> {
        #[derive(sqlx::FromRow)]
        struct Data {
            list_id: String,
            ts_data: String,
            t_data: String,
        }

        let query = r#"SELECT ts.list_id, json(ts.data) as ts_data, json(t.data) as t_data
             FROM taskseries ts, tasks t
             USING (list_id, taskseries_id)
             WHERE
                t.deleted != TRUE AND
                jsonb_extract(t.data, "$.completed") = "" AND
                jsonb_extract(ts.data, "$.parent_task_id") = ?
                "#;
        let data: Vec<Data> = sqlx::query_as(query)
            .bind(parent_id)
            .fetch_all(&self.pool)
            .await?;
        let mut result = RTMTasks {
            rev: Default::default(),
            list: Vec::new(),
        };
        for item in data {
            let mut list = RTMLists {
                id: item.list_id,
                taskseries: None,
            };
            let mut ts_json: serde_json::Value = serde_json::from_str(&item.ts_data).unwrap();
            let t_json: serde_json::Value =
                vec![serde_json::from_str::<serde_json::Value>(&item.t_data).unwrap()].into();
            ts_json
                .as_object_mut()
                .unwrap()
                .insert("task".to_string(), t_json);
            let ts: TaskSeries = serde_json::from_value(ts_json).unwrap();
            list.taskseries = Some(vec![ts]);
            result.list.push(list);
        }
        Ok(result)
    }

    /// Add a task and update the cache.
    pub async fn add_task(
        &self,
        timeline: &RTMTimeline,
        name: &str,
        list: Option<&RTMLists>,
        parent: Option<&Task>,
        external_id: Option<&str>,
        smart: bool,
    ) -> std::result::Result<Option<RTMLists>, crate::Error> {
        let result = self
            .api
            .add_task(timeline, name, list, parent, external_id, smart)
            .await?;
        self.sync().await?;
        Ok(result)
    }

    /// Get a new timeline
    pub async fn get_timeline(&self) -> std::result::Result<RTMTimeline, crate::Error> {
        self.api.get_timeline().await
    }
    /// Get lists
    pub async fn get_lists(&self) -> std::result::Result<Vec<RTMList>, crate::Error> {
        let items: Vec<(String, String)> = sqlx::query_as(
            r#"
            SELECT list_id, name FROM lists"#,
        )
        .fetch_all(&self.pool)
        .await?;
        Ok(items
            .into_iter()
            .map(|(id, name)| RTMList { id, name })
            .collect())
    }
    /// Mark complete
    pub async fn mark_complete(
        &self,
        timeline: &RTMTimeline,
        list: &RTMLists,
        taskseries: &TaskSeries,
        task: &Task,
    ) -> std::result::Result<Option<RTMTransaction>, crate::Error> {
        let result = self
            .api
            .mark_complete(timeline, list, taskseries, task)
            .await?;
        self.sync().await?;
        Ok(result)
    }
    /// Mark complete
    pub async fn mark_complete_id(
        &self,
        timeline: &RTMTimeline,
        list_id: &str,
        taskseries_id: &str,
        task_id: &str,
    ) -> std::result::Result<Option<RTMTransaction>, crate::Error> {
        let result = self
            .api
            .mark_complete_id(timeline, list_id, taskseries_id, task_id)
            .await?;
        self.sync().await?;
        Ok(result)
    }
    /// Undo transaction
    pub async fn undo_transaction(
        &self,
        timeline: &RTMTimeline,
        transaction_id: &str,
    ) -> std::result::Result<(), crate::Error> {
        self.api.undo_transaction(timeline, transaction_id).await
    }

    /// Return all tasks in a given list, according to the optional filter.
    pub async fn get_tasks_in_list(
        &self,
        list_id: &str,
        filt: &str,
    ) -> std::result::Result<RTMTasks, crate::Error> {
        let mut filter_clause = String::new();
        let mut filter_binds = vec![list_id.to_string()];
        if !filt.is_empty() {
            let filter = filter::parse_filter(filt)?;
            let mut context = filter::FilterContext {
                now: Local::now(),
                ..Default::default()
            };
            let lists = self.get_lists().await?;
            for list in lists {
                context.lists_name_to_id.insert(list.name, list.id);
            }
            let (clause, binds) = filter.to_sqlite_where_clause(&context)?;
            filter_clause = clause;
            filter_binds.extend(binds);

            log::info!("Filter clause: {filter_clause}");
        }

        #[derive(sqlx::FromRow)]
        struct Data {
            list_id: String,
            ts_data: String,
            t_data: String,
        }

        let query_str = format!(
            r#"SELECT ts.list_id, json(ts.data) as ts_data, json(t.data) as t_data
             FROM taskseries ts, tasks t
             USING (list_id, taskseries_id)
             WHERE
                t.deleted != TRUE AND
                list_id = ? AND
                {filter_clause};
                "#
        );
        let mut query = sqlx::query_as(&query_str);
        for bind in filter_binds {
            query = query.bind(bind);
        }
        let data: Vec<Data> = query.fetch_all(&self.pool).await?;
        let mut result = RTMTasks {
            rev: Default::default(),
            list: Vec::new(),
        };
        for item in data {
            let mut list = RTMLists {
                id: item.list_id,
                taskseries: None,
            };
            let mut ts_json: serde_json::Value = serde_json::from_str(&item.ts_data).unwrap();
            let t_json: serde_json::Value =
                vec![serde_json::from_str::<serde_json::Value>(&item.t_data).unwrap()].into();
            ts_json
                .as_object_mut()
                .unwrap()
                .insert("task".to_string(), t_json);
            let ts: TaskSeries = serde_json::from_value(ts_json).unwrap();
            list.taskseries = Some(vec![ts]);
            result.list.push(list);
        }
        Ok(result)
    }
}