Log invariant violations in fuzzy string match iterator (#21983)

Michael Sloan created 1 year ago

Seeing frequent inscrutable panics here

Release Notes:

- N/A

Change summary

Cargo.lock                  |  1 +
crates/fuzzy/Cargo.toml     |  1 +
crates/fuzzy/src/strings.rs | 14 ++++++++++++++
3 files changed, 16 insertions(+)

Detailed changes

Cargo.lock

@@ -5030,6 +5030,7 @@ name = "fuzzy"
 version = "0.1.0"
 dependencies = [
  "gpui",
+ "log",
  "util",
 ]
 

crates/fuzzy/Cargo.toml

@@ -15,3 +15,4 @@ doctest = false
 [dependencies]
 gpui.workspace = true
 util.workspace = true
+log.workspace = true

crates/fuzzy/src/strings.rs

@@ -61,9 +61,23 @@ impl StringMatch {
         let mut positions = self.positions.iter().peekable();
         iter::from_fn(move || {
             if let Some(start) = positions.next().copied() {
+                if start >= self.string.len() {
+                    log::error!(
+                        "Invariant violation: Index {start} out of range in string {:?}",
+                        self.string
+                    );
+                    return None;
+                }
                 let mut end = start + self.char_len_at_index(start);
                 while let Some(next_start) = positions.peek() {
                     if end == **next_start {
+                        if end >= self.string.len() {
+                            log::error!(
+                                "Invariant violation: Index {end} out of range in string {:?}",
+                                self.string
+                            );
+                            return None;
+                        }
                         end += self.char_len_at_index(end);
                         positions.next();
                     } else {