sofie-db 0.4.0

The handler model (inputs, events, replies), aggregates, read models, the query builder, the unit of work, migrations, the worker and the database seam.
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

use std::sync::Arc;

use serde_json::Value;
use sofie_auth::SigningKeys;
use sofie_core::{Error, Result, Uuid};

use crate::{Actor, Claimed, Context, Db, Outcome, Reach, Step, Writes};

pub struct JobContext {
    pub(crate) db: Db,
    pub(crate) payload: Value,
    event: Option<&'static str>,
    pub(crate) actor: Option<Actor>,
    completion: Step,
    #[cfg(feature = "remote-contracts")]
    pub(crate) message: sofie_core::Uuid,
    /// Keyed by the message's id, so a retry gets the same key.
    #[cfg(feature = "idempotency")]
    pub(crate) work: crate::Work,
    #[cfg(feature = "contracts")]
    pub(crate) retried_for: std::time::Duration,
}

impl JobContext {
    pub(super) fn new(
        worker: &super::Worker,
        message: &Claimed,
        event: Option<&'static str>,
        completion: Step,
    ) -> Self {
        Self {
            db: worker.db.clone(),
            payload: message.payload.clone(),
            event,
            actor: message.actor.clone(),
            completion,
            #[cfg(feature = "remote-contracts")]
            message: message.id,
            #[cfg(feature = "idempotency")]
            work: crate::Work::new(message.id.to_string(), message.name.clone()),
            #[cfg(feature = "contracts")]
            retried_for: super::backoff::retried_for(worker.max_attempts),
        }
    }

    /// The keys requests sign links with, so a job's links open the same routes.
    pub fn signing_keys(&self) -> Result<Arc<SigningKeys>> {
        self.db.signing_keys().ok_or_else(|| {
            Error::internal_message(
                "the worker's database has no signing keys; give it the app's with \
                 `Db::with_signing_keys`",
            )
        })
    }

    pub(crate) async fn complete(self, outcome: &mut dyn Outcome) -> Result<()> {
        let reach = self.reach();
        self.db
            .commit_with(outcome, vec![self.completion], reach)
            .await
    }
}

/// A job reaches every record, as the principal whose action queued it if one did.
impl Context for JobContext {
    fn db(&self) -> &Db {
        &self.db
    }

    fn reach(&self) -> Reach {
        self.actor
            .as_ref()
            .map_or(Reach::All, |actor| Reach::AllAs(actor.principal))
    }

    /// The framework wrote the payload, so a missing id is its fault, not a lookup's.
    fn bound(&self, name: &str) -> Result<Uuid> {
        self.payload
            .get(name)
            .and_then(Value::as_str)
            .and_then(|text| text.parse().ok())
            .ok_or_else(|| Error::internal_message(format!("the payload has no id named `{name}`")))
    }

    #[cfg(feature = "jobs")]
    fn input(&mut self) -> Result<Value> {
        Ok(self.payload.clone())
    }

    fn event(&self, name: &str) -> Result<Value> {
        match self.event {
            Some(delivered) if delivered == name => Ok(self.payload.clone()),
            Some(delivered) => Err(Error::internal_message(format!(
                "this listener receives `{delivered}`, so it cannot take a `{name}`"
            ))),
            None => Err(Error::internal_message(format!(
                "a scheduled job receives no event, so it cannot take a `{name}`"
            ))),
        }
    }
}

impl Writes for JobContext {}