Include ScopeKind in the Acorn scope parser

We need to differentiate between function/block scopes to be able to
construct the "Scopes proposal" scopes from AST and mappings.

R=bmeurer@chromium.org

Bug: 449575926
Change-Id: I1114ab5b6e743d59d778a80a193a9df7f04c0d16
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/7002917
Reviewed-by: Benedikt Meurer <bmeurer@chromium.org>
Commit-Queue: Simon Zünd <szuend@chromium.org>

Author: szuend

front_end/core/sdk/ScopeTreeCache.test.ts

@@ -21,7 +21,8 @@ describe('ScopeTreeCache', () => {
     });
 
     it('requests the scope tree once for a script', async () => {
-      const scopeTree = {start: 0, end: 20, variables: [], children: []};
+      const scopeTree =
+          {start: 0, end: 20, kind: Formatter.FormatterWorkerPool.ScopeKind.GLOBAL, variables: [], children: []};
       javaScriptScopeTreeStub.returns(Promise.resolve(scopeTree));
 
       const actualScopeTree1 = await scopeTreeForScript(script);
@@ -44,7 +45,8 @@ describe('ScopeTreeCache', () => {
     });
 
     it('requests the scope tree once for a script, even if the first request is not done yet', async () => {
-      const scopeTree = {start: 0, end: 20, variables: [], children: []};
+      const scopeTree =
+          {start: 0, end: 20, kind: Formatter.FormatterWorkerPool.ScopeKind.GLOBAL, variables: [], children: []};
       const {promise: scopeTreePromise, resolve: scopeTreeResolve} =
           Promise.withResolvers<Formatter.FormatterWorkerPool.ScopeTreeNode|null>();
       javaScriptScopeTreeStub.returns(scopeTreePromise);

front_end/entrypoints/formatter_worker/FormatterActions.ts

@@ -44,9 +44,16 @@ export const enum DefinitionKind {
   FIXED = 3,
 }
 
+export const enum ScopeKind {
+  BLOCK = 1,
+  FUNCTION = 2,
+  GLOBAL = 3,
+}
+
 export interface ScopeTreeNode {
   variables: Array<{name: string, kind: DefinitionKind, offsets: number[]}>;
   start: number;
   end: number;
+  kind: ScopeKind;
   children: ScopeTreeNode[];
 }

front_end/entrypoints/formatter_worker/ScopeParser.ts

@@ -5,7 +5,7 @@
 import * as Acorn from '../../third_party/acorn/acorn.js';
 
 import {ECMA_VERSION} from './AcornTokenizer.js';
-import {DefinitionKind, type ScopeTreeNode} from './FormatterActions.js';
+import {DefinitionKind, ScopeKind, type ScopeTreeNode} from './FormatterActions.js';
 
 export function parseScopes(expression: string, sourceType: 'module'|'script' = 'script'): Scope|null {
   // Parse the expression and find variables and scopes.
@@ -36,12 +36,14 @@ export class Scope {
   readonly parent: Scope|null;
   readonly start: number;
   readonly end: number;
+  readonly kind: ScopeKind;
   readonly children: Scope[] = [];
 
-  constructor(start: number, end: number, parent: Scope|null) {
+  constructor(start: number, end: number, parent: Scope|null, kind: ScopeKind) {
     this.start = start;
     this.end = end;
     this.parent = parent;
+    this.kind = kind;
     if (parent) {
       parent.children.push(this);
     }
@@ -61,6 +63,7 @@ export class Scope {
       start: this.start,
       end: this.end,
       variables,
+      kind: this.kind,
       children,
     };
   }
@@ -137,7 +140,7 @@ export class ScopeVariableAnalysis {
 
   constructor(node: Acorn.ESTree.Node) {
     this.#rootNode = node;
-    this.#rootScope = new Scope(node.start, node.end, null);
+    this.#rootScope = new Scope(node.start, node.end, null, ScopeKind.GLOBAL);
     this.#currentScope = this.#rootScope;
   }
 
@@ -169,7 +172,7 @@ export class ScopeVariableAnalysis {
         node.elements.forEach(item => this.#processNode(item));
         break;
       case 'ArrowFunctionExpression': {
-        this.#pushScope(node.start, node.end);
+        this.#pushScope(node.start, node.end, ScopeKind.FUNCTION);
         node.params.forEach(this.#processNodeAsDefinition.bind(this, DefinitionKind.VAR, false));
         if (node.body.type === 'BlockStatement') {
           // Include the body of the arrow function in the same scope as the arguments.
@@ -188,7 +191,7 @@ export class ScopeVariableAnalysis {
         this.#processNode(node.right);
         break;
       case 'BlockStatement':
-        this.#pushScope(node.start, node.end);
+        this.#pushScope(node.start, node.end, ScopeKind.BLOCK);
         node.body.forEach(this.#processNode.bind(this));
         this.#popScope(false);
         break;
@@ -202,7 +205,7 @@ export class ScopeVariableAnalysis {
         break;
       }
       case 'CatchClause':
-        this.#pushScope(node.start, node.end);
+        this.#pushScope(node.start, node.end, ScopeKind.BLOCK);
         this.#processNodeAsDefinition(DefinitionKind.LET, false, node.param);
         this.#processNode(node.body);
         this.#popScope(false);
@@ -234,14 +237,14 @@ export class ScopeVariableAnalysis {
         break;
       case 'ForInStatement':
       case 'ForOfStatement':
-        this.#pushScope(node.start, node.end);
+        this.#pushScope(node.start, node.end, ScopeKind.BLOCK);
         this.#processNode(node.left);
         this.#processNode(node.right);
         this.#processNode(node.body);
         this.#popScope(false);
         break;
       case 'ForStatement':
-        this.#pushScope(node.start, node.end);
+        this.#pushScope(node.start, node.end, ScopeKind.BLOCK);
         this.#processNode(node.init ?? null);
         this.#processNode(node.test ?? null);
         this.#processNode(node.update ?? null);
@@ -250,7 +253,7 @@ export class ScopeVariableAnalysis {
         break;
       case 'FunctionDeclaration':
         this.#processNodeAsDefinition(DefinitionKind.VAR, false, node.id);
-        this.#pushScope(node.id?.end ?? node.start, node.end);
+        this.#pushScope(node.id?.end ?? node.start, node.end, ScopeKind.FUNCTION);
         this.#addVariable('this', node.start, DefinitionKind.FIXED);
         this.#addVariable('arguments', node.start, DefinitionKind.FIXED);
         node.params.forEach(this.#processNodeAsDefinition.bind(this, DefinitionKind.LET, false));
@@ -259,7 +262,7 @@ export class ScopeVariableAnalysis {
         this.#popScope(true);
         break;
       case 'FunctionExpression':
-        this.#pushScope(node.id?.end ?? node.start, node.end);
+        this.#pushScope(node.id?.end ?? node.start, node.end, ScopeKind.FUNCTION);
         this.#addVariable('this', node.start, DefinitionKind.FIXED);
         this.#addVariable('arguments', node.start, DefinitionKind.FIXED);
         node.params.forEach(this.#processNodeAsDefinition.bind(this, DefinitionKind.LET, false));
@@ -421,8 +424,8 @@ export class ScopeVariableAnalysis {
     return this.#allNames;
   }
 
-  #pushScope(start: number, end: number): void {
-    this.#currentScope = new Scope(start, end, this.#currentScope);
+  #pushScope(start: number, end: number, kind: ScopeKind): void {
+    this.#currentScope = new Scope(start, end, this.#currentScope, kind);
   }
 
   #popScope(isFunctionContext: boolean): void {

front_end/models/formatter/FormatterWorkerPool.ts

@@ -5,7 +5,7 @@
 import * as Common from '../../core/common/common.js';
 import * as FormatterActions from '../../entrypoints/formatter_worker/FormatterActions.js';  // eslint-disable-line rulesdir/es-modules-import
 
-export {DefinitionKind, type ScopeTreeNode} from '../../entrypoints/formatter_worker/FormatterActions.js';
+export {DefinitionKind, ScopeKind, type ScopeTreeNode} from '../../entrypoints/formatter_worker/FormatterActions.js';
 
 let formatterWorkerPoolInstance: FormatterWorkerPool;