WASM ABI: get_table_id -> table_id_from_name (#1634)

Author: Centril

crates/bindings-csharp/Runtime/Exceptions.cs

@@ -7,14 +7,14 @@ public abstract class StdbException : Exception
     public abstract override string Message { get; }
 }
 
-public class NoSuchTableException : StdbException
+public class NotInTransactionException : StdbException
 {
-    public override string Message => "No such table";
+    public override string Message => "ABI call can only be made while in a transaction";
 }
 
-public class LookupNotFoundException : StdbException
+public class NoSuchTableException : StdbException
 {
-    public override string Message => "Value or range provided not found in table";
+    public override string Message => "No such table";
 }
 
 public class UniqueAlreadyExistsException : StdbException

crates/bindings-csharp/Runtime/Internal/FFI.cs

@@ -23,8 +23,8 @@ public enum Errno : short
     EXHAUSTED = -1,
     OK = 0,
     HOST_CALL_FAILURE = 1,
+    NOT_IN_TRANSACTION = 2,
     NO_SUCH_TABLE = 4,
-    LOOKUP_NOT_FOUND = 2,
     NO_SUCH_ITER = 6,
     NO_SUCH_BYTES = 8,
     NO_SPACE = 9,
@@ -69,8 +69,8 @@ public static CheckedStatus ConvertToManaged(Errno status)
                 }
                 throw status switch
                 {
+                    Errno.NOT_IN_TRANSACTION => new NotInTransactionException(),
                     Errno.NO_SUCH_TABLE => new NoSuchTableException(),
-                    Errno.LOOKUP_NOT_FOUND => new LookupNotFoundException(),
                     Errno.UNIQUE_ALREADY_EXISTS => new UniqueAlreadyExistsException(),
                     Errno.BUFFER_TOO_SMALL => new BufferTooSmallException(),
                     Errno.NO_SUCH_BYTES => new NoSuchBytesException(),
@@ -114,7 +114,7 @@ public readonly record struct RowIter(uint Handle)
     }
 
     [LibraryImport(StdbNamespace)]
