Add information about the CLI version to generated code. (#2673)

Author: jsdt

.github/workflows/ci.yml

@@ -102,12 +102,12 @@ jobs:
         run: cargo test --all
 
       - name: Check that the test outputs are up-to-date
-        run: git diff --exit-code
+        run: bash tools/check-diff.sh
 
       - name: Ensure C# autogen bindings are up-to-date
         run: |
           cargo run -p spacetimedb-codegen --example regen-csharp-moduledef
-          git diff --exit-code -- crates/bindings-csharp
+          bash tools/check-diff.sh crates/bindings-csharp
 
       - name: C# bindings tests
         working-directory: crates/bindings-csharp

Cargo.lock

@@ -185,7 +185,7 @@ hyper-util = { version = "0.1", features = ["tokio"] }
 imara-diff = "0.1.3"
 indexmap = "2.0.0"
 indicatif = "0.17"
-insta = { version = "1.21.0", features = ["toml"] }
+insta = { version = "1.21.0", features = ["toml", "filters"] }
 is-terminal = "0.4"
 itertools = "0.12"
 itoa = "1"

Cargo.toml

@@ -1,4 +1,5 @@
 pub const CLI_VERSION: &str = env!("CARGO_PKG_VERSION");
+pub const CLI_GIT_HASH: &str = env!("GIT_HASH");
 
 pub fn long_version() -> String {
     format!(
@@ -7,7 +8,7 @@ Path: {path}
 Commit: {commit}
 spacetimedb tool version {CLI_VERSION}; spacetimedb-lib version {lib_ver};",
         path = std::env::current_exe().unwrap_or_else(|_| "<unknown>".into()).display(),
-        commit = env!("GIT_HASH"),
+        commit = CLI_GIT_HASH,
         lib_ver = spacetimedb_lib::version::spacetimedb_lib_version()
     )
 }

crates/bindings-csharp/Runtime/Internal/Autogen/IndexType.g.cs

@@ -16,6 +16,7 @@ use spacetimedb_schema::type_for_generate::{AlgebraicTypeDef, AlgebraicTypeUse,
 
 use super::code_indenter::{CodeIndenter, Indenter};
 use super::Lang;
+use spacetimedb_lib::version::spacetimedb_lib_version;
 
 type Imports = BTreeSet<AlgebraicTypeRef>;
 
@@ -357,6 +358,11 @@ removeOnUpdate = (cb: (ctx: EventContext, onRow: {row_type}, newRow: {row_type})
         }
         out.dedent(1);
         writeln!(out, "}},");
+        writeln!(out, "versionInfo: {{");
+        out.indent(1);
+        writeln!(out, "cliVersion: \"{}\",", spacetimedb_lib_version());
+        out.dedent(1);
+        writeln!(out, "}},");
         writeln!(
             out,
             "// Constructors which are used by the DbConnectionImpl to

crates/bindings-csharp/Runtime/Internal/Autogen/Lifecycle.g.cs

@@ -8,6 +8,7 @@ use std::{
 use super::code_indenter::Indenter;
 use convert_case::{Case, Casing};
 use itertools::Itertools;
+use spacetimedb_lib::version;
 use spacetimedb_lib::{db::raw_def::v9::Lifecycle, sats::AlgebraicTypeRef};
 use spacetimedb_primitives::ColList;
 use spacetimedb_schema::schema::TableSchema;
@@ -53,6 +54,13 @@ const AUTO_GENERATED_FILE_COMMENT: &[&str] = &[
 
 pub(super) fn print_auto_generated_file_comment(output: &mut Indenter) {
     print_lines(output, AUTO_GENERATED_FILE_COMMENT);
+    writeln!(
+        output,
+        "// This was generated using spacetimedb cli version {} (commit {}).",
+        version::spacetimedb_lib_version(),
+        version::GIT_HASH
+    );
+    writeln!(output);
 }
 
 pub(super) fn type_ref_name(module: &ModuleDef, typeref: AlgebraicTypeRef) -> String {

crates/bindings-csharp/Runtime/Internal/Autogen/MiscModuleExport.g.cs

@@ -17,7 +17,15 @@ macro_rules! declare_tests {
         fn $name() {
             let module = extract_descriptions(compiled_module()).unwrap().try_into().unwrap();
             let outfiles = HashMap::<_, _>::from_iter(generate(&module, &$lang));
-            insta::with_settings!({ sort_maps => true }, {
+            let mut settings = insta::Settings::clone_current();
+            settings.set_sort_maps(true);
+            // Ignore the autogenerated comments with version info, since it changes with every
+            // build.
+            settings.add_filter(r"// This was generated using spacetimedb cli version \d+\.\d+\.\d+ .*", "VERSION_COMMENT");
+            // Ignore the place where the CLI version is put in the typescript REMOTE_MODULE info,
+            // so it isn't constantly changing.
+            settings.add_filter(r#"cliVersion: "\d+\.\d+\.\d+","#, r#"cliVersion: "X.Y.Z","#);
+            settings.bind(|| {
                 insta::assert_toml_snapshot!(outfiles);
             });
         }