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

Define class elements in the correct order #12723

Merged
merged 5 commits into from Feb 2, 2021
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
Expand Up @@ -20,16 +20,6 @@ var Point = /*#__PURE__*/function () {
}

babelHelpers.createClass(Point, [{
key: "equals",
value: function equals(p) {
return babelHelpers.classPrivateFieldLooseBase(this, _x)[_x] === babelHelpers.classPrivateFieldLooseBase(p, _x)[_x] && babelHelpers.classPrivateFieldLooseBase(this, _y)[_y] === babelHelpers.classPrivateFieldLooseBase(p, _y)[_y];
}
}, {
key: "toString",
value: function toString() {
return `Point<${babelHelpers.classPrivateFieldLooseBase(this, _x)[_x]},${babelHelpers.classPrivateFieldLooseBase(this, _y)[_y]}>`;
}
}, {
key: "x",
get: function () {
return babelHelpers.classPrivateFieldLooseBase(this, _x)[_x];
Expand All @@ -45,6 +35,16 @@ var Point = /*#__PURE__*/function () {
set: function (value) {
babelHelpers.classPrivateFieldLooseBase(this, _y)[_y] = +value;
}
}, {
key: "equals",
value: function equals(p) {
return babelHelpers.classPrivateFieldLooseBase(this, _x)[_x] === babelHelpers.classPrivateFieldLooseBase(p, _x)[_x] && babelHelpers.classPrivateFieldLooseBase(this, _y)[_y] === babelHelpers.classPrivateFieldLooseBase(p, _y)[_y];
}
}, {
key: "toString",
value: function toString() {
return `Point<${babelHelpers.classPrivateFieldLooseBase(this, _x)[_x]},${babelHelpers.classPrivateFieldLooseBase(this, _y)[_y]}>`;
}
}]);
return Point;
}();
Expand Up @@ -23,16 +23,6 @@ var Point = /*#__PURE__*/function () {
}

babelHelpers.createClass(Point, [{
key: "equals",
value: function equals(p) {
return babelHelpers.classPrivateFieldGet(this, _x) === babelHelpers.classPrivateFieldGet(p, _x) && babelHelpers.classPrivateFieldGet(this, _y) === babelHelpers.classPrivateFieldGet(p, _y);
}
}, {
key: "toString",
value: function toString() {
return `Point<${babelHelpers.classPrivateFieldGet(this, _x)},${babelHelpers.classPrivateFieldGet(this, _y)}>`;
}
}, {
key: "x",
get: function () {
return babelHelpers.classPrivateFieldGet(this, _x);
Expand All @@ -48,6 +38,16 @@ var Point = /*#__PURE__*/function () {
set: function (value) {
babelHelpers.classPrivateFieldSet(this, _y, +value);
}
}, {
key: "equals",
value: function equals(p) {
return babelHelpers.classPrivateFieldGet(this, _x) === babelHelpers.classPrivateFieldGet(p, _x) && babelHelpers.classPrivateFieldGet(this, _y) === babelHelpers.classPrivateFieldGet(p, _y);
}
}, {
key: "toString",
value: function toString() {
return `Point<${babelHelpers.classPrivateFieldGet(this, _x)},${babelHelpers.classPrivateFieldGet(this, _y)}>`;
}
}]);
return Point;
}();
Expand Up @@ -32,9 +32,6 @@ var MyClass = /*#__PURE__*/function () {
}

babelHelpers.createClass(MyClass, [{
key: _ref2,
value: function () {}
}, {
key: "whatever",
get: function () {},
set: function (value) {}
Expand All @@ -44,9 +41,12 @@ var MyClass = /*#__PURE__*/function () {
}, {
key: _computed2,
set: function (value) {}
}], [{
key: 10,
}, {
key: _ref2,
value: function () {}
}], [{
key: "10",
value: function _() {}
}]);
return MyClass;
}();
Expand Down
Expand Up @@ -32,9 +32,6 @@ var MyClass = /*#__PURE__*/function () {
}

babelHelpers.createClass(MyClass, [{
key: _ref2,
value: function () {}
}, {
key: "whatever",
get: function () {},
set: function (value) {}
Expand All @@ -44,9 +41,12 @@ var MyClass = /*#__PURE__*/function () {
}, {
key: _computed2,
set: function (value) {}
}], [{
key: 10,
}, {
key: _ref2,
value: function () {}
}], [{
key: "10",
value: function _() {}
}]);
return MyClass;
}();
Expand Down
1 change: 0 additions & 1 deletion packages/babel-plugin-transform-classes/package.json
Expand Up @@ -15,7 +15,6 @@
"main": "lib/index.js",
"dependencies": {
"@babel/helper-annotate-as-pure": "workspace:^7.10.4",
"@babel/helper-define-map": "workspace:^7.10.4",
"@babel/helper-function-name": "workspace:^7.10.4",
"@babel/helper-optimise-call-expression": "workspace:^7.10.4",
"@babel/helper-plugin-utils": "workspace:^7.10.4",
Expand Down
136 changes: 78 additions & 58 deletions packages/babel-plugin-transform-classes/src/transformClass.js
Expand Up @@ -4,7 +4,6 @@ import ReplaceSupers, {
environmentVisitor,
} from "@babel/helper-replace-supers";
import optimiseCall from "@babel/helper-optimise-call-expression";
import * as defineMap from "@babel/helper-define-map";
import { traverse, template, types as t } from "@babel/core";
import annotateAsPure from "@babel/helper-annotate-as-pure";

Expand Down Expand Up @@ -49,8 +48,6 @@ export default function transformClass(
userConstructorPath: undefined,
hasConstructor: false,

instancePropBody: [],
instancePropRefs: {},
staticPropBody: [],
body: [],
superThises: [],
Expand All @@ -59,10 +56,21 @@ export default function transformClass(
protoAlias: null,
isLoose: false,

hasInstanceDescriptors: false,
hasStaticDescriptors: false,
instanceMutatorMap: {},
staticMutatorMap: {},
methods: {
// 'list' is in the same order as the elements appear in the class body.
// if there aren't computed keys, we can safely reorder class elements
// and use 'map' to merge duplicates.
instance: {
hasComputed: false,
list: [],
map: new Map(),
},
static: {
hasComputed: false,
list: [],
map: new Map(),
},
},
};

const setState = newState => {
Expand All @@ -78,25 +86,6 @@ export default function transformClass(
},
]);

function pushToMap(node, enumerable, kind = "value", scope?) {
let mutatorMap;
if (node.static) {
setState({ hasStaticDescriptors: true });
mutatorMap = classState.staticMutatorMap;
} else {
setState({ hasInstanceDescriptors: true });
mutatorMap = classState.instanceMutatorMap;
}

const map = defineMap.push(mutatorMap, node, kind, classState.file, scope);

if (enumerable) {
map.enumerable = t.booleanLiteral(true);
}

return map;
}

/**
* Creates a class constructor or bail out if there is none
*/
Expand Down Expand Up @@ -202,48 +191,43 @@ export default function transformClass(
}
}

function clearDescriptors() {
setState({
hasInstanceDescriptors: false,
hasStaticDescriptors: false,
instanceMutatorMap: {},
staticMutatorMap: {},
});
}

function pushDescriptors() {
pushInheritsToBody();

const { body } = classState;

let instanceProps;
let staticProps;

if (classState.hasInstanceDescriptors) {
instanceProps = defineMap.toClassObject(classState.instanceMutatorMap);
}
const props = {
instance: null,
static: null,
};

if (classState.hasStaticDescriptors) {
staticProps = defineMap.toClassObject(classState.staticMutatorMap);
}
for (const placement of ["static", "instance"]) {
if (classState.methods[placement].list.length) {
props[placement] = classState.methods[placement].list.map(desc => {
const obj = t.objectExpression([
t.objectProperty(t.identifier("key"), desc.key),
]);

for (const kind of ["get", "set", "value"]) {
if (desc[kind] != null) {
obj.properties.push(
t.objectProperty(t.identifier(kind), desc[kind]),
);
}
}

if (instanceProps || staticProps) {
if (instanceProps) {
instanceProps = defineMap.toComputedObjectFromClass(instanceProps);
}
if (staticProps) {
staticProps = defineMap.toComputedObjectFromClass(staticProps);
return obj;
});
}
}

if (props.instance || props.static) {
let args = [
t.cloneNode(classState.classRef), // Constructor
t.nullLiteral(), // instanceDescriptors
t.nullLiteral(), // staticDescriptors
props.instance ? t.arrayExpression(props.instance) : t.nullLiteral(), // instanceDescriptors
props.static ? t.arrayExpression(props.static) : t.nullLiteral(), // staticDescriptors
];

if (instanceProps) args[1] = instanceProps;
if (staticProps) args[2] = staticProps;

let lastNonNullIndex = 0;
for (let i = 0; i < args.length; i++) {
if (!t.isNullLiteral(args[i])) lastNonNullIndex = i;
Expand All @@ -256,8 +240,6 @@ export default function transformClass(
),
);
}

clearDescriptors();
}

function wrapSuperCall(bareSuper, superRef, thisRef, body) {
Expand Down Expand Up @@ -428,7 +410,45 @@ export default function transformClass(
if (processMethod(node, scope)) return;
}

pushToMap(node, false, null, scope);
const placement = node.static ? "static" : "instance";
const methods = classState.methods[placement];

const descKey = node.kind === "method" ? "value" : node.kind;
const key =
t.isNumericLiteral(node.key) || t.isBigIntLiteral(node.key)
? t.stringLiteral(String(node.key.value))
: t.toComputedKey(node);

let fn = t.toExpression(node);

if (t.isStringLiteral(key)) {
// infer function name
if (node.kind === "method") {
fn = nameFunction({ id: key, node: node, scope });
}
Copy link
Member Author

Choose a reason for hiding this comment

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

We can also infer the name of getters and setters, but I'll do that in a separate PR since it's not strictly related to this one.

} else {
methods.hasComputed = true;
}

let descriptor;
if (!methods.hasComputed && methods.map.has(key.value)) {
descriptor = methods.map.get(key.value);
descriptor[descKey] = fn;

if (descKey === "value") {
descriptor.get = null;
descriptor.set = null;
} else {
descriptor.value = null;
}
} else {
descriptor = { key: key, [descKey]: fn };
methods.list.push(descriptor);

if (!methods.hasComputed) {
methods.map.set(key.value, descriptor);
}
}
}

function processMethod(node, scope) {
Expand Down
@@ -0,0 +1,21 @@
let x = 1;

class A {
get [x]() {}
[(x = 3, 2)]() {}
set [x](_) {}
}

expect(Object.getOwnPropertyDescriptors(A.prototype)).toMatchObject({
1: {
get: expect.any(Function),
set: undefined,
},
2: {
value: expect.any(Function),
},
3: {
get: undefined,
set: expect.any(Function),
}
});
@@ -0,0 +1,5 @@
class A {
get [x]() {}
[(x = 2, 3)]() {}
set [x](_) {}
}
@@ -0,0 +1,3 @@
{
"minNodeVersion": "8.0.0"
}
@@ -0,0 +1,26 @@
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }

function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }

let A = /*#__PURE__*/function () {
"use strict";

function A() {
_classCallCheck(this, A);
}

_createClass(A, [{
key: x,
get: function () {}
}, {
key: (x = 2, 3),
value: function () {}
}, {
key: x,
set: function (_) {}
}]);

return A;
}();
@@ -0,0 +1,12 @@
class A {
get x() {}
x() {}
set x(_) {}
}

expect(Object.getOwnPropertyDescriptors(A.prototype)).toMatchObject({
x: {
get: undefined,
set: expect.any(Function),
}
});