runledger-runtime 0.5.0

Async worker, scheduler, and reaper runtime for the Runledger job system
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
use std::collections::BTreeMap;
use std::sync::Arc;

use runledger_core::jobs::{JobHandler, JobHandlerRegistry, JobType, JobTypeName};
use runledger_postgres::jobs::JobDefinitionUpsert;

use crate::registry::JobRegistry;

use super::schedule_spec::{CatalogJobScheduleSpec, StoredCatalogJobScheduleSpec};
use super::types::CatalogJob;
use super::{
    CatalogError, JobCatalog, JobCatalogDefaults, JobCatalogDefinitionOverrides,
    JobCatalogSyncScope,
};

impl JobCatalog {
    /// Creates an empty catalog with default definition values.
    #[must_use]
    pub fn new() -> Self {
        Self {
            defaults: JobCatalogDefaults::default(),
            jobs: BTreeMap::new(),
            schedules: Vec::new(),
        }
    }

    /// Replaces the definition defaults used by subsequent sync operations.
    #[must_use]
    pub fn defaults(mut self, defaults: JobCatalogDefaults) -> Self {
        self.defaults = defaults;
        self
    }

    /// Registers a handler after validating declared and handler job types match.
    ///
    /// # Errors
    /// Returns [`CatalogError`] when job types are blank, mismatched, or duplicated.
    pub fn try_job<H>(mut self, job_type: &'static str, handler: H) -> Result<Self, CatalogError>
    where
        H: JobHandler + 'static,
    {
        let declared = Self::validate_declared_job_type(job_type)?;
        let handler_type = Self::validate_handler_job_type(&handler)?;
        if declared != handler_type {
            return Err(CatalogError::HandlerJobTypeMismatch {
                declared: declared.as_str().to_owned(),
                handler: handler_type.as_str().to_owned(),
            });
        }

        let key = JobTypeName::new(job_type).map_err(|source| CatalogError::InvalidJobType {
            job_type: job_type.to_owned(),
            source,
        })?;
        if self.jobs.contains_key(&key) {
            return Err(CatalogError::DuplicateJobType {
                job_type: job_type.to_owned(),
            });
        }

        self.jobs.insert(
            key,
            CatalogJob {
                job_type: declared,
                handler: Arc::new(handler),
                definition_overrides: JobCatalogDefinitionOverrides::new(),
                retry_delay_overrides: BTreeMap::new(),
            },
        );
        Ok(self)
    }

    /// Registers a handler, panicking when validation fails.
    #[must_use]
    pub fn job<H>(self, job_type: &'static str, handler: H) -> Self
    where
        H: JobHandler + 'static,
    {
        self.try_job(job_type, handler).unwrap_or_else(|error| {
            panic!("invalid job catalog registration for {job_type:?}: {error}");
        })
    }

    /// Registers a handler with job-specific definition overrides.
    ///
    /// # Errors
    /// Returns [`CatalogError`] when job types are blank, mismatched, or duplicated.
    pub fn try_job_with_definition_overrides<H>(
        self,
        job_type: &'static str,
        handler: H,
        overrides: JobCatalogDefinitionOverrides,
    ) -> Result<Self, CatalogError>
    where
        H: JobHandler + 'static,
    {
        self.try_job(job_type, handler)?
            .try_definition_overrides(job_type, overrides)
    }

    /// Registers a handler with job-specific definition overrides, panicking
    /// when validation fails.
    #[must_use]
    pub fn job_with_definition_overrides<H>(
        self,
        job_type: &'static str,
        handler: H,
        overrides: JobCatalogDefinitionOverrides,
    ) -> Self
    where
        H: JobHandler + 'static,
    {
        self.try_job_with_definition_overrides(job_type, handler, overrides)
            .unwrap_or_else(|error| {
                panic!(
                    "invalid job catalog registration with definition overrides for {job_type:?}: {error}"
                );
            })
    }

    /// Replaces the definition overrides for one registered catalog job.
    ///
    /// # Errors
    /// Returns [`CatalogError::UnknownJobType`] when the job type is not registered.
    pub fn try_definition_overrides(
        mut self,
        job_type: &str,
        overrides: JobCatalogDefinitionOverrides,
    ) -> Result<Self, CatalogError> {
        let key = self.require_job_key(job_type)?;
        overrides
            .validate()
            .map_err(|field| CatalogError::InvalidJobDefinitionValue {
                job_type: job_type.to_owned(),
                field,
            })?;
        self.jobs
            .get_mut(&key)
            .expect("job key validated")
            .definition_overrides = overrides;
        Ok(self)
    }

    /// Replaces the definition overrides for one registered catalog job,
    /// panicking when validation fails.
    #[must_use]
    pub fn definition_overrides(
        self,
        job_type: &str,
        overrides: JobCatalogDefinitionOverrides,
    ) -> Self {
        self.try_definition_overrides(job_type, overrides)
            .unwrap_or_else(|error| {
                panic!("invalid definition overrides for job type {job_type:?}: {error}");
            })
    }

    /// Registers a retry-delay override for a catalog job type.
    ///
    /// # Errors
    /// Returns [`CatalogError`] when the job type is unknown or override values are invalid.
    pub fn try_retry_delay_override(
        mut self,
        job_type: &str,
        failure_code: &'static str,
        retry_delay_ms: i32,
    ) -> Result<Self, CatalogError> {
        let key = self.require_job_key(job_type)?;
        Self::validate_failure_code(failure_code)?;
        Self::validate_retry_delay(retry_delay_ms)?;
        self.jobs
            .get_mut(&key)
            .expect("job key validated")
            .retry_delay_overrides
            .insert(failure_code, retry_delay_ms);
        Ok(self)
    }

    /// Registers a retry-delay override, panicking when validation fails.
    #[must_use]
    pub fn retry_delay_override(
        self,
        job_type: &str,
        failure_code: &'static str,
        retry_delay_ms: i32,
    ) -> Self {
        self.try_retry_delay_override(job_type, failure_code, retry_delay_ms)
            .unwrap_or_else(|error| {
                panic!(
                    "invalid retry delay override for job type {job_type:?}, failure code {failure_code:?}: {error}"
                );
            })
    }

    /// Registers a catalog-owned schedule after validating its shape and job type.
    ///
    /// Registered schedules are used by [`Self::sync_schedules`] and
    /// [`Self::sync_schedules_exact`]. The referenced job must already be
    /// registered on this builder and effectively enabled.
    ///
    /// # Errors
    /// Returns [`CatalogError`] when the schedule spec is invalid, the job type
    /// is unknown or disabled, or the schedule name is already registered.
    pub fn try_schedule(mut self, spec: CatalogJobScheduleSpec<'_>) -> Result<Self, CatalogError> {
        spec.validate_shape()
            .map_err(|field| CatalogError::InvalidScheduleSpec {
                name: spec.name.to_owned(),
                field,
            })?;
        self.require_catalog_enabled_job_type(spec.job_type)?;

        if self.schedules.iter().any(|stored| stored.name == spec.name) {
            return Err(CatalogError::DuplicateScheduleName {
                name: spec.name.to_owned(),
            });
        }

        self.schedules
            .push(StoredCatalogJobScheduleSpec::from(&spec));
        Ok(self)
    }

    /// Registers a catalog-owned schedule, panicking when validation fails.
    ///
    /// Use [`Self::try_schedule`] when registration data is not static or should
    /// be reported as a recoverable startup error.
    #[must_use]
    pub fn schedule(self, spec: CatalogJobScheduleSpec<'_>) -> Self {
        self.try_schedule(spec).unwrap_or_else(|error| {
            panic!("invalid job catalog schedule registration: {error}");
        })
    }

    /// Converts the catalog into a runtime [`JobRegistry`].
    ///
    /// Disabled catalog jobs still register handlers so workers can process
    /// already-queued work and dead-letter hooks.
    #[must_use]
    pub fn to_registry(&self) -> JobRegistry {
        let mut registry = JobRegistry::new();
        for entry in self.jobs.values() {
            registry.register_boxed(Arc::clone(&entry.handler));
            for (failure_code, retry_delay_ms) in &entry.retry_delay_overrides {
                registry.register_retry_delay_override(
                    entry.job_type,
                    failure_code,
                    *retry_delay_ms,
                );
            }
        }
        registry
    }

    /// Returns whether the catalog has a registered job type.
    #[must_use]
    pub fn contains(&self, job_type: JobType<'_>) -> bool {
        self.jobs.contains_key(job_type.as_str())
    }

    /// Returns a catalog job type when it is registered.
    ///
    /// # Errors
    /// Returns [`CatalogError::UnknownJobType`] when the name is not in the catalog.
    pub fn require_job_type(&self, job_type: &str) -> Result<JobType<'static>, CatalogError> {
        let key = self.require_job_key(job_type)?;
        Ok(self.jobs.get(&key).expect("job key validated").job_type)
    }

    /// Returns a catalog job type when it is registered and catalog-enabled.
    ///
    /// This checks catalog configuration only. It does not read `job_definitions`;
    /// operator-disabled database rows are enforced later by persistence APIs.
    /// Job-specific definition overrides take precedence over the catalog
    /// default enabled flag when present.
    ///
    /// # Errors
    /// Returns [`CatalogError::UnknownJobType`] or [`CatalogError::DisabledJobType`].
    pub fn require_catalog_enabled_job_type(
        &self,
        job_type: &str,
    ) -> Result<JobType<'static>, CatalogError> {
        let key = self.require_job_key(job_type)?;
        let entry = self.jobs.get(&key).expect("job key validated");
        if !self.effective_defaults(entry).is_enabled {
            return Err(CatalogError::DisabledJobType {
                job_type: entry.job_type.as_str().to_owned(),
            });
        }
        Ok(entry.job_type)
    }

