Skip to main content

launchdarkly_server_sdk/
lib.rs

1//! launchdarkly-server-sdk is the main crate for the LaunchDarkly SDK.
2//!
3//! This package contains the types and methods for the SDK client [Client] and its overall
4//! configuration.
5//!
6//! For more information and code examples, see the Rust SDK Reference:
7//! <https://docs.launchdarkly.com/sdk/server-side/rust>
8
9#![deny(rustdoc::missing_crate_level_docs)]
10#![deny(missing_docs)]
11
12#[macro_use]
13extern crate log;
14
15#[cfg(test)]
16#[macro_use]
17extern crate serde_json;
18
19use http::HeaderValue;
20pub use launchdarkly_server_sdk_evaluation::Error as EvalError;
21pub use launchdarkly_server_sdk_evaluation::{
22    AttributeValue, Context, ContextBuilder, Detail, FlagValue, Kind, MultiContextBuilder, Reason,
23    Reference,
24};
25use std::sync::LazyLock;
26
27pub use client::Client;
28
29// Re-export
30pub use client::{BuildError, StartError};
31pub use config::{ApplicationInfo, BuildError as ConfigBuildError, Config, ConfigBuilder};
32pub use data_source_builders::{
33    BuildError as DataSourceBuildError, PollingDataSourceBuilder, StreamingDataSourceBuilder,
34};
35pub use evaluation::{FlagDetail, FlagDetailConfig, FlagFilter};
36pub use events::event::MigrationOpEvent;
37pub use events::processor::EventProcessor;
38pub use events::processor_builders::{
39    BuildError as EventProcessorBuildError, EventProcessorBuilder, NullEventProcessorBuilder,
40};
41pub use feature_requester_builders::{
42    BuildError as FeatureRequestBuilderError, FeatureRequesterFactory,
43};
44pub use launchdarkly_server_sdk_evaluation::{Flag, FlagBuilder, RuleBuilder, Segment, Versioned};
45pub use migrations::{
46    ExecutionOrder, MigrationOpTracker, Migrator, MigratorBuilder, Operation, Origin, Stage,
47};
48pub use service_endpoints::ServiceEndpointsBuilder;
49pub use stores::persistent_store::{PersistentDataStore, PersistentStoreError};
50pub use stores::persistent_store_builders::{
51    PersistentDataStoreBuilder, PersistentDataStoreFactory,
52};
53pub use stores::store_types::{AllData, DataKind, SerializedItem, StorageItem};
54pub use test_data::TestData;
55pub use version::version_string;
56
57mod client;
58mod config;
59mod data_source;
60mod data_source_builders;
61mod data_system;
62mod evaluation;
63mod events;
64#[allow(dead_code)] // Tested but not yet reachable from production code.
65mod fdv2;
66mod feature_requester;
67mod feature_requester_builders;
68mod migrations;
69mod reqwest;
70mod sampler;
71mod service_endpoints;
72mod stores;
73mod test_common;
74mod test_data;
75mod version;
76
77static LAUNCHDARKLY_EVENT_SCHEMA_HEADER: &str = "x-launchdarkly-event-schema";
78static LAUNCHDARKLY_PAYLOAD_ID_HEADER: &str = "x-launchdarkly-payload-id";
79static LAUNCHDARKLY_TAGS_HEADER: &str = "x-launchdarkly-tags";
80// X-LaunchDarkly-Instance-Id identifies this SDK instance for the purpose of estimating
81// server-connection-minutes when polling. It contains a v4 UUID that is generated once
82// per SDK instance and remains constant for the lifetime of the client.
83//
84// See: sdk-specs / SCMP-server-connection-minutes-polling.
85static LAUNCHDARKLY_INSTANCE_ID_HEADER: &str = "x-launchdarkly-instance-id";
86static CURRENT_EVENT_SCHEMA: &str = "4";
87
88static USER_AGENT: LazyLock<String> =
89    LazyLock::new(|| format!("RustServerClient/{}", version_string()));
90
91static EMPTY_HEADER: LazyLock<HeaderValue> = LazyLock::new(|| HeaderValue::from_static(""));
92
93#[cfg(all(test, feature = "float-roundtrip"))]
94mod tests {
95    use test_case::test_case;
96
97    // Fractional numbers must parse to the same f64 that Go's encoding/json produces, so that
98    // numeric flag values and numeric context attributes behave identically across LaunchDarkly
99    // SDKs. This requires serde_json's correctly-rounded parser, which the float-roundtrip
100    // feature selects.
101    #[test_case("130.65331632653061", 130.65331632653061)]
102    #[test_case("130.65331632653062", 130.65331632653061)]
103    #[test_case("130.65331632653063", 130.65331632653064)]
104    fn json_float_serialization_matches_go(float_as_string: &str, expected: f64) {
105        let parsed: f64 = serde_json::from_str(float_as_string).unwrap();
106        assert_eq!(expected, parsed);
107    }
108}