Apply toPropertyKey on decorator context name (#16139)

* refactor: extract toPrimitive and toProeprtyKey to single helpers

* update test fixtures

* apply toPropertyKey for decorator context name

* fix: allow BigIntLiteral in ClassMethod.key

* Add 2021-12 test cases

* copy paste to other versions

* Suppress TS error

* Update packages/babel-helpers/src/helpers/toPrimitive.ts

Co-authored-by: liuxingbaoyu <[email protected]>

* update generated helpers

* update test fixtures

---------

Co-authored-by: liuxingbaoyu <[email protected]>

Author: JLHwung

packages/babel-helpers/src/helpers-generated.ts

@@ -865,31 +865,6 @@ helpers.skipFirstGeneratorNext = helper("7.0.0-beta.0")`
   }
 `;
 
-helpers.toPrimitive = helper("7.1.5")`
-  export default function _toPrimitive(
-    input,
-    hint /*: "default" | "string" | "number" | void */
-  ) {
-    if (typeof input !== "object" || input === null) return input;
-    var prim = input[Symbol.toPrimitive];
-    if (prim !== undefined) {
-      var res = prim.call(input, hint || "default");
-      if (typeof res !== "object") return res;
-      throw new TypeError("@@toPrimitive must return a primitive value.");
-    }
-    return (hint === "string" ? String : Number)(input);
-  }
-`;
-
-helpers.toPropertyKey = helper("7.1.5")`
-  import toPrimitive from "toPrimitive";
-
-  export default function _toPropertyKey(arg) {
-    var key = toPrimitive(arg, "string");
-    return typeof key === "symbol" ? key : String(key);
-  }
-`;
-
 /**
  * Add a helper that will throw a useful error if the transform fails to detect the class
  * property assignment, so users know something failed.

packages/babel-helpers/src/helpers.ts

@@ -1,5 +1,6 @@
 /* @minVersion 7.17.8 */
 
+import toPropertyKey from "toPropertyKey";
 /**
  * NOTE: This is an old version of the helper, used for 2021-12 decorators.
  * Updates should be done in applyDecs2203R.js.
@@ -168,7 +169,7 @@ function old_memberDec(
 
   var ctx = {
     kind: kindStr,
-    name: isPrivate ? "#" + name : name,
+    name: isPrivate ? "#" + name : toPropertyKey(name),
     isStatic: isStatic,
     isPrivate: isPrivate,
   };

packages/babel-helpers/src/helpers/applyDecs.js

@@ -1,5 +1,7 @@
 /* @minVersion 7.20.0 */
 
+import toPropertyKey from "toPropertyKey";
+
 /**
   Enums are used in this file, but not assigned to vars to avoid non-hoistable values
 
@@ -58,7 +60,7 @@ function applyDecs2203RFactory() {
 
     var ctx = {
       kind: kindStr,
-      name: isPrivate ? "#" + name : name,
+      name: isPrivate ? "#" + name : toPropertyKey(name),
       static: isStatic,
       private: isPrivate,
     };

packages/babel-helpers/src/helpers/applyDecs2203R.js

@@ -1,6 +1,7 @@
 /* @minVersion 7.21.0 */
 
 import checkInRHS from "checkInRHS";
+import toPropertyKey from "toPropertyKey";
 
 /**
   Enums are used in this file, but not assigned to vars to avoid non-hoistable values
@@ -69,7 +70,7 @@ function applyDecs2301Factory() {
 
     var ctx = {
       kind: kindStr,
-      name: isPrivate ? "#" + name : name,
+      name: isPrivate ? "#" + name : toPropertyKey(name),
       static: isStatic,
       private: isPrivate,
     };

packages/babel-helpers/src/helpers/applyDecs2301.js

@@ -2,6 +2,8 @@
 
 // @ts-expect-error helper
 import checkInRHS from "checkInRHS";
+// @ts-expect-error helper
+import toPropertyKey from "toPropertyKey";
 
 /**
   Enums are used in this file, but not assigned to vars to avoid non-hoistable values
@@ -94,7 +96,7 @@ function memberDec(
       kind
     ] as any,
 
-    name: isPrivate ? "#" + name : name,
+    name: isPrivate ? "#" + name : toPropertyKey(name),
     static: isStatic,
     private: isPrivate,
     metadata: metadata,

packages/babel-helpers/src/helpers/applyDecs2305.ts

@@ -0,0 +1,17 @@
+/* @minVersion 7.1.5 */
+
+// https://tc39.es/ecma262/#sec-toprimitive
+export default function toPrimitive(
+  input: unknown,
+  hint: "default" | "string" | "number" | void,
+) {
+  if (typeof input !== "object" || !input) return input;
+  // @ts-expect-error Symbol.toPrimitive might not index {}
+  var prim = input[Symbol.toPrimitive];
+  if (prim !== undefined) {
+    var res = prim.call(input, hint || "default");
+    if (typeof res !== "object") return res;
+    throw new TypeError("@@toPrimitive must return a primitive value.");
+  }
+  return (hint === "string" ? String : Number)(input);
+}

packages/babel-helpers/src/helpers/toPrimitive.ts

@@ -0,0 +1,11 @@
+/* @minVersion 7.1.5 */
+
+// https://tc39.es/ecma262/#sec-topropertykey
+
+// @ts-expect-error helper
+import toPrimitive from "toPrimitive";
+
+export default function toPropertyKey(arg: unknown) {
+  var key = toPrimitive(arg, "string");
+  return typeof key === "symbol" ? key : String(key);
+}

packages/babel-helpers/src/helpers/toPropertyKey.ts

@@ -0,0 +1,20 @@
+const logs = [];
+const dec = (value, context) => { logs.push(context.name) };
+const f = () => { logs.push("computing f"); return { [Symbol.toPrimitive]: () => "f()" }; };
+class Foo {
+  @dec static accessor a;
+  @dec static accessor #a;
+
+  @dec static accessor "b"
+  @dec static accessor ["c"];
+
+  @dec static accessor 0;
+  @dec static accessor [1];
+
+  @dec static accessor 2n;
+  @dec static accessor [3n];
+
+  @dec static accessor [f()];
+}
+
+expect(logs).toStrictEqual(["computing f", "a", "#a", "b", "c", "0", "1", "2", "3", "f()"]);