define ReducerName backed by EcoString

Author: Centril

Cargo.lock

@@ -31,7 +31,7 @@ use spacetimedb_sats::{
     ser::Serialize,
     AlgebraicType, SpacetimeType,
 };
-use spacetimedb_schema::table_name::TableName;
+use spacetimedb_schema::{reducer_name::ReducerName, table_name::TableName};
 use std::sync::Arc;
 
 pub const TEXT_PROTOCOL: &str = "v1.json.spacetimedb";
@@ -152,7 +152,7 @@ impl<Args> ClientMessage<Args> {
 #[sats(crate = spacetimedb_lib)]
 pub struct CallReducer<Args> {
     /// The name of the reducer to call.
-    pub reducer: Box<str>,
+    pub reducer: ReducerName,
     /// The arguments to the reducer.
     ///
     /// In the wire format, this will be a [`Bytes`], BSATN or JSON encoded according to the reducer's argument schema
@@ -589,7 +589,7 @@ pub struct ReducerCallInfo<F: WebsocketFormat> {
     /// We should consider not sending this at all and instead
     /// having a startup message where the name <-> id bindings
     /// are established between the host and the client.
-    pub reducer_name: Box<str>,
+    pub reducer_name: ReducerName,
     /// The numerical id of the reducer that was called.
     pub reducer_id: u32,
     /// The arguments to the reducer, encoded as BSATN or JSON according to the reducer's argument schema

crates/client-api-messages/src/websocket.rs

@@ -343,8 +343,8 @@ pub(super) fn parse_table_update(
         let reducer_name = reducer.name.deref();
         let func_name = reducer_function_name(reducer);
         let set_reducer_flags_trait = reducer_flags_trait_name(reducer);
-        let args_type = function_args_type_name(&reducer.name);
-        let enum_variant_name = reducer_variant_name(&reducer.name);
+        let args_type = function_args_type_name(&reducer.name.into_identifier());
+        let enum_variant_name = reducer_variant_name(&reducer.name.into_identifier());
 
         // Define an "args struct" for the reducer.
         // This is not user-facing (note the `pub(super)` visibility);
@@ -366,7 +366,7 @@ pub(super) fn parse_table_update(
 
         out.newline();
 
-        let callback_id = reducer_callback_id_name(&reducer.name);
+        let callback_id = reducer_callback_id_name(&reducer.name.into_identifier());
 
         let FormattedArglist {
             arglist_no_delimiters,
@@ -494,7 +494,7 @@ impl {set_reducer_flags_trait} for super::SetReducerFlags {{
         );
 
         OutputFile {
-            filename: reducer_module_name(&reducer.name) + ".rs",
+            filename: reducer_module_name(&reducer.name.into_identifier()) + ".rs",
             code: output.into_inner(),
         }
     }
@@ -1129,7 +1129,7 @@ fn reducer_flags_trait_name(reducer: &ReducerDef) -> String {
 fn iter_module_names(module: &ModuleDef) -> impl Iterator<Item = String> + '_ {
     itertools::chain!(
         iter_types(module).map(|ty| type_module_name(&ty.name)),
-        iter_reducers(module).map(|r| reducer_module_name(&r.name)),
+        iter_reducers(module).map(|r| reducer_module_name(&r.name.into_identifier())),
         iter_tables(module).map(|tbl| table_module_name(&tbl.name)),
         iter_views(module).map(|view| table_module_name(&view.name)),
         iter_procedures(module).map(|proc| procedure_module_name(&proc.name)),
@@ -1160,10 +1160,10 @@ fn print_module_reexports(module: &ModuleDef, out: &mut Indenter) {
         writeln!(out, "pub use {mod_name}::*;");
     }
     for reducer in iter_reducers(module) {
-        let mod_name = reducer_module_name(&reducer.name);
+        let mod_name = reducer_module_name(&reducer.name.into_identifier());
         let reducer_trait_name = reducer_function_name(reducer);
         let flags_trait_name = reducer_flags_trait_name(reducer);
-        let callback_id_name = reducer_callback_id_name(&reducer.name);
+        let callback_id_name = reducer_callback_id_name(&reducer.name.into_identifier());
         writeln!(
             out,
             "pub use {mod_name}::{{{reducer_trait_name}, {flags_trait_name}, {callback_id_name}}};"
@@ -1193,7 +1193,7 @@ fn print_reducer_enum_defn(module: &ModuleDef, out: &mut Indenter) {
         "pub enum Reducer {",
         |out| {
             for reducer in iter_reducers(module) {
-                write!(out, "{} ", reducer_variant_name(&reducer.name));
+                write!(out, "{} ", reducer_variant_name(&reducer.name.into_identifier()));
                 if !reducer.params_for_generate.elements.is_empty() {
                     // If the reducer has any arguments, generate a "struct variant,"
                     // like `Foo { bar: Baz, }`.
@@ -1226,7 +1226,11 @@ impl __sdk::InModule for Reducer {{
                         "match self {",
                         |out| {
                             for reducer in iter_reducers(module) {
-                                write!(out, "Reducer::{}", reducer_variant_name(&reducer.name));
+                                write!(
+                                    out,
+                                    "Reducer::{}",
+                                    reducer_variant_name(&reducer.name.into_identifier())
+                                );
                                 if !reducer.params_for_generate.elements.is_empty() {
                                     // Because we're emitting unit variants when the payload is empty,
                                     // we will emit different patterns for empty vs non-empty variants.
@@ -1282,8 +1286,8 @@ impl __sdk::InModule for Reducer {{
                                     out,
                                     "{:?} => Ok(__sdk::parse_reducer_args::<{}::{}>({:?}, &value.args)?.into()),",
                                     reducer.name.deref(),
-                                    reducer_module_name(&reducer.name),
-                                    function_args_type_name(&reducer.name),
+                                    reducer_module_name(&reducer.name.into_identifier()),
+                                    function_args_type_name(&reducer.name.into_identifier()),
                                     reducer.name.deref(),
                                 );
                             }

crates/codegen/src/rust.rs

@@ -157,7 +157,7 @@ impl Lang for TypeScript {
         define_body_for_reducer(module, out, &reducer.params_for_generate.elements);
 
         OutputFile {
-            filename: reducer_module_name(&reducer.name) + ".ts",
+            filename: reducer_module_name(&reducer.name.into_identifier()) + ".ts",
             code: output.into_inner(),
         }
     }
@@ -212,8 +212,8 @@ impl Lang for TypeScript {
         writeln!(out, "// Import and reexport all reducer arg types");
         for reducer in iter_reducers(module) {
             let reducer_name = &reducer.name;
-            let reducer_module_name = reducer_module_name(reducer_name);
-            let args_type = reducer_args_type_name(&reducer.name);
+            let reducer_module_name = reducer_module_name(&reducer_name.into_identifier());
+            let args_type = reducer_args_type_name(&reducer.name.into_identifier());
             writeln!(out, "import {args_type} from \"./{reducer_module_name}\";");
             writeln!(out, "export {{ {args_type} }};");
         }
@@ -290,7 +290,7 @@ impl Lang for TypeScript {
                 continue;
             }
             let reducer_name = &reducer.name;
-            let args_type = reducer_args_type_name(&reducer.name);
+            let args_type = reducer_args_type_name(&reducer.name.into_identifier());
             writeln!(out, "__reducerSchema(\"{}\", {}),", reducer_name, args_type);
         }
         out.dedent(1);

crates/codegen/src/typescript.rs

@@ -21,6 +21,7 @@ async-stream = { workspace = true, optional = true }
 bitflags.workspace = true
 bytes= { workspace = true, optional = true }
 crc32c.workspace = true
+ecow.workspace = true
 futures = { workspace = true, optional = true }
 itertools.workspace = true
 log.workspace = true

crates/commitlog/Cargo.toml

@@ -11,6 +11,7 @@ use spacetimedb_datastore::execution_context::WorkloadType;
 use spacetimedb_lib::de::serde::DeserializeWrapper;
 use spacetimedb_lib::identity::RequestId;
 use spacetimedb_lib::{bsatn, ConnectionId, Timestamp};
+use spacetimedb_schema::reducer_name::ReducerName;
 use std::borrow::Cow;
 use std::sync::Arc;
 use std::time::{Duration, Instant};
@@ -163,7 +164,7 @@ pub async fn handle(client: &ClientConnection, message: DataMessage, timer: Inst
 #[derive(thiserror::Error, Debug)]
 #[error("error executing message (reducer: {reducer:?}) (err: {err:#})")]
 pub struct MessageExecutionError {
-    pub reducer: Option<Box<str>>,
+    pub reducer: Option<ReducerName>,
     pub reducer_id: Option<ReducerId>,
     pub caller_identity: Identity,
     pub caller_connection_id: Option<ConnectionId>,
@@ -178,7 +179,7 @@ impl MessageExecutionError {
             caller_identity: self.caller_identity,
             caller_connection_id: self.caller_connection_id,
             function_call: ModuleFunctionCall {
-                reducer: self.reducer.unwrap_or_else(|| "<none>".into()).into(),
+                reducer: self.reducer.unwrap_or_else(|| ReducerName::new_from_str("<none>")),
                 reducer_id: self.reducer_id.unwrap_or(u32::MAX.into()),
                 args: Default::default(),
             },

crates/core/src/client/message_handlers.rs

@@ -282,7 +282,7 @@ impl ToProtocol for TransactionUpdateMessage {
                 status,
                 caller_identity: event.caller_identity,
                 reducer_call: ws::ReducerCallInfo {
-                    reducer_name: event.function_call.reducer.to_owned().into(),
+                    reducer_name: event.function_call.reducer.clone(),
                     reducer_id: event.function_call.reducer_id.into(),
                     args,
                     request_id,

crates/core/src/client/messages.rs

@@ -1,6 +1,7 @@
 use std::sync::Arc;
 
 use enum_map::EnumMap;
+use spacetimedb_schema::reducer_name::ReducerName;
 use tokio::sync::mpsc;
 
 use crate::subscription::ExecutionCounters;
@@ -37,7 +38,7 @@ pub struct Config {
 /// We use a separate task to record metrics to avoid blocking transactions.
 pub struct MetricsMessage {
     /// The reducer the produced these metrics.
-    reducer: String,
+    reducer: ReducerName,
     /// Metrics from a mutable transaction.
     metrics_for_writer: Option<TxMetrics>,
     /// Metrics from a read-only transaction.
@@ -60,7 +61,7 @@ pub struct MetricsRecorderQueue {
 impl MetricsRecorderQueue {
     pub fn send_metrics(
         &self,
-        reducer: String,
+        reducer: ReducerName,
         metrics_for_writer: Option<TxMetrics>,
         metrics_for_reader: Option<TxMetrics>,
         tx_data: Option<Arc<TxData>>,

crates/core/src/db/mod.rs

@@ -46,6 +46,7 @@ use spacetimedb_sats::algebraic_type::fmt::fmt_algebraic_type;
 use spacetimedb_sats::memory_usage::MemoryUsage;
 use spacetimedb_sats::{AlgebraicType, AlgebraicValue, ProductType, ProductValue};
 use spacetimedb_schema::def::{ModuleDef, TableDef, ViewDef};
+use spacetimedb_schema::reducer_name::ReducerName;
 use spacetimedb_schema::schema::{
     ColumnSchema, IndexSchema, RowLevelSecuritySchema, Schema, SequenceSchema, TableSchema,
 };
@@ -769,7 +770,7 @@ impl RelationalDB {
     }
 
     #[tracing::instrument(level = "trace", skip_all)]
-    pub fn rollback_mut_tx(&self, tx: MutTx) -> (TxOffset, TxMetrics, String) {
+    pub fn rollback_mut_tx(&self, tx: MutTx) -> (TxOffset, TxMetrics, ReducerName) {
         log::trace!("ROLLBACK MUT TX");
         self.inner.rollback_mut_tx(tx)
     }
@@ -781,14 +782,14 @@ impl RelationalDB {
     }
 
     #[tracing::instrument(level = "trace", skip_all)]
-    pub fn release_tx(&self, tx: Tx) -> (TxOffset, TxMetrics, String) {
+    pub fn release_tx(&self, tx: Tx) -> (TxOffset, TxMetrics, ReducerName) {
         log::trace!("RELEASE TX");
         self.inner.release_tx(tx)
     }
 
     #[tracing::instrument(level = "trace", skip_all)]
     #[allow(clippy::type_complexity)]
-    pub fn commit_tx(&self, tx: MutTx) -> Result<Option<(TxOffset, Arc<TxData>, TxMetrics, String)>, DBError> {
+    pub fn commit_tx(&self, tx: MutTx) -> Result<Option<(TxOffset, Arc<TxData>, TxMetrics, ReducerName)>, DBError> {
         log::trace!("COMMIT MUT TX");
 
         let reducer_context = tx.ctx.reducer_context().cloned();
@@ -1002,7 +1003,7 @@ impl RelationalDB {
     /// Should only be called after the tx lock has been fully released.
     pub(crate) fn report_tx_metrics(
         &self,
-        reducer: String,
+        reducer: ReducerName,
         tx_data: Option<Arc<TxData>>,
         metrics_for_writer: Option<TxMetrics>,
         metrics_for_reader: Option<TxMetrics>,
@@ -1469,12 +1470,12 @@ impl RelationalDB {
     }
 
     /// Reports the metrics for `reducer`, using counters provided by `db`.
-    pub fn report_mut_tx_metrics(&self, reducer: String, metrics: TxMetrics, tx_data: Option<Arc<TxData>>) {
+    pub fn report_mut_tx_metrics(&self, reducer: ReducerName, metrics: TxMetrics, tx_data: Option<Arc<TxData>>) {
         self.report_tx_metrics(reducer, tx_data, Some(metrics), None);
     }
 
     /// Reports subscription metrics for `reducer`, using counters provided by `db`.
-    pub fn report_read_tx_metrics(&self, reducer: String, metrics: TxMetrics) {
+    pub fn report_read_tx_metrics(&self, reducer: ReducerName, metrics: TxMetrics) {
         self.report_tx_metrics(reducer, None, None, Some(metrics));
     }
 
@@ -3277,7 +3278,7 @@ mod tests {
         let timestamp = Timestamp::now();
         let workload = |name: &str| {
             Workload::Reducer(ReducerContext {
-                name: name.into(),
+                name: ReducerName::new_from_str(name),
                 caller_identity: Identity::__dummy(),
                 caller_connection_id: ConnectionId::ZERO,
                 timestamp,
@@ -3468,9 +3469,9 @@ mod tests {
                 arg_bsatn,
             } = ReducerContext::try_from(&input).unwrap();
             if i == 0 {
-                assert_eq!(reducer_name, "__identity_connected__");
+                assert_eq!(&*reducer_name, "__identity_connected__");
             } else {
-                assert_eq!(reducer_name, "abstract_concrete_proxy_factory_impl");
+                assert_eq!(&*reducer_name, "abstract_concrete_proxy_factory_impl");
             }
             assert!(
                 arg_bsatn.is_empty(),

crates/core/src/db/relational_db.rs

@@ -61,6 +61,7 @@ use spacetimedb_query::compile_subscription;
 use spacetimedb_sats::{AlgebraicTypeRef, ProductValue};
 use spacetimedb_schema::auto_migrate::{AutoMigrateError, MigrationPolicy};
 use spacetimedb_schema::def::{ModuleDef, ProcedureDef, ReducerDef, TableDef, ViewDef};
+use spacetimedb_schema::reducer_name::ReducerName;
 use spacetimedb_schema::schema::{Schema, TableSchema};
 use spacetimedb_schema::table_name::TableName;
 use spacetimedb_vm::relation::RelValue;
@@ -193,15 +194,15 @@ impl EventStatus {
 
 #[derive(Debug, Clone, Default)]
 pub struct ModuleFunctionCall {
-    pub reducer: String,
+    pub reducer: ReducerName,
     pub reducer_id: ReducerId,
     pub args: ArgsTuple,
 }
 
 impl ModuleFunctionCall {
     pub fn update() -> Self {
         Self {
-            reducer: String::from("update"),
+            reducer: ReducerName::new_from_str("update"),
             reducer_id: u32::MAX.into(),
             args: ArgsTuple::nullary(),
         }