Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update detection of pure nodes (Scope#isPure) #14424

Merged
merged 8 commits into from Apr 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -1,8 +1,4 @@
var _ref2;
var _ref;

const result = (_ref2 = Math.pow(5, 2), [1, 2, 3].map(n => {
var _ref;

return _ref = (n + _ref2) * 2, `${_ref} apples`.toUpperCase();
}).join());
const result = (_ref = Math.pow(5, 2), [1, 2, 3].map(n => `${(n + _ref) * 2} apples`.toUpperCase()).join());
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. Babel is generating less.

expect(result).toEqual('52 APPLES,54 APPLES,56 APPLES');
@@ -1,4 +1,4 @@
var _ref;

const result = (_ref = Math.pow(5, 2) + 1, `${_ref} apples`.toUpperCase());
const result = (_ref = Math.pow(5, 2), `${_ref + 1} apples`.toUpperCase());
expect(result).toEqual('26 APPLES');
@@ -1,8 +1,4 @@
var _ref2;
var _ref;

const result = (_ref2 = Math.pow(5, 2), [1, 2, 3].map(n => {
var _ref;

return _ref = (n + _ref2) * 2, `${_ref} apples`.toUpperCase();
}).join());
const result = (_ref = Math.pow(5, 2), [1, 2, 3].map(n => `${(n + _ref) * 2} apples`.toUpperCase()).join());
expect(result).toEqual('52 APPLES,54 APPLES,56 APPLES');
@@ -1,4 +1,4 @@
var _ref;

const result = (_ref = Math.pow(5, 2) + 1, `${_ref} apples`.toUpperCase());
const result = (_ref = Math.pow(5, 2), `${_ref + 1} apples`.toUpperCase());
expect(result).toEqual('26 APPLES');
@@ -1,8 +1,4 @@
var _ref2;
var _ref;

const result = (_ref2 = Math.pow(5, 2), [1, 2, 3].map(n => {
var _ref;

return _ref = (n + _ref2) * 2, `${_ref} apples`.toUpperCase();
}).join());
const result = (_ref = Math.pow(5, 2), [1, 2, 3].map(n => `${(n + _ref) * 2} apples`.toUpperCase()).join());
expect(result).toEqual('52 APPLES,54 APPLES,56 APPLES');
@@ -1,4 +1,4 @@
var _ref;

const result = (_ref = Math.pow(5, 2) + 1, `${_ref} apples`.toUpperCase());
const result = (_ref = Math.pow(5, 2), `${_ref + 1} apples`.toUpperCase());
expect(result).toEqual('26 APPLES');
@@ -1,8 +1,4 @@
var _ref2;
var _ref;

const result = (_ref2 = Math.pow(5, 2), [1, 2, 3].map(n => {
var _ref;

return _ref = (n + _ref2) * 2, `${_ref} apples`.toUpperCase();
}).join());
const result = (_ref = Math.pow(5, 2), [1, 2, 3].map(n => `${(n + _ref) * 2} apples`.toUpperCase()).join());
expect(result).toEqual('52 APPLES,54 APPLES,56 APPLES');
@@ -1,4 +1,4 @@
var _ref;

const result = (_ref = Math.pow(5, 2) + 1, `${_ref} apples`.toUpperCase());
const result = (_ref = Math.pow(5, 2), `${_ref + 1} apples`.toUpperCase());
expect(result).toEqual('26 APPLES');
@@ -1,8 +1,4 @@
var _ref2;
var _ref;

const result = (_ref2 = Math.pow(5, 2), [1, 2, 3].map(n => {
var _ref;

return _ref = (n + _ref2) * 2, `${_ref} apples`.toUpperCase();
}).join());
const result = (_ref = Math.pow(5, 2), [1, 2, 3].map(n => `${(n + _ref) * 2} apples`.toUpperCase()).join());
expect(result).toEqual('52 APPLES,54 APPLES,56 APPLES');
@@ -1,4 +1,4 @@
var _ref;

const result = (_ref = Math.pow(5, 2) + 1, `${_ref} apples`.toUpperCase());
const result = (_ref = Math.pow(5, 2), `${_ref + 1} apples`.toUpperCase());
expect(result).toEqual('26 APPLES');
2 changes: 2 additions & 0 deletions packages/babel-traverse/scripts/generators/validators.js
Expand Up @@ -24,6 +24,8 @@ export interface NodePathValidators {
output += `is${type}(opts?: object): this is NodePath<t.${type}>;`;
} else if (types /* in VirtualTypeAliases */) {
output += `is${type}(opts?: object): this is NodePath<VirtualTypeAliases["${type}"]>;`;
} else if (type === "Pure") {
output += `isPure(constantsOnly?: boolean): boolean;`;
} else {
// if it don't have types, then VirtualTypeAliases[type] is t.Node
// which TS marked as always true
Expand Down
2 changes: 1 addition & 1 deletion packages/babel-traverse/src/path/generated/validators.ts
Expand Up @@ -441,7 +441,7 @@ export interface NodePathValidators {
isNumericLiteralTypeAnnotation(
opts?: object,
): this is NodePath<VirtualTypeAliases["NumericLiteralTypeAnnotation"]>;
isPure(opts?: object): boolean;
isPure(constantsOnly?: boolean): boolean;
isReferenced(opts?: object): boolean;
isReferencedIdentifier(
opts?: object,
Expand Down
4 changes: 2 additions & 2 deletions packages/babel-traverse/src/path/lib/virtual-types.ts
Expand Up @@ -124,8 +124,8 @@ export const Generated = {
};

export const Pure = {
checkPath(path: NodePath, opts?): boolean {
return path.scope.isPure(path.node, opts);
checkPath(path: NodePath, constantsOnly?: boolean): boolean {
return path.scope.isPure(path.node, constantsOnly);
},
};

Expand Down
38 changes: 32 additions & 6 deletions packages/babel-traverse/src/scope/index.ts
Expand Up @@ -42,6 +42,12 @@ import {
unaryExpression,
variableDeclaration,
variableDeclarator,
isRecordExpression,
isTupleExpression,
isObjectProperty,
isTopicReference,
isMetaProperty,
isPrivateName,
} from "@babel/types";
import type * as t from "@babel/types";
import { scope as scopeCache } from "../cache";
Expand Down Expand Up @@ -535,7 +541,7 @@ export default class Scope {
*/

isStatic(node: t.Node): boolean {
if (isThisExpression(node) || isSuper(node)) {
if (isThisExpression(node) || isSuper(node) || isTopicReference(node)) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A topic reference should be treated as a constant IdentifierReference, therefore it is static and pure.

return true;
}

Expand Down Expand Up @@ -823,10 +829,20 @@ export default class Scope {
if (!binding) return false;
if (constantsOnly) return binding.constant;
return true;
} else if (
isThisExpression(node) ||
isMetaProperty(node) ||
isTopicReference(node) ||
isPrivateName(node)
) {
return true;
} else if (isClass(node)) {
if (node.superClass && !this.isPure(node.superClass, constantsOnly)) {
return false;
}
if (node.decorators?.length > 0) {
return false;
}
return this.isPure(node.body, constantsOnly);
} else if (isClassBody(node)) {
for (const method of node.body) {
Expand All @@ -838,24 +854,34 @@ export default class Scope {
this.isPure(node.left, constantsOnly) &&
this.isPure(node.right, constantsOnly)
);
} else if (isArrayExpression(node)) {
} else if (isArrayExpression(node) || isTupleExpression(node)) {
for (const elem of node.elements) {
if (!this.isPure(elem, constantsOnly)) return false;
if (elem !== null && !this.isPure(elem, constantsOnly)) return false;
}
return true;
} else if (isObjectExpression(node)) {
} else if (isObjectExpression(node) || isRecordExpression(node)) {
for (const prop of node.properties) {
if (!this.isPure(prop, constantsOnly)) return false;
}
return true;
} else if (isMethod(node)) {
if (node.computed && !this.isPure(node.key, constantsOnly)) return false;
if (node.kind === "get" || node.kind === "set") return false;
if (node.decorators?.length > 0) {
return false;
}
return true;
} else if (isProperty(node)) {
// @ts-expect-error todo(flow->ts): computed in not present on private properties
if (node.computed && !this.isPure(node.key, constantsOnly)) return false;
return this.isPure(node.value, constantsOnly);
if (node.decorators?.length > 0) {
return false;
}
if (isObjectProperty(node) || node.static) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Evaluating a non-static field definition should be pure as long as it has no computed keys / fancy decorators, since the field initializer is not executed yet.

if (node.value !== null && !this.isPure(node.value, constantsOnly)) {
return false;
}
}
return true;
} else if (isUnaryExpression(node)) {
return this.isPure(node.argument, constantsOnly);
} else if (isTaggedTemplateExpression(node)) {
Expand Down
110 changes: 110 additions & 0 deletions packages/babel-traverse/test/path/isPure.js
@@ -0,0 +1,110 @@
import { parse } from "@babel/parser";

import _traverse from "../../lib/index.js";
const traverse = _traverse.default;

function getPath(code) {
const ast = parse(code, {
plugins: [
["decorators", { version: "2021-12", decoratorsBeforeExport: true }],
["recordAndTuple", { syntaxType: "hash" }],
"decoratorAutoAccessors",
["pipelineOperator", { proposal: "hack", topicToken: "%" }],
],
});
let path;
traverse(ast, {
Program: function (_path) {
path = _path;
_path.stop();
},
});
return path;
}

describe("isPure() returns true", () => {
it.each([
"class C { [0]() {} }",
"class C extends class {} {}",
"class C { static accessor x = 1; accessor y = f() }",
"class C { #x = f(); static #y }",
"class C { static target = new.target }",
"class X { get foo() { return 1 } set foo(v) {} }",
"class C { static #p = #p in C }",
])(`NodePath(%p).get("body.0").isPure() should be true`, input => {
const path = getPath(input).get("body.0");
expect(path.node).toBeTruthy();
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This assertion ensures that the pathRef passed in .get() is correct. In fact our previous tests on "class X { get foo() { return 1 } }" always succeed because path.get(body.0.expression) is an empty NodePath.

expect(path.isPure()).toBe(true);
});

it.each([
"({ x: 1, foo() { return 1 } })",
"String.raw`foo`",
`"a" + "b"`,
`[function () {}]`,
`#{ 0: 0, 1n: 1, two: "two"}`,
`#[0, 1n, "2", \`3\`]`,
`[,]`,
`-1 || void 0`,
`null ?? (true && false)`,
`this`,
])(`NodePath(%p).get("body.0.expression").isPure() should be true`, input => {
const path = getPath(input).get("body.0.expression");
expect(path.node).toBeTruthy();
expect(path.isPure()).toBe(true);
});

it.each(["let a = 1; `${a}`", `let a = 1; a |> % + %`])(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh, the first one is definitely not pure:

let a = { toString() { console.log("Hi :)") } };
`${a}`;

however, it was already behaving like this before this PR so if we want to change it I'd prefer to do it in another one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, we can introduce the pureToString compiler assumption, just like we have pureGetter.

`NodePath(%p).get("body.1.expression").isPure() should be true`,
input => {
const path = getPath(input).get("body.1.expression");
expect(path.node).toBeTruthy();
expect(path.isPure()).toBe(true);
},
);
});

describe("isPure() returns false", () => {
it.each([
"@dec() class X {}",
"@dec class C {}; function dec () {}",
"class C { @dec foo() {} }",
"class C { @dec foo }",
"class C { @dec accessor foo = 1 }",
"class C { static {} }",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is technically pure, however the only reason to use a static block is to have a side effect so we can err on the side of "it's never pure" and avoid recursing in its contents.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly, static {} is likely only used in the Babel testcase.

"class C extends class { [f()] } {}",
])(`NodePath(%p).get("body.0").isPure() should be false`, input => {
const path = getPath(input).get("body.0");
expect(path.node).toBeTruthy();
expect(path.isPure()).toBe(false);
});

it.each(["`${a}`", "tagged`foo`"])(
`NodePath(%p).get("body.0.expression").isPure() should be false`,
input => {
const path = getPath(input).get("body.0.expression");
expect(path.node).toBeTruthy();
expect(path.isPure()).toBe(false);
},
);

it.each(["let a = 1; `${a++}`"])(
`NodePath(%p).get("body.1.expression").isPure() should be false`,
input => {
const path = getPath(input).get("body.1.expression");
expect(path.node).toBeTruthy();
expect(path.isPure()).toBe(false);
},
);
});

describe("isPure(constantsOnly: true) returns false", () => {
it.each(["x", "1 + x", "({ [x]: 0 })", "(class { static x = x })"])(
`NodePath(%p).get("body.0.expression").isPure(/* constantsOnly */true) should be false`,
input => {
const path = getPath(input).get("body.0.expression");
expect(path.node).toBeTruthy();
expect(path.isPure(true)).toBe(false);
},
);
});
35 changes: 1 addition & 34 deletions packages/babel-traverse/test/scope.js
Expand Up @@ -365,39 +365,6 @@ describe("scope", () => {
).toBe(false);
});

it("purity", function () {
expect(
getPath("({ x: 1, foo() { return 1 } })")
.get("body")[0]
.get("expression")
.isPure(),
).toBeTruthy();
expect(
getPath("class X { get foo() { return 1 } }")
.get("body")[0]
.get("expression")
.isPure(),
).toBeFalsy();
expect(
getPath("`${a}`").get("body")[0].get("expression").isPure(),
).toBeFalsy();
expect(
getPath("let a = 1; `${a}`").get("body")[1].get("expression").isPure(),
).toBeTruthy();
expect(
getPath("let a = 1; `${a++}`")
.get("body")[1]
.get("expression")
.isPure(),
).toBeFalsy();
expect(
getPath("tagged`foo`").get("body")[0].get("expression").isPure(),
).toBeFalsy();
expect(
getPath("String.raw`foo`").get("body")[0].get("expression").isPure(),
).toBeTruthy();
});

test("label", function () {
expect(getPath("foo: { }").scope.getBinding("foo")).toBeUndefined();
expect(getPath("foo: { }").scope.getLabel("foo").type).toBe(
Expand Down Expand Up @@ -542,7 +509,7 @@ describe("scope", () => {
path.scope.crawl();
path.scope.crawl();

expect(path.scope.references._jsx).toBeTruthy();
expect(path.scope.references._jsx).toBe(true);
});

test("generateUid collision check after re-crawling", function () {
Expand Down