fix: embed stack trace regex into main pattern, update tests

Author: nedpals

error_template.go

@@ -50,6 +50,10 @@ func (tmp *CompiledErrorTemplate) ExtractVariables(msg string) map[string]string
 				continue
 			}
 
+			if v, ok := variables[groupNames[idx]]; ok && len(v) != 0 {
+				continue
+			}
+
 			variables[groupNames[idx]] = matchedContent
 		}
 	}
@@ -108,7 +112,11 @@ func (tmp *CompiledErrorTemplate) Match(str string) bool {
 
 type ErrorTemplates map[string]*CompiledErrorTemplate
 
-const defaultStackTraceRegex = `(?P<stacktrace>(?:.|\s)*)`
+const defaultStackTraceRegexOpening = `(?P<stacktrace>(?:`
+const defaultStackTraceRegexClosing = `)*)`
+const defaultStackTraceRegex = defaultStackTraceRegexOpening + `.|\s` + defaultStackTraceRegexClosing
+
+var stackTraceCaptureGroupRegex = regexp.MustCompile(`\(\?P<(?:symbol|path|position)>([a-z0-9A-Z_\\//+.]+)\)`)
 
 func (tmps *ErrorTemplates) Add(language *Language, template ErrorTemplate) (*CompiledErrorTemplate, error) {
 	key := TemplateKey(language.Name, template.Name)
@@ -143,8 +151,10 @@ func (tmps *ErrorTemplates) Add(language *Language, template ErrorTemplate) (*Co
 	}
 
 	if strings.Contains(patternForCompile, "$stacktrace") {
-		patternForCompile =
-			strings.ReplaceAll(patternForCompile, "$stacktrace", defaultStackTraceRegex)
+		rawStackTracePattern := template.StackTracePattern
+		if len(rawStackTracePattern) == 0 && len(language.StackTracePattern) != 0 {
+			rawStackTracePattern = language.StackTracePattern
+		}
 
 		if len(template.StackTracePattern) != 0 {
 			var err error
@@ -153,6 +163,19 @@ func (tmps *ErrorTemplates) Add(language *Language, template ErrorTemplate) (*Co
 				return nil, err
 			}
 		}
+
+		if len(rawStackTracePattern) != 0 {
+			// strip first the group names before replacing $stacktrace
+			strippedStackTracePattern := stackTraceCaptureGroupRegex.ReplaceAllString(rawStackTracePattern, "$1")
+
+			// replace $stacktrace with the actual stack trace pattern
+			patternForCompile =
+				strings.ReplaceAll(patternForCompile, "$stacktrace",
+					defaultStackTraceRegexOpening+strippedStackTracePattern+defaultStackTraceRegexClosing)
+		} else {
+			patternForCompile =
+				strings.ReplaceAll(patternForCompile, "$stacktrace", defaultStackTraceRegex)
+		}
 	}
 
 	compiledPattern, err := regexp.Compile("(?m)^" + patternForCompile + "$")

error_template_test.go

@@ -34,7 +34,7 @@ func TestErrorTemplate(t *testing.T) {
 
 		testutils.Equals(t, tmp.Name, "ErrorA")
 		testutils.Equals(t, tmp.Language, lib.TestLanguage)
-		testutils.Equals(t, tmp.Pattern.String(), `(?m)^This is a sample error(?P<stacktrace>(?:.|\s)*)$`)
+		testutils.Equals(t, tmp.Pattern.String(), `(?m)^This is a sample error(?P<stacktrace>(?:\sin \S+ at \S+:\d+)*)$`)
 		testutils.Equals(t, tmp.StackTraceRegex().String(), `(?m)\sin (?P<symbol>\S+) at (?P<path>\S+):(?P<position>\d+)`)
 		testutils.ExpectNil(t, tmp.StackTracePattern)
 	})
@@ -54,7 +54,7 @@ func TestErrorTemplate(t *testing.T) {
 
 		testutils.Equals(t, tmp.Name, "ErrorB")
 		testutils.Equals(t, tmp.Language, lib.TestLanguage)
-		testutils.Equals(t, tmp.Pattern.String(), `(?m)^This is a sample error with stack trace(?P<stacktrace>(?:.|\s)*)$`)
+		testutils.Equals(t, tmp.Pattern.String(), `(?m)^This is a sample error with stack trace(?P<stacktrace>(?:\S+:\S+:\d+)*)$`)
 		testutils.Equals(t, tmp.StackTraceRegex().String(), `(?P<symbol>\S+):(?P<path>\S+):(?P<position>\d+)`)
 	})
 
