-
Notifications
You must be signed in to change notification settings - Fork 14
/
index.js
601 lines (558 loc) · 20.3 KB
/
index.js
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
// Copyright 2019 The Matrix.org Foundation C.I.C.
//
// 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.
const {promisify} = require('util');
const seshatNative = require('./index.node');
/**
* @typedef searchResult
* @type {Object}
* @property {string} next_batch A token that can be used to grab more results
* in the next search call.
* @property {number} count The total number of results that were found.
* @property {Array.<singleResult>} results The list of results that was found.
*/
/**
* @typedef singleResult
* @type {Object}
* @property {number} rank The rank of the search result.
* @property {matrixEvent} result The full event of the search result.
* @property {searchContext} context The context of the result, containing
* events before and after the result.
*/
/**
* @typedef searchContext
* @type {Object}
* @property {Array.<matrixEvent>} events_before Events that happened before the
* search result.
* @property {Array.<matrixEvent>} events_after Events that happened after the
* search result.
* @property {{user_id: matrixProfile}} profile_info The historic profile
* information of the users that sent the events returned.
*/
/**
* @typedef matrixEvent
* @type {Object}
* @property {string} event_id The unique ID of the event.
* @property {string} sender The MXID of the user who sent this event.
* @property {string} room_id The ID of the room where the event was sent.
* @property {number} origin_server_ts The timestamp in milliseconds of the
* originating homeserver when this event was sent.
* @property {Object} content The content of the event. The content needs to
* have either a body, topic or name key.
*/
/**
* @typedef matrixProfile
* @type {Object}
* @property {string} displayname The users display name, if one is set.
* @property {string} avatar_url The users avatar url, if one is set.
*/
/**
* @typedef checkpoint
* @type {Object}
* @property {string} roomId The unique id of the room that this checkpoint
* belongs to.
* @property {string} token The token that can be used to fetch more events for
* the given room.
* @property {boolean} fullCrawl Is this checkpoint of a crawl that should
* re-crawl the complete room history.
* @property {string} direction The crawl direction of the checkpoint. Can be
* one of "b" or "f".
*/
/**
* @typedef loadResult
* @type {Object}
* @property {matrixEvent} event A matrix event that was loaded from the
* database.
* @property {matrixProfile} profile The profile of the sender at the time the
* event was sent.
*/
/**
* @typedef databaseStats
* @type {Object}
* @property {number} size The number of bytes that the database is consuming on
* the disk.
* @property {number} eventCount The number events that are stored in the
* database.
* @property {number} roomCount The number of rooms the database knows about.
*/
/**
* @typedef recoveryInfo
* @type {Object}
* @property {number} totalEvents The total number of events that the database
* holds.
* @property {number} reindexedEvents The number of events that have been
* reindexed.
* @property {number} done The percentage showing the re-index progress.
*/
/**
* Seshat re-index error.<br>
*
* This error will be thrown if a Seshat database can't be opened because it
* needs to be re-indexed.
*
* The database can be opened as a recovery database with the SeshatRecovery
* class. This class provides method to re-index the database.
*
*/
class ReindexError extends Error {
/**
* Create a new ReindexError
*/
constructor(...params) {
super(...params);
if (Error.captureStackTrace) {
Error.captureStackTrace(this, ReindexError);
}
this.name = 'ReindexError';
this.message = 'The Seshat database needs to be reindexed.';
}
}
/**
* Seshat database.<br>
*
* A Seshat database can be used to store and index Matrix events. A full-text
* search can be done on the database retrieving events that match a search
* query.
*/
class Seshat {
/**
* Open an existing or create a new Seshat database.
*
* @param {string} path The path where the database should be stored. If a
* database already exist in the given folder the database will be reused.
* @param {object} config Additional configuration for the database.
* database already exist in the given folder the database will be reused.
* @param {string} config.language The language that the database should
* use for indexing. Picking the correct indexing language may improve the
* search. @param {string} config.passphrase The passphrase that should be
* used to encrypt the database. The database is left unencrypted it no
* passphrase is set.
*
* @constructor
*
* @example
* // create a Seshat database in the given folder
* let db = new Seshat("/home/example/database_dir");
* // Add a Matrix event to the database.
* db.addEvent(textEvent, profile);
* // Commit events waiting in the queue to the database.
* await db.commit();
* // Search the database for messages containing the word 'Test'
* let results = await db.search('Test');
*/
constructor(path, config = undefined) {
config = config || {};
try {
this.inner = seshatNative.createDb(path, config);
} catch (e) {
// The Rust side throws a RangeError, this is a bit silly so convert
// it to a custom error.
if (e.constructor.name === 'RangeError') {
throw new ReindexError();
} else {
throw e;
}
}
}
/**
* Add an event to the database.
*
* This method adds an event only to a queue. To write the events to the
* database the <code>commit()</code> methods needs to be called.
*
* @param {matrixEvent} matrixEvent A Matrix event that should be added to
* the database.
* @param {matrixProfile} profile The user profile of the sender at the
* time the event was sent.
*
* @return {Void}
*/
addEvent(matrixEvent, profile = {}) {
return seshatNative.addEvent(this.inner, matrixEvent, profile);
};
/**
* Delete an event from the database.
*
* This method adds an event only to a queue. To write the events to the
* database the <code>commit()</code> methods needs to be called.
*
* @param {string} eventId The unique id of the event that should be
* deleted from the database.
*
* @return {Promise<boolean>} A boolean indicating if the event was removed
* from the index or if a commit later on will be needed.
*/
async deleteEvent(eventId) {
const deleteEvent = promisify(seshatNative.deleteEvent);
return deleteEvent(this.inner, eventId);
};
/**
* Commit the queued up events to the database.
*
* This is the asynchronous equivalent of the <code>commitSync()</code>
* method.
*
* @param {boolean} force Force the commit, commits to the index are
* usually rate limited. This gets around the limit and forces the
* documents to be added to the index. This should only be used for testing
* purposes.
*
* @return {Promise<number>} The latest stamp of the commit. The stamp is
* a unique incrementing number that identifies the commit.
*/
async commit(force = false) {
const commit = promisify(seshatNative.commit);
return commit(this.inner, force);
}
/**
* Commit the queued up events to the database.
*
* @param {boolean} wait Wait for the events to be committed. If true will
* block until the events are committed.
* @param {boolean} force Force the commit, commits to the index are
* usually rate limited. This gets around the limit and forces the
* documents to be added to the index. This should only be used for testing
* purposes.
*
* @return {number} The latest stamp of the commit. The stamp is a unique
* incrementing number that identifies the commit.
*/
commitSync(wait = false, force = false) {
return seshatNative.commitSync(this.inner, wait, force);
}
/**
* Reload the indexer of the database to reflect the changes of the last
* commit. A reload will happen automatically, this method is mainly useful
* for unit testing purposes to force a reload before a search.
*/
reload() {
seshatNative.reload(this.inner);
};
/**
* Search the database for events using the given search term.
* This is the asynchronous equivalent of the <code>searchSync()</code>
* method.
*
* @param {object} args Arguments object for the search.
* @param {string} args.searchTerm The term that is used to search the
* database.
* @param {number} args.limit The maximum number of events that the search
* should return.
* @param {number} args.before_limit The number of events to fetch that
* preceded the event that matched the search term.
* @param {number} args.after_limit The number of events to fetch that
* followed the event that matched the search term.
* @param {boolean} args.order_by_recency Should the search results be
* ordered by event recency.
* @param {string} args.next_batch The token to request the next page of
* results.
*
* @return {Promise<searchResult>} The array of events that matched
* the search term.
*/
async search(args) {
const search = promisify(seshatNative.search);
return search(this.inner, args);
}
/**
* Search the database for events using the given search term.
*
* @param {string} term The term that is used to search the database.
* @param {number} limit The maximum number of events that the search
* should return.
* @param {number} before_limit The number of events to fetch that
* preceded the event that matched the search term.
* @param {number} after_limit The number of events to fetch that followed
* the event that matched the search term.
* @param {boolean} order_by_recency Should the search results be ordered
* by event recency.
*
* @return {searchResult} The array of events that matched the
* search term.
*/
searchSync(term, limit = 10, before_limit = 0, after_limit = 0,
order_by_recency = false) {
return seshatNative.searchSync(this.inner, term, limit, before_limit,
after_limit, order_by_recency);
}
/**
* Add a batch of events from the room history to the database.
*
* @param {array<matrixEvent>} events An array of events that will be
* added to the database.
* @param {checkpoint} newCheckpoint
* @param {checkpoint} oldCheckPoint
*
* @return {boolean} True if the added events were already in the store,
* false otherwise.
*/
addHistoricEventsSync(events, newCheckpoint = null, oldCheckPoint = null) {
return seshatNative.addHistoricEventsSync(this.inner, events,
newCheckpoint, oldCheckPoint);
}
/**
* Add a batch of events from the room history to the database.
*
* @param {array<matrixEvent>} events An array of events that will be
* added to the database.
* @param {checkpoint} newCheckpoint
* @param {checkpoint} oldCheckPoint
*
* @return {Promise<boolean>} A promise that will resolve to true if all
* the events have already been added to the database, false otherwise.
*/
async addHistoricEvents(events, newCheckpoint = null, oldCheckPoint = null) {
const addHistoricEvents = promisify(seshatNative.addHistoricEvents);
return addHistoricEvents(
this.inner,
events,
newCheckpoint,
oldCheckPoint,
);
}
/**
* Add a message crawler checkpoint.
*
* @param {checkpoint} checkpoint
*
* @return {Promise} A promise that will resolve when the checkpoint has
* been stored in the database.
*/
async addCrawlerCheckpoint(checkpoint) {
return this.addHistoricEvents([], checkpoint);
}
/**
* Remove a message crawler checkpoint.
* @param {checkpoint} checkpoint
*
* @return {Promise} A promise that will resolve when the checkpoint has
* been removed from the database.
*/
async removeCrawlerCheckpoint(checkpoint) {
return this.addHistoricEvents([], null, checkpoint);
}
/**
* Load the stored crawler checkpoints.
* @param {checkpoint} checkpoint
*
* @return {Promise<Array.<checkpoint>>} A promise that will resolve to an
* array of checkpoints when they are loaded from the database.
*/
async loadCheckpoints() {
const loadCheckpoints = promisify(seshatNative.loadCheckpoints);
return loadCheckpoints(this.inner);
}
/**
* Get the size of the database.
* This returns the number of bytes the database is using on disk.
*
* @return {Promise<number>} A promise that will resolve to the database
* size in bytes.
*/
async getSize() {
const getSize = promisify(seshatNative.getSize);
return getSize(this.inner);
}
/**
* Get statistical information of the database.
*
* @return {Promise<databaseStats>} A promise that will resolve to an object
* containing statistical information of the database.
*/
async getStats() {
const getStats = promisify(seshatNative.getStats);
return getStats(this.inner);
}
/**
* Delete the Seshat database.
*
* @return {Promise} A promise that will resolve when the database has
* been deleted.
*/
async delete() {
const deleteDb = promisify(seshatNative.deleteDb);
return deleteDb(this.inner);
}
/**
* Shutdown and close the Seshat database.
*
* @return {Promise} A promise that will resolve when the database has
* been closed.
*/
async shutdown() {
const shutdown = promisify(seshatNative.shutdown);
return shutdown(this.inner);
}
/**
* Change the passphrase of the database
*
* This will also close the database, just like shutdown does.
*
* @param {string} newPassphrase The new passphrase that should from now on
* be used to encrypt the database.
*
* @return {Promise} A promise that will resolve when the passphrase has
* been changed.
*/
async changePassphrase(newPassphrase) {
const changePassphrase = promisify(seshatNative.changePassphrase);
return changePassphrase(this.inner, newPassphrase);
}
/**
* Check if the database is completely empty.
*
* @return {Promise<boolean>} A promise that will resolve to true if the
* database is empty, that is, it doesn't contain any events, false
* otherwise.
*/
async isEmpty() {
const isEmpty = promisify(seshatNative.isEmpty);
return isEmpty(this.inner);
}
/**
* Check if the room with the given id is already indexed.
*
* @param {string} roomId The ID of the room which we want to check if it
* has been already indexed.
*
* @return {Promise<boolean>} A promise that will resolve to true if the
* database contains events for the given room, false otherwise.
*/
async isRoomIndexed(roomId) {
const isRoomIndexed = promisify(seshatNative.isRoomIndexed);
return isRoomIndexed(this.inner, roomId);
}
/**
* Get the custom user specific version from the database.
*
* @return {Promise<number>} A promise that will resolve to a number that
* represents the user version of the database.
*/
async getUserVersion() {
const getUserVersion = promisify(seshatNative.getUserVersion);
return getUserVersion(this.inner);
}
/**
* Set the custom user version to the given value.
*
* @param {number} version The new version that should be stored in the
* database.
*
* @return {Promise<void>} A promise that will resolve once the new version
* has been stored in the database.
*/
async setUserVersion(version) {
const setUserVersion = promisify(seshatNative.setUserVersion);
return setUserVersion(this.inner, version);
}
/**
* Load events that contain an mxc URL to a file.
*
* @param {object} args Arguments object for the method.
* @param {string} args.roomId The ID of the room for which the events
* should be loaded.
* @param {number} args.limit The maximum number of events to return.
* @param {string} args.fromEvent An event id of a previous event returned
* by this method. If set events that are older than the event with the
* given event ID will be returned.
* @param {string} args.direction The direction that we are going to
* continue lading events to. Can be either "backwards", "b", "forwards" or
* "f".
*
* @return {Promise<[loadResult]>} A promise that will resolve to an array
* of Matrix events that contain mxc URLs.
*/
async loadFileEvents(args) {
const loadFileEvents = promisify(seshatNative.loadFileEvents);
return loadFileEvents(this.inner, args);
}
}
/**
* Seshat recovery database.<br>
*
* A Seshat recovery database can be used to re-index a Seshat database.
*
* This will be needed if schema changes to the index were required and the
* library has been upgraded.
*
* The recovery database uses the same parameters in the constructor like the
* normal Seshat database.
*
* @param {string} path The path where the database should be stored. If a
* database already exist in the given folder the database will be reused.
* @param {object} config Additional configuration for the database.
* database already exist in the given folder the database will be reused.
* @param {string} config.language The language that the database should use
* for indexing. Picking the correct indexing language may improve the search.
* @param {string} config.passphrase The passphrase that should be used to
* encrypt the database. The database is left unencrypted it no passphrase is
* set.
*
* @constructor
*
* @example
* // open a Seshat recovery database in the given folder
* let recovery = new SeshatRecovery("/home/example/database_dir");
* // reindex the database
* await recovery.reindex();
*/
class SeshatRecovery {
constructor(path, config = undefined) {
config = config || {};
this.inner = seshatNative.createRecoveryDb(path, config);
}
/**
* Get info about the re-index status.
*
* @return {recoveryInfo} A object that holds the number of total events,
* re-indexed events and the done percentage.
*/
info() {
return seshatNative.getInfoRecoveryDb(this.inner);
}
/**
* Get the custom user specific version from the database.
*
* @return {Promise<number>} A promise that will resolve to a number that
* represents the user version of the database.
*/
async getUserVersion() {
const getUserVersion = promisify(seshatNative.getUserVersionRecoveryDb);
return getUserVersion(this.inner);
}
/**
* Shutdown and close the Seshat recovery database.
*
* @return {Promise} A promise that will resolve when the database has
* been closed.
*/
async shutdown() {
const shutdown = promisify(seshatNative.shutdownRecoveryDb);
return shutdown(this.inner);
}
/**
* Re-index the database.
*
* @return {Promise} A promise that will resolve once the database has
* been re-indexed.
*/
async reindex() {
const reindex = promisify(seshatNative.reindexRecoveryDb);
return reindex(this.inner);
}
}
module.exports = {
Seshat: Seshat,
SeshatRecovery: SeshatRecovery,
ReindexError: ReindexError,
};