aven-core 0.1.28

Core library for the Aven local-first task manager
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
use anyhow::{Result, bail};
use chrono::{DateTime, Utc};

use crate::choices::TaskStatus;
use crate::db::Database;
use crate::ids::{TaskId, WorkspaceId};
use crate::recurrence::RecurrenceSeriesId;
use crate::refs::DisplayRefContext;
use crate::types::Task;

mod database_stats;
mod dependencies;
mod details;
mod doctor;
pub mod fragments;
mod hydration;
mod projects;
mod recent_actions;
mod recurrence;
mod related;
mod search;
mod sidebar;
mod sorting;
mod sync_history;
mod tasks;
#[cfg(test)]
mod test_support;
mod types;

pub use database_stats::{DatabaseStats, DatabaseStatsPriorityCounts, DatabaseStatsStatusCounts};
pub use dependencies::{TaskDependencyItem, TaskDependencySummary};
pub(crate) use dependencies::{task_dependency_summary, task_dependency_summary_with_display_refs};
pub use details::{TaskDetail, TaskDetailConflict};
pub(crate) use details::{conflict_display_value, task_detail, task_detail_with_display_refs};
pub use doctor::WorkspaceTaskCounts;
pub(crate) use doctor::{unresolved_conflict_count, workspace_task_counts};
pub(crate) use projects::list_project_items_in_workspace;
pub(crate) use recent_actions::{
    list_recent_actions_in_workspace, task_activity_for_tasks_in_workspace,
};
pub(crate) use recurrence::task_recurrence_summaries;
pub use related::TaskRelatedLink;
pub(crate) use related::{related_links_for_tasks, task_related_links};
pub use search::{
    SearchMatchedField, TaskSearchPreviewResultSet, TaskSearchQuery, TaskSearchResult,
};
pub(crate) use search::{
    search_task_items_in_workspace, search_task_occurrence_items_in_workspace,
    search_task_preview_set_in_workspace,
};
pub(crate) use sidebar::sidebar_counts_for_scope_in_workspace;
pub use sync_history::SyncHistoryStats;
pub(crate) use sync_history::sync_history_stats;
pub(crate) use tasks::{
    list_bulk_update_task_items_in_workspace, list_task_items_in_workspace,
    list_task_items_with_display_refs, list_task_items_without_activity_in_workspace,
    list_task_summary_items_in_workspace,
};
pub use types::RecentActionTarget;
pub use types::{
    AttachmentMetadata, EpicRollup, MetadataFilter, ProjectListItem, RecentActionItem,
    RecurrenceCounts, RecurrenceHistoryEntry, RecurrenceHistoryKind, RecurrenceHistoryPage,
    RecurrenceOccurrenceLink, RecurrenceReconciliation, RecurrenceSeriesConflict,
    RecurrenceSeriesDetail, RecurrenceSeriesLifecycleFilter, RecurrenceSeriesListItem,
    RecurrenceSeriesListQuery, RecurrenceSeriesSummary, RecurrenceTaskGroup, SidebarCounts,
    SortDirection, TaskAvailabilityFilter, TaskDependencyLink, TaskFilters, TaskIdFilter,
    TaskItemHydration, TaskListItem, TaskNote, TaskQueryMode, TaskRecurrenceSummary, TaskSort,
};

pub const MAX_RECURRENCE_HISTORY_LIMIT: usize = 500;

pub(crate) fn status_order(status: TaskStatus) -> u8 {
    match status {
        TaskStatus::Active => 0,
        TaskStatus::Todo => 1,
        TaskStatus::Inbox => 2,
        TaskStatus::Backlog => 3,
        TaskStatus::Done => 4,
        TaskStatus::Canceled => 5,
    }
}

fn validate_search_limit(limit: usize) -> Result<()> {
    if limit == 0 {
        bail!("error search-limit-invalid limit=0 min=1 hint=\"pass a limit of 1 or greater\"");
    }
    Ok(())
}

fn validate_recurrence_history_limit(limit: usize) -> Result<()> {
    if !(1..=MAX_RECURRENCE_HISTORY_LIMIT).contains(&limit) {
        bail!(
            "error recurrence-history-limit-invalid limit={} min=1 max={} hint=\"pass a limit between 1 and {}\"",
            limit,
            MAX_RECURRENCE_HISTORY_LIMIT,
            MAX_RECURRENCE_HISTORY_LIMIT
        );
    }
    Ok(())
}

