fix: include ID in serialized matches (#426)

getgrit · Jul 19, 2024 · 86b88bf · 86b88bf
1 parent 8043cfa
commit 86b88bf
Show file tree

Hide file tree

Showing 39 changed files with 105 additions and 41 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/cli_bin/Cargo.toml b/crates/cli_bin/Cargo.toml
@@ -37,7 +37,7 @@ tracing-subscriber = { version = "0.3", default-features = false, optional = tru
 serde_json = "1.0.96"
 tempfile = "3.1"
 rayon = "1.8.0"
-insta = { version = "1.30.0", features = ["yaml", "redactions"] }
+insta = { version = "1.30.0", features = ["yaml", "redactions", "filters"] }
 predicates = "3.0.3"
 fs_extra = "1.3"
 ntest = "0.9.0"

diff --git a/crates/cli_bin/tests/apply.rs b/crates/cli_bin/tests/apply.rs
@@ -20,7 +20,7 @@ use rayon::iter::ParallelIterator;
 use regex::Regex;
 use std::sync::Once;
 
-use crate::common::{get_fixture, get_fixtures_root, run_init_cmd};
+use crate::common::{get_fixture, get_fixtures_root, run_init_cmd, INSTA_FILTERS};
 
 mod common;
 
@@ -1708,7 +1708,9 @@ fn output_jsonl() -> Result<()> {
     );
 
     let content = fs_err::read_to_string(dir.join("output.jsonl"))?;
-    assert_snapshot!(content);
+    insta::with_settings!({filters => INSTA_FILTERS.to_vec()}, {
+        assert_snapshot!(content);
+    });
 
     let line_count = content.lines().count();
     assert_eq!(line_count, 3);

diff --git a/crates/cli_bin/tests/common/mod.rs b/crates/cli_bin/tests/common/mod.rs
@@ -8,6 +8,10 @@ use marzano_gritmodule::config::GRIT_GLOBAL_DIR_ENV;
 use tempfile::tempdir;
 
 pub const BIN_NAME: &str = "marzano";
+pub const INSTA_FILTERS: &[(&str, &str)] = &[(
+    r"\b[[:xdigit:]]{8}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{12}\b",
+    "[UUID]",
+)];
 
 #[allow(dead_code)]
 pub fn get_test_cmd() -> Result<Command> {

diff --git a/crates/cli_bin/tests/snapshots/apply__output_jsonl.snap b/crates/cli_bin/tests/snapshots/apply__output_jsonl.snap
diff --git a/crates/core/Cargo.toml b/crates/core/Cargo.toml
@@ -25,7 +25,7 @@ grit-util = { path = "../grit-util" }
 tracing = { version = "0.1.40", default-features = false, features = [] }
 tracing-opentelemetry = { version = "0.22.0", optional = true, default-features = false, features = [
 ] }
-
+uuid = { version = "1.1", features = ["v4", "serde"] }
 regex = { version = "1.7.3" }
 anyhow = { version = "1.0.70" }
 itertools = { version = "0.10.5" }
@@ -47,7 +47,7 @@ fs-err = { version = "2.11.0" }
 [dev-dependencies]
 similar = "2.2.1"
 lazy_static = "1.4.0"
-insta = { version = "1.30.0", features = ["yaml", "redactions"] }
+insta = { version = "1.30.0", features = ["yaml", "redactions", "filters"] }
 trim-margin = "0.1.0"
 marzano-auth = { path = "../auth", features = ["test-utils"] }
 walkdir = "2.3.3"

diff --git a/crates/core/src/api.rs b/crates/core/src/api.rs
@@ -10,6 +10,7 @@ use serde::{Deserialize, Serialize};
 use serde_json::to_string_pretty;
 use std::path::PathBuf;
 use std::{fmt, str::FromStr, vec};
+use uuid::Uuid;
 
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
 #[serde(rename_all = "camelCase")]
@@ -343,6 +344,8 @@ pub struct Match {
     pub ranges: Vec<Range>,
     #[serde(default)]
     pub reason: Option<MatchReason>,
+    #[serde(default)]
+    pub id: Uuid,
 }
 
 impl From<EntireFile> for Match {
@@ -354,6 +357,7 @@ impl From<EntireFile> for Match {
             ranges: file_match.ranges,
             reason: None,
             content: file_match.content,
+            id: Uuid::new_v4(),
         }
     }
 }
@@ -456,6 +460,8 @@ pub struct Rewrite {
     pub rewritten: EntireFile,
     #[serde(default)]
     pub reason: Option<MatchReason>,
+    #[serde(default)]
+    pub id: Uuid,
 }
 
 impl From<Rewrite> for MatchResult {
@@ -558,6 +564,7 @@ impl Rewrite {
             original,
             rewritten,
             reason,
+            id: Uuid::new_v4(),
         }
     }
 }
@@ -568,6 +575,8 @@ pub struct CreateFile {
     pub rewritten: EntireFile,
     range: Option<Vec<Range>>,
     pub reason: Option<MatchReason>,
+    #[serde(default)]
+    pub id: Uuid,
 }
 
 impl From<CreateFile> for MatchResult {
@@ -582,6 +591,7 @@ impl CreateFile {
             rewritten: EntireFile::file_to_entire_file(name, body, None),
             range: None,
             reason: None,
+            id: Uuid::new_v4(),
         }
     }
 }
