sova-activity 0.1.0

Laravel-style activity / audit log for Sova
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

//! Activity log insert + list (sqlite).

use sova_activity::{
    list_activity, Activity, ActivityEntry, ActivityExt, ActivityFilter, ActivityLog,
    ActivityMigrator,
};
use sova_core::{Json, Request, ResponseAssert, TestClient};
use sova_testing::{SqliteTestDb, TestApp};
use serde_json::json;

#[tokio::test]
async fn insert_and_list_by_subject() {
    let tdb = SqliteTestDb::migrate::<ActivityMigrator>().await;
    let db = tdb.handle().await;

    ActivityLog::record(
        &db,
        ActivityEntry {
            actor_id: Some(1),
            subject_type: "user".into(),
            subject_id: "42".into(),
            event: "profile.updated".into(),
            properties: json!({ "name": { "old": "Ada", "new": "Ada Lovelace" } }),
            ip: Some("127.0.0.1".into()),
            user_agent: None,
        },
    )
    .await;

    ActivityLog::record(
        &db,
        ActivityEntry {
            actor_id: Some(1),
            subject_type: "user".into(),
            subject_id: "99".into(),
            event: "user.login".into(),
            properties: json!({}),
            ip: None,
            user_agent: None,
        },
    )
    .await;

    let rows = list_activity(
        &db,
        ActivityFilter {
            subject_type: Some("user".into()),
            subject_id: Some("42".into()),
            event: None,
            actor_id: None,
            limit: 50,
        },
    )
    .await
    .unwrap();
    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].event, "profile.updated");
    assert_eq!(rows[0].actor_id, Some(1));
}

#[tokio::test]
async fn mount_list_and_req_helper() {
    let (_db, app) = TestApp::builder()
        .migrator::<ActivityMigrator>()
        .install(Activity::new().mount("/activity"))
        .configure(|app| {
            app.post("/note", |req: Request| async move {
                req.log_activity("note.created", "note", 7, json!({ "title": "hi" }))
                    .await;
                Ok::<_, sova_core::Error>(Json(json!({ "ok": true })))
            });
        })
        .build()
        .await;

    let c = TestClient::tracked(app).unwrap();

    c.post("/note").await.assert_status(200);

    let list = c.get("/activity?subject_type=note&subject_id=7").await;
    list.assert_status(200);
    let body = list.json_value();
    let arr = body.as_array().expect("array");
    assert_eq!(arr.len(), 1);
    assert_eq!(arr[0]["event"], "note.created");
}

/// Properties must never carry password/hash-like keys in the public entry helper docs —
/// this unit check documents the redaction contract for callers.
#[test]
fn entry_properties_are_plain_json_not_secrets() {
    let entry = ActivityEntry {
        actor_id: None,
        subject_type: "user".into(),
        subject_id: "1".into(),
        event: "password.changed".into(),
        properties: json!({ "via": "profile" }),
        ip: None,
        user_agent: None,
    };
    let s = serde_json::to_string(&entry.properties).unwrap();
    assert!(!s.contains("password"));
    assert!(!s.contains("hash"));
    assert!(!s.contains("secret"));
}

#[tokio::test]
async fn list_filters_by_event_and_actor() {
    let tdb = SqliteTestDb::migrate::<ActivityMigrator>().await;
    let db = tdb.handle().await;

    ActivityLog::record(
        &db,
        ActivityEntry {
            actor_id: Some(7),
            subject_type: "note".into(),
            subject_id: "1".into(),
            event: "note.created".into(),
            properties: json!({}),
            ip: None,
            user_agent: None,
        },
    )
    .await;
    ActivityLog::record(
        &db,
        ActivityEntry {
            actor_id: Some(7),
            subject_type: "note".into(),
            subject_id: "1".into(),
            event: "note.updated".into(),
            properties: json!({}),
            ip: None,
            user_agent: None,
        },
    )
    .await;
    ActivityLog::record(
        &db,
        ActivityEntry {
            actor_id: Some(9),
            subject_type: "note".into(),
            subject_id: "1".into(),
            event: "note.created".into(),
            properties: json!({}),
            ip: None,
            user_agent: None,
        },
    )
    .await;

    let by_event = list_activity(
        &db,
        ActivityFilter {
            subject_type: None,
            subject_id: None,
            event: Some("note.created".into()),
            actor_id: Some(7),
            limit: 50,
        },
    )
    .await
    .unwrap();
    assert_eq!(by_event.len(), 1);
    assert_eq!(by_event[0].actor_id, Some(7));
    assert_eq!(by_event[0].event, "note.created");
}