Merge branch 'master' into bradley/fix-validate-goldens-ci

Author: bradleyshep

.github/workflows/ci.yml

@@ -271,6 +271,9 @@ jobs:
     needs: [lints]
     name: Keynote Bench
     runs-on: spacetimedb-benchmark-runner
+    concurrency:
+      group: ci-benchmark-runner
+      queue: max
     timeout-minutes: 60
     env:
       CARGO_TARGET_DIR: ${{ github.workspace }}/target
@@ -325,6 +328,50 @@ jobs:
       - name: Run keynote-2 benchmark regression check
         run: cargo ci keynote-bench
 
+  index_scan_bench:
+    needs: [lints]
+    name: Index Scan Bench
+    runs-on: spacetimedb-benchmark-runner
+    concurrency:
+      group: ci-benchmark-runner
+      queue: max
+    timeout-minutes: 60
+    env:
+      CARGO_TARGET_DIR: ${{ github.workspace }}/target
+      RUST_BACKTRACE: full
+    steps:
+      - name: Find Git ref
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          PR_NUMBER="${{ github.event.inputs.pr_number || null }}"
+          if test -n "${PR_NUMBER}"; then
+            GIT_REF="$( gh pr view --repo clockworklabs/SpacetimeDB $PR_NUMBER --json headRefName --jq .headRefName )"
+          else
+            GIT_REF="${{ github.ref }}"
+          fi
+          echo "GIT_REF=${GIT_REF}" >>"$GITHUB_ENV"
+
+      - name: Checkout sources
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ env.GIT_REF }}
+
+      - uses: dsherret/rust-toolchain-file@v1
+      - name: Set default rust toolchain
+        run: rustup default $(rustup show active-toolchain | cut -d' ' -f1)
+
+      - name: Cache Rust dependencies
+        uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: ${{ github.workspace }}
+          shared-key: spacetimedb
+          save-if: false
+          prefix-key: v1
+
+      - name: Run index scan benchmark regression check
+        run: cargo bench -p spacetimedb-bench --bench index_scan_gate
+
   lints:
     name: Lints
     runs-on: spacetimedb-new-runner-2

.github/workflows/cla-gate.yml

@@ -0,0 +1,108 @@
+name: CLA Gate
+
+# This workflow makes CLA checks work with merge queue entries. Merge groups get
+# a repository-owned `CLA Gate` commit status on the synthetic queue SHA, while
+# pull request/status events use this Actions job result based on CLA Assistant's
+# raw `license/cla` status.
+#
+# SECURITY: Pull request runs must still check out trusted base-branch code, not
+# PR code, before running repository scripts.
+
+on:
+  pull_request:
+    types: [opened, reopened]
+  status:
+  merge_group:
+
+permissions:
+  contents: read
+  pull-requests: read
+  statuses: write
+
+jobs:
+  publish-cla-gate-status:
+    name: CLA status
+    runs-on: ubuntu-latest
+    if: github.event_name != 'status' || github.event.context == 'license/cla'
+
+    steps:
+      - name: Check out trusted base code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.repository.default_branch }}
+
+      - uses: dsherret/rust-toolchain-file@v1
+
+      - name: Publish CLA Gate status
+        uses: actions/github-script@v7
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        with:
+          script: |
+            const { execFileSync } = require("child_process");
+
+            function claStatus(args) {
+              const output = execFileSync("cargo", ["ci", "cla-assistant", "status", ...args], {
+                encoding: "utf8",
+                env: process.env,
+              });
+              return JSON.parse(output);
+            }
+
+            async function postStatus({ sha, state, description, targetUrl }) {
+              const statusContext = "CLA Gate";
+              core.info(
+                `Publishing ${statusContext}=${state} for ${sha}: ${description}`
+              );
+
+              await github.rest.repos.createCommitStatus({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                sha,
+                state,
+                description,
+                context: statusContext,
+                target_url: targetUrl,
+              });
+            }
+
+            let targetSha;
+            let claStatusArgs;
+
+            if (context.eventName === "merge_group") {
+              await postStatus({
+                sha: process.env.GITHUB_SHA,
+                state: "success",
+                description: "Merge group entry; CLA already checked before queue",
+              });
+              return;
+            }
+
+            if (context.eventName === "status") {
+              targetSha = context.payload.sha;
+              claStatusArgs = ["--sha", targetSha];
+            } else if (context.eventName === "pull_request") {
+              const pr = context.payload.pull_request;
+              targetSha = pr.head.sha;
+              claStatusArgs = ["--pr", String(pr.number)];
+            } else {
+              core.setFailed(`Unsupported event type: ${context.eventName}`);
+              return;
+            }
+
+            const status = claStatus(claStatusArgs);
+
+            if (!status.state) {
+              core.info(`No CLA Gate status to publish for ${targetSha}`);
+              return;
+            }
+
+            if (status.state === "success") {
+              core.info(`license/cla is success for ${targetSha}`);
+              return;
+            }
+
+            const state = status.state || "missing";
+            const description = status.description || "license/cla status is missing";
+            const targetUrl = status.target_url ? ` (${status.target_url})` : "";
+            core.setFailed(`license/cla is ${state}: ${description}${targetUrl}`);

