Skip to main content

EventProcessor

Struct EventProcessor 

Source
pub struct EventProcessor { /* private fields */ }
Expand description

Processes raw GitHub webhooks into normalized event envelopes.

The event processor handles:

  • Signature validation (optional)
  • JSON parsing and validation
  • Entity extraction and classification
  • Session ID generation for ordering
  • Metadata population

§Examples

use github_bot_sdk::events::{EventProcessor, ProcessorConfig};

let config = ProcessorConfig::default();
let processor = EventProcessor::new(config);

let envelope = processor.process_webhook(
    "pull_request",
    b"{\"action\":\"opened\",\"number\":1}",
    Some("delivery-123"),
).await?;

println!("Processed event: {}", envelope.event_id);

Implementations§

Source§

impl EventProcessor

Source

pub fn new(config: ProcessorConfig) -> Self

Create a new event processor with the given configuration.

Source

pub async fn process_webhook( &self, event_type: &str, payload: &[u8], delivery_id: Option<&str>, ) -> Result<EventEnvelope, EventError>

Process a raw webhook into a normalized event envelope.

§Arguments
  • event_type - GitHub event type (from X-GitHub-Event header)
  • payload - Raw webhook payload bytes
  • delivery_id - GitHub delivery ID (from X-GitHub-Delivery header)
§Returns

A normalized EventEnvelope or an error if processing fails.

§Errors

Returns EventError if:

  • Payload exceeds maximum size
  • Payload is not valid JSON
  • Required fields are missing
  • Event type is unsupported
Source

pub fn extract_entity_info( &self, event_type: &str, payload: &Value, ) -> Result<(EntityType, Option<String>), EventError>

Extract entity information from the payload.

Determines the primary entity type and ID for session correlation.

Source

pub fn generate_session_id( &self, entity_type: &EntityType, entity_id: &Option<String>, repository: &Repository, ) -> Option<String>

Generate a session ID for ordered processing.

Uses the configured strategy to create session IDs that group related events together for sequential processing.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, 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