Process

I suggest the following process:

Run parser on source to produce AST (AST v1).
Run semantic on AST.
Run transformer on AST.
Store ScopeTree and SymbolTable from after transform (Semantic v1).
Clone AST (making AST v2).
~~Traverse AST v2 and set all scope_id, symbol_id and reference_id fields to None. i.e. AST v2 is now returned to virgin state like it would have been if it had come fresh out of the parser.~~
Run semantic on AST v2. Store the new ScopeTree and SymbolTable (Semantic v2).
Compare scope_id, symbol_id and reference_id fields between AST 1 and AST 2. They should match.
Compare ScopeTree + SymbolTable v1 and v2. They should also match.

i.e. AST v2 and ScopeTree + SymbolTable v2 are how they should be. Make sure that state of both AST and Semantic after transform (v1) matches that.

The complication

The tricky part is what constitutes "matches".

For example if this is the input:

if (x) enum Foo {}
function f() {}

The output of transformer is:

if (x) {}
function f() {}

The scope IDs are:

Before transform:

// Scope ID 0
if (x) enum Foo { /* Scope ID 1 */ }
function f() { /* Scope ID 2 */ }

After transform:

// Scope ID 0
if (x) { /* Scope ID 3 */ } // <-- newly created scope
function f() { /* Scope ID 2 */ }

vs fresh semantic run on post-transform AST:

// Scope ID 0
if (x) { /* Scope ID 1 */ } // <-- numbered 1 as it's 2nd scope found in visitation order
function f() { /* Scope ID 2 */ }

Scope IDs of the if {} block are different in the 2 versions, because in the post-transform version, that scope was newly created in transformer.

But we don't want to throw an error on this because they are equivalent.

Likely same kind of thing will happen with SymbolIds and ReferenceIds.

Conclusion

So this is all a bit of a pain! But, if we can build this test infra, it will give us extremely good test coverage and we can be very confident that transformer is keeping scopes/symbols in sync correctly.

Side note: I'd imagine running these checks as part of transformer conformance, so we get instant feedback on PRs if they foul up scopes.

Process

The complication

Suggested solution

Conclusion

Uh oh!

semantic: check symbols and scopes after transformation #4790

Description

Metadata

Metadata

Assignees

Labels

Type

Fields

Projects

Milestone

Relationships

Development

Issue actions