Simple implementation of insert_or_update and try_insert_or_update (#2678)

Co-authored-by: Zeke Foppa <[email protected]>

Author: rafaelGuerreiro

crates/bindings/src/table.rs

@@ -388,6 +388,38 @@ impl<Tbl: Table, Col: Index + Column<Table = Tbl>> UniqueColumn<Tbl, Col::ColTyp
         let buf = IterBuf::take();
         update::<Tbl>(Col::index_id(), new_row, buf)
     }
+
+    /// Inserts `new_row` into the table, first checking for an existing
+    /// row with a matching value in the unique column and deleting it if present.
+    ///
+    /// Be careful: in case of a constraint violation, this method will return Err,
+    /// but the previous row will be deleted. If you propagate the error, SpacetimeDB will
+    /// rollback the transaction and the old row will be restored. If you ignore the error,
+    /// the old row will be lost.
+    #[track_caller]
+    #[doc(alias = "try_upsert")]
+    #[cfg(feature = "unstable")]
+    pub fn try_insert_or_update(&self, new_row: Tbl::Row) -> Result<Tbl::Row, TryInsertError<Tbl>> {
+        let col_val = Col::get_field(&new_row);
+        // If the row doesn't exist, delete will return false, which we ignore.
+        let _ = self.delete(col_val);
+
+        // Then, insert the new row.
+        let buf = IterBuf::take();
+        insert::<Tbl>(new_row, buf)
+    }
+
+    /// Inserts `new_row` into the table, first checking for an existing
+    /// row with a matching value in the unique column and deleting it if present.
+    ///
+    /// # Panics
+    /// Panics if either the delete or the insertion would violate a constraint.
+    #[track_caller]
+    #[doc(alias = "upsert")]
+    #[cfg(feature = "unstable")]
+    pub fn insert_or_update(&self, new_row: Tbl::Row) -> Tbl::Row {
+        self.try_insert_or_update(new_row).unwrap_or_else(|e| panic!("{e}"))
+    }
 }
 
 pub trait Index {

modules/module-test/Cargo.toml

@@ -12,7 +12,7 @@ crate-type = ["cdylib"]
 bench = false
 
 [dependencies]
-spacetimedb = { path = "../../crates/bindings" }
+spacetimedb = { path = "../../crates/bindings", features = ["unstable"] }
 
 anyhow.workspace = true
 log.workspace = true

modules/module-test/src/lib.rs

@@ -305,7 +305,13 @@ pub fn test(ctx: &ReducerContext, arg: TestAlias, arg2: TestB, arg3: TestC, arg4
 
 #[spacetimedb::reducer]
 pub fn add_player(ctx: &ReducerContext, name: String) -> Result<(), String> {
-    ctx.db.test_e().try_insert(TestE { id: 0, name })?;
+    // This always creates a new one because id is auto-incremented.
+    let inserted = ctx.db.test_e().id().try_insert_or_update(TestE { id: 0, name })?;
+
+    // Since the previous one is always inserted, at this point it's always updated by this function.
+    // This is a no-op, but we can still call it.
+    ctx.db.test_e().id().try_insert_or_update(inserted)?;
+
     Ok(())
 }