@@ -622,6 +632,8 @@ pub struct RemoveFile {
     pub original: EntireFile,
     #[serde(default)]
     pub reason: Option<MatchReason>,
+    #[serde(default)]
+    pub id: Uuid,
 }
 
 impl From<RemoveFile> for MatchResult {

diff --git a/crates/core/src/snapshots/marzano_core__test__add_to_set.snap b/crates/core/src/snapshots/marzano_core__test__add_to_set.snap
@@ -147,6 +147,7 @@ expression: results
         end: 68
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
 - __typename: AnalysisLog

diff --git a/crates/core/src/snapshots/marzano_core__test__add_to_set_via_pattern.snap b/crates/core/src/snapshots/marzano_core__test__add_to_set_via_pattern.snap
@@ -150,6 +150,7 @@ expression: results
         end: 68
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
 - __typename: AnalysisLog

diff --git a/crates/core/src/snapshots/marzano_core__test__after_each_file.snap b/crates/core/src/snapshots/marzano_core__test__after_each_file.snap
@@ -59,5 +59,6 @@ expression: results
         end: 16
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
diff --git a/crates/core/src/snapshots/marzano_core__test__basic_md.snap b/crates/core/src/snapshots/marzano_core__test__basic_md.snap
@@ -51,5 +51,6 @@ expression: results
         end: 15
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: foo.md
diff --git a/crates/core/src/snapshots/marzano_core__test__basic_python.snap b/crates/core/src/snapshots/marzano_core__test__basic_python.snap
@@ -62,5 +62,6 @@ expression: results
         end: 19
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: foo.py
diff --git a/crates/core/src/snapshots/marzano_core__test__before_and_after_each_file.snap b/crates/core/src/snapshots/marzano_core__test__before_and_after_each_file.snap
@@ -67,5 +67,6 @@ expression: results
         end: 19
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
diff --git a/crates/core/src/snapshots/marzano_core__test__before_each_file.snap b/crates/core/src/snapshots/marzano_core__test__before_each_file.snap
@@ -56,5 +56,6 @@ expression: results
         end: 16
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
diff --git a/crates/core/src/snapshots/marzano_core__test__clone_activites.snap b/crates/core/src/snapshots/marzano_core__test__clone_activites.snap
@@ -57,6 +57,7 @@ expression: results
   content: "import { findConfigs } from './configs';\n// Remember: ./packages/timekeeper/src/__generated__/stdlib.ts\nexport const stdlib = {\n  show,\n  apply,\n  sh,\n};\n\nexport type StdLibFunctions = typeof stdlib;"
   ranges: []
   reason: ~
+  id: [UUID]
 - __typename: Rewrite
   original:
     messages: []
@@ -123,6 +124,7 @@ expression: results
         end: 47
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: ~/dev/rewriter/packages/sdk/src/stdlib/index.ts
 - __typename: DoneFile

diff --git a/crates/core/src/snapshots/marzano_core__test__code_span.snap b/crates/core/src/snapshots/marzano_core__test__code_span.snap
@@ -62,5 +62,6 @@ expression: results
         end: 12
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: foo.md
diff --git a/crates/core/src/snapshots/marzano_core__test__file_rename.snap b/crates/core/src/snapshots/marzano_core__test__file_rename.snap
@@ -57,5 +57,6 @@ expression: results
         end: 27
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
diff --git a/crates/core/src/snapshots/marzano_core__test__filename.snap b/crates/core/src/snapshots/marzano_core__test__filename.snap
@@ -43,5 +43,6 @@ expression: results
         end: 13
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
diff --git a/crates/core/src/snapshots/marzano_core__test__filename_autoset.snap b/crates/core/src/snapshots/marzano_core__test__filename_autoset.snap
@@ -51,5 +51,6 @@ expression: results
         end: 7
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
diff --git a/crates/core/src/snapshots/marzano_core__test__import_all_already_there.snap b/crates/core/src/snapshots/marzano_core__test__import_all_already_there.snap
@@ -176,5 +176,6 @@ expression: results
       startByte: 9
       endByte: 12
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
diff --git a/crates/core/src/snapshots/marzano_core__test__import_just_insert.snap b/crates/core/src/snapshots/marzano_core__test__import_just_insert.snap
@@ -229,5 +229,6 @@ expression: results
         end: 95
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
diff --git a/crates/core/src/snapshots/marzano_core__test__import_multiple.snap b/crates/core/src/snapshots/marzano_core__test__import_multiple.snap
@@ -369,5 +369,6 @@ expression: results
         end: 114
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
diff --git a/crates/core/src/snapshots/marzano_core__test__import_none.snap b/crates/core/src/snapshots/marzano_core__test__import_none.snap
@@ -153,5 +153,6 @@ expression: results
       startByte: 9
       endByte: 12
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
diff --git a/crates/core/src/snapshots/marzano_core__test__json_file_match_snippet.snap b/crates/core/src/snapshots/marzano_core__test__json_file_match_snippet.snap
@@ -57,5 +57,6 @@ expression: results
         end: 63
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: foo.package.json
diff --git a/crates/core/src/snapshots/marzano_core__test__json_file_match_string.snap b/crates/core/src/snapshots/marzano_core__test__json_file_match_string.snap
@@ -57,5 +57,6 @@ expression: results
         end: 63
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: foo.package.json
diff --git a/crates/core/src/snapshots/marzano_core__test__md_link_metavariable.snap b/crates/core/src/snapshots/marzano_core__test__md_link_metavariable.snap
@@ -73,5 +73,6 @@ expression: results
         end: 30
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: foo.md
diff --git a/crates/core/src/snapshots/marzano_core__test__md_link_node.snap b/crates/core/src/snapshots/marzano_core__test__md_link_node.snap
@@ -73,5 +73,6 @@ expression: results
         end: 27
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: foo.md
diff --git a/crates/core/src/snapshots/marzano_core__test__multifile_pattern.snap b/crates/core/src/snapshots/marzano_core__test__multifile_pattern.snap
@@ -148,6 +148,7 @@ expression: results
         end: 27
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: Rewrite
   original:
     messages: []
@@ -294,6 +295,7 @@ expression: results
         end: 34
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: file1.tsx
 - __typename: DoneFile

diff --git a/crates/core/src/snapshots/marzano_core__test__multifile_propagates_scope_between_steps.snap b/crates/core/src/snapshots/marzano_core__test__multifile_propagates_scope_between_steps.snap
@@ -66,6 +66,7 @@ expression: results
   content: foo(1)
   ranges: []
   reason: ~
+  id: [UUID]
 - __typename: Rewrite
   original:
     messages: []
@@ -141,6 +142,7 @@ expression: results
         end: 6
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: file1.tsx
 - __typename: DoneFile

diff --git a/crates/core/src/snapshots/marzano_core__test__program.snap b/crates/core/src/snapshots/marzano_core__test__program.snap
@@ -40,5 +40,6 @@ expression: results
         end: 30
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
diff --git a/crates/core/src/snapshots/marzano_core__test__program_autoset.snap b/crates/core/src/snapshots/marzano_core__test__program_autoset.snap
@@ -51,5 +51,6 @@ expression: results
         end: 7
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
diff --git a/crates/core/src/snapshots/marzano_core__test__rewrite_dot.snap b/crates/core/src/snapshots/marzano_core__test__rewrite_dot.snap
@@ -52,6 +52,7 @@ expression: results
     byteRanges: []
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
 - __typename: AnalysisLog

diff --git a/crates/core/src/snapshots/marzano_core__test__rewrite_or_bubble_pattern_argument.snap b/crates/core/src/snapshots/marzano_core__test__rewrite_or_bubble_pattern_argument.snap
@@ -107,5 +107,6 @@ expression: results
         end: 110
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
diff --git a/crates/core/src/snapshots/marzano_core__test__saving_info.snap b/crates/core/src/snapshots/marzano_core__test__saving_info.snap
@@ -262,6 +262,7 @@ expression: results
         end: 18
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
 - __typename: AnalysisLog

diff --git a/crates/core/src/snapshots/marzano_core__test__shorthand_log.snap b/crates/core/src/snapshots/marzano_core__test__shorthand_log.snap
@@ -57,6 +57,7 @@ expression: results
       startByte: 8
       endByte: 11
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
 - __typename: AnalysisLog

diff --git a/crates/core/src/snapshots/marzano_core__test__should_log_variable.snap b/crates/core/src/snapshots/marzano_core__test__should_log_variable.snap
@@ -73,6 +73,7 @@ expression: results
         end: 42
     ranges: []
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
 - __typename: AnalysisLog

diff --git a/crates/core/src/snapshots/marzano_core__test__simple_log.snap b/crates/core/src/snapshots/marzano_core__test__simple_log.snap
@@ -51,6 +51,7 @@ expression: results
       startByte: 0
       endByte: 13
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
 - __typename: AnalysisLog

diff --git a/crates/core/src/snapshots/marzano_core__test__variable_message_log.snap b/crates/core/src/snapshots/marzano_core__test__variable_message_log.snap
@@ -54,6 +54,7 @@ expression: results
       startByte: 0
       endByte: 13
   reason: ~
+  id: [UUID]
 - __typename: DoneFile
   relativeFilePath: test-file.tsx
 - __typename: AnalysisLog