impl Database {
    /// Reconciles recurrence projections before a report reads current state.
    ///
    /// The candidate count is bounded. Each changed series writes one atomic projection
    /// transaction that can archive one superseded task and materialize one successor.
    pub async fn reconcile_recurrence_reports_at(
        &self,
        workspace_id: &WorkspaceId,
        at: DateTime<Utc>,
    ) -> Result<RecurrenceReconciliation> {
        let (workspace, candidates, incomplete) = {
            let mut conn = self.acquire_reader().await?;
            let workspace = crate::workspaces::workspace_for_id(&mut conn, workspace_id).await?;
            let (candidates, incomplete) =
                recurrence::recurrence_reconciliation_candidates(&mut conn, workspace_id, at)
                    .await?;
            (workspace, candidates, incomplete)
        };
        let mut report = RecurrenceReconciliation {
            workspace_id: Some(workspace_id.clone()),
            examined: candidates.len(),
            incomplete,
            ..RecurrenceReconciliation::default()
        };
        for series_id in candidates {
            let result = self
                .reconcile_recurrence_series(&workspace, &series_id, at)
                .await?;
            report.changed += usize::from(result.changed);
            report.lifecycle_blocked += usize::from(result.lifecycle_blocked);
        }
        recurrence::validate_reconciliation(&report)?;
        Ok(report)
    }

    pub async fn reconcile_recurrence_reports(
        &self,
        workspace_id: &WorkspaceId,
    ) -> Result<RecurrenceReconciliation> {
        let at = crate::ids::now_utc();
        self.reconcile_recurrence_reports_at(workspace_id, at).await
    }

    pub async fn list_recurrence_series_view_at(
        &self,
        workspace_id: &WorkspaceId,
        at: DateTime<Utc>,
        query: RecurrenceSeriesListQuery,
    ) -> Result<Vec<RecurrenceSeriesListItem>> {
        self.reconcile_recurrence_reports_at(workspace_id, at)
            .await?;
        self.list_recurrence_series_view_from_current_projection(workspace_id, query)
            .await
    }

    /// Reads the persisted recurrence projection as-is.
    ///
    /// Callers establish projection currency by reconciling the workspace for the report snapshot.
    #[doc(hidden)]
    pub async fn list_recurrence_series_view_from_current_projection(
        &self,
        workspace_id: &WorkspaceId,
        query: RecurrenceSeriesListQuery,
    ) -> Result<Vec<RecurrenceSeriesListItem>> {
        let mut conn = self.acquire_reader().await?;
        recurrence::list_recurrence_series_view(&mut conn, workspace_id, &query).await
    }

    pub async fn list_recurrence_series_view(
        &self,
        workspace_id: &WorkspaceId,
        query: RecurrenceSeriesListQuery,
    ) -> Result<Vec<RecurrenceSeriesListItem>> {
        let at = crate::ids::now_utc();
        self.list_recurrence_series_view_at(workspace_id, at, query)
            .await
    }

    pub async fn list_recurrence_series_at(
        &self,
        workspace_id: &WorkspaceId,
        at: DateTime<Utc>,
    ) -> Result<Vec<RecurrenceSeriesSummary>> {
        self.reconcile_recurrence_reports_at(workspace_id, at)
            .await?;
        let mut conn = self.acquire_reader().await?;
        recurrence::list_recurrence_series(&mut conn, workspace_id, at).await
    }

    pub async fn recurrence_series_detail_at(
        &self,
        workspace_id: &WorkspaceId,
        series_id: &RecurrenceSeriesId,
        at: DateTime<Utc>,
    ) -> Result<RecurrenceSeriesDetail> {
        self.reconcile_recurrence_reports_at(workspace_id, at)
            .await?;
        self.recurrence_series_detail_at_from_current_projection(workspace_id, series_id, at)
            .await
    }

    /// Reads the persisted recurrence projection as-is.
    ///
    /// Callers establish projection currency by reconciling the workspace for the report snapshot.
    #[doc(hidden)]
    pub async fn recurrence_series_detail_at_from_current_projection(
        &self,
        workspace_id: &WorkspaceId,
        series_id: &RecurrenceSeriesId,
        at: DateTime<Utc>,
    ) -> Result<RecurrenceSeriesDetail> {
        let mut conn = self.acquire_reader().await?;
        recurrence::recurrence_series_detail(&mut conn, workspace_id, series_id, at).await
    }

