Skip to main content

statsig_rust/event_logging/event_queue/
queued_experiment_expo.rs

1use crate::{
2    evaluation::evaluation_types::ExtraExposureInfo,
3    event_logging::{
4        event_logger::ExposureTrigger,
5        exposure_sampling::{EvtSamplingDecision, ExposureSamplingKey},
6        exposure_utils::{get_metadata_with_details, get_statsig_metadata_with_sampling_decision},
7        statsig_event::StatsigEvent,
8        statsig_event_internal::{StatsigEventInternal, CONFIG_EXPOSURE_EVENT_NAME},
9    },
10    interned_string::InternedString,
11    statsig_types::Experiment,
12    user::{StatsigUserInternal, StatsigUserLoggable},
13    EvaluationDetails, SecondaryExposure,
14};
15
16use super::queued_event::{EnqueueOperation, QueuedEvent, QueuedExposure};
17use crate::event_logging::statsig_event::string_metadata_to_value_metadata;
18
19pub struct EnqueueExperimentExpoOp<'a> {
20    pub user: &'a StatsigUserInternal<'a, 'a>,
21    pub experiment: &'a Experiment,
22    pub trigger: ExposureTrigger,
23    pub exposure_time: u64,
24}
25
26impl EnqueueOperation for EnqueueExperimentExpoOp<'_> {
27    fn as_exposure(&self) -> Option<&impl QueuedExposure<'_>> {
28        Some(self)
29    }
30
31    fn into_queued_event(self, sampling_decision: EvtSamplingDecision) -> QueuedEvent {
32        let evaluation = self.experiment.__evaluation.as_ref();
33        let secondary_exposures = evaluation.map(|eval| &eval.base.secondary_exposures);
34        let exposure_info = evaluation.and_then(|eval| eval.base.exposure_info.as_ref());
35        let (version, override_config_name) = exposure_info
36            .map(|info| (info.version, info.override_config_name.clone()))
37            .unwrap_or_default();
38
39        QueuedEvent::ExperimentExposure(QueuedExperimentExposureEvent {
40            user: self.user.to_loggable(),
41            experiment_name: self.experiment.name.clone(),
42            rule_id: self.experiment.rule_id.clone(),
43            secondary_exposures: secondary_exposures.cloned(),
44            evaluation_details: self.experiment.details.clone(),
45            version,
46            exposure_trigger: self.trigger,
47            sampling_decision,
48            override_config_name,
49            exposure_time: self.exposure_time,
50        })
51    }
52}
53
54impl<'a> QueuedExposure<'a> for EnqueueExperimentExpoOp<'a> {
55    fn create_exposure_sampling_key(&self) -> ExposureSamplingKey {
56        let user_data = &self.user.user_ref.data;
57        let evaluation = self.experiment.__evaluation.as_ref().map(|e| &e.base);
58        let in_experiment = self
59            .experiment
60            .__evaluation
61            .as_ref()
62            .is_some_and(|e| e.is_user_in_experiment == Some(true));
63
64        let additional_hash = in_experiment as u64;
65
66        ExposureSamplingKey::new(
67            evaluation,
68            user_data,
69            additional_hash,
70            Some(&self.experiment.id_type),
71        )
72    }
73
74    fn get_rule_id_ref(&self) -> &'a str {
75        &self.experiment.rule_id
76    }
77
78    fn get_extra_exposure_info_ref(&self) -> Option<&'a ExtraExposureInfo> {
79        self.experiment
80            .__evaluation
81            .as_ref()?
82            .base
83            .exposure_info
84            .as_ref()
85    }
86}
87
88pub struct QueuedExperimentExposureEvent {
89    pub user: StatsigUserLoggable,
90    pub experiment_name: String,
91    pub rule_id: String,
92    pub secondary_exposures: Option<Vec<SecondaryExposure>>,
93    pub evaluation_details: EvaluationDetails,
94    pub version: Option<u32>,
95    pub exposure_trigger: ExposureTrigger,
96    pub sampling_decision: EvtSamplingDecision,
97    pub override_config_name: Option<InternedString>,
98    pub exposure_time: u64,
99}
100
101impl QueuedExperimentExposureEvent {
102    pub fn into_statsig_event_internal(self) -> StatsigEventInternal {
103        let mut metadata = get_metadata_with_details(self.evaluation_details);
104        metadata.insert("config".into(), self.experiment_name);
105        metadata.insert("ruleID".into(), self.rule_id);
106
107        if let Some(version) = self.version {
108            metadata.insert("configVersion".into(), version.to_string());
109        }
110
111        if self.exposure_trigger == ExposureTrigger::Manual {
112            metadata.insert("isManualExposure".into(), "true".into());
113        }
114
115        if let Some(override_config_name) = self.override_config_name {
116            metadata.insert(
117                "overrideConfigName".into(),
118                override_config_name.unperformant_to_string(),
119            );
120        }
121
122        let statsig_metadata = get_statsig_metadata_with_sampling_decision(self.sampling_decision);
123
124        let event = StatsigEvent {
125            event_name: CONFIG_EXPOSURE_EVENT_NAME.into(),
126            value: None,
127            metadata: Some(string_metadata_to_value_metadata(metadata)),
128            statsig_metadata: Some(statsig_metadata),
129        };
130
131        StatsigEventInternal::new(
132            self.exposure_time,
133            self.user,
134            event,
135            Some(self.secondary_exposures.unwrap_or_default()),
136        )
137    }
138}