refactor: split core modules out into foundation

technobaboo · technobaboo · commit cda3a9c0030e · 2025-12-05T13:01:43.000-08:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -10,7 +10,7 @@ repository = "https://github.com/StardustXR/stardust-xr-server/"
 homepage = "https://stardustxr.org"
 
 [workspace]
-members = ["codegen"]
+members = ["codegen", "foundation"]
 
 [[bin]]
 name = "stardust-xr-server"
@@ -176,3 +176,6 @@ git = "https://github.com/StardustXR/core.git"
 
 [dependencies.stardust-xr-server-codegen]
 path = "codegen"
+
+[dependencies.stardust-xr-server-foundation]
+path = "foundation"
diff --git a/foundation/Cargo.toml b/foundation/Cargo.toml
@@ -0,0 +1,28 @@
+[package]
+edition = "2024"
+name = "stardust-xr-server-foundation"
+version = "0.1.0"
+
+[features]
+default = []
+profile_tokio = ["tokio/tracing"]
+
+[dependencies]
+# small utility thingys
+rustc-hash = "2.0.0"
+parking_lot = "0.12.3"
+dashmap = "6.1.0"
+
+# rust errors/logging
+color-eyre = { version = "0.6.3", default-features = false }
+thiserror = "2.0.11"
+
+# (de)serialization
+serde = { version = "1.0.205", features = ["derive"] }
+
+# mathy stuffs
+tokio = { version = "1.39.2", features = ["rt-multi-thread", "signal", "time"] }
+
+[dependencies.stardust-xr-wire]
+git = "https://github.com/StardustXR/core.git"
+# path = "../core/wire"
diff --git a/foundation/src/delta.rs b/foundation/src/delta.rs
diff --git a/foundation/src/error.rs b/foundation/src/error.rs
@@ -36,13 +36,13 @@ pub enum ServerError {
 #[macro_export]
 macro_rules! bail {
     ($msg:literal $(,)?) => {
-        return Err($crate::core::error::ServerError::from(color_eyre::eyre::eyre!($msg)));
+        return Err($crate::error::ServerError::from(color_eyre::eyre::eyre!($msg)));
     };
     ($err:expr $(,)?) => {
-        return Err($crate::core::error::ServerError::from(color_eyre::eyre::eyre!($err)));
+        return Err($crate::error::ServerError::from(color_eyre::eyre::eyre!($err)));
     };
     ($fmt:expr, $($arg:tt)*) => {
-        return Err($crate::core::error::ServerError::from(color_eyre::eyre::eyre!($fmt, $($arg)*)));
+        return Err($crate::error::ServerError::from(color_eyre::eyre::eyre!($fmt, $($arg)*)));
     };
 }
 
@@ -55,17 +55,17 @@ macro_rules! ensure {
     };
     ($cond:expr, $msg:literal $(,)?) => {
         if !$cond {
-            return Err($crate::core::error::ServerError::from(color_eyre::eyre::eyre!($msg)));
+            return Err($crate::error::ServerError::from(color_eyre::eyre::eyre!($msg)));
         }
     };
     ($cond:expr, $err:expr $(,)?) => {
         if !$cond {
-            return Err($crate::core::error::ServerError::from(color_eyre::eyre::eyre!($err)));
+            return Err($crate::error::ServerError::from(color_eyre::eyre::eyre!($err)));
         }
     };
     ($cond:expr, $fmt:expr, $($arg:tt)*) => {
         if !$cond {
-            return Err($crate::core::error::ServerError::from(color_eyre::eyre::eyre!($fmt, $($arg)*)));
+            return Err($crate::error::ServerError::from(color_eyre::eyre::eyre!($fmt, $($arg)*)));
         }
     };
 }
diff --git a/foundation/src/id.rs b/foundation/src/id.rs
diff --git a/foundation/src/lib.rs b/foundation/src/lib.rs
@@ -0,0 +1,8 @@
+pub mod delta;
+pub mod error;
+pub mod id;
+pub mod registry;
+pub mod resource;
+pub mod task;
+
+pub use id::*;
diff --git a/foundation/src/registry.rs b/foundation/src/registry.rs
@@ -9,7 +9,6 @@ use std::sync::{Arc, LazyLock, Weak};
 
 #[derive(Debug)]
 pub struct Registry<T: Send + Sync + ?Sized>(MaybeLazy<DashMap<usize, Weak<T>>>);
