Add rust sdk tests for views (#3755)

# Description of Changes

Rust SDK test suite for views

# API and ABI breaking changes

None

# Expected complexity level and risk

1

# Testing

This patch only adds tests, it does not change functionality.

Author: joshua-spacetime

Cargo.lock

@@ -44,10 +44,12 @@ members = [
   "modules/sdk-test",
   "modules/sdk-test-connect-disconnect",
   "modules/sdk-test-procedure",
+  "modules/sdk-test-view",
   "sdks/rust/tests/test-client",
   "sdks/rust/tests/test-counter",
   "sdks/rust/tests/connect_disconnect_client",
   "sdks/rust/tests/procedure-client",
+  "sdks/rust/tests/view-client",
   "tools/upgrade-version",
   "tools/license-check",
   "tools/replace-spacetimedb",

Cargo.toml

@@ -0,0 +1,2 @@
+[build]
+target = "wasm32-unknown-unknown"

modules/sdk-test-view/.cargo/config.toml

@@ -0,0 +1,18 @@
+[package]
+name = "sdk-test-view"
+version = "0.1.0"
+edition.workspace = true
+license-file = "LICENSE"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+log.workspace = true
+anyhow.workspace = true
+paste.workspace = true
+
+[dependencies.spacetimedb]
+workspace = true

modules/sdk-test-view/Cargo.toml

@@ -0,0 +1 @@
+../../licenses/BSL.txt

modules/sdk-test-view/LICENSE

@@ -0,0 +1,14 @@
+# `sdk-test-view` *Rust* test
+
+This module tests that:
+1. Rust client bindings are generated for views
+2. You can register callbacks for views just like regular tables
+3. Those callbacks are triggered when a view's dependencies are updated
+
+## How to Run
+
+Run tests named with `view` in the [Rust client SDK test suite](../../sdks/rust/tests/test.rs):
+
+```sh
+cargo test -p spacetimedb-sdk view
+```

modules/sdk-test-view/README.md

@@ -0,0 +1,75 @@
+use spacetimedb::{
+    reducer, table, view, AnonymousViewContext, Identity, ReducerContext, SpacetimeType, Table, ViewContext,
+};
+
+#[table(name = player)]
+struct Player {
+    #[primary_key]
+    #[auto_inc]
+    entity_id: u64,
+    #[unique]
+    identity: Identity,
+}
+
+#[table(name = player_level)]
+struct PlayerLevel {
+    #[unique]
+    entity_id: u64,
+    #[index(btree)]
+    level: u64,
+}
+
+#[derive(SpacetimeType)]
+struct PlayerAndLevel {
+    entity_id: u64,
+    identity: Identity,
+    level: u64,
+}
+
+#[reducer]
+fn insert_player(ctx: &ReducerContext, identity: Identity, level: u64) {
+    let Player { entity_id, .. } = ctx.db.player().insert(Player { entity_id: 0, identity });
+    ctx.db.player_level().insert(PlayerLevel { entity_id, level });
+}
+
+#[reducer]
+fn delete_player(ctx: &ReducerContext, identity: Identity) {
+    if let Some(player) = ctx.db.player().identity().find(identity) {
+        ctx.db.player().entity_id().delete(player.entity_id);
+        ctx.db.player_level().entity_id().delete(player.entity_id);
+    }
+}
+
+#[view(name = my_player, public)]
+fn my_player(ctx: &ViewContext) -> Option<Player> {
+    ctx.db.player().identity().find(ctx.sender)
+}
+
+#[view(name = my_player_and_level, public)]
+fn my_player_and_level(ctx: &ViewContext) -> Option<PlayerAndLevel> {
+    ctx.db
+        .player()
+        .identity()
+        .find(ctx.sender)
+        .and_then(|Player { entity_id, identity }| {
+            ctx.db
+                .player_level()
+                .entity_id()
+                .find(entity_id)
+                .map(|PlayerLevel { level, .. }| PlayerAndLevel {
+                    entity_id,
+                    identity,
+                    level,
+                })
+        })
+}
+
+#[view(name = players_at_level_0, public)]
+fn players_at_level_0(ctx: &AnonymousViewContext) -> Vec<Player> {
+    ctx.db
+        .player_level()
+        .level()
+        .filter(0u64)
+        .filter_map(|p| ctx.db.player().entity_id().find(p.entity_id))
+        .collect()
+}

modules/sdk-test-view/src/lib.rs

@@ -329,3 +329,37 @@ macro_rules! procedure_tests {
 
 procedure_tests!(rust_procedures, "");
 procedure_tests!(typescript_procedures, "-ts");
+
+mod view {
+    use spacetimedb_testing::sdk::Test;
+
+    const MODULE: &str = "sdk-test-view";
+    const CLIENT: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/tests/view-client");
+
+    fn make_test(subcommand: &str) -> Test {
+        Test::builder()
+            .with_name(subcommand)
+            .with_module(MODULE)
+            .with_client(CLIENT)
+            .with_language("rust")
+            .with_bindings_dir("src/module_bindings")
+            .with_compile_command("cargo build")
+            .with_run_command(format!("cargo run -- {}", subcommand))
+            .build()
+    }
+
+    #[test]
+    fn subscribe_anonymous_view() {
+        make_test("view-anonymous-subscribe").run()
+    }
+
+    #[test]
+    fn subscribe_non_anonymous_view() {
+        make_test("view-non-anonymous-subscribe").run()
+    }
+
+    #[test]
+    fn subscribe_view_non_table_return() {
+        make_test("view-non-table-return").run()
+    }
+}

sdks/rust/tests/test.rs

@@ -0,0 +1,17 @@
+[package]
+name = "view-client"
+version.workspace = true
+edition.workspace = true
+license-file = "LICENSE"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+spacetimedb-sdk = { path = "../.." }
+spacetimedb-lib.workspace = true
+test-counter = { path = "../test-counter" }
+anyhow.workspace = true
+env_logger.workspace = true
+
+[lints]
+workspace = true

sdks/rust/tests/view-client/Cargo.toml

@@ -0,0 +1 @@
+../../../../licenses/BSL.txt