-    public static partial CheckedStatus _get_table_id(
+    public static partial CheckedStatus _table_id_from_name(
         [In] byte[] name,
         uint name_len,
         out TableId out_

crates/bindings-csharp/Runtime/Internal/ITable.cs

@@ -135,7 +135,7 @@ protected override void IterStart(out FFI.RowIter handle) =>
         new(() =>
         {
             var name_bytes = System.Text.Encoding.UTF8.GetBytes(typeof(T).Name);
-            FFI._get_table_id(name_bytes, (uint)name_bytes.Length, out var out_);
+            FFI._table_id_from_name(name_bytes, (uint)name_bytes.Length, out var out_);
             return out_;
         });
 

crates/bindings-csharp/Runtime/bindings.c

@@ -42,7 +42,7 @@ IMPORT(void, _console_log,
        (level, target, target_len, filename, filename_len, line_number, message,
         message_len));
 
-IMPORT(Status, _get_table_id,
+IMPORT(Status, _table_id_from_name,
        (const uint8_t* name, uint32_t name_len, TableId* id),
        (name, name_len, id));
 IMPORT(Status, _iter_by_col_eq,

crates/bindings-csharp/Runtime/build/SpacetimeDB.Runtime.targets

@@ -4,13 +4,13 @@
     <NativeLibrary Include="$(MSBuildThisFileDirectory)..\bindings.c" />
     <UnmanagedEntryPointsAssembly Include="SpacetimeDB.Runtime" />
     <WasmImport Include="$(SpacetimeNamespace)!_console_log" />
-    <WasmImport Include="$(SpacetimeNamespace)!_get_table_id" />
     <WasmImport Include="$(SpacetimeNamespace)!_iter_by_col_eq" />
     <WasmImport Include="$(SpacetimeNamespace)!_insert" />
     <WasmImport Include="$(SpacetimeNamespace)!_delete_by_col_eq" />
     <WasmImport Include="$(SpacetimeNamespace)!_delete_by_rel" />
     <WasmImport Include="$(SpacetimeNamespace)!_iter_start" />
     <WasmImport Include="$(SpacetimeNamespace)!_iter_start_filtered" />
+    <WasmImport Include="$(SpacetimeNamespace)!_table_id_from_name" />
     <WasmImport Include="$(SpacetimeNamespace)!_row_iter_bsatn_advance" />
     <WasmImport Include="$(SpacetimeNamespace)!_row_iter_bsatn_close" />
     <WasmImport Include="$(SpacetimeNamespace)!_bytes_source_read" />

crates/bindings-macro/src/lib.rs

@@ -567,11 +567,11 @@ fn spacetimedb_tabletype_impl(item: syn::DeriveInput) -> syn::Result<TokenStream
 
     let mut columns = Vec::<Column>::new();
 
-    let get_table_id_func = quote! {
+    let table_id_from_name_func = quote! {
         fn table_id() -> spacetimedb::TableId {
             static TABLE_ID: std::sync::OnceLock<spacetimedb::TableId> = std::sync::OnceLock::new();
             *TABLE_ID.get_or_init(|| {
-                spacetimedb::get_table_id(<Self as spacetimedb::TableType>::TABLE_NAME)
+                spacetimedb::table_id_from_name(<Self as spacetimedb::TableType>::TABLE_NAME)
             })
         }
     };
@@ -774,7 +774,7 @@ fn spacetimedb_tabletype_impl(item: syn::DeriveInput) -> syn::Result<TokenStream
             ];
             const INDEXES: &'static [spacetimedb::IndexDesc<'static>] = &[#(#indexes),*];
             type InsertResult = #insert_result;
-            #get_table_id_func
+            #table_id_from_name_func
         }
     };
 

crates/bindings-sys/src/lib.rs

@@ -21,16 +21,24 @@ pub mod raw {
     #[link(wasm_import_module = "spacetime_10.0")]
     extern "C" {
         /// Queries the `table_id` associated with the given (table) `name`
-        /// where `name` points to a UTF-8 slice in WASM memory of `name_len` bytes.
+        /// where `name` is the UTF-8 slice in WASM memory at `name_ptr[..name_len]`.
         ///
         /// The table id is written into the `out` pointer.
         ///
-        /// Returns an error if
-        /// - a table with the provided `table_id` doesn't exist
-        /// - the slice `(name, name_len)` is not valid UTF-8
-        /// - `name + name_len` overflows a 64-bit address.
-        /// - writing to `out` overflows a 32-bit integer
-        pub fn _get_table_id(name: *const u8, name_len: usize, out: *mut TableId) -> u16;
+        /// # Traps
+        ///
+        /// Traps if:
+        /// - `name_ptr` is NULL or `name` is not in bounds of WASM memory.
+        /// - `name` is not valid UTF-8.
+        /// - `out` is NULL or `out[..size_of::<TableId>()]` is not in bounds of WASM memory.
+        ///
+        /// # Errors
+        ///
+        /// Returns an error:
+        ///
+        /// - `NOT_IN_TRANSACTION`, when called outside of a transaction.
+        /// - `NO_SUCH_TABLE`, when `name` is not the name of a table.
+        pub fn _table_id_from_name(name: *const u8, name_len: usize, out: *mut TableId) -> u16;
 
         /// Finds all rows in the table identified by `table_id`,
         /// where the row has a column, identified by `col_id`,
@@ -511,8 +519,8 @@ unsafe fn call<T: Copy>(f: impl FnOnce(*mut T) -> u16) -> Result<T, Errno> {
 ///
 /// Returns an error if the table does not exist.
 #[inline]
-pub fn get_table_id(name: &str) -> Result<TableId, Errno> {
-    unsafe { call(|out| raw::_get_table_id(name.as_ptr(), name.len(), out)) }
+pub fn table_id_from_name(name: &str) -> Result<TableId, Errno> {
+    unsafe { call(|out| raw::_table_id_from_name(name.as_ptr(), name.len(), out)) }
 }
 
 /// Finds all rows in the table identified by `table_id`,

crates/bindings/src/lib.rs

@@ -116,8 +116,8 @@ pub fn decode_schema<'a>(bytes: &mut impl BufReader<'a>) -> Result<ProductType,
 /// Queries and returns the `table_id` associated with the given (table) `name`.
 ///
 /// Panics if the table does not exist.
-pub fn get_table_id(table_name: &str) -> TableId {
-    sys::get_table_id(table_name).unwrap_or_else(|_| {
+pub fn table_id_from_name(table_name: &str) -> TableId {
+    sys::table_id_from_name(table_name).unwrap_or_else(|_| {
         panic!("Failed to get table with name: {}", table_name);
     })
 }

crates/core/src/error.rs

@@ -322,10 +322,6 @@ pub enum NodesError {
     DecodeFilter(#[source] DecodeError),
     #[error("table with provided name or id doesn't exist")]
     TableNotFound,
-    #[error("row with column of given value not found")]
-    ColumnValueNotFound,
-    #[error("range of rows not found")]
-    RangeNotFound,
     #[error("column is out of bounds")]
     BadColumn,
     #[error("can't perform operation; not inside transaction")]

crates/core/src/host/instance_env.rs

@@ -187,9 +187,10 @@ impl InstanceEnv {
 
     /// Returns the `table_id` associated with the given `table_name`.
     ///
-    /// Errors with `TableNotFound` if the table does not exist.
+    /// Errors with `GetTxError` if not in a transaction
+    /// and `TableNotFound` if the table does not exist.
     #[tracing::instrument(skip_all)]
-    pub fn get_table_id(&self, table_name: &str) -> Result<TableId, NodesError> {
+    pub fn table_id_from_name(&self, table_name: &str) -> Result<TableId, NodesError> {
         let stdb = &*self.dbic.relational_db;
         let tx = &mut *self.get_tx()?;