Merge pull request #19 from PostHog/olly_global_client

chore: add global functions

Author: oliverb123

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "posthog-rs"
 license = "MIT"
-version = "0.3.0"
+version = "0.3.1"
 authors = ["christos <christos@openquery.io>"]
 description = "An unofficial Rust client for Posthog (https://posthog.com/)."
 repository = "https://github.com/openquery-io/posthog-rs"

src/client/blocking.rs

@@ -54,8 +54,5 @@ pub fn client<C: Into<ClientOptions>>(options: C) -> Client {
         .timeout(Duration::from_secs(options.request_timeout_seconds))
         .build()
         .unwrap(); // Unwrap here is as safe as `HttpClient::new`
-    Client {
-        options: options.into(),
-        client,
-    }
+    Client { options, client }
 }

src/error.rs

@@ -5,14 +5,17 @@ impl Display for Error {
         match self {
             Error::Connection(msg) => write!(f, "Connection Error: {}", msg),
             Error::Serialization(msg) => write!(f, "Serialization Error: {}", msg),
+            Error::AlreadyInitialized => write!(f, "Client already initialized"),
+            Error::NotInitialized => write!(f, "Client not initialized"),
         }
     }
 }
 
-impl std::error::Error for Error {}
-
 #[derive(Debug)]
+#[non_exhaustive]
 pub enum Error {
     Connection(String),
     Serialization(String),
+    AlreadyInitialized,
+    NotInitialized,
 }

src/global.rs

@@ -0,0 +1,33 @@
+use std::sync::OnceLock;
+
+use crate::{client, Client, ClientOptions, Error, Event};
+
+pub static GLOBAL_CLIENT: OnceLock<Client> = OnceLock::new();
+
+#[cfg(feature = "async-client")]
+pub async fn init_global_client<C: Into<ClientOptions>>(options: C) -> Result<(), Error> {
+    let client = client(options).await;
+    GLOBAL_CLIENT
+        .set(client)
+        .map_err(|_| Error::AlreadyInitialized)
+}
+
+#[cfg(not(feature = "async-client"))]
+pub fn init_global_client<C: Into<ClientOptions>>(options: C) -> Result<(), Error> {
+    let client = client(options);
+    GLOBAL_CLIENT
+        .set(client)
+        .map_err(|_| Error::AlreadyInitialized)
+}
+
+#[cfg(feature = "async-client")]
+pub async fn capture(event: Event) -> Result<(), Error> {
+    let client = GLOBAL_CLIENT.get().ok_or(Error::NotInitialized)?;
+    client.capture(event).await
+}
+
+#[cfg(not(feature = "async-client"))]
+pub fn capture(event: Event) -> Result<(), Error> {
+    let client = GLOBAL_CLIENT.get().ok_or(Error::NotInitialized)?;
+    client.capture(event)
+}

src/lib.rs

@@ -1,6 +1,7 @@
 mod client;
 mod error;
 mod event;
+mod global;
 
 const API_ENDPOINT: &str = "https://us.i.posthog.com/capture/";
 
@@ -15,3 +16,7 @@ pub use error::Error;
 
 // Event
 pub use event::Event;
+
+// We expose a global capture function as a convenience, that uses a global client
+pub use global::capture;
+pub use global::init_global_client as init_global;