shardline_provider_events/lib.rs
1#![deny(unsafe_code)]
2#![cfg_attr(
3 test,
4 allow(
5 clippy::unwrap_used,
6 clippy::expect_used,
7 clippy::indexing_slicing,
8 clippy::shadow_unrelated,
9 clippy::let_underscore_must_use,
10 clippy::format_push_string,
11 clippy::items_after_test_module
12 )
13)]
14
15//! Provider webhook event processing for the Shardline server.
16//!
17//! This crate handles incoming provider webhook events (repository deleted,
18//! renamed, access changed, revision pushed) and applies the corresponding
19//! metadata mutations.
20//!
21//! # Quick start
22//!
23//! The outcome types are pure data describing what one webhook application
24//! did, so they are the easiest entry point:
25//!
26//! ```
27//! use shardline_provider_events::{ProviderWebhookOutcome, ProviderWebhookOutcomeKind};
28//! use shardline_vcs::ProviderKind;
29//!
30//! let outcome = ProviderWebhookOutcome {
31//! provider: ProviderKind::GitHub,
32//! owner: "acme".to_owned(),
33//! repo: "assets".to_owned(),
34//! delivery_id: "delivery-123".to_owned(),
35//! event_kind: ProviderWebhookOutcomeKind::RepositoryDeleted,
36//! affected_file_versions: 12,
37//! affected_chunks: 34,
38//! applied_holds: 1,
39//! retention_seconds: Some(3600),
40//! };
41//!
42//! assert_eq!(outcome.owner, "acme");
43//! assert!(matches!(outcome.event_kind, ProviderWebhookOutcomeKind::RepositoryDeleted));
44//! ```
45//!
46//! A rename carries the new location:
47//!
48//! ```
49//! use shardline_provider_events::ProviderWebhookOutcomeKind;
50//!
51//! let kind = ProviderWebhookOutcomeKind::RepositoryRenamed {
52//! new_owner: "acme".to_owned(),
53//! new_repo: "assets-v2".to_owned(),
54//! };
55//! assert!(matches!(
56//! kind,
57//! ProviderWebhookOutcomeKind::RepositoryRenamed { new_repo, .. } if new_repo == "assets-v2"
58//! ));
59//! ```
60//!
61//! To apply a webhook to real state, call [`apply_provider_webhook_with_stores`]
62//! with explicit record, index, and object-store adapters.
63
64mod outcome;
65mod records;
66mod repository;
67mod state;
68#[cfg(test)]
69mod tests;
70
71mod provider_events;
72#[cfg(test)]
73pub(crate) use provider_events::duplicate_webhook_outcome;
74pub use provider_events::*;