Sort short/exact emoji matches before longer incomplete matches (#10212)

* apply sort for exact match

* add tests for emoji provider

* apply filter in the emoji picker

* add tests

* revert cypress version

* put correct copyright

* fix eslint

* fix eslint

* add type

* fix cypress test

* fix tsc types issues

* add forgotten space...

---------

Co-authored-by: grimhilt <grimhilt@users.noreply.github.com>
Co-authored-by: David Baker <dbkr@users.noreply.github.com>

test/autocomplete/EmojiProvider-test.ts

@@ -69,20 +69,30 @@ describe("EmojiProvider", function () {
         },
     );
 
-    it("Returns correct autocompletion based on recently used emoji", async function () {
+    it("Recently used emojis are correctly sorted", async function () {
         add("😘"); //kissing_heart
-        add("😘");
-        add("😚"); //kissing_closed_eyes
-        const emojiProvider = new EmojiProvider(null!);
+        add("💗"); //heartpulse
+        add("💗"); //heartpulse
+        add("😍"); //heart_eyes
 
-        let completionsList = await emojiProvider.getCompletions(":kis", { beginning: true, end: 3, start: 3 });
-        expect(completionsList[0].component!.props.title).toEqual(":kissing_heart:");
-        expect(completionsList[1].component!.props.title).toEqual(":kissing_closed_eyes:");
+        const ep = new EmojiProvider(testRoom);
+        const completionsList = await ep.getCompletions(":heart", { beginning: true, start: 0, end: 6 });
+        expect(completionsList[0]?.component?.props.title).toEqual(":heartpulse:");
+        expect(completionsList[1]?.component?.props.title).toEqual(":heart_eyes:");
+    });
 
-        completionsList = await emojiProvider.getCompletions(":kissing_c", { beginning: true, end: 3, start: 3 });
-        expect(completionsList[0].component!.props.title).toEqual(":kissing_closed_eyes:");
+    it("Exact match in recently used takes the lead", async function () {
+        add("😘"); //kissing_heart
+        add("💗"); //heartpulse
+        add("💗"); //heartpulse
+        add("😍"); //heart_eyes
 
-        completionsList = await emojiProvider.getCompletions(":so", { beginning: true, end: 2, start: 2 });
-        expect(completionsList[0].component!.props.title).toEqual(":sob:");
+        add("❤️"); //heart
+        const ep = new EmojiProvider(testRoom);
+        const completionsList = await ep.getCompletions(":heart", { beginning: true, start: 0, end: 6 });
+
+        expect(completionsList[0]?.component?.props.title).toEqual(":heart:");
+        expect(completionsList[1]?.component?.props.title).toEqual(":heartpulse:");
+        expect(completionsList[2]?.component?.props.title).toEqual(":heart_eyes:");
     });
 });

test/components/views/emojipicker/EmojiPicker-test.tsx

@@ -0,0 +1,34 @@
+/*
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import EmojiPicker from "../../../../src/components/views/emojipicker/EmojiPicker";
+import { stubClient } from "../../../test-utils";
+
+describe("EmojiPicker", function () {
+    stubClient();
+
+    it("sort emojis by shortcode and size", function () {
+        const ep = new EmojiPicker({ onChoose: (str: String) => false });
+
+        //@ts-ignore private access
+        ep.onChangeFilter("heart");
+
+        //@ts-ignore private access
+        expect(ep.memoizedDataByCategory["people"][0].shortcodes[0]).toEqual("heart");
+        //@ts-ignore private access
+        expect(ep.memoizedDataByCategory["people"][1].shortcodes[0]).toEqual("heartbeat");
+    });
+});