webhook feature flag

Author: 64bit

async-openai/Cargo.toml

@@ -25,6 +25,7 @@ native-tls-vendored = ["reqwest/native-tls-vendored"]
 realtime = ["dep:tokio-tungstenite"]
 # Bring your own types
 byot = []
+webhook = ["dep:hmac", "dep:sha2", "dep:hex"]
 
 [dependencies]
 async-openai-macros = { path = "../async-openai-macros", version = "0.1.0" }
@@ -50,9 +51,9 @@ secrecy = { version = "0.10.3", features = ["serde"] }
 bytes = "1.9.0"
 eventsource-stream = "0.2.3"
 tokio-tungstenite = { version = "0.26.1", optional = true, default-features = false }
-hmac = "0.12.1"
-sha2 = "0.10.8"
-hex = "0.4.3"
+hmac = { version = "0.12", optional = true, default-features = false}
+sha2 = { version = "0.10", optional = true, default-features = false }
+hex = { version = "0.4", optional = true, default-features = false }
 
 [dev-dependencies]
 tokio-test = "0.4.4"

async-openai/src/error.rs

@@ -28,17 +28,6 @@ pub enum OpenAIError {
     InvalidArgument(String),
 }
 
-/// Errors that can occur when processing webhooks
-#[derive(Debug, thiserror::Error)]
-pub enum WebhookError {
-    /// Invalid webhook signature or signature verification failed
-    #[error("invalid webhook signature: {0}")]
-    InvalidSignature(String),
-    /// Failed to deserialize webhook payload
-    #[error("failed to deserialize webhook payload: error:{0} content:{1}")]
-    Deserialization(serde_json::Error, String),
-}
-
 #[derive(Debug, thiserror::Error)]
 pub enum StreamError {
     /// Underlying error from reqwest_eventsource library when reading the stream

async-openai/src/lib.rs

@@ -179,6 +179,7 @@ mod vector_store_file_batches;
 mod vector_store_files;
 mod vector_stores;
 mod video;
+#[cfg(feature = "webhook")]
 pub mod webhooks;
 
 pub use assistants::Assistants;

async-openai/src/types/mod.rs

@@ -34,6 +34,8 @@ mod upload;
 mod users;
 mod vector_store;
 mod video;
+#[cfg_attr(docsrs, doc(cfg(feature = "webhook")))]
+#[cfg(feature = "webhook")]
 pub mod webhooks;
 
 pub use assistant::*;

async-openai/src/webhooks.rs

@@ -1,10 +1,20 @@
-use crate::error::WebhookError;
 use crate::types::webhooks::WebhookEvent;
 use base64::{engine::general_purpose::STANDARD as BASE64, Engine};
 use hmac::{Hmac, Mac};
 use sha2::Sha256;
 use std::time::{SystemTime, UNIX_EPOCH};
 
+/// Errors that can occur when processing webhooks
+#[derive(Debug, thiserror::Error)]
+pub enum WebhookError {
+    /// Invalid webhook signature or signature verification failed
+    #[error("invalid webhook signature: {0}")]
+    InvalidSignature(String),
+    /// Failed to deserialize webhook payload
+    #[error("failed to deserialize webhook payload: error:{0} content:{1}")]
+    Deserialization(serde_json::Error, String),
+}
+
 type HmacSha256 = Hmac<Sha256>;
 
 const DEFAULT_TOLERANCE_SECONDS: i64 = 300;
@@ -356,7 +366,7 @@ mod tests {
         assert!(result.is_err());
         assert!(matches!(
             result.unwrap_err(),
-            WebhookError::Deserialization(_)
+            WebhookError::Deserialization(..)
         ));
     }
 }