    pub(super) fn validate_defaults(&self) -> Result<(), CatalogError> {
        self.defaults
            .validate()
            .map_err(|field| CatalogError::InvalidDefinitionValue { field })?;

        for entry in self.jobs.values() {
            self.effective_defaults(entry).validate().map_err(|field| {
                CatalogError::InvalidJobDefinitionValue {
                    job_type: entry.job_type.as_str().to_owned(),
                    field,
                }
            })?;
        }

        Ok(())
    }

    pub(super) fn validate_exact_sync_scope(
        &self,
        scope: &JobCatalogSyncScope,
    ) -> Result<(), CatalogError> {
        if self.jobs.is_empty() {
            return Err(CatalogError::EmptyExactSyncCatalog);
        }

        for entry in self.jobs.values() {
            if !scope.contains(entry.job_type) {
                return Err(CatalogError::JobTypeOutsideExactSyncScope {
                    job_type: entry.job_type.as_str().to_owned(),
                });
            }
        }

        Ok(())
    }

    pub(super) fn materialize_definition(
        &self,
        entry: &CatalogJob,
    ) -> JobDefinitionUpsert<'static> {
        let defaults = self.effective_defaults(entry);
        JobDefinitionUpsert {
            job_type: entry.job_type,
            version: defaults.version,
            max_attempts: defaults.max_attempts,
            default_timeout_seconds: defaults.default_timeout_seconds,
            default_priority: defaults.default_priority,
            is_enabled: defaults.is_enabled,
        }
    }

    pub(super) fn effective_defaults(&self, entry: &CatalogJob) -> JobCatalogDefaults {
        entry.definition_overrides.apply_to(self.defaults)
    }

    pub(super) fn require_job_key(&self, job_type: &str) -> Result<JobTypeName, CatalogError> {
        let key = JobTypeName::new(job_type).map_err(|source| CatalogError::InvalidJobType {
            job_type: job_type.to_owned(),
            source,
        })?;
        if self.jobs.contains_key(&key) {
            Ok(key)
        } else {
            Err(CatalogError::UnknownJobType {
                job_type: job_type.to_owned(),
            })
        }
    }

    fn validate_declared_job_type(
        job_type: &'static str,
    ) -> Result<JobType<'static>, CatalogError> {
        JobType::try_new(job_type).map_err(|source| CatalogError::InvalidJobType {
            job_type: job_type.to_owned(),
            source,
        })
    }

    fn validate_handler_job_type<H: JobHandler + ?Sized>(
        handler: &H,
    ) -> Result<JobType<'static>, CatalogError> {
        let handler_job_type = handler.job_type();
        JobType::try_new(handler_job_type.as_str()).map_err(|source| {
            CatalogError::InvalidHandlerJobType {
                handler_job_type: handler_job_type.as_str().to_owned(),
                source,
            }
        })
    }

    fn validate_failure_code(failure_code: &str) -> Result<(), CatalogError> {
        if failure_code.trim().is_empty() {
            Err(CatalogError::InvalidFailureCode)
        } else {
            Ok(())
        }
    }

    fn validate_retry_delay(retry_delay_ms: i32) -> Result<(), CatalogError> {
        if retry_delay_ms <= 0 {
            Err(CatalogError::InvalidRetryDelay)
        } else {
            Ok(())
        }
    }
}

impl Default for JobCatalog {
    fn default() -> Self {
        Self::new()
    }
}