Allows search to recognize full room links (#8275)

* fix matrix search link

* fix matrix search link

Signed-off-by: Boluwatife Omosowon <[email protected]>

* fix: allow full link search

Signed-off-by: Boluwatife Omosowon <[email protected]>

* fix: allow full link search on new search feature

Signed-off-by: Boluwatife Omosowon <[email protected]>

* improve transformSearchTerm function

Signed-off-by: Boluwatife Omosowon <[email protected]>

* improve transformSearchTerm function

Signed-off-by: Boluwatife Omosowon <[email protected]>

* add review changes

* Signed-off-by: Boluwatife Omosowon <[email protected]>

added review correction

changed the transformSearchTerm function to use parsePermaLink
removed extra spaces

* add angle brackets to copyright email title

* removed extra space

Signed-off-by: Boluwatife Omosowon <[email protected]>

* Update src/utils/SearchInput.ts

Co-authored-by: Travis Ralston <[email protected]>

* fixed spolight dialog search for room and user links

* added tests for transformSearchTerm

* removed transformSearchTerm from room search bar

* replaces two test cases to one that should return the primaryEntityId if the search term was a permalink

* corrected ts issues

* changed type of transformSearchTerm to string

* changed return value from empty string to the original search term if the primaryEntityId of the parsedLink is null

* changed return value from empty string to the original search term if the primaryEntityId of the parsedLink is null

* refactored transformSearchTerm and added a new test case

* rewrote transformSearchTerm doc

* changed mocked return values of test case - should return the original search term if the search term is a permalink and the primaryEntityId is null

* lint corrections

---------

Signed-off-by: Boluwatife Omosowon <[email protected]>
Co-authored-by: Boluwatife Omosowon <[email protected]>
Co-authored-by: Travis Ralston <[email protected]>

Author: 3 people

src/components/views/dialogs/spotlight/SpotlightDialog.tsx

@@ -89,6 +89,7 @@ import { isLocalRoom } from "../../../../utils/localRoom/isLocalRoom";
 import RoomAvatar from "../../avatars/RoomAvatar";
 import { useFeatureEnabled } from "../../../../hooks/useSettings";
 import { filterBoolean } from "../../../../utils/arrays";
+import { transformSearchTerm } from "../../../../utils/SearchInput";
 
 const MAX_RECENT_SEARCHES = 10;
 const SECTION_LIMIT = 50; // only show 50 results per section for performance reasons
@@ -466,7 +467,7 @@ const SpotlightDialog: React.FC<IProps> = ({ initialText = "", initialFilter = n
     const [spaceResults, spaceResultsLoading] = useSpaceResults(activeSpace ?? undefined, query);
 
     const setQuery = (e: ChangeEvent<HTMLInputElement>): void => {
-        const newQuery = e.currentTarget.value;
+        const newQuery = transformSearchTerm(e.currentTarget.value);
         _setQuery(newQuery);
     };
     useEffect(() => {

src/utils/SearchInput.ts

@@ -0,0 +1,30 @@
+/*
+Copyright 2023 Boluwatife Omosowon <[email protected]>
+
+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 { parsePermalink } from "./permalinks/Permalinks";
+
+/**
+ * Returns the primaryEntityId(roomIdOrAlias or userId) if the search term
+ * is a permalink and the primaryEntityId is not null. Otherwise, it returns
+ * the original search term.
+ * E.g https://matrix.to/#/#element-dev:matrix.org returns #element-dev:matrix.org
+ * @param {string} searchTerm The search term.
+ * @returns {string} The roomId, alias, userId, or the original search term
+ */
+export function transformSearchTerm(searchTerm: string): string {
+    const parseLink = parsePermalink(searchTerm);
+    return parseLink?.primaryEntityId ?? searchTerm;
+}

test/utils/SearchInput-test.ts

@@ -0,0 +1,60 @@
+/*
+Copyright 2023 Boluwatife Omosowon <[email protected]>
+
+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 { mocked } from "jest-mock";
+
+import { parsePermalink } from "../../src/utils/permalinks/Permalinks";
+import { transformSearchTerm } from "../../src/utils/SearchInput";
+
+jest.mock("../../src/utils/permalinks/Permalinks");
+
+describe("transforming search term", () => {
+    it("should return the primaryEntityId if the search term was a permalink", () => {
+        const roomLink = "https://matrix.to/#/#element-dev:matrix.org";
+        const parsedPermalink = "#element-dev:matrix.org";
+
+        mocked(parsePermalink).mockReturnValue({
+            primaryEntityId: parsedPermalink,
+            roomIdOrAlias: parsedPermalink,
+            eventId: "",
+            userId: "",
+            viaServers: [],
+            sigil: "",
+        });
+
+        expect(transformSearchTerm(roomLink)).toBe(parsedPermalink);
+    });
+
+    it("should return the original search term if the search term is a permalink and the primaryEntityId is null", () => {
+        const searchTerm = "https://matrix.to/#/#random-link:matrix.org";
+
+        mocked(parsePermalink).mockReturnValue({
+            primaryEntityId: null,
+            roomIdOrAlias: null,
+            eventId: null,
+            userId: null,
+            viaServers: null,
+            sigil: "?",
+        });
+
+        expect(transformSearchTerm(searchTerm)).toBe(searchTerm);
+    });
+
+    it("should return the original search term if the search term was not a permalink", () => {
+        const searchTerm = "search term";
+        mocked(parsePermalink).mockReturnValue(null);
+        expect(transformSearchTerm(searchTerm)).toBe(searchTerm);
+    });
+});