commit a9f127dc51aeb0de37af4fa67d1de85a1832bea5
author Paul Berry <paulberry@google.com> Tue Apr 01 11:19:47 2025 -0700
committer Commit Queue <dart-scoped@luci-project-accounts.iam.gserviceaccount.com> Tue Apr 01 11:19:47 2025 -0700
tree 985aa8c296f36a25d1ba2c80d67e3783755e1d66
parent d7e0c3c9f6f2dd49c101d8686cbf05b2815afca0

[analyzer] Rewrite `ResultComparator`.

Previously, this class was based on `AstComparator` (and was the sole
user of `AstComparator`). The new implementation is based on
`AstNodeImpl.namedChildEntities`. In a follow-up CL I'll remove
`AstComparator`, which should make future modifications to the
analyzer AST classes just a little bit easier and less error-prone.

I've gone ahead and made some improvements to `ResultComparator` in
the process:

- I've improved the failure messages when there is a token mismatch,
  so that the token details (synthetic/non-synthetic, token type,
  lexeme, and length) are shown, as well as the path to the mismatched
  token in the AST.

- I've improved the syntax for showing the path to the
  mismatch. Previously all that was shown was the types of the
  ancestor AST nodes, which was useful but didn't give complete
  information. Now the types are shown as well as the getter names and
  indices necessary to reach the mismatch. For example, a mismatch
  between `class X {}` and `class C {}` is now shown with the path
  `((root as CompilationUnit).declarations[0] as
  ClassDeclaration).name`.

- I've tightened up the rules for token matching. An "actual" token
  that is synthetic no longer matches just any old "expected" token;
  the expected token must be `_s_` for a synthetic identifier, or an
  empty string for a synthetic string. This required some minor fixes
  to be made to `try_statement_test.dart`.

- Documentation comments are now fully checked; previously only
  comment references were checked.

Note that the tests `ModifiersTest.test_classDeclaration_static` and
`MissingCodeTest.test_stringInterpolation_unclosed` now pass. These
tests exercise parser recovery scenarios where a token is either
ignored or synthetically inserted at the very beginning or end of a
compilation unit. These tests were failing under the old
`AstComparator`-based implementation of `ResultComparator`, because in
addition to recursively comparing the AST structures of a compilation
unit, `AstComparator` compares `CompilationUnit.beginToken` and
`CompilationUnit.endToken`. These fields store the true starting and
ending tokens of the compilation unit (not the results of parser error
recovery), so as a result, the old `AstComparator`-based
implementation of `ResultComparator` was reporting that parser error
recovery had failed when it had in fact succeeded. The new
implementation of `ResultComparator` only compares the AST structures,
so it correctly concludes that parser error recovery has succeeded.

Change-Id: Ifac2065b823e604e07a64500eb2b6b2be125802d
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/419521
Reviewed-by: Konstantin Shcheglov <scheglov@google.com>
Commit-Queue: Paul Berry <paulberry@google.com>