From b94896a0f8fa43b957a9bdd6ab57ada0ab8101af Mon Sep 17 00:00:00 2001 From: MohamedBassem Date: Sun, 27 Jul 2025 19:37:11 +0100 Subject: refactor: Extract meilisearch as a plugin --- packages/plugins-search-meilisearch/src/env.ts | 8 ++ packages/plugins-search-meilisearch/src/index.ts | 174 +++++++++++++++++++++++ 2 files changed, 182 insertions(+) create mode 100644 packages/plugins-search-meilisearch/src/env.ts create mode 100644 packages/plugins-search-meilisearch/src/index.ts (limited to 'packages/plugins-search-meilisearch/src') diff --git a/packages/plugins-search-meilisearch/src/env.ts b/packages/plugins-search-meilisearch/src/env.ts new file mode 100644 index 00000000..c06fdd55 --- /dev/null +++ b/packages/plugins-search-meilisearch/src/env.ts @@ -0,0 +1,8 @@ +import { z } from "zod"; + +export const envConfig = z + .object({ + MEILI_ADDR: z.string().optional(), + MEILI_MASTER_KEY: z.string().default(""), + }) + .parse(process.env); diff --git a/packages/plugins-search-meilisearch/src/index.ts b/packages/plugins-search-meilisearch/src/index.ts new file mode 100644 index 00000000..6153a9c4 --- /dev/null +++ b/packages/plugins-search-meilisearch/src/index.ts @@ -0,0 +1,174 @@ +import type { Index } from "meilisearch"; +import { MeiliSearch } from "meilisearch"; + +import type { + BookmarkSearchDocument, + SearchIndexClient, + SearchOptions, + SearchResponse, +} from "@karakeep/shared/search"; +import { PluginProvider } from "@karakeep/shared/plugins"; + +import { envConfig } from "./env"; + +class MeiliSearchIndexClient implements SearchIndexClient { + constructor(private index: Index) {} + + async addDocuments(documents: BookmarkSearchDocument[]): Promise { + const task = await this.index.addDocuments(documents, { + primaryKey: "id", + }); + await this.index.waitForTask(task.taskUid); + const taskResult = await this.index.getTask(task.taskUid); + if (taskResult.error) { + throw new Error( + `MeiliSearch add documents failed: ${taskResult.error.message}`, + ); + } + } + + async updateDocuments(documents: BookmarkSearchDocument[]): Promise { + const task = await this.index.updateDocuments(documents, { + primaryKey: "id", + }); + await this.index.waitForTask(task.taskUid); + const taskResult = await this.index.getTask(task.taskUid); + if (taskResult.error) { + throw new Error( + `MeiliSearch update documents failed: ${taskResult.error.message}`, + ); + } + } + + async deleteDocument(id: string): Promise { + const task = await this.index.deleteDocument(id); + await this.index.waitForTask(task.taskUid); + const taskResult = await this.index.getTask(task.taskUid); + if (taskResult.error) { + throw new Error( + `MeiliSearch delete document failed: ${taskResult.error.message}`, + ); + } + } + + async deleteDocuments(ids: string[]): Promise { + const task = await this.index.deleteDocuments(ids); + await this.index.waitForTask(task.taskUid); + const taskResult = await this.index.getTask(task.taskUid); + if (taskResult.error) { + throw new Error( + `MeiliSearch delete documents failed: ${taskResult.error.message}`, + ); + } + } + + async search(options: SearchOptions): Promise { + const result = await this.index.search(options.query, { + filter: options.filter, + limit: options.limit, + offset: options.offset, + sort: options.sort, + }); + + return { + hits: result.hits.map((hit) => ({ + id: hit.id, + score: hit._rankingScore, + })), + totalHits: result.estimatedTotalHits ?? 0, + processingTimeMs: result.processingTimeMs, + }; + } + + async clearIndex(): Promise { + const task = await this.index.deleteAllDocuments(); + await this.index.waitForTask(task.taskUid); + const taskResult = await this.index.getTask(task.taskUid); + if (taskResult.error) { + throw new Error( + `MeiliSearch clear index failed: ${taskResult.error.message}`, + ); + } + } +} + +export class MeiliSearchProvider implements PluginProvider { + private client: MeiliSearch | undefined; + private indexClient: SearchIndexClient | undefined; + private readonly indexName = "bookmarks"; + + constructor() { + if (MeiliSearchProvider.isConfigured()) { + this.client = new MeiliSearch({ + host: envConfig.MEILI_ADDR!, + apiKey: envConfig.MEILI_MASTER_KEY, + }); + } + } + + static isConfigured(): boolean { + return !!envConfig.MEILI_ADDR; + } + + async getClient(): Promise { + if (this.indexClient) { + return this.indexClient; + } + + if (!this.client) { + return null; + } + + const indices = await this.client.getIndexes(); + let indexFound = indices.results.find((i) => i.uid === this.indexName); + + if (!indexFound) { + const idx = await this.client.createIndex(this.indexName, { + primaryKey: "id", + }); + await this.client.waitForTask(idx.taskUid); + indexFound = await this.client.getIndex( + this.indexName, + ); + } + + await this.configureIndex(indexFound); + this.indexClient = new MeiliSearchIndexClient(indexFound); + return this.indexClient; + } + + private async configureIndex( + index: Index, + ): Promise { + const desiredFilterableAttributes = ["id", "userId"].sort(); + const desiredSortableAttributes = ["createdAt"].sort(); + + const settings = await index.getSettings(); + + if ( + JSON.stringify(settings.filterableAttributes?.sort()) !== + JSON.stringify(desiredFilterableAttributes) + ) { + console.log( + `[meilisearch] Updating desired filterable attributes to ${desiredFilterableAttributes} from ${settings.filterableAttributes}`, + ); + const taskId = await index.updateFilterableAttributes( + desiredFilterableAttributes, + ); + await this.client!.waitForTask(taskId.taskUid); + } + + if ( + JSON.stringify(settings.sortableAttributes?.sort()) !== + JSON.stringify(desiredSortableAttributes) + ) { + console.log( + `[meilisearch] Updating desired sortable attributes to ${desiredSortableAttributes} from ${settings.sortableAttributes}`, + ); + const taskId = await index.updateSortableAttributes( + desiredSortableAttributes, + ); + await this.client!.waitForTask(taskId.taskUid); + } + } +} -- cgit v1.2.3-70-g09d2