beet_net 0.0.8

Cross-platform networking utilities
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

use crate::prelude::*;
use beet_core::prelude::*;
use serde::Deserialize;
use serde::Serialize;
use serde_json::Value;

pub fn analytics_plugin(app: &mut App) {
	app.add_systems(PostStartup, spawn_analytics_event_store)
		.add_observer(handle_analytics_events);
}

// TODO deprecate after beet_router refactor, this should
// be TableStore component on the endpoint
#[derive(Clone, Deref, DerefMut, Resource)]
pub struct AnalyticsEventStore {
	pub store: TableStore<AnalyticsEvent>,
}
/// Spawn the analytics event store resource, using the
fn spawn_analytics_event_store(
	mut commands: AsyncCommands,
	ws_config: When<Res<WorkspaceConfig>>,
	pkg_config: When<Res<PackageConfig>>,
) {
	let fs_dir = ws_config.analytics_dir.into_abs();
	let bucket_name = pkg_config.analytics_bucket_name();
	let access = pkg_config.service_access;
	commands.run(async move |queue| {
		let store = dynamo_fs_selector(&fs_dir, &bucket_name, access).await;
		queue.insert_resource(AnalyticsEventStore { store });
	});
}


/// A listener for [`AnalyticsEvent`] triggers, pushing them to the [`AnalyticsEventStore`] resource
fn handle_analytics_events(
	trigger: On<AnalyticsEvent>,
	store: ResMut<AnalyticsEventStore>,
	mut commands: AsyncCommands,
) {
	let store = store.clone();
	let event = trigger.event().clone();
	commands.run(async move |_| {
		store.push(event).await?;
		Ok(())
	});
}

/// An event to be recorded, usually representing a user interaction on the site.
///
#[derive(Debug, Clone, Serialize, Deserialize, Event)]
pub struct AnalyticsEvent {
	pub id: Uuid,
	/// The performance.now() timestamp from the client when the event was recorded
	pub client_timestamp: u64,
	pub event_type: String,
	#[serde(flatten)]
	pub event_data: Value,
	#[serde(flatten)]
	pub session_data: Value,
}


impl AnalyticsEvent {
	pub fn parse(payload: Value) -> Result<Self> {
		// these fields are serde flattened, ensure they wont overwrite primary key
		if !payload["event_data"]["id"].is_null() {
			bevybail!("event_data.id field is not allowed");
		}
		if !payload["session_data"]["id"].is_null() {
			bevybail!("session_data.id field is not allowed");
		}

		let event_obj = payload["event_data"].as_object();
		let session_obj = payload["session_data"].as_object();
		if let (Some(event_map), Some(session_map)) = (event_obj, session_obj) {
			for key in event_map.keys() {
				if session_map.contains_key(key) {
					bevybail!(
						"conflicting field '{}' in event_data and session_data",
						key
					);
				}
			}
		}

		Self {
			id: Uuid::now_v7(),
			client_timestamp: payload["client_timestamp"].as_u64().unwrap_or(0),
			event_type: payload["event_type"]
				.as_str()
				.unwrap_or("unknown")
				.to_string(),
			event_data: payload["event_data"].clone(),
			session_data: payload["session_data"].clone(),
		}
		.xok()
	}
}

impl TableRow for AnalyticsEvent {
	fn id(&self) -> Uuid { self.id }
}

#[cfg(test)]
mod test {
	use crate::prelude::*;
	use serde_json::Value;
	use serde_json::json;
	use beet_core::prelude::*;

	fn event() -> Value {
		json! ({
			"client_timestamp": 123456,
			"event_type": "client_error",
			"event_data": {
				"message": "bar"
			},
			"session_data": {
				"session_id": "abc123"
			}
		})
	}


	#[test]
	fn not_allowed() {
		AnalyticsEvent::parse(json!({
			"event_data": { "id": "foo" }
		}))
		.xpect_err();
		AnalyticsEvent::parse(json!({
			"session_data": { "id": "foo" }
		}))
		.xpect_err();
		AnalyticsEvent::parse(json!({
			"event_data": { "foo": "bar" },
			"session_data": { "foo": "bar" }
		}))
		.xpect_err();
	}
	#[test]
	fn works() {
		let ev = AnalyticsEvent::parse(event()).unwrap();
		let json = serde_json::to_value(&ev).unwrap();
		json["id"].as_str().unwrap().len().xpect_eq(36);
		json["event_type"]
			.as_str()
			.unwrap()
			.xpect_eq("client_error");
		json["message"].as_str().unwrap().xpect_eq("bar");
	}
}