Fix parser regression for bad related diagnostic on missing matching …

…brackets (#44158)

* Revert "Revert #43460 and #40884 (#44175)"

This reverts commit 5770434.

* fix missing opening brace match error

* refactor parseExpectedMatchingBrackets

* use getNodePos

* accept baselines

* delete mistakenly added files

* Revert getNodePos addition

Co-authored-by: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>

src/compiler/diagnosticMessages.json

@@ -15,7 +15,7 @@
         "category": "Error",
         "code": 1006
     },
-    "The parser expected to find a '}' to match the '{' token here.": {
+    "The parser expected to find a '{1}' to match the '{0}' token here.": {
         "category": "Error",
         "code": 1007
     },

src/compiler/parser.ts

@@ -1434,24 +1434,27 @@ namespace ts {
             return inContext(NodeFlags.AwaitContext);
         }
 
-        function parseErrorAtCurrentToken(message: DiagnosticMessage, arg0?: any): void {
-            parseErrorAt(scanner.getTokenPos(), scanner.getTextPos(), message, arg0);
+        function parseErrorAtCurrentToken(message: DiagnosticMessage, arg0?: any): DiagnosticWithDetachedLocation | undefined {
+            return parseErrorAt(scanner.getTokenPos(), scanner.getTextPos(), message, arg0);
         }
 
-        function parseErrorAtPosition(start: number, length: number, message: DiagnosticMessage, arg0?: any): void {
+        function parseErrorAtPosition(start: number, length: number, message: DiagnosticMessage, arg0?: any): DiagnosticWithDetachedLocation | undefined {
             // Don't report another error if it would just be at the same position as the last error.
             const lastError = lastOrUndefined(parseDiagnostics);
+            let result: DiagnosticWithDetachedLocation | undefined;
             if (!lastError || start !== lastError.start) {
-                parseDiagnostics.push(createDetachedDiagnostic(fileName, start, length, message, arg0));
+                result = createDetachedDiagnostic(fileName, start, length, message, arg0);
+                parseDiagnostics.push(result);
             }
 
             // Mark that we've encountered an error.  We'll set an appropriate bit on the next
             // node we finish so that it can't be reused incrementally.
             parseErrorBeforeNextFinishedNode = true;
+            return result;
         }
 
-        function parseErrorAt(start: number, end: number, message: DiagnosticMessage, arg0?: any): void {
-            parseErrorAtPosition(start, end - start, message, arg0);
+        function parseErrorAt(start: number, end: number, message: DiagnosticMessage, arg0?: any): DiagnosticWithDetachedLocation | undefined {
+            return parseErrorAtPosition(start, end - start, message, arg0);
         }
 
         function parseErrorAtRange(range: TextRange, message: DiagnosticMessage, arg0?: any): void {
@@ -1779,6 +1782,23 @@ namespace ts {
             return false;
         }
 
+        function parseExpectedMatchingBrackets(openKind: SyntaxKind, closeKind: SyntaxKind, openParsed: boolean, openPosition: number) {
+            if (token() === closeKind) {
+                nextToken();
+                return;
+            }
+            const lastError = parseErrorAtCurrentToken(Diagnostics._0_expected, tokenToString(closeKind));
+            if (!openParsed) {
+                return;
+            }
+            if (lastError) {
+                addRelatedInfo(
+                    lastError,
+                    createDetachedDiagnostic(fileName, openPosition, 1, Diagnostics.The_parser_expected_to_find_a_1_to_match_the_0_token_here, tokenToString(openKind), tokenToString(closeKind))
+                );
+            }
+        }
+
         function parseOptional(t: SyntaxKind): boolean {
             if (token() === t) {
                 nextToken();
@@ -3739,7 +3759,7 @@ namespace ts {
                 if (lastError && lastError.code === Diagnostics._0_expected.code) {
                     addRelatedInfo(
                         lastError,
-                        createDetachedDiagnostic(fileName, openBracePosition, 1, Diagnostics.The_parser_expected_to_find_a_to_match_the_token_here)
+                        createDetachedDiagnostic(fileName, openBracePosition, 1, Diagnostics.The_parser_expected_to_find_a_1_to_match_the_0_token_here, "{", "}")
                     );
                 }
             }
@@ -5772,10 +5792,11 @@ namespace ts {
 
         function parseArrayLiteralExpression(): ArrayLiteralExpression {
             const pos = getNodePos();
-            parseExpected(SyntaxKind.OpenBracketToken);
+            const openBracketPosition = scanner.getTokenPos();
+            const openBracketParsed = parseExpected(SyntaxKind.OpenBracketToken);
             const multiLine = scanner.hasPrecedingLineBreak();
             const elements = parseDelimitedList(ParsingContext.ArrayLiteralMembers, parseArgumentOrArrayLiteralElement);
-            parseExpected(SyntaxKind.CloseBracketToken);
+            parseExpectedMatchingBrackets(SyntaxKind.OpenBracketToken, SyntaxKind.CloseBracketToken, openBracketParsed, openBracketPosition);
             return finishNode(factory.createArrayLiteralExpression(elements, multiLine), pos);
         }
 
@@ -5841,18 +5862,10 @@ namespace ts {
         function parseObjectLiteralExpression(): ObjectLiteralExpression {
             const pos = getNodePos();
             const openBracePosition = scanner.getTokenPos();
-            parseExpected(SyntaxKind.OpenBraceToken);
+            const openBraceParsed = parseExpected(SyntaxKind.OpenBraceToken);
             const multiLine = scanner.hasPrecedingLineBreak();
             const properties = parseDelimitedList(ParsingContext.ObjectLiteralMembers, parseObjectLiteralElement, /*considerSemicolonAsDelimiter*/ true);
-            if (!parseExpected(SyntaxKind.CloseBraceToken)) {
-                const lastError = lastOrUndefined(parseDiagnostics);
-                if (lastError && lastError.code === Diagnostics._0_expected.code) {
-                    addRelatedInfo(
-                        lastError,
-                        createDetachedDiagnostic(fileName, openBracePosition, 1, Diagnostics.The_parser_expected_to_find_a_to_match_the_token_here)
-                    );
-                }
-            }
+            parseExpectedMatchingBrackets(SyntaxKind.OpenBraceToken, SyntaxKind.CloseBraceToken, openBraceParsed, openBracePosition);
             return finishNode(factory.createObjectLiteralExpression(properties, multiLine), pos);
         }
 
@@ -5916,18 +5929,11 @@ namespace ts {
             const pos = getNodePos();
             const hasJSDoc = hasPrecedingJSDocComment();
             const openBracePosition = scanner.getTokenPos();
-            if (parseExpected(SyntaxKind.OpenBraceToken, diagnosticMessage) || ignoreMissingOpenBrace) {
+            const openBraceParsed = parseExpected(SyntaxKind.OpenBraceToken, diagnosticMessage);
+            if (openBraceParsed || ignoreMissingOpenBrace) {
                 const multiLine = scanner.hasPrecedingLineBreak();
                 const statements = parseList(ParsingContext.BlockStatements, parseStatement);
-                if (!parseExpected(SyntaxKind.CloseBraceToken)) {
-                    const lastError = lastOrUndefined(parseDiagnostics);
-                    if (lastError && lastError.code === Diagnostics._0_expected.code) {
-                        addRelatedInfo(
-                            lastError,
-                            createDetachedDiagnostic(fileName, openBracePosition, 1, Diagnostics.The_parser_expected_to_find_a_to_match_the_token_here)
-                        );
-                    }
-                }
+                parseExpectedMatchingBrackets(SyntaxKind.OpenBraceToken, SyntaxKind.CloseBraceToken, openBraceParsed, openBracePosition);
                 const result = withJSDoc(finishNode(factory.createBlock(statements, multiLine), pos), hasJSDoc);
                 if (token() === SyntaxKind.EqualsToken) {
                     parseErrorAtCurrentToken(Diagnostics.Declaration_or_statement_expected_This_follows_a_block_of_statements_so_if_you_intended_to_write_a_destructuring_assignment_you_might_need_to_wrap_the_the_whole_assignment_in_parentheses);
@@ -5983,9 +5989,10 @@ namespace ts {
             const pos = getNodePos();
             const hasJSDoc = hasPrecedingJSDocComment();
             parseExpected(SyntaxKind.IfKeyword);
-            parseExpected(SyntaxKind.OpenParenToken);
+            const openParenPosition = scanner.getTokenPos();
+            const openParenParsed = parseExpected(SyntaxKind.OpenParenToken);
             const expression = allowInAnd(parseExpression);
-            parseExpected(SyntaxKind.CloseParenToken);
+            parseExpectedMatchingBrackets(SyntaxKind.OpenParenToken, SyntaxKind.CloseParenToken, openParenParsed, openParenPosition);
             const thenStatement = parseStatement();
             const elseStatement = parseOptional(SyntaxKind.ElseKeyword) ? parseStatement() : undefined;
             return withJSDoc(finishNode(factory.createIfStatement(expression, thenStatement, elseStatement), pos), hasJSDoc);
@@ -5997,9 +6004,10 @@ namespace ts {
             parseExpected(SyntaxKind.DoKeyword);
             const statement = parseStatement();
             parseExpected(SyntaxKind.WhileKeyword);
-            parseExpected(SyntaxKind.OpenParenToken);
+            const openParenPosition = scanner.getTokenPos();
+            const openParenParsed = parseExpected(SyntaxKind.OpenParenToken);
             const expression = allowInAnd(parseExpression);
-            parseExpected(SyntaxKind.CloseParenToken);
+            parseExpectedMatchingBrackets(SyntaxKind.OpenParenToken, SyntaxKind.CloseParenToken, openParenParsed, openParenPosition);
 
             // From: https://mail.mozilla.org/pipermail/es-discuss/2011-August/016188.html
             // 157 min --- All allen at wirfs-brock.com CONF --- "do{;}while(false)false" prohibited in
@@ -6013,9 +6021,10 @@ namespace ts {
             const pos = getNodePos();
             const hasJSDoc = hasPrecedingJSDocComment();
             parseExpected(SyntaxKind.WhileKeyword);
-            parseExpected(SyntaxKind.OpenParenToken);
+            const openParenPosition = scanner.getTokenPos();
+            const openParenParsed = parseExpected(SyntaxKind.OpenParenToken);
             const expression = allowInAnd(parseExpression);
-            parseExpected(SyntaxKind.CloseParenToken);
+            parseExpectedMatchingBrackets(SyntaxKind.OpenParenToken, SyntaxKind.CloseParenToken, openParenParsed, openParenPosition);
             const statement = parseStatement();
             return withJSDoc(finishNode(factory.createWhileStatement(expression, statement), pos), hasJSDoc);
         }
@@ -6091,9 +6100,10 @@ namespace ts {
             const pos = getNodePos();
             const hasJSDoc = hasPrecedingJSDocComment();
             parseExpected(SyntaxKind.WithKeyword);
-            parseExpected(SyntaxKind.OpenParenToken);
+            const openParenPosition = scanner.getTokenPos();
+            const openParenParsed = parseExpected(SyntaxKind.OpenParenToken);
             const expression = allowInAnd(parseExpression);
-            parseExpected(SyntaxKind.CloseParenToken);
+            parseExpectedMatchingBrackets(SyntaxKind.OpenParenToken, SyntaxKind.CloseParenToken, openParenParsed, openParenPosition);
             const statement = doInsideOfContext(NodeFlags.InWithStatement, parseStatement);
             return withJSDoc(finishNode(factory.createWithStatement(expression, statement), pos), hasJSDoc);
         }
@@ -7398,7 +7408,7 @@ namespace ts {
                     if (lastError && lastError.code === Diagnostics._0_expected.code) {
                         addRelatedInfo(
                             lastError,
-                            createDetachedDiagnostic(fileName, openBracePosition, 1, Diagnostics.The_parser_expected_to_find_a_to_match_the_token_here)
+                            createDetachedDiagnostic(fileName, openBracePosition, 1, Diagnostics.The_parser_expected_to_find_a_1_to_match_the_0_token_here, "{", "}")
                         );
                     }
                 }
@@ -8453,13 +8463,9 @@ namespace ts {
                             hasChildren = true;
                             if (child.kind === SyntaxKind.JSDocTypeTag) {
                                 if (childTypeTag) {
-                                    parseErrorAtCurrentToken(Diagnostics.A_JSDoc_typedef_comment_may_not_contain_multiple_type_tags);
-                                    const lastError = lastOrUndefined(parseDiagnostics);
+                                    const lastError = parseErrorAtCurrentToken(Diagnostics.A_JSDoc_typedef_comment_may_not_contain_multiple_type_tags);
                                     if (lastError) {
-                                        addRelatedInfo(
-                                            lastError,
-                                            createDetachedDiagnostic(fileName, 0, 0, Diagnostics.The_tag_was_first_specified_here)
-                                        );
+                                        addRelatedInfo(lastError, createDetachedDiagnostic(fileName, 0, 0, Diagnostics.The_tag_was_first_specified_here));
                                     }
                                     break;
                                 }

tests/baselines/reference/constructorWithIncompleteTypeAnnotation.errors.txt

@@ -121,6 +121,7 @@ tests/cases/compiler/constructorWithIncompleteTypeAnnotation.ts(261,1): error TS
                     if (retValue != 0 ^=  {
                                       ~~
 !!! error TS1005: ')' expected.
+!!! related TS1007 tests/cases/compiler/constructorWithIncompleteTypeAnnotation.ts:22:20: The parser expected to find a ')' to match the '(' token here.
                                           ~
 
 

tests/baselines/reference/errorRecoveryWithDotFollowedByNamespaceKeyword.errors.txt

@@ -16,5 +16,4 @@ tests/cases/compiler/errorRecoveryWithDotFollowedByNamespaceKeyword.ts(9,2): err
     }
 
 !!! error TS1005: '}' expected.
-!!! related TS1007 tests/cases/compiler/errorRecoveryWithDotFollowedByNamespaceKeyword.ts:3:19: The parser expected to find a '}' to match the '{' token here.
-!!! related TS1007 tests/cases/compiler/errorRecoveryWithDotFollowedByNamespaceKeyword.ts:2:20: The parser expected to find a '}' to match the '{' token here.
+!!! related TS1007 tests/cases/compiler/errorRecoveryWithDotFollowedByNamespaceKeyword.ts:3:19: The parser expected to find a '}' to match the '{' token here.

tests/baselines/reference/jsonParserRecovery/JSX.errors.txt

@@ -33,5 +33,4 @@ JSX(15,10): error TS1005: '}' expected.
               </div>
             )
 
-!!! error TS1005: '}' expected.
-!!! related TS1007 JSX:4:9: The parser expected to find a '}' to match the '{' token here.
+!!! error TS1005: '}' expected.

tests/baselines/reference/jsonParserRecovery/TypeScript_code.errors.txt

@@ -16,5 +16,4 @@ TypeScript code(1,22): error TS1005: '}' expected.
                      ~~~~
 !!! error TS1012: Unexpected token.
 
-!!! error TS1005: '}' expected.
-!!! related TS1007 TypeScript code:1:18: The parser expected to find a '}' to match the '{' token here.
+!!! error TS1005: '}' expected.

tests/baselines/reference/jsonParserRecovery/trailing_identifier.errors.txt

@@ -7,5 +7,4 @@ trailing identifier(1,8): error TS1005: '}' expected.
        ~~~~
 !!! error TS1012: Unexpected token.
 
-!!! error TS1005: '}' expected.
-!!! related TS1007 trailing identifier:1:4: The parser expected to find a '}' to match the '{' token here.
+!!! error TS1005: '}' expected.

tests/baselines/reference/missingCloseBracketInArray.errors.txt

@@ -0,0 +1,8 @@
+tests/cases/compiler/missingCloseBracketInArray.ts(1,48): error TS1005: ']' expected.
+
+
+==== tests/cases/compiler/missingCloseBracketInArray.ts (1 errors) ====
+    var alphas:string[] = alphas = ["1","2","3","4"
+
+!!! error TS1005: ']' expected.
+!!! related TS1007 tests/cases/compiler/missingCloseBracketInArray.ts:1:32: The parser expected to find a ']' to match the '[' token here.

tests/baselines/reference/missingCloseBracketInArray.js

@@ -0,0 +1,5 @@
+//// [missingCloseBracketInArray.ts]
+var alphas:string[] = alphas = ["1","2","3","4"
+
+//// [missingCloseBracketInArray.js]
+var alphas = alphas = ["1", "2", "3", "4"];

tests/baselines/reference/missingCloseBracketInArray.symbols

@@ -0,0 +1,5 @@
+=== tests/cases/compiler/missingCloseBracketInArray.ts ===
+var alphas:string[] = alphas = ["1","2","3","4"
+>alphas : Symbol(alphas, Decl(missingCloseBracketInArray.ts, 0, 3))
+>alphas : Symbol(alphas, Decl(missingCloseBracketInArray.ts, 0, 3))
+

tests/baselines/reference/missingCloseBracketInArray.types

@@ -0,0 +1,11 @@
+=== tests/cases/compiler/missingCloseBracketInArray.ts ===
+var alphas:string[] = alphas = ["1","2","3","4"
+>alphas : string[]
+>alphas = ["1","2","3","4" : string[]
+>alphas : string[]
+>["1","2","3","4" : string[]
+>"1" : "1"
+>"2" : "2"
+>"3" : "3"
+>"4" : "4"
+

tests/baselines/reference/missingCloseParenStatements.errors.txt

@@ -0,0 +1,32 @@
+tests/cases/compiler/missingCloseParenStatements.ts(2,26): error TS1005: ')' expected.
+tests/cases/compiler/missingCloseParenStatements.ts(4,5): error TS1005: ')' expected.
+tests/cases/compiler/missingCloseParenStatements.ts(8,39): error TS1005: ')' expected.
+tests/cases/compiler/missingCloseParenStatements.ts(11,35): error TS1005: ')' expected.
+
+
+==== tests/cases/compiler/missingCloseParenStatements.ts (4 errors) ====
+    var a1, a2, a3 = 0;
+    if ( a1 && (a2 + a3 > 0) {
+                             ~
+!!! error TS1005: ')' expected.
+!!! related TS1007 tests/cases/compiler/missingCloseParenStatements.ts:2:4: The parser expected to find a ')' to match the '(' token here.
+        while( (a2 > 0) && a1
+        {
+        ~
+!!! error TS1005: ')' expected.
+!!! related TS1007 tests/cases/compiler/missingCloseParenStatements.ts:3:10: The parser expected to find a ')' to match the '(' token here.
+            do {
+                var i = i + 1;
+                a1 = a1 + i;
+                with ((a2 + a3 > 0) && a1 {
+                                          ~
+!!! error TS1005: ')' expected.
+!!! related TS1007 tests/cases/compiler/missingCloseParenStatements.ts:8:18: The parser expected to find a ')' to match the '(' token here.
+                    console.log(x);
+                  }
+            } while (i < 5 && (a1 > 5);
+                                      ~
+!!! error TS1005: ')' expected.
+!!! related TS1007 tests/cases/compiler/missingCloseParenStatements.ts:11:17: The parser expected to find a ')' to match the '(' token here.
+        }
+    }

tests/baselines/reference/missingCloseParenStatements.js

@@ -0,0 +1,28 @@
+//// [missingCloseParenStatements.ts]
+var a1, a2, a3 = 0;
+if ( a1 && (a2 + a3 > 0) {
+    while( (a2 > 0) && a1
+    {
+        do {
+            var i = i + 1;
+            a1 = a1 + i;
+            with ((a2 + a3 > 0) && a1 {
+                console.log(x);
+              }
+        } while (i < 5 && (a1 > 5);
+    }
+}
+
+//// [missingCloseParenStatements.js]
+var a1, a2, a3 = 0;
+if (a1 && (a2 + a3 > 0)) {
+    while ((a2 > 0) && a1) {
+        do {
+            var i = i + 1;
+            a1 = a1 + i;
+            with ((a2 + a3 > 0) && a1) {
+                console.log(x);
+            }
+        } while (i < 5 && (a1 > 5));
+    }
+}