Improve error messages and tests

onflow · Sep 20, 2024 · 99f4ae4 · 99f4ae4
1 parent 81c3004
commit 99f4ae4
Show file tree

Hide file tree

Showing 5 changed files with 358 additions and 74 deletions.
diff --git a/runtime/parser/expression.go b/runtime/parser/expression.go
@@ -1186,6 +1186,9 @@ func defineStringExpression() {
  if curToken.Is(lexer.TokenStringTemplate) {
  p.next()
  // advance to the expression
+ if !p.current.Is(lexer.TokenIdentifier) {
+ return nil, p.syntaxError("expected an identifier got: %s", p.currentTokenSource())
+ }
  value, err := parseExpression(p, lowestBindingPower)
  if err != nil {
  return nil, err

diff --git a/runtime/parser/expression_test.go b/runtime/parser/expression_test.go
@@ -6055,107 +6055,175 @@ func TestParseStringWithUnicode(t *testing.T) {
  utils.AssertEqualWithDiff(t, expected, actual)
 }
 
-func TestParseStringTemplateSimple(t *testing.T) {
+func TestParseStringTemplate(t *testing.T) {
 
  t.Parallel()
 
- actual, errs := testParseExpression(`
- "$test"
- `)
+ t.Run("simple", func(t *testing.T) {
 
- var err error
- if len(errs) > 0 {
- err = Error{
- Errors: errs,
+ t.Parallel()
+
+ actual, errs := testParseExpression(`
+ "$test"
+ `)
+
+ var err error
+ if len(errs) > 0 {
+ err = Error{
+ Errors: errs,
+ }
  }
- }
 
- require.NoError(t, err)
+  require.NoError(t, err)
 
- expected := &ast.StringTemplateExpression{
- Values: []string{
- "",
- "",
- },
- Expressions: []ast.Expression{
- &ast.IdentifierExpression{
- Identifier: ast.Identifier{
- Identifier: "test",
- Pos: ast.Position{Offset: 9, Line: 2, Column: 8},
+ expected := &ast.StringTemplateExpression{
+ Values: []string{
+ "",
+ "",
+ },
+ Expressions: []ast.Expression{
+ &ast.IdentifierExpression{
+ Identifier: ast.Identifier{
+ Identifier: "test",
+ Pos: ast.Position{Offset: 5, Line: 2, Column: 4},
+ },
  },
  },
- },
- Range: ast.Range{
- StartPos: ast.Position{Offset: 7, Line: 2, Column: 6},
- EndPos: ast.Position{Offset: 13, Line: 2, Column: 12},
- },
- }
+ Range: ast.Range{
+ StartPos: ast.Position{Offset: 3, Line: 2, Column: 2},
+ EndPos: ast.Position{Offset: 9, Line: 2, Column: 8},
+ },
+ }
 
- utils.AssertEqualWithDiff(t, expected, actual)
-}
+  utils.AssertEqualWithDiff(t, expected, actual)
+ })
 
-func TestParseStringTemplateMulti(t *testing.T) {
+ t.Run("multi", func(t *testing.T) {
 
- t.Parallel()
+  t.Parallel()
 
- actual, errs := testParseExpression(`
- "this is a test $abc $def test"
- `)
+  actual, errs := testParseExpression(`
+ "this is a test $abc$def test"
+  `)
 
- var err error
- if len(errs) > 0 {
- err = Error{
- Errors: errs,
+ var err error
+ if len(errs) > 0 {
+ err = Error{
+ Errors: errs,
+ }
  }
- }
 
- require.NoError(t, err)
+  require.NoError(t, err)
 
- expected := &ast.StringTemplateExpression{
- Values: []string{
- "this is a test ",
- " ",
- " test",
- },
- Expressions: []ast.Expression{
- &ast.IdentifierExpression{
- Identifier: ast.Identifier{
- Identifier: "abc",
- Pos: ast.Position{Offset: 24, Line: 2, Column: 23},
+ expected := &ast.StringTemplateExpression{
+ Values: []string{
+ "this is a test ",
+ "",
+ " test",
+ },
+ Expressions: []ast.Expression{
+ &ast.IdentifierExpression{
+ Identifier: ast.Identifier{
+ Identifier: "abc",
+ Pos: ast.Position{Offset: 20, Line: 2, Column: 19},
+ },
+ },
+ &ast.IdentifierExpression{
+ Identifier: ast.Identifier{
+ Identifier: "def",
+ Pos: ast.Position{Offset: 24, Line: 2, Column: 24},
+ },
  },
  },
- &ast.IdentifierExpression{
- Identifier: ast.Identifier{
- Identifier: "def",
- Pos: ast.Position{Offset: 29, Line: 2, Column: 28},
+ Range: ast.Range{
+ StartPos: ast.Position{Offset: 3, Line: 2, Column: 2},
+ EndPos: ast.Position{Offset: 32, Line: 2, Column: 32},
+ },
+ }
+
+ utils.AssertEqualWithDiff(t, expected, actual)
+ })
+
+ t.Run("missing end", func(t *testing.T) {
+
+ t.Parallel()
+
+ _, errs := testParseExpression(`
+ "this is a test $FOO
+ `)
+
+ var err error
+ if len(errs) > 0 {
+ err = Error{
+ Errors: errs,
+ }
+ }
+
+ require.Error(t, err)
+ utils.AssertEqualWithDiff(t,
+ []error{
+ &SyntaxError{
+ Message: "invalid end of string literal: missing '\"'",
+ Pos: ast.Position{Offset: 25, Line: 2, Column: 25},
  },
  },
- },
- Range: ast.Range{
- StartPos: ast.Position{Offset: 7, Line: 2, Column: 6},
- EndPos: ast.Position{Offset: 37, Line: 2, Column: 36},
- },
- }
+ errs,
+ )
+ })
 
- utils.AssertEqualWithDiff(t, expected, actual)
-}
+ t.Run("invalid identifier", func(t *testing.T) {
 
-func TestParseStringTemplateFail(t *testing.T) {
+ t.Parallel()
 
- t.Parallel()
+ _, errs := testParseExpression(`
+ "$$"
+ `)
 
- _, errs := testParseExpression(`
- "this is a test $FOO
- `)
+ var err error
+ if len(errs) > 0 {
+ err = Error{
+ Errors: errs,
+ }
+ }
 
- var err error
- if len(errs) > 0 {
- err = Error{
- Errors: errs,
+ require.Error(t, err)
+ utils.AssertEqualWithDiff(t,
+ []error{
+ &SyntaxError{
+ Message: "expected an identifier got: $",
+ Pos: ast.Position{Offset: 7, Line: 2, Column: 6},
+ },
+ },
+ errs,
+ )
+ })
+
+ t.Run("invalid, num", func(t *testing.T) {
+
+ t.Parallel()
+
+ _, errs := testParseExpression(`
+ "$(2 + 2) is a"
+ `)
+
+ var err error
+ if len(errs) > 0 {
+ err = Error{
+ Errors: errs,
+ }
  }
- }
 
- require.Error(t, err)
+ require.Error(t, err)
+ utils.AssertEqualWithDiff(t,
+ []error{
+ &SyntaxError{
+ Message: "expected an identifier got: (",
+ Pos: ast.Position{Offset: 7, Line: 2, Column: 6},
+ },
+ },
+ errs,
+ )
+ })
 }
 
 func TestParseNilCoalescing(t *testing.T) {