Ensure the [[@@toPrimitive]] call of a decorated class member key i…

…s invoked once (#16161) * refactor: unify computed key memoise criteria * fix: memoise the toPropertyKey results of computed key * update test outputs * remove debug test case
babel · Dec 8, 2023 · a1da072 · a1da072
1 parent d677b3c
commit a1da072
Show file tree

Hide file tree

Showing 234 changed files with 921 additions and 1,147 deletions.
diff --git a/packages/babel-plugin-proposal-decorators/src/transformer-2023-05.ts b/packages/babel-plugin-proposal-decorators/src/transformer-2023-05.ts
@@ -525,6 +525,10 @@ function createSetFunctionNameCall(
   ]);
 }
 
+function createToPropertyKeyCall(state: PluginPass, propertyKey: t.Expression) {
+  return t.callExpression(state.addHelper("toPropertyKey"), [propertyKey]);
+}
+
 function transformClass(
   path: NodePath<t.ClassExpression | t.ClassDeclaration>,
   state: PluginPass,
@@ -590,18 +594,17 @@ function transformClass(
 
       const newId = generateClassPrivateUid();
       const newField = generateClassProperty(newId, value, isStatic);
-
+      const keyPath = element.get("key");
       const [newPath] = element.replaceWith(newField);
-      const keyType = key.type;
+
       addProxyAccessorsFor(
         path.node.id,
         newPath,
-        computed &&
-          !scopeParent.isStatic(key) &&
-          keyType !== "StringLiteral" &&
-          keyType !== "NumericLiteral" &&
-          keyType !== "BigIntLiteral"
-          ? memoiseExpression(key as t.Expression, "computedKey")
+        computed && !keyPath.isConstantExpression()
+          ? memoiseExpression(
+              createToPropertyKeyCall(state, key as t.Expression),
+              "computedKey",
+            )
           : key,
         newId,
         version,
@@ -703,8 +706,11 @@ function transformClass(
       const isComputed =
         "computed" in element.node && element.node.computed === true;
       if (isComputed) {
-        if (!scopeParent.isStatic(node.key)) {
-          node.key = memoiseExpression(node.key as t.Expression, "computedKey");
+        if (!element.get("key").isConstantExpression()) {
+          node.key = memoiseExpression(
+            createToPropertyKeyCall(state, node.key as t.Expression),
+            "computedKey",
+          );
         }
       }
 

diff --git a/...lugin-proposal-decorators/test/fixtures/2021-12-accessors--to-es2015/context-name/exec.js b/...lugin-proposal-decorators/test/fixtures/2021-12-accessors--to-es2015/context-name/exec.js
@@ -1,6 +1,6 @@
 const logs = [];
 const dec = (value, context) => { logs.push(context.name) };
-const f = () => { logs.push("computing f"); return { [Symbol.toPrimitive]: () => "f()" }; };
+const f = () => { logs.push("computing f"); return { [Symbol.toPrimitive]: () => (logs.push("calling toPrimitive"), "f()") }; };
 class Foo {
   @dec static accessor a;
   @dec static accessor #a;
@@ -17,4 +17,4 @@ class Foo {
   @dec static accessor [f()];
 }
 
-expect(logs).toStrictEqual(["computing f", "a", "#a", "b", "c", "0", "1", "2", "3", "f()"]);
+expect(logs).toStrictEqual(["computing f", "calling toPrimitive", "a", "#a", "b", "c", "0", "1", "2", "3", "f()"]);
diff --git a/...ugin-proposal-decorators/test/fixtures/2021-12-accessors--to-es2015/context-name/input.js b/...ugin-proposal-decorators/test/fixtures/2021-12-accessors--to-es2015/context-name/input.js
@@ -1,6 +1,6 @@
 const logs = [];
 const dec = (value, context) => { logs.push(context.name) };
-const f = () => { logs.push("computing f"); return { [Symbol.toPrimitive]: () => "f()" }; };
+const f = () => { logs.push("computing f"); return { [Symbol.toPrimitive]: () => (logs.push("calling toPrimitive"), "f()") }; };
 class Foo {
   @dec static accessor a;
   @dec static accessor #a;
@@ -17,4 +17,4 @@ class Foo {
   @dec static accessor [f()];
 }
 
-expect(logs).toStrictEqual(["computing f", "a", "#a", "b", "c", "0", "1", "2", "3", "f()"]);
+expect(logs).toStrictEqual(["computing f", "calling toPrimitive", "a", "#a", "b", "c", "0", "1", "2", "3", "f()"]);
diff --git a/...gin-proposal-decorators/test/fixtures/2021-12-accessors--to-es2015/context-name/output.js b/...gin-proposal-decorators/test/fixtures/2021-12-accessors--to-es2015/context-name/output.js
@@ -1,18 +1,15 @@
-var _init_a, _init_a2, _get_a, _set_a, _init_computedKey, _computedKey, _init_computedKey2, _init_computedKey3, _computedKey2, _init_computedKey4, _init_computedKey5, _computedKey3, _init_computedKey6, _computedKey4, _init_computedKey7, _initStatic, _class;
+var _init_a, _init_a2, _get_a, _set_a, _init_computedKey, _init_computedKey2, _init_computedKey3, _init_computedKey4, _init_computedKey5, _init_computedKey6, _computedKey, _init_computedKey7, _initStatic, _class;
 const logs = [];
 const dec = (value, context) => {
   logs.push(context.name);
 };
 const f = () => {
   logs.push("computing f");
   return {
-    [Symbol.toPrimitive]: () => "f()"
+    [Symbol.toPrimitive]: () => (logs.push("calling toPrimitive"), "f()")
   };
 };
-_computedKey = "c";
-_computedKey2 = 1;
-_computedKey3 = 3n;
-_computedKey4 = f();
+_computedKey = babelHelpers.toPropertyKey(f());
 var _a = /*#__PURE__*/new WeakMap();
 class Foo {
   constructor() {
@@ -33,10 +30,10 @@ class Foo {
   static set "b"(v) {
     babelHelpers.classStaticPrivateFieldSpecSet(this, Foo, _C, v);
   }
-  static get [_computedKey]() {
+  static get ["c"]() {
     return babelHelpers.classStaticPrivateFieldSpecGet(this, Foo, _D);
   }
-  static set [_computedKey](v) {
+  static set ["c"](v) {
     babelHelpers.classStaticPrivateFieldSpecSet(this, Foo, _D, v);
   }
   static get 0() {
@@ -45,10 +42,10 @@ class Foo {
   static set 0(v) {
     babelHelpers.classStaticPrivateFieldSpecSet(this, Foo, _E, v);
   }
-  static get [_computedKey2]() {
+  static get [1]() {
     return babelHelpers.classStaticPrivateFieldSpecGet(this, Foo, _F);
   }
-  static set [_computedKey2](v) {
+  static set [1](v) {
     babelHelpers.classStaticPrivateFieldSpecSet(this, Foo, _F, v);
   }
   static get 2n() {
@@ -57,16 +54,16 @@ class Foo {
   static set 2n(v) {
     babelHelpers.classStaticPrivateFieldSpecSet(this, Foo, _G, v);
   }
-  static get [_computedKey3]() {
+  static get [3n]() {
     return babelHelpers.classStaticPrivateFieldSpecGet(this, Foo, _H);
   }
-  static set [_computedKey3](v) {
+  static set [3n](v) {
     babelHelpers.classStaticPrivateFieldSpecSet(this, Foo, _H, v);
   }
-  static get [_computedKey4]() {
+  static get [_computedKey]() {
     return babelHelpers.classStaticPrivateFieldSpecGet(this, Foo, _I);
   }
-  static set [_computedKey4](v) {
+  static set [_computedKey](v) {
     babelHelpers.classStaticPrivateFieldSpecSet(this, Foo, _I, v);
   }
 }
@@ -82,7 +79,7 @@ function _get_a2() {
     return babelHelpers.classStaticPrivateFieldSpecGet(this, _class, _B);
   }, function (value) {
     babelHelpers.classStaticPrivateFieldSpecSet(this, _class, _B, value);
-  }], [dec, 6, "b"], [dec, 6, _computedKey], [dec, 6, 0], [dec, 6, _computedKey2], [dec, 6, 2n], [dec, 6, _computedKey3], [dec, 6, _computedKey4]], []);
+  }], [dec, 6, "b"], [dec, 6, "c"], [dec, 6, 0], [dec, 6, 1], [dec, 6, 2n], [dec, 6, 3n], [dec, 6, _computedKey]], []);
   _initStatic(_class);
 })();
 var _A = {
@@ -121,4 +118,4 @@ var _I = {
   writable: true,
   value: _init_computedKey7(_class)
 };
-expect(logs).toStrictEqual(["computing f", "a", "#a", "b", "c", "0", "1", "2", "3", "f()"]);
+expect(logs).toStrictEqual(["computing f", "calling toPrimitive", "a", "#a", "b", "c", "0", "1", "2", "3", "f()"]);
diff --git a/...el-plugin-proposal-decorators/test/fixtures/2021-12-accessors--to-es2015/public/output.js b/...el-plugin-proposal-decorators/test/fixtures/2021-12-accessors--to-es2015/public/output.js
@@ -1,6 +1,5 @@
-var _init_a, _init_b, _computedKey, _init_computedKey, _initProto, _class;
+var _init_a, _init_b, _init_computedKey, _initProto, _class;
 const dec = () => {};
-_computedKey = 'c';
 var _A = /*#__PURE__*/new WeakMap();
 var _B = /*#__PURE__*/new WeakMap();
 var _C = /*#__PURE__*/new WeakMap();
@@ -31,12 +30,12 @@ class Foo {
   set b(v) {
     babelHelpers.classPrivateFieldSet(this, _B, v);
   }
-  get [_computedKey]() {
+  get ['c']() {
     return babelHelpers.classPrivateFieldGet(this, _C);
   }
-  set [_computedKey](v) {
+  set ['c'](v) {
     babelHelpers.classPrivateFieldSet(this, _C, v);
   }
 }
 _class = Foo;
-[_init_a, _init_b, _init_computedKey, _initProto] = babelHelpers.applyDecs(_class, [[dec, 1, "a"], [dec, 1, "b"], [dec, 1, _computedKey]], []);
+[_init_a, _init_b, _init_computedKey, _initProto] = babelHelpers.applyDecs(_class, [[dec, 1, "a"], [dec, 1, "b"], [dec, 1, 'c']], []);
diff --git a/...in-proposal-decorators/test/fixtures/2021-12-accessors--to-es2015/static-public/output.js b/...in-proposal-decorators/test/fixtures/2021-12-accessors--to-es2015/static-public/output.js
@@ -1,6 +1,5 @@
-var _init_a, _init_b, _computedKey, _init_computedKey, _initStatic, _class;
+var _init_a, _init_b, _init_computedKey, _initStatic, _class;
 const dec = () => {};
-_computedKey = 'c';
 class Foo {
   static get a() {
     return babelHelpers.classStaticPrivateFieldSpecGet(this, Foo, _A);
@@ -14,16 +13,16 @@ class Foo {
   static set b(v) {
     babelHelpers.classStaticPrivateFieldSpecSet(this, Foo, _B, v);
   }
-  static get [_computedKey]() {
+  static get ['c']() {
     return babelHelpers.classStaticPrivateFieldSpecGet(this, Foo, _C);
   }
-  static set [_computedKey](v) {
+  static set ['c'](v) {
     babelHelpers.classStaticPrivateFieldSpecSet(this, Foo, _C, v);
   }
 }
 _class = Foo;
 (() => {
-  [_init_a, _init_b, _init_computedKey, _initStatic] = babelHelpers.applyDecs(_class, [[dec, 6, "a"], [dec, 6, "b"], [dec, 6, _computedKey]], []);
+  [_init_a, _init_b, _init_computedKey, _initStatic] = babelHelpers.applyDecs(_class, [[dec, 6, "a"], [dec, 6, "b"], [dec, 6, 'c']], []);
   _initStatic(_class);
 })();
 var _A = {

diff --git a/...ges/babel-plugin-proposal-decorators/test/fixtures/2021-12-accessors/context-name/exec.js b/...ges/babel-plugin-proposal-decorators/test/fixtures/2021-12-accessors/context-name/exec.js
@@ -1,6 +1,6 @@
 const logs = [];
 const dec = (value, context) => { logs.push(context.name) };
-const f = () => { logs.push("computing f"); return { [Symbol.toPrimitive]: () => "f()" }; };
+const f = () => { logs.push("computing f"); return { [Symbol.toPrimitive]: () => (logs.push("calling toPrimitive"), "f()") }; };
 class Foo {
   @dec static accessor a;
   @dec static accessor #a;
@@ -17,4 +17,4 @@ class Foo {
   @dec static accessor [f()];
 }
 
-expect(logs).toStrictEqual(["computing f", "a", "#a", "b", "c", "0", "1", "2", "3", "f()"]);
+expect(logs).toStrictEqual(["computing f", "calling toPrimitive", "a", "#a", "b", "c", "0", "1", "2", "3", "f()"]);
diff --git a/...es/babel-plugin-proposal-decorators/test/fixtures/2021-12-accessors/context-name/input.js b/...es/babel-plugin-proposal-decorators/test/fixtures/2021-12-accessors/context-name/input.js
@@ -1,6 +1,6 @@
 const logs = [];
 const dec = (value, context) => { logs.push(context.name) };
-const f = () => { logs.push("computing f"); return { [Symbol.toPrimitive]: () => "f()" }; };
+const f = () => { logs.push("computing f"); return { [Symbol.toPrimitive]: () => (logs.push("calling toPrimitive"), "f()") }; };
 class Foo {
   @dec static accessor a;
   @dec static accessor #a;
@@ -17,4 +17,4 @@ class Foo {
   @dec static accessor [f()];
 }
 
-expect(logs).toStrictEqual(["computing f", "a", "#a", "b", "c", "0", "1", "2", "3", "f()"]);
+expect(logs).toStrictEqual(["computing f", "calling toPrimitive", "a", "#a", "b", "c", "0", "1", "2", "3", "f()"]);
diff --git a/...s/babel-plugin-proposal-decorators/test/fixtures/2021-12-accessors/context-name/output.js b/...s/babel-plugin-proposal-decorators/test/fixtures/2021-12-accessors/context-name/output.js
@@ -1,25 +1,22 @@
-var _init_a, _init_a2, _get_a, _set_a, _init_computedKey, _computedKey, _init_computedKey2, _init_computedKey3, _computedKey2, _init_computedKey4, _init_computedKey5, _computedKey3, _init_computedKey6, _computedKey4, _init_computedKey7, _initStatic;
+var _init_a, _init_a2, _get_a, _set_a, _init_computedKey, _init_computedKey2, _init_computedKey3, _init_computedKey4, _init_computedKey5, _init_computedKey6, _computedKey, _init_computedKey7, _initStatic;
 const logs = [];
 const dec = (value, context) => {
   logs.push(context.name);
 };
 const f = () => {
   logs.push("computing f");
   return {
-    [Symbol.toPrimitive]: () => "f()"
+    [Symbol.toPrimitive]: () => (logs.push("calling toPrimitive"), "f()")
   };
 };
-_computedKey = "c";
-_computedKey2 = 1;
-_computedKey3 = 3n;
-_computedKey4 = f();
+_computedKey = babelHelpers.toPropertyKey(f());
 class Foo {
   static {
     [_init_a, _init_a2, _get_a, _set_a, _init_computedKey, _init_computedKey2, _init_computedKey3, _init_computedKey4, _init_computedKey5, _init_computedKey6, _init_computedKey7, _initStatic] = babelHelpers.applyDecs(this, [[dec, 6, "a"], [dec, 6, "a", function () {
       return this.#B;
     }, function (value) {
       this.#B = value;
-    }], [dec, 6, "b"], [dec, 6, _computedKey], [dec, 6, 0], [dec, 6, _computedKey2], [dec, 6, 2n], [dec, 6, _computedKey3], [dec, 6, _computedKey4]], []);
+    }], [dec, 6, "b"], [dec, 6, "c"], [dec, 6, 0], [dec, 6, 1], [dec, 6, 2n], [dec, 6, 3n], [dec, 6, _computedKey]], []);
     _initStatic(this);
   }
   static #A = _init_a(this);
@@ -44,10 +41,10 @@ class Foo {
     this.#C = v;
   }
   static #D = _init_computedKey2(this);
-  static get [_computedKey]() {
+  static get ["c"]() {
     return this.#D;
   }
-  static set [_computedKey](v) {
+  static set ["c"](v) {
     this.#D = v;
   }
   static #E = _init_computedKey3(this);
@@ -58,10 +55,10 @@ class Foo {
     this.#E = v;
   }
   static #F = _init_computedKey4(this);
-  static get [_computedKey2]() {
+  static get [1]() {
     return this.#F;
   }
-  static set [_computedKey2](v) {
+  static set [1](v) {
     this.#F = v;
   }
   static #G = _init_computedKey5(this);
@@ -72,18 +69,18 @@ class Foo {
     this.#G = v;
   }
   static #H = _init_computedKey6(this);
-  static get [_computedKey3]() {
+  static get [3n]() {
     return this.#H;
   }
-  static set [_computedKey3](v) {
+  static set [3n](v) {
     this.#H = v;
   }
   static #I = _init_computedKey7(this);
-  static get [_computedKey4]() {
+  static get [_computedKey]() {
     return this.#I;
   }
-  static set [_computedKey4](v) {
+  static set [_computedKey](v) {
     this.#I = v;
   }
 }
-expect(logs).toStrictEqual(["computing f", "a", "#a", "b", "c", "0", "1", "2", "3", "f()"]);
+expect(logs).toStrictEqual(["computing f", "calling toPrimitive", "a", "#a", "b", "c", "0", "1", "2", "3", "f()"]);
diff --git a/packages/babel-plugin-proposal-decorators/test/fixtures/2021-12-accessors/public/output.js b/packages/babel-plugin-proposal-decorators/test/fixtures/2021-12-accessors/public/output.js
@@ -1,9 +1,8 @@
-var _init_a, _init_b, _computedKey, _init_computedKey, _initProto;
+var _init_a, _init_b, _init_computedKey, _initProto;
 const dec = () => {};
-_computedKey = 'c';
 class Foo {
   static {
-    [_init_a, _init_b, _init_computedKey, _initProto] = babelHelpers.applyDecs(this, [[dec, 1, "a"], [dec, 1, "b"], [dec, 1, _computedKey]], []);
+    [_init_a, _init_b, _init_computedKey, _initProto] = babelHelpers.applyDecs(this, [[dec, 1, "a"], [dec, 1, "b"], [dec, 1, 'c']], []);
   }
   #A = (_initProto(this), _init_a(this));
   get a() {
@@ -20,10 +19,10 @@ class Foo {
     this.#B = v;
   }
   #C = _init_computedKey(this, 456);
-  get [_computedKey]() {
+  get ['c']() {
     return this.#C;
   }
-  set [_computedKey](v) {
+  set ['c'](v) {
     this.#C = v;
   }
 }
diff --git a/.../babel-plugin-proposal-decorators/test/fixtures/2021-12-accessors/static-public/output.js b/.../babel-plugin-proposal-decorators/test/fixtures/2021-12-accessors/static-public/output.js
@@ -1,9 +1,8 @@
-var _init_a, _init_b, _computedKey, _init_computedKey, _initStatic;
+var _init_a, _init_b, _init_computedKey, _initStatic;
 const dec = () => {};
-_computedKey = 'c';
 class Foo {
   static {
-    [_init_a, _init_b, _init_computedKey, _initStatic] = babelHelpers.applyDecs(this, [[dec, 6, "a"], [dec, 6, "b"], [dec, 6, _computedKey]], []);
+    [_init_a, _init_b, _init_computedKey, _initStatic] = babelHelpers.applyDecs(this, [[dec, 6, "a"], [dec, 6, "b"], [dec, 6, 'c']], []);
     _initStatic(this);
   }
   static #A = _init_a(this);
@@ -21,10 +20,10 @@ class Foo {
     this.#B = v;
   }
   static #C = _init_computedKey(this, 456);
-  static get [_computedKey]() {
+  static get ['c']() {
     return this.#C;
   }
-  static set [_computedKey](v) {
+  static set ['c'](v) {
     this.#C = v;
   }
 }
diff --git a/...orators/test/fixtures/2021-12-duplicated-keys--to-es2015/computed-keys-same-ast/output.js b/...orators/test/fixtures/2021-12-duplicated-keys--to-es2015/computed-keys-same-ast/output.js
@@ -1,7 +1,7 @@
 var _computedKey, _computedKey2, _initProto, _class;
 const dec = () => {};
-_computedKey = getKey();
-_computedKey2 = getKey();
+_computedKey = babelHelpers.toPropertyKey(getKey());
+_computedKey2 = babelHelpers.toPropertyKey(getKey());
 class Foo {
   constructor(...args) {
     _initProto(this);

diff --git a/...ators/test/fixtures/2021-12-duplicated-keys--to-es2015/computed-keys-same-value/output.js b/...ators/test/fixtures/2021-12-duplicated-keys--to-es2015/computed-keys-same-value/output.js
@@ -1,7 +1,7 @@
 var _computedKey, _computedKey2, _initProto, _class;
 const dec = () => {};
-_computedKey = getKeyI();
-_computedKey2 = getKeyJ();
+_computedKey = babelHelpers.toPropertyKey(getKeyI());
+_computedKey2 = babelHelpers.toPropertyKey(getKeyJ());
 class Foo {
   constructor(...args) {
     _initProto(this);