1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
import type { Index } from "meilisearch";
import { MeiliSearch } from "meilisearch";
import type {
BookmarkSearchDocument,
FilterQuery,
SearchIndexClient,
SearchOptions,
SearchResponse,
} from "@karakeep/shared/search";
import serverConfig from "@karakeep/shared/config";
import { PluginProvider } from "@karakeep/shared/plugins";
import { envConfig } from "./env";
function filterToMeiliSearchFilter(filter: FilterQuery): string {
switch (filter.type) {
case "eq":
return `${filter.field} = "${filter.value}"`;
case "in":
return `${filter.field} IN [${filter.values.join(",")}]`;
default: {
const exhaustiveCheck: never = filter;
throw new Error(`Unhandled color case: ${exhaustiveCheck}`);
}
}
}
class MeiliSearchIndexClient implements SearchIndexClient {
constructor(private index: Index<BookmarkSearchDocument>) {}
async addDocuments(documents: BookmarkSearchDocument[]): Promise<void> {
const task = await this.index.addDocuments(documents, {
primaryKey: "id",
});
await this.ensureTaskSuccess(task.taskUid);
}
async deleteDocuments(ids: string[]): Promise<void> {
const task = await this.index.deleteDocuments(ids);
await this.ensureTaskSuccess(task.taskUid);
}
async search(options: SearchOptions): Promise<SearchResponse> {
const result = await this.index.search(options.query, {
filter: options.filter?.map((f) => filterToMeiliSearchFilter(f)),
limit: options.limit,
offset: options.offset,
sort: options.sort?.map((s) => `${s.field}:${s.order}`),
attributesToRetrieve: ["id"],
showRankingScore: true,
});
return {
hits: result.hits.map((hit) => ({
id: hit.id,
score: hit._rankingScore,
})),
totalHits: result.estimatedTotalHits ?? 0,
processingTimeMs: result.processingTimeMs,
};
}
async clearIndex(): Promise<void> {
const task = await this.index.deleteAllDocuments();
await this.ensureTaskSuccess(task.taskUid);
}
private async ensureTaskSuccess(taskUid: number): Promise<void> {
const task = await this.index.waitForTask(taskUid, {
intervalMs: 200,
timeOutMs: serverConfig.search.jobTimeoutSec * 1000 * 0.9,
});
if (task.error) {
throw new Error(`Search task failed: ${task.error.message}`);
}
}
}
export class MeiliSearchProvider implements PluginProvider<SearchIndexClient> {
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<SearchIndexClient | null> {
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<BookmarkSearchDocument>(
this.indexName,
);
}
await this.configureIndex(indexFound);
this.indexClient = new MeiliSearchIndexClient(indexFound);
return this.indexClient;
}
private async configureIndex(
index: Index<BookmarkSearchDocument>,
): Promise<void> {
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);
}
}
}
|