.github/workflows/retry-cla-assistant.yml

@@ -77,6 +77,6 @@ jobs:
         run: |
           while read -r pr_number; do
             if [ -n "${pr_number}" ]; then
-              cargo ci retry-cla-assistant --pr-number "${pr_number}"
+              cargo ci cla-assistant retry --pr-number "${pr_number}"
             fi
           done < "${{ steps.prs.outputs.path }}"

.github/workflows/tag-release.yml

@@ -2,6 +2,8 @@ on:
   release:
     types: [published]
 
+permissions: {}
+
 jobs:
   on-release:
     name: Re-tag latest
@@ -21,3 +23,18 @@ jobs:
         run: |
           VERSION=${GITHUB_REF#refs/*/}
           docker buildx imagetools create clockworklabs/spacetimedb:$VERSION --tag clockworklabs/spacetimedb:latest
+
+  announce-release:
+    name: Announce GitHub release
+    runs-on: ubuntu-latest
+    needs: on-release
+    if: always()
+    steps:
+      - name: Send Discord notification
+        run: |
+          set -euo pipefail
+
+          message="SpacetimeDB GitHub release published: [${{ github.event.release.name }}](<${{ github.event.release.html_url }}>)"
+
+          data="$(jq --null-input --arg msg "$message" '.content=$msg')"
+          curl -X POST -H 'Content-Type: application/json' -d "$data" "${{ secrets.DISCORD_WEBHOOK_RELEASE_ANNOUNCE_URL }}"

crates/bench/Cargo.toml

@@ -30,6 +30,10 @@ harness = false
 name = "index"
 harness = false
 
+[[bench]]
+name = "index_scan_gate"
+harness = false
+
 [[bin]]
 name = "summarize"
 

crates/bench/benches/index_scan_gate.rs

@@ -0,0 +1,80 @@
+use std::time::Duration;
+
+use anyhow::{bail, Context, Result};
+use spacetimedb_sats::product;
+use spacetimedb_testing::modules::{start_runtime, CompilationMode, CompiledModule, IN_MEMORY_CONFIG};
+
+#[cfg(not(target_env = "msvc"))]
+use tikv_jemallocator::Jemalloc;
+
+#[cfg(not(target_env = "msvc"))]
+#[global_allocator]
+static GLOBAL: Jemalloc = Jemalloc;
+
+const WARMUP_RUNS: usize = 5;
+const MEASURED_RUNS: usize = 31;
+const MEDIAN_THRESHOLD: Duration = Duration::from_micros(100);
+
+const REDUCERS: &[&str] = &[
+    "test_index_scan_on_id",
+    "test_index_scan_on_chunk",
+    "test_index_scan_on_x_z_dimension",
+    "test_index_scan_on_x_z",
+];
+
+fn main() -> Result<()> {
+    let module = CompiledModule::compile("perf-test", CompilationMode::Release);
+    let runtime = start_runtime();
+
+    runtime.block_on(async {
+        let module = module.load_module(IN_MEMORY_CONFIG, None).await;
+        let no_args = product![];
+
+        println!("loading perf-test location table...");
+        module
+            .call_reducer_binary("load_location_table", &no_args)
+            .await
+            .context("failed to load perf-test location table")?;
+
+        let mut failures = Vec::new();
+        for &reducer in REDUCERS {
+            for _ in 0..WARMUP_RUNS {
+                module
+                    .call_reducer_binary_result(reducer, &no_args)
+                    .await
+                    .with_context(|| format!("failed during warmup for {reducer}"))?;
+            }
+
+            let mut samples = Vec::with_capacity(MEASURED_RUNS);
+            for _ in 0..MEASURED_RUNS {
+                let result = module
+                    .call_reducer_binary_result(reducer, &no_args)
+                    .await
+                    .with_context(|| format!("failed during measured run for {reducer}"))?;
+                samples.push(result.execution_duration);
+            }
+
+            samples.sort_unstable();
+            let median = samples[samples.len() / 2];
+
+            println!("{reducer:<36} median={median:?}");
+            if median >= MEDIAN_THRESHOLD {
+                failures.push(format!("{reducer} median {median:?}"));
+            }
+        }
+
+        if !failures.is_empty() {
+            bail!(
+                "index scan benchmark failed; median threshold is {:?}; failures: {}",
+                MEDIAN_THRESHOLD,
+                failures.join(", ")
+            );
+        }
+
+        println!(
+            "index scan benchmark passed; all medians are below {:?}",
+            MEDIAN_THRESHOLD
+        );
+        Ok(())
+    })
+}

crates/core/src/db/update.rs

@@ -558,9 +558,18 @@ mod test {
         Ok(())
     }
 
+    fn with_snapshotting(manual: bool) -> anyhow::Result<TestDB> {
+        Ok(if manual {
+            TestDB::durable_without_snapshot_repo()?
+        } else {
+            TestDB::durable()?
+        })
+    }
+
     fn replay_event_table_schema_change(snapshot: TakeSnapshot) -> anyhow::Result<()> {
         let auth_ctx = AuthCtx::for_testing();
-        let stdb = TestDB::durable()?;
+        let with_snapshot = matches!(snapshot, TakeSnapshot::BeforeAutomigration);
+        let stdb = with_snapshotting(with_snapshot)?;
 
         let module_v1 = event_table_module(ProductType::from([
             ("old_payload", AlgebraicType::U64),
@@ -576,7 +585,7 @@ mod test {
             stdb.commit_tx(tx)?;
         }
 
-        if matches!(snapshot, TakeSnapshot::BeforeAutomigration) {
+        if with_snapshot {
             take_snapshot(&stdb)?;
         }
 
@@ -635,7 +644,8 @@ mod test {
     /// permanently preventing the database from reopening.
     fn replay_event_table_drop(snapshot: TakeSnapshot) -> anyhow::Result<()> {
         let auth_ctx = AuthCtx::for_testing();
-        let stdb = TestDB::durable()?;
+        let with_snapshot = matches!(snapshot, TakeSnapshot::BeforeAutomigration);
+        let stdb = with_snapshotting(with_snapshot)?;
 
         let module_v1 = event_table_module(ProductType::from([("payload", AlgebraicType::U64)]));
         let module_v2 = empty_module();
@@ -659,7 +669,7 @@ mod test {
             stdb.commit_tx(tx)?;
         }
 
-        if matches!(snapshot, TakeSnapshot::BeforeAutomigration) {
+        if with_snapshot {
             take_snapshot(&stdb)?;
         }
 

crates/runtime/Cargo.toml

@@ -10,7 +10,7 @@ rust-version.workspace = true
 workspace = true
 
 [dependencies]
-tokio = { workspace = true, optional = true }
+tokio.workspace = true
 async-task = { version = "4.4", default-features = false, optional = true }
 spin = { version = "0.9", default-features = false, features = ["mutex", "spin_mutex"], optional = true }
 libc = { version = "0.2", optional = true }
@@ -20,5 +20,5 @@ futures.workspace = true
 
 [features]
 default = ["tokio"]
-tokio = ["dep:tokio"]
+tokio = []
 simulation = ["dep:async-task", "dep:spin", "dep:libc"]