Upgrade emojibase-bindings and remove local handling of emoticon variations (#127)

* Updgrade emojibase-bindings and remove local handling of emoticon variations

* bump bindings to fix issue of mission emojis with version == 0

* update lockfile

* test emoji variation in RTE

Author: langleyd

package.json

@@ -73,7 +73,7 @@
     "dependencies": {
         "@babel/runtime": "^7.12.5",
         "@matrix-org/analytics-events": "^0.26.0",
-        "@matrix-org/emojibase-bindings": "^1.1.2",
+        "@matrix-org/emojibase-bindings": "^1.3.3",
         "@vector-im/matrix-wysiwyg": "2.37.13",
         "@matrix-org/react-sdk-module-api": "^2.4.0",
         "@matrix-org/spec": "^1.7.0",

src/components/views/rooms/BasicMessageComposer.tsx

@@ -201,9 +201,9 @@ export default class BasicMessageEditor extends React.Component<IProps, IState>
         // so xd will not match if the string was "mixd 123456"
         // and we are lookinh at xd 123456 part of the string
         if (emoticonMatch && (n >= 0 || emoticonMatch.index !== 0)) {
-            const query = emoticonMatch[1].replace("-", "");
-            // try both exact match and lower-case, this means that xd won't match xD but :P will match :p
-            const data = EMOTICON_TO_EMOJI.get(query) || EMOTICON_TO_EMOJI.get(query.toLowerCase());
+            const query = emoticonMatch[1];
+            // variations of plaintext emoitcons(E.g. :P vs :p vs :-P) are handled upstream by the emojibase-bindings library
+            const data = EMOTICON_TO_EMOJI.get(query);
 
             if (data) {
                 const { partCreator } = model;

src/components/views/rooms/wysiwyg_composer/hooks/useSuggestion.ts

@@ -388,7 +388,9 @@ function shouldIncrementEndIndex(text: string, index: number): boolean {
  */
 export function getMappedSuggestion(text: string, isAutoReplaceEmojiEnabled?: boolean): MappedSuggestion | null {
     if (isAutoReplaceEmojiEnabled) {
-        const emoji = EMOTICON_TO_EMOJI.get(text.toLocaleLowerCase());
+        // variations of plaintext emoitcons(E.g. :P vs :p vs :-P) are handled upstream by the emojibase-bindings/emojibase libraries.
+        // See rules for variations here https://github.com/milesj/emojibase/blob/master/packages/core/src/generateEmoticonPermutations.ts#L3-L32
+        const emoji = EMOTICON_TO_EMOJI.get(text);
         if (emoji?.unicode) {
             return { keyChar: "", text: emoji.unicode, type: "custom" };
         }

test/components/views/rooms/BasicMessageComposer-test.tsx

@@ -63,6 +63,7 @@ describe("BasicMessageComposer", () => {
             { before: ":-D", after: "😄" },
             { before: ":D", after: "😄" },
             { before: ":3", after: "😽" },
+            { before: "=-]", after: "🙂" },
         ];
         const input = screen.getByRole("textbox");
 

test/components/views/rooms/wysiwyg_composer/components/WysiwygComposer-test.tsx

@@ -435,6 +435,18 @@ describe("WysiwygComposer", () => {
                 inputType: "insertText",
             });
 
+            await waitFor(() => expect(onChange).toHaveBeenNthCalledWith(3, expect.stringContaining("😛")));
+        });
+        it("typing a space to trigger an emoji varitation replacement", async () => {
+            fireEvent.input(screen.getByRole("textbox"), {
+                data: ":-P",
+                inputType: "insertText",
+            });
+            fireEvent.input(screen.getByRole("textbox"), {
+                data: " ",
+                inputType: "insertText",
+            });
+
             await waitFor(() => expect(onChange).toHaveBeenNthCalledWith(3, expect.stringContaining("😛")));
         });
     });

yarn.lock

@@ -1898,13 +1898,13 @@
   resolved "https://registry.yarnpkg.com/@matrix-org/analytics-events/-/analytics-events-0.26.0.tgz#7c8f8f924d8313c87951a0e941640ef8ff78f3d6"
   integrity sha512-cjKZBejajUG8wPhVygMkBTwTLdEn74luUP6g6RjCUqPR3RYIl3NVi58Zil8CWfRTILb4wVLCPpAvehgXJn1HnQ==
 
-"@matrix-org/emojibase-bindings@^1.1.2":
-  version "1.1.3"
-  resolved "https://registry.yarnpkg.com/@matrix-org/emojibase-bindings/-/emojibase-bindings-1.1.3.tgz#d35f0367d586d83261564662b6bb67fda8845d68"
-  integrity sha512-ljr0kPerx8yUc4JVJz7japebb1ZbtGH4V4cvlO2LYgTg+warjagDwkJ5x+ZUVuTU6MH8x0LrUxmkqVgmSoQyWA==
+"@matrix-org/emojibase-bindings@^1.3.3":
+  version "1.3.3"
+  resolved "https://registry.yarnpkg.com/@matrix-org/emojibase-bindings/-/emojibase-bindings-1.3.3.tgz#cee82a739c0866bf3100b03755647ace1f3ba6ef"
+  integrity sha512-GwuZdmF+wZT34RKehQYjTzdgba1ju2W3FM4jPJfwqh0jUxVXZLb+6b6dV3lna6/7EDzgGvOMwTwCAolILDwS0g==
   dependencies:
-    emojibase "^15.0.0"
-    emojibase-data "^15.0.0"
+    emojibase "^15.3.1"
+    emojibase-data "^15.3.1"
 
 "@matrix-org/matrix-sdk-crypto-wasm@^7.0.0":
   version "7.0.0"
@@ -4431,20 +4431,20 @@ emoji-regex@^9.2.2:
   resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-9.2.2.tgz#840c8803b0d8047f4ff0cf963176b32d4ef3ed72"
   integrity sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==
 
-emojibase-data@^15.0.0:
-  version "15.2.0"
-  resolved "https://registry.yarnpkg.com/emojibase-data/-/emojibase-data-15.2.0.tgz#475a786c091a101ef4bcf57227771c6260ee39b2"
-  integrity sha512-hDiw4ugxnI4pcVQO+73NlKx6aZP/A+BAPfDgK/3A83RVbHZa0Ut6GHpd5r5XUV9G7BZhKejlIRuxhXialpbt6Q==
+emojibase-data@^15.3.1:
+  version "15.3.2"
+  resolved "https://registry.yarnpkg.com/emojibase-data/-/emojibase-data-15.3.2.tgz#2742246bfe14f16a7829b42ca156dec09934cf85"
+  integrity sha512-TpDyTDDTdqWIJixV5sTA6OQ0P0JfIIeK2tFRR3q56G9LK65ylAZ7z3KyBXokpvTTJ+mLUXQXbLNyVkjvnTLE+A==
 
 [email protected]:
   version "15.3.2"
   resolved "https://registry.yarnpkg.com/emojibase-regex/-/emojibase-regex-15.3.2.tgz#5175231715b86d4b437754527288844a6c29318f"
   integrity sha512-ue6BVeb2qu33l97MkxcOoyMJlg6Tug3eTv2z1at+M9TjvlWKvdmAPvZIDG1JbT2RH3FSyJNLucO5K5H/yxT03w==
 
-emojibase@^15.0.0:
-  version "15.2.0"
-  resolved "https://registry.yarnpkg.com/emojibase/-/emojibase-15.2.0.tgz#0a175d4218f4a1600f2ada6b3a3184cef1b3ec7b"
-  integrity sha512-gB6rIVtyJPersQvAo4nOGYPeILMhlcfZdiwCWVeRAtkJ7sm0tExZETGyLhrTQcHvZQhDEYI1vlCeqUhn5gZkQA==
+emojibase@^15.3.1:
+  version "15.3.1"
+  resolved "https://registry.yarnpkg.com/emojibase/-/emojibase-15.3.1.tgz#7f6ff5482486f23e59a457de64e974bd35f3c9a3"
+  integrity sha512-GNsjHnG2J3Ktg684Fs/vZR/6XpOSkZPMAv85EHrr6br2RN2cJNwdS4am/3YSK3y+/gOv2kmoK3GGdahXdMxg2g==
 
 emojis-list@^3.0.0:
   version "3.0.0"