-
 impl<T: Send + Sync + ?Sized> Registry<T> {
 	pub const fn new() -> Self {
 		Registry(MaybeLazy::Lazy(LazyLock::new(DashMap::default)))
@@ -91,7 +90,6 @@ impl<T: Send + Sync + ?Sized> Registry<T> {
 		self.0.iter().all(|v| v.value().strong_count() == 0)
 	}
 }
-
 impl<T: Send + Sync + ?Sized> Clone for Registry<T> {
 	fn clone(&self) -> Self {
 		Self(self.0.clone())
@@ -102,7 +100,6 @@ impl<T: Send + Sync + ?Sized> Default for Registry<T> {
 		Self::new()
 	}
 }
-
 impl<T: Send + Sync + Sized> FromIterator<Arc<T>> for Registry<T> {
 	fn from_iter<I: IntoIterator<Item = Arc<T>>>(iter: I) -> Self {
 		Registry(MaybeLazy::NonLazy(
@@ -175,6 +172,11 @@ impl<T: Send + Sync + ?Sized> OwnedRegistry<T> {
 		self.lock().clear();
 	}
 }
+impl<T: Send + Sync + ?Sized> Default for OwnedRegistry<T> {
+	fn default() -> Self {
+		Self::new()
+	}
+}
 impl<T: Send + Sync + ?Sized> Clone for OwnedRegistry<T> {
 	fn clone(&self) -> Self {
 		Self(Mutex::new(self.0.lock().clone()))
diff --git a/foundation/src/resource.rs b/foundation/src/resource.rs
@@ -2,13 +2,14 @@ use stardust_xr_wire::values::ResourceID;
 use std::{
 	ffi::OsStr,
 	path::{Path, PathBuf},
+	sync::LazyLock,
 };
 
-use super::client::Client;
-
-lazy_static::lazy_static! {
-	static ref THEMES: Vec<PathBuf> = std::env::var("STARDUST_THEMES").map(|s| s.split(':').map(PathBuf::from).collect()).unwrap_or_default();
-}
+static THEMES: LazyLock<Vec<PathBuf>> = LazyLock::new(|| {
+	std::env::var("STARDUST_THEMES")
+		.map(|s| s.split(':').map(PathBuf::from).collect())
+		.unwrap_or_default()
+});
 
 fn has_extension(path: &Path, extensions: &[&OsStr]) -> bool {
 	if let Some(path_extension) = path.extension() {
@@ -18,9 +19,9 @@ fn has_extension(path: &Path, extensions: &[&OsStr]) -> bool {
 	}
 }
 
-pub fn get_resource_file(
+pub fn get_resource_file<'a>(
 	resource: &ResourceID,
-	client: &Client,
+	base_prefixes: impl Iterator<Item = &'a PathBuf>,
 	extensions: &[&OsStr],
 ) -> Option<PathBuf> {
 	match resource {
@@ -30,10 +31,9 @@ pub fn get_resource_file(
 		}
 		ResourceID::Namespaced { namespace, path } => {
 			let file_name = path.file_name()?;
-			let base_prefixes = client.base_resource_prefixes.lock().clone();
 			THEMES
 				.iter()
-				.chain(base_prefixes.iter())
+				.chain(base_prefixes)
 				.filter_map(|prefix| {
 					let prefixed_path = prefix.clone().join(namespace).join(path);
 					let parent = prefixed_path.parent()?;
diff --git a/foundation/src/task.rs b/foundation/src/task.rs
diff --git a/src/core/mod.rs b/src/core/mod.rs
@@ -2,13 +2,7 @@ pub mod bevy_channel;
 pub mod client;
 pub mod client_state;
 pub mod color;
-pub mod delta;
 pub mod entity_handle;
-pub mod error;
-mod id;
-pub mod registry;
-pub mod resource;
 pub mod scenegraph;
-pub mod task;
 
-pub use id::Id;
+pub use stardust_xr_server_foundation::*;
diff --git a/src/nodes/audio.rs b/src/nodes/audio.rs
@@ -103,9 +103,10 @@ pub struct Sound {
 }
 impl Sound {
 	pub fn add_to(node: &Arc<Node>, resource_id: ResourceID) -> Result<Arc<Sound>> {
+		let client = node.get_client().ok_or_else(|| eyre!("Client not found"))?;
 		let pending_audio_path = get_resource_file(
 			&resource_id,
-			&*node.get_client().ok_or_else(|| eyre!("Client not found"))?,
+			client.base_resource_prefixes.lock().iter(),
 			&[OsStr::new("wav"), OsStr::new("mp3")],
 		)
 		.ok_or_else(|| eyre!("Resource not found"))?;
diff --git a/src/nodes/drawable/mod.rs b/src/nodes/drawable/mod.rs
@@ -56,7 +56,7 @@ impl InterfaceAspect for Interface {
 			.map(|tex| {
 				get_resource_file(
 					&tex,
-					&calling_client,
+					calling_client.base_resource_prefixes.lock().iter(),
 					&[OsStr::new("hdr"), OsStr::new("png"), OsStr::new("jpg")],
 				)
 				.ok_or(eyre!("Could not find resource"))
@@ -75,7 +75,7 @@ impl InterfaceAspect for Interface {
 			.map(|light| {
 				get_resource_file(
 					&light,
-					&calling_client,
+					calling_client.base_resource_prefixes.lock().iter(),
 					&[OsStr::new("hdr"), OsStr::new("png"), OsStr::new("jpg")],
 				)
 				.ok_or(eyre!("Could not find resource"))
diff --git a/src/nodes/drawable/model.rs b/src/nodes/drawable/model.rs
@@ -1,4 +1,5 @@
 use super::{MODEL_PART_ASPECT_ALIAS_INFO, MaterialParameter, ModelAspect, ModelPartAspect};
+use crate::BevyMaterial;
 use crate::core::Id;
 use crate::core::bevy_channel::{BevyChannel, BevyChannelReader};
 use crate::core::client::Client;
@@ -10,7 +11,6 @@ use crate::core::resource::get_resource_file;
 use crate::nodes::Node;
 use crate::nodes::alias::{Alias, AliasList};
 use crate::nodes::spatial::{Spatial, SpatialNode};
-use crate::{BevyMaterial, bail};
 use bevy::asset::{load_internal_asset, weak_handle};
 use bevy::gltf::GltfLoaderSettings;
 use bevy::pbr::{ExtendedMaterial, MaterialExtension};
@@ -20,6 +20,7 @@ use bevy::render::render_resource::{AsBindGroup, ShaderRef};
 use color_eyre::eyre::eyre;
 use parking_lot::Mutex;
 use rustc_hash::{FxHashMap, FxHasher};
+use stardust_xr_server_foundation::bail;
 use stardust_xr_wire::values::ResourceID;
 use std::ffi::OsStr;
 use std::hash::{Hash, Hasher};
@@ -444,9 +445,11 @@ impl MaterialParameter {
 				}
 			},
 			MaterialParameter::Texture(resource) => {
-				let Some(texture_path) =
-					get_resource_file(resource, client, &[OsStr::new("png"), OsStr::new("jpg")])
-				else {
+				let Some(texture_path) = get_resource_file(
+					resource,
+					client.base_resource_prefixes.lock().iter(),
+					&[OsStr::new("png"), OsStr::new("jpg")],
+				) else {
 					return;
 				};
 				let handle = asset_server.load(texture_path);
@@ -544,9 +547,10 @@ pub struct Model {
 }
 impl Model {
 	pub fn add_to(node: &Arc<Node>, resource_id: ResourceID) -> Result<Arc<Model>> {
+		let client = node.get_client().ok_or_else(|| eyre!("Client not found"))?;
 		let pending_model_path = get_resource_file(
 			&resource_id,
-			&*node.get_client().ok_or_else(|| eyre!("Client not found"))?,
+			client.base_resource_prefixes.lock().iter(),
 			&[OsStr::new("glb"), OsStr::new("gltf")],
 		)
 		.ok_or_else(|| eyre!("Resource not found"))?;
diff --git a/src/nodes/drawable/text.rs b/src/nodes/drawable/text.rs
@@ -188,7 +188,11 @@ impl Text {
 		let text = TEXT_REGISTRY.add(Text {
 			spatial: node.get_aspect::<Spatial>().unwrap().clone(),
 			font_path: style.font.as_ref().and_then(|res| {
-				get_resource_file(res, &client, &[OsStr::new("ttf"), OsStr::new("otf")])
+				get_resource_file(
+					res,
+					client.base_resource_prefixes.lock().iter(),
+					&[OsStr::new("ttf"), OsStr::new("otf")],
+				)
 			}),
 
 			entity: Mutex::new(None),
diff --git a/src/nodes/items/camera.rs b/src/nodes/items/camera.rs
@@ -1,6 +1,5 @@
 #![allow(dead_code)]
 use super::{Item, ItemType, create_item_acceptor_flex, register_item_ui_flex};
-use crate::bail;
 use crate::core::Id;
 use crate::core::error::Result;
 use crate::nodes::Aspect;
@@ -20,6 +19,7 @@ use glam::Mat4;
 use lazy_static::lazy_static;
 use mint::{ColumnMatrix4, Vector2};
 use parking_lot::Mutex;
+use stardust_xr_server_foundation::bail;
 
 use stardust_xr_wire::flex::{deserialize, serialize};
 use std::sync::Arc;
diff --git a/src/nodes/items/mod.rs b/src/nodes/items/mod.rs
@@ -11,11 +11,11 @@ use crate::core::Id;
 use crate::core::client::Client;
 use crate::core::error::Result;
 use crate::core::registry::Registry;
-use crate::ensure;
 use crate::nodes::alias::AliasInfo;
 use crate::nodes::spatial::SPATIAL_ASPECT_ALIAS_INFO;
 use crate::nodes::spatial::Transform;
 use parking_lot::Mutex;
+use stardust_xr_server_foundation::ensure;
 use std::hash::Hash;
 use std::sync::{Arc, Weak};
 
diff --git a/src/nodes/items/panel.rs b/src/nodes/items/panel.rs
@@ -1,6 +1,5 @@
 use super::camera::CameraItemAcceptor;
 use super::{create_item_acceptor_flex, register_item_ui_flex};
-use crate::bail;
 use crate::core::Id;
 use crate::nodes::{
 	Aspect, AspectIdentifier,
@@ -24,6 +23,7 @@ use lazy_static::lazy_static;
 use mint::Vector2;
 use parking_lot::Mutex;
 use slotmap::{DefaultKey, Key, KeyData, SlotMap};
+use stardust_xr_server_foundation::bail;
 use std::sync::{Arc, Weak};
 use tracing::debug;
 
diff --git a/src/nodes/root.rs b/src/nodes/root.rs
@@ -1,13 +1,13 @@
 use super::spatial::Spatial;
 use super::{Aspect, AspectIdentifier, Node};
-use crate::bail;
 use crate::core::Id;
 use crate::core::client::{CLIENTS, Client};
 use crate::core::client_state::ClientStateParsed;
 use crate::core::error::Result;
 use crate::nodes::spatial::SPATIAL_REF_ASPECT_ALIAS_INFO;
 use crate::session::connection_env;
 use glam::Mat4;
+use stardust_xr_server_foundation::bail;
 use std::path::PathBuf;
 use std::sync::Arc;
 use std::time::Instant;
diff --git a/src/nodes/spatial.rs b/src/nodes/spatial.rs
@@ -1,6 +1,5 @@
 use super::alias::Alias;
 use super::{Aspect, AspectIdentifier};
-use crate::bail;
 use crate::core::Id;
 use crate::core::client::Client;
 use crate::core::entity_handle::EntityHandle;
@@ -16,6 +15,7 @@ use glam::{Mat4, Quat, Vec3};
 use mint::Vector3;
 use parking_lot::{Mutex, RwLock};
 use rustc_hash::FxHashMap;
+use stardust_xr_server_foundation::bail;
 use std::fmt::Debug;
 use std::pin::Pin;
 use std::sync::atomic::Ordering;

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,6 @@ use std::sync::{Arc, LazyLock, Weak};`
`9`	`9`
`10`	`10`	`#[derive(Debug)]`
`11`	`11`	`pub struct Registry<T: Send + Sync + ?Sized>(MaybeLazy<DashMap<usize, Weak<T>>>);`
`12`		`-`
`13`	`12`	`impl<T: Send + Sync + ?Sized> Registry<T> {`
`14`	`13`	`pub const fn new() -> Self {`
`15`	`14`	`Registry(MaybeLazy::Lazy(LazyLock::new(DashMap::default)))`
`@@ -91,7 +90,6 @@ impl<T: Send + Sync + ?Sized> Registry<T> {`
`91`	`90`	`self.0.iter().all(\|v\| v.value().strong_count() == 0)`
`92`	`91`	`}`
`93`	`92`	`}`
`94`		`-`
`95`	`93`	`impl<T: Send + Sync + ?Sized> Clone for Registry<T> {`
`96`	`94`	`fn clone(&self) -> Self {`
`97`	`95`	`Self(self.0.clone())`
`@@ -102,7 +100,6 @@ impl<T: Send + Sync + ?Sized> Default for Registry<T> {`
`102`	`100`	`Self::new()`
`103`	`101`	`}`
`104`	`102`	`}`
`105`		`-`
`106`	`103`	`impl<T: Send + Sync + Sized> FromIterator<Arc<T>> for Registry<T> {`
`107`	`104`	`fn from_iter<I: IntoIterator<Item = Arc<T>>>(iter: I) -> Self {`
`108`	`105`	`Registry(MaybeLazy::NonLazy(`
`@@ -175,6 +172,11 @@ impl<T: Send + Sync + ?Sized> OwnedRegistry<T> {`
`175`	`172`	`self.lock().clear();`
`176`	`173`	`}`
`177`	`174`	`}`
	`175`	`+impl<T: Send + Sync + ?Sized> Default for OwnedRegistry<T> {`
	`176`	`+ fn default() -> Self {`
	`177`	`+ Self::new()`
	`178`	`+ }`
	`179`	`+}`
`178`	`180`	`impl<T: Send + Sync + ?Sized> Clone for OwnedRegistry<T> {`
`179`	`181`	`fn clone(&self) -> Self {`
`180`	`182`	`Self(Mutex::new(self.0.lock().clone()))`