Skip to main content

WebhookConfig

Struct WebhookConfig 

Source
pub struct WebhookConfig {
    pub secret: Arc<dyn WebhookSecretResolver>,
    pub branch: Option<String>,
    pub repo: Option<String>,
    pub dedup: Arc<Mutex<DeliveryDedupCache>>,
    pub extractor: Arc<dyn WebhookPayloadExtractor>,
    pub concurrency: Option<Arc<WebhookConcurrencyLimit>>,
    pub rate_limit: Option<Arc<WebhookRateLimiter>>,
}
Expand description

Per-route config attached to the webhook handler.

Fields§

§secret: Arc<dyn WebhookSecretResolver>

Resolves the shared secret on every request so a wizard rotate flow doesn’t require a router rebuild.

§branch: Option<String>

When Some(branch), only payloads whose ref equals refs/heads/<branch> trigger a scan. None accepts any branch.

§repo: Option<String>

Optional repo filter forwarded to the ScanTrigger. None scans every enabled repo, matching the API’s manual-trigger behaviour.

§dedup: Arc<Mutex<DeliveryDedupCache>>

Bounded set of delivery ids already processed, so a webhook-UI redelivery (or a hostile replay of a captured-and-still-valid HMAC body) does not retrigger the dispatcher. Shared across clones of the config so a router rebuild keeps the cache hot.

§extractor: Arc<dyn WebhookPayloadExtractor>

Provider-specific decoder for the verified push body. Operators pick this via [triggers].webhook_provider; the default (refheads) covers GitHub / Gitea / Forgejo / Gogs / GitLab, which all ship the branch under top-level ref.

§concurrency: Option<Arc<WebhookConcurrencyLimit>>

Optional cap on simultaneous in-flight handler invocations. None disables the gate (every request is admitted). When set, requests past the cap return 429 before HMAC verification so a flood of valid-signed pushes cannot peg the executor.

§rate_limit: Option<Arc<WebhookRateLimiter>>

Optional per-source-IP token bucket. None disables the gate (every IP is admitted). When set, requests past the per-IP budget return 429 before HMAC verification. The handler reads the source IP from the request’s ConnectInfo extension; deployments that route through a reverse proxy without preserving the peer address will not see per-IP throttling and fall back to the global concurrency cap.

Implementations§

Source§

impl WebhookConfig

Source

pub fn new( secret: Arc<dyn WebhookSecretResolver>, branch: Option<String>, repo: Option<String>, ) -> Self

Build a webhook config with a fresh dedup cache and the default ref: refs/heads/<branch> extractor.

Source

pub fn with_extractor( secret: Arc<dyn WebhookSecretResolver>, branch: Option<String>, repo: Option<String>, extractor: Arc<dyn WebhookPayloadExtractor>, ) -> Self

Build a webhook config with a fresh dedup cache and an explicit extractor. Used when the operator’s [triggers].webhook_provider names a non-default shape (Bitbucket Server, Sourcehut, …).

Source

pub fn with_concurrency_limit(self, limit: Arc<WebhookConcurrencyLimit>) -> Self

Attach a concurrency cap. Subsequent requests past the cap return 429 before HMAC verification.

Source

pub fn with_rate_limit(self, limit: Arc<WebhookRateLimiter>) -> Self

Attach a per-source-IP rate limiter. Requests past the per-IP budget return 429 before HMAC verification.

Trait Implementations§

Source§

impl Clone for WebhookConfig

Source§

fn clone(&self) -> WebhookConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Fruit for T
where T: Send + Downcast,

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,