feature(macro): hash based id for js macro

lingui · Feb 15, 2023 · 546d172 · 546d172
1 parent 44f8360
commit 546d172
Show file tree

Hide file tree

Showing 16 changed files with 513 additions and 287 deletions.
diff --git a/packages/babel-plugin-extract-messages/test/__snapshots__/index.ts.snap b/packages/babel-plugin-extract-messages/test/__snapshots__/index.ts.snap
@@ -140,8 +140,8 @@ Array [
   Object {
     comment: undefined,
     context: undefined,
-    id: Message,
-    message: undefined,
+    id: xDAtGP,
+    message: Message,
     origin: Array [
       js-with-macros.js,
       3,
@@ -150,8 +150,8 @@ Array [
   Object {
     comment: undefined,
     context: undefined,
-    id: Message,
-    message: undefined,
+    id: xDAtGP,
+    message: Message,
     origin: Array [
       js-with-macros.js,
       5,
@@ -160,8 +160,8 @@ Array [
   Object {
     comment: description,
     context: undefined,
-    id: Description,
-    message: undefined,
+    id: Nu4oKW,
+    message: Description,
     origin: Array [
       js-with-macros.js,
       7,
@@ -180,8 +180,8 @@ Array [
   Object {
     comment: undefined,
     context: undefined,
-    id: Values {param},
-    message: undefined,
+    id: QCVtWw,
+    message: Values {param},
     origin: Array [
       js-with-macros.js,
       17,
@@ -285,8 +285,8 @@ Array [
   Object {
     comment: undefined,
     context: undefined,
-    id: Title,
-    message: undefined,
+    id: MHrjPM,
+    message: Title,
     origin: Array [
       jsx-with-macros.js,
       7,
@@ -295,8 +295,8 @@ Array [
   Object {
     comment: undefined,
     context: undefined,
-    id: {count, plural, one {# book} other {# books}},
-    message: undefined,
+    id: esnaQO,
+    message: {count, plural, one {# book} other {# books}},
     origin: Array [
       jsx-with-macros.js,
       9,

diff --git a/packages/macro/package.json b/packages/macro/package.json
@@ -34,8 +34,7 @@
   "dependencies": {
     "@babel/runtime": "^7.20.13",
     "@babel/types": "^7.20.7",
-    "@lingui/conf": "3.17.1",
-    "ramda": "^0.27.1"
+    "@lingui/conf": "3.17.1"
   },
   "peerDependencies": {
     "@lingui/core": "^3.13.0",

diff --git a/packages/macro/src/generateMessageId.test.ts b/packages/macro/src/generateMessageId.test.ts
@@ -0,0 +1,24 @@
+import { generateMessageId } from "./generateMessageId"
+
+describe("generateMessageId", () => {
+  it("Should generate an id for a message", () => {
+    expect(generateMessageId("my message")).toMatchInlineSnapshot(`vQhkQx`)
+  })
+
+  it("Should generate different id when context is provided", () => {
+    const withContext = generateMessageId("my message", "custom context")
+    expect(withContext).toMatchInlineSnapshot(`gGUeZH`)
+
+    expect(withContext != generateMessageId("my message")).toBeTruthy()
+  })
+
+  it("Message + context should not clash with message with suffix or prefix", () => {
+    const context = "custom context"
+    const withContext = generateMessageId("my message", context)
+    const withSuffix = generateMessageId("my message" + context)
+    const withPrefix = generateMessageId(context + "my message")
+
+    expect(withContext != withSuffix).toBeTruthy()
+    expect(withContext != withPrefix).toBeTruthy()
+  })
+})
diff --git a/packages/macro/src/generateMessageId.ts b/packages/macro/src/generateMessageId.ts
@@ -0,0 +1,11 @@
+import crypto from "crypto"
+
+const UNIT_SEPARATOR = "\u001F"
+
+export function generateMessageId(msg: string, context = "") {
+  return crypto
+    .createHash("sha256")
+    .update(msg + UNIT_SEPARATOR + context)
+    .digest("base64")
+    .slice(0, 6)
+}