Refactor yield await classification (#12230)
* fix: incomplete ParamKind declaration * refactor: add expression scope handler * test: update test262 allowlist * chore: cleanup * fix: push expression scope for function body * fix: push new expression scope for initializer and static block * test: add more test cases * fix flow error * refactor: remove unecessary expression scope * fix: parameter initializer error should not cross expression scope boundary * chore: cleanup outdated comments * fix: do not record async arrow error on ParameterDeclaration * Update packages/babel-parser/src/util/expression-scope.js Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> * polish: clear ancestry declaration error on validate Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com>
This commit is contained in:
@@ -4,6 +4,7 @@ import type { Options } from "../options";
|
||||
import type State from "../tokenizer/state";
|
||||
import type { PluginsMap } from "./index";
|
||||
import type ScopeHandler from "../util/scope";
|
||||
import type ExpressionScopeHandler from "../util/expression-scope";
|
||||
import type ClassScopeHandler from "../util/class-scope";
|
||||
import type ProductionParameterHandler from "../util/production-parameter";
|
||||
|
||||
@@ -14,6 +15,7 @@ export default class BaseParser {
|
||||
scope: ScopeHandler<*>;
|
||||
classScope: ClassScopeHandler;
|
||||
prodParam: ProductionParameterHandler;
|
||||
expressionScope: ExpressionScopeHandler;
|
||||
plugins: PluginsMap;
|
||||
filename: ?string;
|
||||
sawUnambiguousESM: boolean = false;
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
// @flow
|
||||
/* eslint sort-keys: "error" */
|
||||
|
||||
/**
|
||||
* @module parser/error-message
|
||||
*/
|
||||
|
||||
// The Errors key follows https://cs.chromium.org/chromium/src/v8/src/common/message-template.h unless it does not exist
|
||||
export const ErrorMessages = Object.freeze({
|
||||
AccessorIsGenerator: "A %0ter cannot be a generator",
|
||||
|
||||
@@ -49,6 +49,11 @@ import {
|
||||
PARAM,
|
||||
functionFlags,
|
||||
} from "../util/production-parameter";
|
||||
import {
|
||||
newArrowHeadScope,
|
||||
newAsyncArrowScope,
|
||||
newExpressionScope,
|
||||
} from "../util/expression-scope.js";
|
||||
import { Errors } from "./error";
|
||||
|
||||
export default class ExpressionParser extends LValParser {
|
||||
@@ -581,15 +586,10 @@ export default class ExpressionParser extends LValParser {
|
||||
stop: false,
|
||||
};
|
||||
do {
|
||||
const oldMaybeInAsyncArrowHead = this.state.maybeInAsyncArrowHead;
|
||||
if (state.maybeAsyncArrow) {
|
||||
this.state.maybeInAsyncArrowHead = true;
|
||||
}
|
||||
base = this.parseSubscript(base, startPos, startLoc, noCalls, state);
|
||||
|
||||
// After parsing a subscript, this isn't "async" for sure.
|
||||
state.maybeAsyncArrow = false;
|
||||
this.state.maybeInAsyncArrowHead = oldMaybeInAsyncArrowHead;
|
||||
} while (!state.stop);
|
||||
return base;
|
||||
}
|
||||
@@ -714,16 +714,15 @@ export default class ExpressionParser extends LValParser {
|
||||
optional: boolean,
|
||||
): N.Expression {
|
||||
const oldMaybeInArrowParameters = this.state.maybeInArrowParameters;
|
||||
const oldYieldPos = this.state.yieldPos;
|
||||
const oldAwaitPos = this.state.awaitPos;
|
||||
this.state.maybeInArrowParameters = true;
|
||||
this.state.yieldPos = -1;
|
||||
this.state.awaitPos = -1;
|
||||
|
||||
this.next(); // eat `(`
|
||||
|
||||
let node = this.startNodeAt(startPos, startLoc);
|
||||
node.callee = base;
|
||||
if (state.maybeAsyncArrow) {
|
||||
this.expressionScope.enter(newAsyncArrowScope());
|
||||
}
|
||||
|
||||
if (state.optionalChainMember) {
|
||||
node.optional = optional;
|
||||
@@ -743,47 +742,17 @@ export default class ExpressionParser extends LValParser {
|
||||
|
||||
if (state.maybeAsyncArrow && this.shouldParseAsyncArrow() && !optional) {
|
||||
state.stop = true;
|
||||
|
||||
this.expressionScope.validateAsPattern();
|
||||
this.expressionScope.exit();
|
||||
node = this.parseAsyncArrowFromCallExpression(
|
||||
this.startNodeAt(startPos, startLoc),
|
||||
node,
|
||||
);
|
||||
this.checkYieldAwaitInDefaultParams();
|
||||
this.state.yieldPos = oldYieldPos;
|
||||
this.state.awaitPos = oldAwaitPos;
|
||||
} else {
|
||||
this.toReferencedArguments(node);
|
||||
|
||||
// We keep the old value if it isn't null, for cases like
|
||||
// (x = async(yield)) => {}
|
||||
//
|
||||
// Hi developer of the future :) If you are implementing generator
|
||||
// arrow functions, please read the note below about "await" and
|
||||
// verify if the same logic is needed for yield.
|
||||
if (oldYieldPos !== -1) this.state.yieldPos = oldYieldPos;
|
||||
|
||||
// Await is trickier than yield. When parsing a possible arrow function
|
||||
// (e.g. something starting with `async(`) we don't know if its possible
|
||||
// parameters will actually be inside an async arrow function or if it is
|
||||
// a normal call expression.
|
||||
// If it ended up being a call expression, if we are in a context where
|
||||
// await expression are disallowed (and thus "await" is an identifier)
|
||||
// we must be careful not to leak this.state.awaitPos to an even outer
|
||||
// context, where "await" could not be an identifier.
|
||||
// For example, this code is valid because "await" isn't directly inside
|
||||
// an async function:
|
||||
//
|
||||
// async function a() {
|
||||
// function b(param = async (await)) {
|
||||
// }
|
||||
// }
|
||||
//
|
||||
if (
|
||||
(!this.isAwaitAllowed() && !oldMaybeInArrowParameters) ||
|
||||
oldAwaitPos !== -1
|
||||
) {
|
||||
this.state.awaitPos = oldAwaitPos;
|
||||
if (state.maybeAsyncArrow) {
|
||||
this.expressionScope.exit();
|
||||
}
|
||||
this.toReferencedArguments(node);
|
||||
}
|
||||
|
||||
this.state.maybeInArrowParameters = oldMaybeInArrowParameters;
|
||||
@@ -1206,24 +1175,15 @@ export default class ExpressionParser extends LValParser {
|
||||
// async [no LineTerminator here] AsyncArrowBindingIdentifier[?Yield] [no LineTerminator here] => AsyncConciseBody[?In]
|
||||
parseAsyncArrowUnaryFunction(id: N.Expression): N.ArrowFunctionExpression {
|
||||
const node = this.startNodeAtNode(id);
|
||||
const oldMaybeInArrowParameters = this.state.maybeInArrowParameters;
|
||||
const oldMaybeInAsyncArrowHead = this.state.maybeInAsyncArrowHead;
|
||||
const oldYieldPos = this.state.yieldPos;
|
||||
const oldAwaitPos = this.state.awaitPos;
|
||||
this.state.maybeInArrowParameters = true;
|
||||
this.state.maybeInAsyncArrowHead = true;
|
||||
this.state.yieldPos = -1;
|
||||
this.state.awaitPos = -1;
|
||||
// We don't need to push a new ParameterDeclarationScope here since we are sure
|
||||
// 1) it is an async arrow, 2) no biding pattern is allowed in params
|
||||
this.prodParam.enter(functionFlags(true, this.prodParam.hasYield));
|
||||
const params = [this.parseIdentifier()];
|
||||
this.prodParam.exit();
|
||||
if (this.hasPrecedingLineBreak()) {
|
||||
this.raise(this.state.pos, Errors.LineTerminatorBeforeArrow);
|
||||
}
|
||||
this.expect(tt.arrow);
|
||||
this.checkYieldAwaitInDefaultParams();
|
||||
this.state.maybeInArrowParameters = oldMaybeInArrowParameters;
|
||||
this.state.maybeInAsyncArrowHead = oldMaybeInAsyncArrowHead;
|
||||
this.state.yieldPos = oldYieldPos;
|
||||
this.state.awaitPos = oldAwaitPos;
|
||||
// let foo = async bar => {};
|
||||
this.parseArrowExpression(node, params, true);
|
||||
return node;
|
||||
@@ -1393,14 +1353,11 @@ export default class ExpressionParser extends LValParser {
|
||||
|
||||
let val;
|
||||
this.next(); // eat `(`
|
||||
this.expressionScope.enter(newArrowHeadScope());
|
||||
|
||||
const oldMaybeInArrowParameters = this.state.maybeInArrowParameters;
|
||||
const oldYieldPos = this.state.yieldPos;
|
||||
const oldAwaitPos = this.state.awaitPos;
|
||||
const oldInFSharpPipelineDirectBody = this.state.inFSharpPipelineDirectBody;
|
||||
this.state.maybeInArrowParameters = true;
|
||||
this.state.yieldPos = -1;
|
||||
this.state.awaitPos = -1;
|
||||
this.state.inFSharpPipelineDirectBody = false;
|
||||
|
||||
const innerStartPos = this.state.start;
|
||||
@@ -1462,12 +1419,8 @@ export default class ExpressionParser extends LValParser {
|
||||
this.shouldParseArrow() &&
|
||||
(arrowNode = this.parseArrow(arrowNode))
|
||||
) {
|
||||
if (!this.isAwaitAllowed() && !this.state.maybeInAsyncArrowHead) {
|
||||
this.state.awaitPos = oldAwaitPos;
|
||||
}
|
||||
this.checkYieldAwaitInDefaultParams();
|
||||
this.state.yieldPos = oldYieldPos;
|
||||
this.state.awaitPos = oldAwaitPos;
|
||||
this.expressionScope.validateAsPattern();
|
||||
this.expressionScope.exit();
|
||||
for (const param of exprList) {
|
||||
if (param.extra && param.extra.parenthesized) {
|
||||
this.unexpected(param.extra.parenStart);
|
||||
@@ -1477,11 +1430,7 @@ export default class ExpressionParser extends LValParser {
|
||||
this.parseArrowExpression(arrowNode, exprList, false);
|
||||
return arrowNode;
|
||||
}
|
||||
|
||||
// We keep the old value if it isn't null, for cases like
|
||||
// (x = (yield)) => {}
|
||||
if (oldYieldPos !== -1) this.state.yieldPos = oldYieldPos;
|
||||
if (oldAwaitPos !== -1) this.state.awaitPos = oldAwaitPos;
|
||||
this.expressionScope.exit();
|
||||
|
||||
if (!exprList.length) {
|
||||
this.unexpected(this.state.lastTokStart);
|
||||
@@ -2016,11 +1965,6 @@ export default class ExpressionParser extends LValParser {
|
||||
type: string,
|
||||
inClassScope: boolean = false,
|
||||
): T {
|
||||
const oldYieldPos = this.state.yieldPos;
|
||||
const oldAwaitPos = this.state.awaitPos;
|
||||
this.state.yieldPos = -1;
|
||||
this.state.awaitPos = -1;
|
||||
|
||||
this.initFunction(node, isAsync);
|
||||
node.generator = !!isGenerator;
|
||||
const allowModifiers = isConstructor; // For TypeScript parameter properties
|
||||
@@ -2036,9 +1980,6 @@ export default class ExpressionParser extends LValParser {
|
||||
this.prodParam.exit();
|
||||
this.scope.exit();
|
||||
|
||||
this.state.yieldPos = oldYieldPos;
|
||||
this.state.awaitPos = oldAwaitPos;
|
||||
|
||||
return node;
|
||||
}
|
||||
|
||||
@@ -2089,23 +2030,17 @@ export default class ExpressionParser extends LValParser {
|
||||
this.prodParam.enter(flags);
|
||||
this.initFunction(node, isAsync);
|
||||
const oldMaybeInArrowParameters = this.state.maybeInArrowParameters;
|
||||
const oldYieldPos = this.state.yieldPos;
|
||||
const oldAwaitPos = this.state.awaitPos;
|
||||
|
||||
if (params) {
|
||||
this.state.maybeInArrowParameters = true;
|
||||
this.setArrowFunctionParameters(node, params, trailingCommaPos);
|
||||
}
|
||||
this.state.maybeInArrowParameters = false;
|
||||
this.state.yieldPos = -1;
|
||||
this.state.awaitPos = -1;
|
||||
this.parseFunctionBody(node, true);
|
||||
|
||||
this.prodParam.exit();
|
||||
this.scope.exit();
|
||||
this.state.maybeInArrowParameters = oldMaybeInArrowParameters;
|
||||
this.state.yieldPos = oldYieldPos;
|
||||
this.state.awaitPos = oldAwaitPos;
|
||||
|
||||
return this.finishNode(node, "ArrowFunctionExpression");
|
||||
}
|
||||
@@ -2135,8 +2070,7 @@ export default class ExpressionParser extends LValParser {
|
||||
isMethod?: boolean = false,
|
||||
): void {
|
||||
const isExpression = allowExpression && !this.match(tt.braceL);
|
||||
const oldInParameters = this.state.inParameters;
|
||||
this.state.inParameters = false;
|
||||
this.expressionScope.enter(newExpressionScope());
|
||||
|
||||
if (isExpression) {
|
||||
// https://tc39.es/ecma262/#prod-ExpressionBody
|
||||
@@ -2196,10 +2130,9 @@ export default class ExpressionParser extends LValParser {
|
||||
},
|
||||
);
|
||||
this.prodParam.exit();
|
||||
this.expressionScope.exit();
|
||||
this.state.labels = oldLabels;
|
||||
}
|
||||
|
||||
this.state.inParameters = oldInParameters;
|
||||
}
|
||||
|
||||
isSimpleParamList(
|
||||
@@ -2381,12 +2314,11 @@ export default class ExpressionParser extends LValParser {
|
||||
if (this.prodParam.hasAwait) {
|
||||
this.raise(startLoc, Errors.AwaitBindingIdentifier);
|
||||
return;
|
||||
}
|
||||
if (
|
||||
this.state.awaitPos === -1 &&
|
||||
(this.state.maybeInAsyncArrowHead || this.isAwaitAllowed())
|
||||
) {
|
||||
this.state.awaitPos = this.state.start;
|
||||
} else {
|
||||
this.expressionScope.recordAsyncArrowParametersError(
|
||||
startLoc,
|
||||
Errors.AwaitBindingIdentifier,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2434,11 +2366,11 @@ export default class ExpressionParser extends LValParser {
|
||||
|
||||
this.next();
|
||||
|
||||
if (this.state.inParameters) {
|
||||
this.raise(node.start, Errors.AwaitExpressionFormalParameter);
|
||||
} else if (this.state.awaitPos === -1) {
|
||||
this.state.awaitPos = node.start;
|
||||
}
|
||||
this.expressionScope.recordParameterInitializerError(
|
||||
node.start,
|
||||
Errors.AwaitExpressionFormalParameter,
|
||||
);
|
||||
|
||||
if (this.eat(tt.star)) {
|
||||
this.raise(node.start, Errors.ObsoleteAwaitStar);
|
||||
}
|
||||
@@ -2478,11 +2410,10 @@ export default class ExpressionParser extends LValParser {
|
||||
parseYield(): N.YieldExpression {
|
||||
const node = this.startNode();
|
||||
|
||||
if (this.state.inParameters) {
|
||||
this.raise(node.start, Errors.YieldInParameter);
|
||||
} else if (this.state.yieldPos === -1) {
|
||||
this.state.yieldPos = node.start;
|
||||
}
|
||||
this.expressionScope.recordParameterInitializerError(
|
||||
node.start,
|
||||
Errors.YieldInParameter,
|
||||
);
|
||||
|
||||
this.next();
|
||||
if (
|
||||
|
||||
@@ -8,6 +8,7 @@ import StatementParser from "./statement";
|
||||
import { SCOPE_PROGRAM } from "../util/scopeflags";
|
||||
import ScopeHandler from "../util/scope";
|
||||
import ClassScopeHandler from "../util/class-scope";
|
||||
import ExpressionScopeHandler from "../util/expression-scope";
|
||||
import ProductionParameterHandler, {
|
||||
PARAM_AWAIT,
|
||||
PARAM,
|
||||
@@ -34,6 +35,7 @@ export default class Parser extends StatementParser {
|
||||
this.scope = new ScopeHandler(this.raise.bind(this), this.inModule);
|
||||
this.prodParam = new ProductionParameterHandler();
|
||||
this.classScope = new ClassScopeHandler(this.raise.bind(this));
|
||||
this.expressionScope = new ExpressionScopeHandler(this.raise.bind(this));
|
||||
this.plugins = pluginsMap(this.options.plugins);
|
||||
this.filename = options.sourceFilename;
|
||||
}
|
||||
|
||||
@@ -30,6 +30,10 @@ import {
|
||||
} from "../util/scopeflags";
|
||||
import { ExpressionErrors } from "./util";
|
||||
import { PARAM, functionFlags } from "../util/production-parameter";
|
||||
import {
|
||||
newExpressionScope,
|
||||
newParameterDeclarationScope,
|
||||
} from "../util/expression-scope";
|
||||
|
||||
const loopLabel = { kind: "loop" },
|
||||
switchLabel = { kind: "switch" };
|
||||
@@ -1077,11 +1081,7 @@ export default class StatementParser extends ExpressionParser {
|
||||
}
|
||||
|
||||
const oldMaybeInArrowParameters = this.state.maybeInArrowParameters;
|
||||
const oldYieldPos = this.state.yieldPos;
|
||||
const oldAwaitPos = this.state.awaitPos;
|
||||
this.state.maybeInArrowParameters = false;
|
||||
this.state.yieldPos = -1;
|
||||
this.state.awaitPos = -1;
|
||||
this.scope.enter(SCOPE_FUNCTION);
|
||||
this.prodParam.enter(functionFlags(isAsync, node.generator));
|
||||
|
||||
@@ -1113,9 +1113,6 @@ export default class StatementParser extends ExpressionParser {
|
||||
}
|
||||
|
||||
this.state.maybeInArrowParameters = oldMaybeInArrowParameters;
|
||||
this.state.yieldPos = oldYieldPos;
|
||||
this.state.awaitPos = oldAwaitPos;
|
||||
|
||||
return node;
|
||||
}
|
||||
|
||||
@@ -1124,10 +1121,8 @@ export default class StatementParser extends ExpressionParser {
|
||||
}
|
||||
|
||||
parseFunctionParams(node: N.Function, allowModifiers?: boolean): void {
|
||||
const oldInParameters = this.state.inParameters;
|
||||
this.state.inParameters = true;
|
||||
|
||||
this.expect(tt.parenL);
|
||||
this.expressionScope.enter(newParameterDeclarationScope());
|
||||
node.params = this.parseBindingList(
|
||||
tt.parenR,
|
||||
charCodes.rightParenthesis,
|
||||
@@ -1135,8 +1130,7 @@ export default class StatementParser extends ExpressionParser {
|
||||
allowModifiers,
|
||||
);
|
||||
|
||||
this.state.inParameters = oldInParameters;
|
||||
this.checkYieldAwaitInDefaultParams();
|
||||
this.expressionScope.exit();
|
||||
}
|
||||
|
||||
registerFunctionStatementId(node: N.Function): void {
|
||||
@@ -1529,6 +1523,9 @@ export default class StatementParser extends ExpressionParser {
|
||||
this.expectPlugin("classStaticBlock", member.start);
|
||||
// Start a new lexical scope
|
||||
this.scope.enter(SCOPE_CLASS | SCOPE_SUPER);
|
||||
// Start a new expression scope, this is required for parsing edge cases like:
|
||||
// async (x = class { static { await; } }) => {}
|
||||
this.expressionScope.enter(newExpressionScope());
|
||||
// Start a new scope with regard to loop labels
|
||||
const oldLabels = this.state.labels;
|
||||
this.state.labels = [];
|
||||
@@ -1538,6 +1535,7 @@ export default class StatementParser extends ExpressionParser {
|
||||
const body = (member.body = []);
|
||||
this.parseBlockOrModuleBlockBody(body, undefined, false, tt.braceR);
|
||||
this.prodParam.exit();
|
||||
this.expressionScope.exit();
|
||||
this.scope.exit();
|
||||
this.state.labels = oldLabels;
|
||||
classBody.body.push(this.finishNode<N.StaticBlock>(member, "StaticBlock"));
|
||||
@@ -1638,42 +1636,34 @@ export default class StatementParser extends ExpressionParser {
|
||||
methodOrProp: N.ClassMethod | N.ClassProperty,
|
||||
): void {}
|
||||
|
||||
// https://tc39.es/proposal-class-fields/#prod-FieldDefinition
|
||||
parseClassPrivateProperty(
|
||||
node: N.ClassPrivateProperty,
|
||||
): N.ClassPrivateProperty {
|
||||
this.scope.enter(SCOPE_CLASS | SCOPE_SUPER);
|
||||
this.prodParam.enter(PARAM);
|
||||
|
||||
node.value = this.eat(tt.eq) ? this.parseMaybeAssignAllowIn() : null;
|
||||
this.parseInitializer(node);
|
||||
this.semicolon();
|
||||
this.prodParam.exit();
|
||||
|
||||
this.scope.exit();
|
||||
|
||||
return this.finishNode(node, "ClassPrivateProperty");
|
||||
}
|
||||
|
||||
// https://tc39.es/proposal-class-fields/#prod-FieldDefinition
|
||||
parseClassProperty(node: N.ClassProperty): N.ClassProperty {
|
||||
if (!node.typeAnnotation) {
|
||||
if (!node.typeAnnotation || this.match(tt.eq)) {
|
||||
this.expectPlugin("classProperties");
|
||||
}
|
||||
|
||||
this.scope.enter(SCOPE_CLASS | SCOPE_SUPER);
|
||||
this.prodParam.enter(PARAM);
|
||||
|
||||
if (this.match(tt.eq)) {
|
||||
this.expectPlugin("classProperties");
|
||||
this.next();
|
||||
node.value = this.parseMaybeAssignAllowIn();
|
||||
} else {
|
||||
node.value = null;
|
||||
}
|
||||
this.parseInitializer(node);
|
||||
this.semicolon();
|
||||
return this.finishNode(node, "ClassProperty");
|
||||
}
|
||||
|
||||
// https://tc39.es/proposal-class-fields/#prod-Initializer
|
||||
parseInitializer(node: N.ClassProperty | N.ClassPrivateProperty): void {
|
||||
this.scope.enter(SCOPE_CLASS | SCOPE_SUPER);
|
||||
this.expressionScope.enter(newExpressionScope());
|
||||
this.prodParam.enter(PARAM);
|
||||
node.value = this.eat(tt.eq) ? this.parseMaybeAssignAllowIn() : null;
|
||||
this.expressionScope.exit();
|
||||
this.prodParam.exit();
|
||||
this.scope.exit();
|
||||
|
||||
return this.finishNode(node, "ClassProperty");
|
||||
}
|
||||
|
||||
parseClassId(
|
||||
@@ -1998,7 +1988,6 @@ export default class StatementParser extends ExpressionParser {
|
||||
// check for keywords used as local names
|
||||
this.checkReservedWord(local.name, local.start, true, false);
|
||||
// check if export is defined
|
||||
// $FlowIgnore
|
||||
this.scope.checkLocalExport(local);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -164,18 +164,6 @@ export default class UtilParser extends Tokenizer {
|
||||
}
|
||||
}
|
||||
|
||||
checkYieldAwaitInDefaultParams() {
|
||||
if (
|
||||
this.state.yieldPos !== -1 &&
|
||||
(this.state.awaitPos === -1 || this.state.yieldPos < this.state.awaitPos)
|
||||
) {
|
||||
this.raise(this.state.yieldPos, Errors.YieldBindingIdentifier);
|
||||
}
|
||||
if (this.state.awaitPos !== -1) {
|
||||
this.raise(this.state.awaitPos, Errors.AwaitBindingIdentifier);
|
||||
}
|
||||
}
|
||||
|
||||
// tryParse will clone parser state.
|
||||
// It is expensive and should be used with cautions
|
||||
tryParse<T: Node | $ReadOnlyArray<Node>>(
|
||||
|
||||
Reference in New Issue
Block a user