    pub async fn recurrence_history_at(
        &self,
        workspace_id: &WorkspaceId,
        series_id: &RecurrenceSeriesId,
        at: DateTime<Utc>,
        offset: usize,
        limit: usize,
    ) -> Result<RecurrenceHistoryPage> {
        validate_recurrence_history_limit(limit)?;
        self.reconcile_recurrence_reports_at(workspace_id, at)
            .await?;
        let mut conn = self.acquire_reader().await?;
        recurrence::recurrence_history(&mut conn, workspace_id, series_id, at, offset, limit).await
    }

    pub async fn list_recurrence_series(
        &self,
        workspace_id: &WorkspaceId,
    ) -> Result<Vec<RecurrenceSeriesSummary>> {
        let at = crate::ids::now_utc();
        self.list_recurrence_series_at(workspace_id, at).await
    }

    pub async fn recurrence_series_detail(
        &self,
        workspace_id: &WorkspaceId,
        series_id: &RecurrenceSeriesId,
    ) -> Result<RecurrenceSeriesDetail> {
        let at = crate::ids::now_utc();
        self.recurrence_series_detail_at(workspace_id, series_id, at)
            .await
    }

    /// Reads the persisted recurrence projection as-is.
    ///
    /// Callers establish projection currency by reconciling the workspace for the report snapshot.
    #[doc(hidden)]
    pub async fn recurrence_series_detail_from_current_projection(
        &self,
        workspace_id: &WorkspaceId,
        series_id: &RecurrenceSeriesId,
    ) -> Result<RecurrenceSeriesDetail> {
        let at = crate::ids::now_utc();
        self.recurrence_series_detail_at_from_current_projection(workspace_id, series_id, at)
            .await
    }

    pub async fn recurrence_history(
        &self,
        workspace_id: &WorkspaceId,
        series_id: &RecurrenceSeriesId,
        offset: usize,
        limit: usize,
    ) -> Result<RecurrenceHistoryPage> {
        let at = crate::ids::now_utc();
        self.recurrence_history_at(workspace_id, series_id, at, offset, limit)
            .await
    }

    pub async fn list_project_items(
        &self,
        workspace_id: &WorkspaceId,
    ) -> Result<Vec<ProjectListItem>> {
        self.reconcile_recurrence_reports(workspace_id).await?;
        self.list_project_items_from_current_projection(workspace_id)
            .await
    }

    /// Reads the persisted recurrence projection as-is.
    ///
    /// Callers establish projection currency by reconciling the workspace for the report snapshot.
    #[doc(hidden)]
    pub async fn list_project_items_from_current_projection(
        &self,
        workspace_id: &WorkspaceId,
    ) -> Result<Vec<ProjectListItem>> {
        let mut conn = self.acquire_reader().await?;
        list_project_items_in_workspace(&mut conn, workspace_id).await
    }

    pub async fn list_task_items(
        &self,
        workspace_id: &WorkspaceId,
        filters: TaskFilters,
        mode: TaskQueryMode,
        sort: TaskSort,
        direction: SortDirection,
    ) -> Result<Vec<TaskListItem>> {
        self.reconcile_recurrence_reports(workspace_id).await?;
        self.list_task_items_from_current_projection(workspace_id, filters, mode, sort, direction)
            .await
    }

    pub async fn list_bulk_update_task_items(
        &self,
        workspace_id: &WorkspaceId,
        filters: TaskFilters,
        mode: TaskQueryMode,
        sort: TaskSort,
        direction: SortDirection,
    ) -> Result<Vec<TaskListItem>> {
        self.reconcile_recurrence_reports(workspace_id).await?;
        let mut conn = self.acquire_reader().await?;
        list_bulk_update_task_items_in_workspace(
            &mut conn,
            workspace_id,
            filters,
            mode,
            sort,
            direction,
        )
        .await
    }

