Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
fix(search): accept slashes in search queries (closes #11204)
Amp709d32a2206a
diff --git a/apps/client/src/services/search.spec.ts b/apps/client/src/services/search.spec.tsindex 5031154f75..190e1b26c0 100644--- a/apps/client/src/services/search.spec.ts+++ b/apps/client/src/services/search.spec.ts@@ -9,13 +9,13 @@ describe("search service", () => {vi.restoreAllMocks();});- it("searchForNoteIds encodes the search string in the URL and returns the server result", async () => {+ it("searchForNoteIds uses a query parameter", async () => {const get = vi.fn(async () => ["id1", "id2"]);server.get = get as typeof server.get;- const result = await searchService.searchForNoteIds("a b & #c");+ const result = await searchService.searchForNoteIds("a/b & #c");- expect(get).toHaveBeenCalledWith(`search/${encodeURIComponent("a b & #c")}`);+ expect(get).toHaveBeenCalledWith(`search?searchString=${encodeURIComponent("a/b & #c")}`);expect(result).toEqual(["id1", "id2"]);});@@ -28,7 +28,7 @@ describe("search service", () => {const notes = await searchService.searchForNotes("query");- expect(get).toHaveBeenCalledWith(`search/${encodeURIComponent("query")}`);+ expect(get).toHaveBeenCalledWith(`search?searchString=${encodeURIComponent("query")}`);expect(notes.map((n) => n.noteId)).toEqual([noteA.noteId, noteB.noteId]);});diff --git a/apps/client/src/services/search.ts b/apps/client/src/services/search.tsindex b4cbf1c0e4..24028e9226 100644--- a/apps/client/src/services/search.ts+++ b/apps/client/src/services/search.ts@@ -4,7 +4,7 @@ import server from "./server.js";import froca from "./froca.js";async function searchForNoteIds(searchString: string) {- return await server.get<string[]>(`search/${encodeURIComponent(searchString)}`);+ return await server.get<string[]>(`search?searchString=${encodeURIComponent(searchString)}`);}async function searchForNotes(searchString: string) {diff --git a/apps/client/src/widgets/quick_search.spec.ts b/apps/client/src/widgets/quick_search.spec.tsnew file mode 100644index 0000000000..2b4ff0c1da--- /dev/null+++ b/apps/client/src/widgets/quick_search.spec.ts@@ -0,0 +1,38 @@+import { beforeEach, describe, expect, it, vi } from "vitest";++vi.mock("bootstrap", () => ({+ Dropdown: {+ getOrCreateInstance: vi.fn(() => ({+ hide: vi.fn(),+ show: vi.fn(),+ update: vi.fn()+ }))+ },+ Tooltip: vi.fn()+}));++import server from "../services/server.js";+import QuickSearchWidget from "./quick_search.js";++describe("QuickSearchWidget", () => {+ beforeEach(() => {+ vi.restoreAllMocks();+ });++ it("sends slash-bearing text as a query parameter", async () => {+ const get = vi.spyOn(server, "get").mockResolvedValue({+ searchResultNoteIds: [],+ searchResults: [],+ error: ""+ });+ const widget = new QuickSearchWidget();+ const $widget = widget.doRender();+ $widget.find(".search-string").val("中/英");++ await widget.search();++ expect(get).toHaveBeenCalledWith(+ `quick-search?searchString=${encodeURIComponent("中/英")}`+ );+ });+});diff --git a/apps/client/src/widgets/quick_search.ts b/apps/client/src/widgets/quick_search.tsindex b4f28cd47f..7d5dcf6936 100644--- a/apps/client/src/widgets/quick_search.ts+++ b/apps/client/src/widgets/quick_search.ts@@ -261,7 +261,9 @@ export default class QuickSearchWidget extends BasicWidget {${t("quick-search.searching")}</span>`);- const { searchResultNoteIds, searchResults, highlightedTokens, error } = await server.get<QuickSearchResponse>(`quick-search/${encodeURIComponent(searchString)}`);+ const { searchResultNoteIds, searchResults, highlightedTokens, error } = await server.get<QuickSearchResponse>(+ `quick-search?searchString=${encodeURIComponent(searchString)}`+ );this.lastResultViewScope = highlightedTokens?.length ? { searchTerms: highlightedTokens } : undefined;diff --git a/apps/server/e2e/exact_search.spec.ts b/apps/server/e2e/exact_search.spec.tsindex f5c43d9da5..d94d1e1eda 100644--- a/apps/server/e2e/exact_search.spec.ts+++ b/apps/server/e2e/exact_search.spec.ts@@ -3,6 +3,10 @@ import App, { getBaseUrl } from "../../../packages/trilium-e2e/src/support/app";const BASE_URL = getBaseUrl();+function getSearchUrl(path: "search" | "quick-search", searchString: string) {+ return `${BASE_URL}/api/${path}?searchString=${encodeURIComponent(searchString)}`;+}+/*** E2E tests for exact search functionality using the leading "=" operator.*@@ -126,7 +130,7 @@ test.describe("Exact Search with Leading = Operator", () => {test("Quick search without = operator returns all partial matches", async ({ page }) => {// Test the /quick-search endpoint without the = operator- const response = await page.request.get(`${BASE_URL}/api/quick-search/pag`, {+ const response = await page.request.get(getSearchUrl("quick-search", "pag"), {headers: { "x-csrf-token": csrfToken }});@@ -153,7 +157,7 @@ test.describe("Exact Search with Leading = Operator", () => {test("Quick search with = operator returns only exact matches", async ({ page }) => {// Test the /quick-search endpoint WITH the = operator- const response = await page.request.get(`${BASE_URL}/api/quick-search/=pagio`, {+ const response = await page.request.get(getSearchUrl("quick-search", "=pagio"), {headers: { "x-csrf-token": csrfToken }});@@ -185,7 +189,7 @@ test.describe("Exact Search with Leading = Operator", () => {test("Full search API without = operator returns partial matches", async ({ page }) => {// Test the /search endpoint without the = operator- const response = await page.request.get(`${BASE_URL}/api/search/pag`, {+ const response = await page.request.get(getSearchUrl("search", "pag"), {headers: { "x-csrf-token": csrfToken }});@@ -206,7 +210,7 @@ test.describe("Exact Search with Leading = Operator", () => {test("Full search API with = operator returns only exact matches", async ({ page }) => {// Test the /search endpoint WITH the = operator- const response = await page.request.get(`${BASE_URL}/api/search/=pagio`, {+ const response = await page.request.get(getSearchUrl("search", "=pagio"), {headers: { "x-csrf-token": csrfToken }});@@ -256,7 +260,7 @@ test.describe("Exact Search with Leading = Operator", () => {await page.waitForTimeout(500);// Search with exact operator- const response = await page.request.get(`${BASE_URL}/api/quick-search/=test`, {+ const response = await page.request.get(getSearchUrl("quick-search", "=test"), {headers: { "x-csrf-token": csrfToken }});@@ -305,7 +309,7 @@ test.describe("Exact Search with Leading = Operator", () => {await page.waitForTimeout(500);// Search with exact operator in lowercase- const response = await page.request.get(`${BASE_URL}/api/quick-search/=exact`, {+ const response = await page.request.get(getSearchUrl("quick-search", "=exact"), {headers: { "x-csrf-token": csrfToken }});@@ -376,7 +380,7 @@ test.describe("Exact Search with Leading = Operator", () => {await page.waitForTimeout(500);// Search for exact phrase "exact phrase"- const response = await page.request.get(`${BASE_URL}/api/quick-search/='exact phrase'`, {+ const response = await page.request.get(getSearchUrl("quick-search", "='exact phrase'"), {headers: { "x-csrf-token": csrfToken }});@@ -431,7 +435,7 @@ test.describe("Exact Search with Leading = Operator", () => {await page.waitForTimeout(500);// Search for exact phrase "test sentence"- const response = await page.request.get(`${BASE_URL}/api/quick-search/='test sentence'`, {+ const response = await page.request.get(getSearchUrl("quick-search", "='test sentence'"), {headers: { "x-csrf-token": csrfToken }});@@ -480,7 +484,7 @@ test.describe("Exact Search with Leading = Operator", () => {await page.waitForTimeout(500);// Search for "=multi word" without quotes (parser tokenizes as two words)- const response = await page.request.get(`${BASE_URL}/api/quick-search/=multi word`, {+ const response = await page.request.get(getSearchUrl("quick-search", "=multi word"), {headers: { "x-csrf-token": csrfToken }});diff --git a/apps/server/internal.openapi.yaml b/apps/server/internal.openapi.yamlindex cf06b36c08..63f020dcce 100644--- a/apps/server/internal.openapi.yaml+++ b/apps/server/internal.openapi.yaml@@ -1911,14 +1911,14 @@ paths:$ref: '#/components/schemas/Note'# Search- /api/search/{searchString}:+ /api/search:get:tags: [Search]summary: Full text searchoperationId: searchparameters:- name: searchString- in: path+ in: queryrequired: trueschema:type: string@@ -1932,14 +1932,14 @@ paths:items:$ref: '#/components/schemas/SearchResult'- /api/quick-search/{searchString}:+ /api/quick-search:get:tags: [Search]summary: Quick search with highlightingoperationId: quickSearchparameters:- name: searchString- in: path+ in: queryrequired: trueschema:type: stringdiff --git a/packages/trilium-core/src/routes/api/search.spec.ts b/packages/trilium-core/src/routes/api/search.spec.tsindex 195b14eedb..179570e953 100644--- a/packages/trilium-core/src/routes/api/search.spec.ts+++ b/packages/trilium-core/src/routes/api/search.spec.ts@@ -7,6 +7,7 @@ import { isNewTemplate } from "./search";let api: CoreApiTester;const UNIQUE_TOKEN = "ZzUniqueSearchTokenQwerty";+const SLASH_TOKEN = "ZzUniqueSearch/TokenQwerty";async function createSearchNote(searchString: string): Promise<string> {const created = await api.post<{ noteId: string }>("/api/special-notes/search-note", {@@ -24,14 +25,18 @@ function quickSearch(searchString: string, hoistedNoteId?: string) {describe("Search API (core)", () => {let createdNoteId: string;+ let slashNoteId: string;beforeAll(async () => {api = CoreApiTester.build();({ noteId: createdNoteId } = await createTextNote(api, { title: UNIQUE_TOKEN }));+ ({ noteId: slashNoteId } = await createTextNote(api, { title: SLASH_TOKEN }));});it("returns matching note ids for a full search", async () => {- const res = await api.get<string[]>(`/api/search/${UNIQUE_TOKEN}`);+ const res = await api.get<string[]>("/api/search", {+ query: { searchString: UNIQUE_TOKEN }+ });expect(res.status).toBe(200);expect(Array.isArray(res.body)).toBe(true);expect(res.body).toContain(createdNoteId);@@ -77,9 +82,18 @@ describe("Search API (core)", () => {expect(broken.body.error).toBeTruthy();});+ it("accepts slash-bearing full-search queries", async () => {+ const res = await api.get<string[]>("/api/search", {+ query: { searchString: SLASH_TOKEN }+ });+ expect(res.status).toBe(200);+ expect(res.body).toContain(slashNoteId);+ });+it("returns structured quick-search results with snippets", async () => {const res = await api.get<{ searchResultNoteIds: string[]; searchResults: unknown[]; highlightedTokens: string[] }>(- `/api/quick-search/${UNIQUE_TOKEN}`+ "/api/quick-search",+ { query: { searchString: UNIQUE_TOKEN } });expect(res.status).toBe(200);expect(res.body.searchResultNoteIds).toContain(createdNoteId);@@ -133,6 +147,21 @@ describe("Search API (core)", () => {expect(res.body.searchResultNoteIds).not.toContain(hidden.noteId);});+ it("accepts slash-bearing quick-search queries", async () => {+ const res = await api.get<{ searchResultNoteIds: string[] }>("/api/quick-search", {+ query: { searchString: SLASH_TOKEN }+ });+ expect(res.status).toBe(200);+ expect(res.body.searchResultNoteIds).toContain(slashNoteId);+ });++ it("rejects missing and empty search query parameters", async () => {+ for (const path of [ "/api/search", "/api/quick-search" ]) {+ expect((await api.get(path)).status).toBe(400);+ expect((await api.get(path, { query: { searchString: "" } })).status).toBe(400);+ }+ });+it("lists template note ids including a freshly-labelled template", async () => {const { noteId } = await createTextNote(api, { title: "A template note" });await api.post(`/api/notes/${noteId}/attributes`, {diff --git a/packages/trilium-core/src/routes/api/search.ts b/packages/trilium-core/src/routes/api/search.tsindex 66cbe7f2bb..20804a674c 100644--- a/packages/trilium-core/src/routes/api/search.ts+++ b/packages/trilium-core/src/routes/api/search.ts@@ -110,8 +110,8 @@ function getSearchResultDetails(req: Request<{ noteId: string }>): SearchResultD};}-function quickSearch(req: Request<{ searchString: string }>) {- const { searchString } = req.params;+function quickSearch(req: Request) {+ const searchString = getSearchString(req);const searchContext = new SearchContext({fastSearch: false,@@ -139,10 +139,10 @@ function quickSearch(req: Request<{ searchString: string }>) {}function search(- req: Request<{ searchString: string }, unknown, unknown,+ req: Request<unknown, unknown, unknown,{ ancestorNoteId?: string, includeTokens?: string }>): string[] | SearchWithTokensResponse {- const { searchString } = req.params;+ const searchString = getSearchString(req);const { ancestorNoteId, includeTokens } = req.query;const searchContext = new SearchContext({@@ -169,6 +169,14 @@ function search(};}+function getSearchString(req: Request): string {+ if (typeof req.query.searchString !== "string" || req.query.searchString.length === 0) {+ throw new ValidationError("Search string must be a string.");+ }++ return req.query.searchString;+}+function getRelatedNotes(req: Request) {const attr = req.body;diff --git a/packages/trilium-core/src/routes/index.ts b/packages/trilium-core/src/routes/index.tsindex 2a1df91547..4ae7ec5eb9 100644--- a/packages/trilium-core/src/routes/index.ts+++ b/packages/trilium-core/src/routes/index.ts@@ -235,12 +235,12 @@ export function buildSharedApiRoutes({ route, asyncRoute, asyncRouteWithoutTransasyncRoute(GET, "/api/branches/:branchId/export/:type/:format/:taskId", [checkApiAuthOrElectron], exportRoute.exportBranch);//#endregion- apiRoute(GET, "/api/quick-search/:searchString", searchRoute.quickSearch);+ apiRoute(GET, "/api/quick-search", searchRoute.quickSearch);apiRoute(GET, "/api/search-note/:noteId", searchRoute.searchFromNote);apiRoute(PST, "/api/search-note/:noteId/result-details", searchRoute.getSearchResultDetails);apiRoute(PST, "/api/search-and-execute-note/:noteId", searchRoute.searchAndExecute);apiRoute(PST, "/api/search-related", searchRoute.getRelatedNotes);- apiRoute(GET, "/api/search/:searchString", searchRoute.search);+ apiRoute(GET, "/api/search", searchRoute.search);apiRoute(GET, "/api/search-templates", searchRoute.searchTemplates);// Streaming a chat is not here — it has no single form every runtime can serve.