feat: Support user initials in mention search (#10797)

* feat: Support user initials in mention search

* test

app/models/User.test.ts

@@ -0,0 +1,197 @@
+import User from "./User";
+import stores from "~/stores";
+
+describe("User model", () => {
+  const users = stores.users;
+
+  describe("initial", () => {
+    test("should return first character of name uppercased", () => {
+      const user = new User(
+        {
+          id: "123",
+          name: "alice smith",
+        },
+        users
+      );
+      expect(user.initial).toBe("A");
+    });
+
+    test("should return first character when name is already uppercase", () => {
+      const user = new User(
+        {
+          id: "124",
+          name: "Bob Johnson",
+        },
+        users
+      );
+      expect(user.initial).toBe("B");
+    });
+
+    test("should return ? when name is empty", () => {
+      const user = new User(
+        {
+          id: "125",
+          name: "",
+        },
+        users
+      );
+      expect(user.initial).toBe("?");
+    });
+
+    test("should return ? when name is null", () => {
+      const user = new User(
+        {
+          id: "126",
+          name: null,
+        },
+        users
+      );
+      expect(user.initial).toBe("?");
+    });
+
+    test("should return ? when name is undefined", () => {
+      const user = new User(
+        {
+          id: "127",
+          name: undefined,
+        },
+        users
+      );
+      expect(user.initial).toBe("?");
+    });
+  });
+
+  describe("initials", () => {
+    test("should return empty string when name is empty", () => {
+      const user = new User(
+        {
+          id: "201",
+          name: "",
+        },
+        users
+      );
+      expect(user.initials).toBe("");
+    });
+
+    test("should return empty string when name is null", () => {
+      const user = new User(
+        {
+          id: "202",
+          name: null,
+        },
+        users
+      );
+      expect(user.initials).toBe("");
+    });
+
+    test("should return single character uppercased for single word name", () => {
+      const user = new User(
+        {
+          id: "203",
+          name: "alice",
+        },
+        users
+      );
+      expect(user.initials).toBe("A");
+    });
+
+    test("should return single character uppercased for single word name already uppercase", () => {
+      const user = new User(
+        {
+          id: "204",
+          name: "BOB",
+        },
+        users
+      );
+      expect(user.initials).toBe("B");
+    });
+
+    test("should return first and last initials for two word name", () => {
+      const user = new User(
+        {
+          id: "205",
+          name: "alice smith",
+        },
+        users
+      );
+      expect(user.initials).toBe("AS");
+    });
+
+    test("should return first and last initials for three word name", () => {
+      const user = new User(
+        {
+          id: "206",
+          name: "alice marie smith",
+        },
+        users
+      );
+      expect(user.initials).toBe("AS");
+    });
+
+    test("should return first and last initials for many word name", () => {
+      const user = new User(
+        {
+          id: "207",
+          name: "alice marie jane doe smith",
+        },
+        users
+      );
+      expect(user.initials).toBe("AS");
+    });
+
+    test("should handle names with extra spaces", () => {
+      const user = new User(
+        {
+          id: "208",
+          name: "  alice   smith  ",
+        },
+        users
+      );
+      expect(user.initials).toBe("AS");
+    });
+
+    test("should handle names with mixed case", () => {
+      const user = new User(
+        {
+          id: "209",
+          name: "aLiCe sMiTh",
+        },
+        users
+      );
+      expect(user.initials).toBe("AS");
+    });
+
+    test("should handle names with special characters", () => {
+      const user = new User(
+        {
+          id: "210",
+          name: "Jean-Pierre O'Connor",
+        },
+        users
+      );
+      expect(user.initials).toBe("JO");
+    });
+
+    test("should handle single letter names", () => {
+      const user = new User(
+        {
+          id: "211",
+          name: "X",
+        },
+        users
+      );
+      expect(user.initials).toBe("X");
+    });
+
+    test("should handle names with unicode characters", () => {
+      const user = new User(
+        {
+          id: "212",
+          name: "José García",
+        },
+        users
+      );
+      expect(user.initials).toBe("JG");
+    });
+  });
+});

app/models/User.ts

@@ -65,7 +65,7 @@ class User extends ParanoidModel implements Searchable {
 
   @computed
   get searchContent(): string[] {
-    return [this.name, this.email].filter(Boolean);
+    return [this.name, this.email, this.initials].filter(Boolean);
   }
 
   @computed
@@ -78,6 +78,18 @@ class User extends ParanoidModel implements Searchable {
     return (this.name ? this.name[0] : "?").toUpperCase();
   }
 
+  @computed
+  get initials(): string {
+    if (!this.name) {
+      return "";
+    }
+    const names = this.name.trim().split(" ");
+    if (names.length === 1) {
+      return names[0][0].toUpperCase();
+    }
+    return (names[0][0] + names[names.length - 1][0]).toUpperCase();
+  }
+
   /**
    * Whether the user has been invited but not yet signed in.
    */