    /// Reads the persisted recurrence projection as-is.
    ///
    /// Callers establish projection currency by reconciling the workspace for the report snapshot.
    #[doc(hidden)]
    pub async fn list_task_items_from_current_projection(
        &self,
        workspace_id: &WorkspaceId,
        filters: TaskFilters,
        mode: TaskQueryMode,
        sort: TaskSort,
        direction: SortDirection,
    ) -> Result<Vec<TaskListItem>> {
        let mut conn = self.acquire_reader().await?;
        list_task_items_in_workspace(&mut conn, workspace_id, filters, mode, sort, direction).await
    }

    pub async fn list_task_items_without_activity_from_current_projection(
        &self,
        workspace_id: &WorkspaceId,
        filters: TaskFilters,
        mode: TaskQueryMode,
        sort: TaskSort,
        direction: SortDirection,
    ) -> Result<Vec<TaskListItem>> {
        let mut conn = self.acquire_reader().await?;
        list_task_items_without_activity_in_workspace(
            &mut conn,
            workspace_id,
            filters,
            mode,
            sort,
            direction,
        )
        .await
    }

    pub async fn list_task_summary_items(
        &self,
        workspace_id: &WorkspaceId,
        filters: TaskFilters,
        mode: TaskQueryMode,
        sort: TaskSort,
        direction: SortDirection,
        limit: Option<usize>,
    ) -> Result<Vec<TaskListItem>> {
        self.reconcile_recurrence_reports(workspace_id).await?;
        self.list_task_summary_items_from_current_projection(
            workspace_id,
            filters,
            mode,
            sort,
            direction,
            limit,
        )
        .await
    }

    /// Reads the persisted task projection as-is.
    ///
    /// Callers establish projection currency by reconciling the workspace for the report snapshot.
    #[doc(hidden)]
    pub async fn list_task_summary_items_from_current_projection(
        &self,
        workspace_id: &WorkspaceId,
        filters: TaskFilters,
        mode: TaskQueryMode,
        sort: TaskSort,
        direction: SortDirection,
        limit: Option<usize>,
    ) -> Result<Vec<TaskListItem>> {
        let mut conn = self.acquire_reader().await?;
        list_task_summary_items_in_workspace(
            &mut conn,
            workspace_id,
            filters,
            mode,
            sort,
            direction,
            limit,
        )
        .await
    }

    pub async fn sidebar_counts_for_scope(
        &self,
        workspace_id: &WorkspaceId,
        project_key: Option<&str>,
    ) -> Result<SidebarCounts> {
        self.reconcile_recurrence_reports(workspace_id).await?;
        self.sidebar_counts_for_scope_from_current_projection(workspace_id, project_key)
            .await
    }

    /// Reads the persisted recurrence projection as-is.
    ///
    /// Callers establish projection currency by reconciling the workspace for the report snapshot.
    #[doc(hidden)]
    pub async fn sidebar_counts_for_scope_from_current_projection(
        &self,
        workspace_id: &WorkspaceId,
        project_key: Option<&str>,
    ) -> Result<SidebarCounts> {
        let mut conn = self.acquire_reader().await?;
        sidebar_counts_for_scope_in_workspace(&mut conn, workspace_id, project_key).await
    }

    pub async fn list_recent_actions(
        &self,
        workspace_id: &WorkspaceId,
        project_scope: Option<&str>,
    ) -> Result<Vec<RecentActionItem>> {
        self.reconcile_recurrence_reports(workspace_id).await?;
        self.list_recent_actions_from_current_projection(workspace_id, project_scope)
            .await
    }

    /// Reads the persisted recurrence projection as-is.
    ///
    /// Callers establish projection currency by reconciling the workspace for the report snapshot.
    #[doc(hidden)]
    pub async fn list_recent_actions_from_current_projection(
        &self,
        workspace_id: &WorkspaceId,
        project_scope: Option<&str>,
    ) -> Result<Vec<RecentActionItem>> {
        let mut conn = self.acquire_reader().await?;
        list_recent_actions_in_workspace(&mut conn, workspace_id, project_scope).await
    }

    pub async fn task_activity_for_task(
        &self,
        workspace_id: &WorkspaceId,
        task_id: &TaskId,
    ) -> Result<Vec<RecentActionItem>> {
        let mut conn = self.acquire_reader().await?;
        Ok(task_activity_for_tasks_in_workspace(
            &mut conn,
            workspace_id,
            std::slice::from_ref(task_id),
        )
        .await?
        .remove(task_id)
        .unwrap_or_default())
    }