@@ -72,7 +72,7 @@ func TestErrorTemplate(t *testing.T) {
 
 		testutils.Equals(t, tmp.Name, "ErrorC")
 		testutils.Equals(t, tmp.Language, lib.TestLanguage)
-		testutils.Equals(t, tmp.Pattern.String(), `(?m)^Stack trace in middle (?P<stacktrace>(?:.|\s)*)test$`)
+		testutils.Equals(t, tmp.Pattern.String(), `(?m)^Stack trace in middle (?P<stacktrace>(?:\sin \S+ at \S+:\d+)*)test$`)
 		testutils.ExpectNil(t, tmp.StackTracePattern)
 	})
 }
@@ -265,7 +265,7 @@ func TestExtractVariables(t *testing.T) {
 
 		variables := tmp.ExtractVariables(input)
 		exp := map[string]string{
-			"stacktrace": "\nin main at /home/user/main.py:123\nin main at /home/user/main.py:1",
+			"stacktrace": "",
 			"input":      "123abc",
 		}
 
@@ -439,6 +439,8 @@ func TestErrorTemplates(t *testing.T) {
 		OnGenBugFixFn:  emptyBugFixFn,
 	})
 
+	inputStackTrace := " in Abcd at test.file:10"
+
 	fmt.Println(tmp.Pattern.String())
 	fmt.Println(tmp2.Pattern.String())
 
@@ -454,7 +456,10 @@ func TestErrorTemplates(t *testing.T) {
 		}
 
 		for i, input := range inputs {
-			matched := errorTemplates.Match(input + "\n" + lib.TestLanguage.StackTracePattern)
+			matched := errorTemplates.Match(input + "\n" + inputStackTrace)
+			if matched == nil {
+				t.Fatalf("expected %s, got nil", expected[i].Name)
+			}
 
 			if !reflect.DeepEqual(matched, expected[i]) {
 				t.Fatalf("expected %s, got %s", expected[i].Name, matched.Name)
@@ -474,7 +479,10 @@ func TestErrorTemplates(t *testing.T) {
 		}
 
 		for i, input := range inputs {
-			matched := errorTemplates.Match(input + "\n" + lib.TestLanguage.StackTracePattern)
+			matched := errorTemplates.Match(input + "\n" + inputStackTrace)
+			if matched == nil {
+				t.Fatalf("expected %s, got nil", expected[i].Name)
+			}
 
 			if !reflect.DeepEqual(matched, expected[i]) {
 				t.Fatalf("expected %s, got %s", expected[i].Name, matched.Name)
@@ -486,8 +494,8 @@ func TestErrorTemplates(t *testing.T) {
 		inputs := []string{
 			"This is a sample errorz\n",
 			"AAnother exmaple error\n",
-			"Another eaaxmaple error\n" + lib.TestLanguage.StackTracePattern,
-			"This is a sample erroar\n" + lib.TestLanguage.StackTracePattern,
+			"Another eaaxmaple error\n" + inputStackTrace,
+			"This is a sample erroar\n" + inputStackTrace,
 		}
 
 		for _, input := range inputs {
@@ -505,8 +513,11 @@ func TestErrorTemplates(t *testing.T) {
 			"Another exmaple error",
 		}
 
-		input := strings.Join(inputs, "\nin main at /home/user/main.py:1\n\n")
+		input := strings.Join(inputs, "\n in main at /home/user/main.py:1\n\n")
 		matched := errorTemplates.Match(input)
+		if matched == nil {
+			t.Fatalf("expected %s, got nil", tmp.Name)
+		}
 
 		if !reflect.DeepEqual(matched, tmp) {
 			t.Fatalf("expected %s, got %s", tmp.Name, matched.Name)
@@ -520,8 +531,11 @@ func TestErrorTemplates(t *testing.T) {
 			"This is a sample error",
 		}
 
-		input := strings.Join(inputs, "\nin main at /home/user/main.py:1\n\n")
+		input := strings.Join(inputs, "\n in main at /home/user/main.py:1\n\n")
 		matched := errorTemplates.Match(input)
+		if matched == nil {
+			t.Fatalf("expected %s, got nil", tmp2.Name)
+		}
 
 		if !reflect.DeepEqual(matched, tmp2) {
 			t.Fatalf("expected %s, got %s", tmp2.Name, matched.Name)

source.go

@@ -543,6 +543,11 @@ func ParseDocument(path string, r io.Reader, parser *sitter.Parser, selectLang *
 	}
 
 	defer parser.Reset()
+
+	if selectLang.SitterLanguage == nil {
+		return nil, fmt.Errorf("Language %s does not have a parser", selectLang.Name)
+	}
+
 	parser.SetLanguage(selectLang.SitterLanguage)
 
 	var existingTree *sitter.Tree