    pub async fn search_task_items(
        &self,
        workspace_id: &WorkspaceId,
        query: TaskSearchQuery,
    ) -> Result<Vec<TaskSearchResult>> {
        validate_search_limit(query.limit)?;
        self.reconcile_recurrence_reports(workspace_id).await?;
        let mut conn = self.acquire_reader().await?;
        search_task_items_in_workspace(&mut conn, workspace_id, query).await
    }

    pub async fn search_task_occurrence_items(
        &self,
        workspace_id: &WorkspaceId,
        query: TaskSearchQuery,
    ) -> Result<Vec<TaskSearchResult>> {
        validate_search_limit(query.limit)?;
        self.reconcile_recurrence_reports(workspace_id).await?;
        let mut conn = self.acquire_reader().await?;
        search_task_occurrence_items_in_workspace(&mut conn, workspace_id, query).await
    }

    pub async fn search_task_preview_set(
        &self,
        workspace_id: &WorkspaceId,
        query: TaskSearchQuery,
    ) -> Result<TaskSearchPreviewResultSet> {
        validate_search_limit(query.limit)?;
        self.reconcile_recurrence_reports(workspace_id).await?;
        self.search_task_preview_set_from_current_projection(workspace_id, query)
            .await
    }

    /// Reads the persisted recurrence projection as-is.
    ///
    /// Callers establish projection currency by reconciling the workspace for the report snapshot.
    #[doc(hidden)]
    pub async fn search_task_preview_set_from_current_projection(
        &self,
        workspace_id: &WorkspaceId,
        query: TaskSearchQuery,
    ) -> Result<TaskSearchPreviewResultSet> {
        validate_search_limit(query.limit)?;
        let mut conn = self.acquire_reader().await?;
        search_task_preview_set_in_workspace(&mut conn, workspace_id, query).await
    }

    pub async fn task_detail(&self, task: &Task) -> Result<TaskDetail> {
        self.reconcile_recurrence_reports(&task.workspace_id)
            .await?;
        let mut conn = self.acquire_reader().await?;
        task_detail(&mut conn, task).await
    }

    pub async fn task_detail_with_display_refs(
        &self,
        task: &Task,
        display_refs: &DisplayRefContext,
    ) -> Result<TaskDetail> {
        self.reconcile_recurrence_reports(&task.workspace_id)
            .await?;
        let mut conn = self.acquire_reader().await?;
        task_detail_with_display_refs(&mut conn, task, display_refs).await
    }

    pub async fn conflict_display_value(
        &self,
        workspace_id: &WorkspaceId,
        field: &str,
        value: &str,
    ) -> Result<String> {
        let mut conn = self.acquire_reader().await?;
        conflict_display_value(&mut conn, workspace_id, field, value).await
    }

    pub async fn task_dependency_summary(
        &self,
        workspace_id: &WorkspaceId,
        task_id: &TaskId,
    ) -> Result<TaskDependencySummary> {
        let mut conn = self.acquire_reader().await?;
        task_dependency_summary(&mut conn, workspace_id, task_id).await
    }

    pub async fn task_related_links(
        &self,
        workspace_id: &WorkspaceId,
        task_id: &TaskId,
    ) -> Result<Vec<TaskRelatedLink>> {
        let mut conn = self.acquire_reader().await?;
        task_related_links(&mut conn, workspace_id, task_id, None).await
    }

    pub async fn workspace_task_counts(
        &self,
        workspace_id: &WorkspaceId,
    ) -> Result<WorkspaceTaskCounts> {
        let mut conn = self.acquire_reader().await?;
        workspace_task_counts(&mut conn, workspace_id).await
    }

    pub async fn unresolved_conflict_count(&self) -> Result<i64> {
        let mut conn = self.acquire_reader().await?;
        unresolved_conflict_count(&mut conn).await
    }

    pub async fn sync_history_stats(&self) -> Result<SyncHistoryStats> {
        let mut conn = self.acquire_reader().await?;
        sync_history_stats(&mut conn).await
    }

    pub async fn database_stats(
        &self,
        workspace: &crate::workspaces::Workspace,
    ) -> Result<DatabaseStats> {
        let mut conn = self.acquire_reader().await?;
        database_stats::database_stats(&mut conn, workspace).await
    }
}