-
Notifications
You must be signed in to change notification settings - Fork 4
/
test-simple.js
656 lines (536 loc) · 24.1 KB
/
test-simple.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
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
/*\
title: test-simple.js
type: application/javascript
tags: [[$:/tags/test-spec]]
\*/
(function() {
var localforage = require('$:/plugins/hoelzro/full-text-search/localforage.min.js');
var wiki = $tw.wiki;
var nullDriver = {
_driver: 'nullDriver',
_initStorage: function(options) {
return Promise.resolve();
},
clear: function(callback) {
return callback ? callback() : Promise.resolve();
},
getItem: function(key, callback) {
return callback ? callback() : Promise.resolve(null);
},
iterate: function(iterator, callback) {
return callback ? callback() : Promise.resolve();
},
key: function(n, callback) {
return callback ? callback(n) : Promise.resolve(n);
},
keys: function(callback) {
return callback ? callback([]) : Promise.resolve([]);
},
length: function(callback) {
return callback ? callback(0) : Promise.resolve(0);
},
removeItem: function(key, callback) {
return callback ? callback() : Promise.resolve();
},
setItem: function(key, value, callback) {
return callback ? callback(null) : Promise.resolve(null);
},
dropInstance: function(options, callback) {
return callback ? callback() : Promise.resolve();
}
};
function waitForNextTick() {
return new Promise(function(resolve, reject) {
$tw.utils.nextTick(resolve);
});
}
async function buildIndex() {
var FTSActionGenerateIndexWidget = require('$:/plugins/hoelzro/full-text-search/fts-action-generate-index.js')['fts-action-generate-index'];
var widget = new FTSActionGenerateIndexWidget(null, {
wiki: wiki
});
await widget.asyncInvokeAction();
}
async function prepare() {
await buildIndex();
}
var fauxStorage = Object.create(null);
var inMemoryDriver = {
_driver: 'inMemoryDriver',
// XXX re-init between tests
_initStorage: function(options) {
return Promise.resolve();
},
clear: function(callback) {
fauxStorage = Object.create(null);
return callback ? callback() : Promise.resolve();
},
getItem: function(key, callback) {
var value = fauxStorage[key];
if(value != undefined) {
value = JSON.parse(value);
} else {
value = null;
}
return callback ? callback(value) : Promise.resolve(value);
},
iterate: function(iterator, callback) {
return callback ? callback() : Promise.resolve();
},
key: function(n, callback) {
return callback ? callback(n) : Promise.resolve(n);
},
keys: function(callback) {
return callback ? callback(Object.keys(fauxStorage)) : Promise.resolve(Object.keys(fauxStorage));
},
length: function(callback) {
return callback ? callback(Object.keys(fauxStorage).length) : Promise.resolve(Object.keys(fauxStorage).length);
},
removeItem: function(key, callback) {
delete fauxStorage[key];
return callback ? callback() : Promise.resolve();
},
setItem: function(key, value, callback) {
var oldValue = fauxStorage[key];
if(oldValue != undefined) {
oldValue = JSON.parse(oldValue);
} else {
oldValue = null;
}
fauxStorage[key] = JSON.stringify(value);
return callback ? callback(oldValue) : Promise.resolve(oldValue);
},
dropInstance: function(options, callback) {
return callback ? callback() : Promise.resolve();
}
};
async function setupInMemoryDriver() {
// XXX how do I remove this driver after this test to make sure it doesn't interfere?
await localforage.defineDriver(inMemoryDriver);
await localforage.setDriver('inMemoryDriver');
}
function clearIndex() {
require('$:/plugins/hoelzro/full-text-search/shared-index.js').clearIndex();
return Promise.resolve();
}
var nullDriverReady;
var initialTitles = Object.create(null);
for(var title of wiki.compileFilter('[!is[system]]')()) {
initialTitles[title] = true;
}
async function addTiddler(fields) {
wiki.addTiddler(new $tw.Tiddler(
wiki.getCreationFields(),
fields,
wiki.getModificationFields()
));
while(wiki.getSizeOfTiddlerEventQueue() > 0) {
await waitForNextTick();
}
}
async function deleteTiddler(title) {
wiki.deleteTiddler(title);
while(wiki.getSizeOfTiddlerEventQueue() > 0) {
await waitForNextTick();
}
}
beforeEach(async function() {
// XXX clear localforage in memory cache?
require('$:/plugins/hoelzro/full-text-search/shared-index.js').clearIndex();
wiki.addTiddler({
title: 'NoModified',
text: 'No modification date'
});
wiki.addTiddler(new $tw.Tiddler(
wiki.getCreationFields(),
{ title: 'JustSomeText', text: 'This one has a modification date' },
wiki.getModificationFields()));
wiki.addTiddler(new $tw.Tiddler(
{
title: 'Draft of New Tiddler',
'draft.of': 'New Tiddler',
'draft.title': 'New Tiddler',
text: 'test tiddler',
},
wiki.getCreationFields(),
wiki.getModificationFields()));
// XXX wait for wiki to settle
await localforage.defineDriver(nullDriver);
await localforage.setDriver('nullDriver');
nullDriverReady = true;
let lunr = require('$:/plugins/hoelzro/full-text-search/lunr.min.js');
delete lunr.Pipeline.registeredFunctions.expandQuery;
});
afterEach(async function() {
var titles = wiki.compileFilter('[!is[system]]')();
var pending = [];
for(var title of titles) {
if(! (title in initialTitles)) {
pending.push(deleteTiddler(title));
}
}
await Promise.all(pending);
});
describe('Simple test', function() {
it('should start with an uninitialized FTS state', function() {
expect(wiki.getTiddlerText('$:/temp/FTS-state')).toBe('uninitialized');
});
it('should find matching documents without a modified field', async function() {
await prepare();
expect(wiki.getTiddlerText('$:/temp/FTS-state')).toBe('initialized');
var results = wiki.compileFilter('[ftsearch[modification]]')();
expect(results).toContain('NoModified');
});
it("should pick up changes to tiddlers' contents", async function() {
await prepare();
var tiddler = wiki.getTiddler('NoModified');
var newTiddler = new $tw.Tiddler(
tiddler,
{text: "New text without that word we're looking for"},
wiki.getModificationFields());
wiki.addTiddler(newTiddler);
await waitForNextTick();
var results = wiki.compileFilter('[ftsearch[modification]]')();
expect(results).not.toContain('NoModified');
results = wiki.compileFilter('[ftsearch[looking]]')();
expect(results).toContain('NoModified');
});
it("should pick up on renames after initial index", async function() {
await prepare();
$tw.wiki.renameTiddler('NoModified', 'BrandNewName');
await waitForNextTick();
var results = wiki.compileFilter('[ftsearch[modification]]')();
expect(results).toContain('BrandNewName');
});
it("should pick up on deletions after initial index", async function() {
await prepare();
await deleteTiddler('NoModified');
var results = wiki.compileFilter('[ftsearch[modification]]')();
expect(results).not.toContain('NoModified');
});
it('should pick reason with "reason programming language"', async function() {
await prepare();
var text = `
A kind of OCaml that compiles down to JavaScript
https://facebook.github.io/reason/
https://jaredforsyth.com/2017/07/05/a-reason-react-tutorial/
`;
$tw.wiki.addTiddler(new $tw.Tiddler(
$tw.wiki.getCreationFields(),
{ title: 'Reason', tags: 'Someday/Maybe Play Coding [[Programming Languages]]', type: 'text/vnd.tiddlywiki', text: text },
$tw.wiki.getModificationFields()
));
await waitForNextTick();
var results = wiki.compileFilter('[ftsearch[reason programming language]]')();
expect(results).toContain('Reason');
});
xit('should pick up "twitter" in a URL', async function() {
await prepare();
var text = 'https://twitter.com/hoelzro/status/877901644125663232';
$tw.wiki.addTiddler(new $tw.Tiddler(
$tw.wiki.getCreationFields(),
{ title: 'ContainsTweetLink', type: 'text/vnd.tiddlywiki', text: text },
$tw.wiki.getModificationFields()
));
await waitForNextTick();
var results = wiki.compileFilter('[ftsearch[twitter]]')();
expect(results).toContain('ContainsTweetLink');
});
it('should not pick up a non-text tiddler on an update', async function() {
await prepare();
var newTiddler = new $tw.Tiddler(
wiki.getCreationFields(),
{type: 'application/x-tiddler-data', text: 'foo bar', title: 'MyDataTiddler'},
wiki.getModificationFields());
wiki.addTiddler(newTiddler);
await waitForNextTick();
var results = wiki.compileFilter('[ftsearch[foo]]')();
expect(results).not.toContain('MyDataTiddler');
});
it('should not pick up JavaScript code', async function() {
await prepare();
expect(wiki.getTiddlerText('$:/temp/FTS-state')).toBe('initialized');
var results = wiki.compileFilter('[ftsearch[tag]]')();
expect(results).not.toContain('test-simple.js');
});
it('should not fail upon an incomplete query', async function() {
await prepare();
expect(wiki.getTiddlerText('$:/temp/FTS-state')).toBe('initialized');
try {
var results = wiki.compileFilter('[ftsearch[date~]]')();
expect(results.length).toBe(0);
} catch(e) {
console.log(e);
expect(true).toBe(false);
}
});
it('should not index new draft tiddlers', async function() {
await prepare();
var draftTiddler = new $tw.Tiddler(
{
title: 'Draft of New Tiddler 2',
'draft.of': 'New Tiddler 2',
'draft.title': 'New Tiddler 2',
text: 'test tiddler',
},
wiki.getCreationFields(),
wiki.getModificationFields());
wiki.addTiddler(draftTiddler);
await waitForNextTick();
var results = wiki.filterTiddlers('[ftsearch[tiddler]has[draft.of]]');
expect(results.length).toBe(0);
});
it('should not index draft tiddlers from the start', async function() {
await prepare();
var results = wiki.filterTiddlers('[ftsearch[tiddler]has[draft.of]]');
expect(results.length).toBe(0);
});
it('should order results by query relevance', async function() {
await prepare();
var results = wiki.filterTiddlers('[ftsearch[fox]]');
let foxesFoxesFoxesIndex = results.indexOf('Foxes foxes foxes');
let foxInGardenIndex = results.indexOf('A fox in the garden');
expect(foxesFoxesFoxesIndex).not.toBe(-1);
expect(foxInGardenIndex).not.toBe(-1);
expect(foxesFoxesFoxesIndex).toBeLessThan(foxInGardenIndex);
});
});
describe('Cache tests', function() {
function freshBuildIndex() {
let lunr = require('$:/plugins/hoelzro/full-text-search/lunr.min.js');
delete lunr.Pipeline.registeredFunctions.expandQuery;
return clearIndex().then(buildIndex);
}
it('should work with the cache', async function() {
async function modifyTiddler() {
var tiddler = $tw.wiki.getTiddler('JustSomeText');
var newTiddler = new $tw.Tiddler(
tiddler,
{text: "New text without that word we're looking for"},
wiki.getModificationFields());
wiki.addTiddler(newTiddler);
await waitForNextTick();
}
await setupInMemoryDriver();
await localforage.clear();
await buildIndex();
await modifyTiddler();
await freshBuildIndex();
var results = wiki.compileFilter('[ftsearch[modification]]')();
expect(results).not.toContain('JustSomeText');
});
it('should not pick up tiddlers deleted between a save and cache load', async function() {
await setupInMemoryDriver();
await localforage.clear();
await buildIndex();
await clearIndex();
await deleteTiddler('JustSomeText');
await buildIndex();
var results = wiki.compileFilter('[ftsearch[modification]]')();
expect(results).not.toContain('JustSomeText');
});
it('should not pick up tiddlers deleted and re-added between a save and cache load', async function() {
async function readdTiddler() {
var tiddler = $tw.wiki.getTiddler('JustSomeText');
var newTiddler = new $tw.Tiddler(
tiddler,
{text: "New text without that word we're looking for"},
wiki.getModificationFields());
wiki.addTiddler(newTiddler);
await waitForNextTick();
}
await setupInMemoryDriver();
await localforage.clear();
await buildIndex();
await clearIndex();
await deleteTiddler('JustSomeText');
await readdTiddler();
await buildIndex();
var results = wiki.compileFilter('[ftsearch[modification]]')();
expect(results).not.toContain('JustSomeText');
});
});
describe('Query expansion tests', function() {
async function clearRelatedTerms() {
await deleteTiddler('$:/plugins/hoelzro/full-text-search/RelatedTerms.json');
}
it('should expand change to modification', async function() {
async function setupRelatedTerms() {
wiki.addTiddler(new $tw.Tiddler(
wiki.getCreationFields(),
{title: '$:/plugins/hoelzro/full-text-search/RelatedTerms.json', text: '["modification change"]', type: 'application/json'},
wiki.getModificationFields(),
));
await waitForNextTick();
}
await setupRelatedTerms();
await buildIndex();
expect(wiki.getTiddlerText('$:/temp/FTS-state')).toBe('initialized');
var results = wiki.compileFilter('[ftsearch[change]]')();
expect(results).toContain('NoModified');
expect(results).toContain('JustSomeText');
});
it("shouldn't expand anything if the config tiddler has no data", async function() {
await clearRelatedTerms();
await buildIndex();
expect(wiki.getTiddlerText('$:/temp/FTS-state')).toBe('initialized');
var results = wiki.compileFilter('[ftsearch[change]]')();
expect(results).not.toContain('NoModified');
expect(results).not.toContain('JustSomeText');
});
it("should invalidate the index if the config tiddler is changed", async function() {
async function setupRelatedTerms() {
wiki.addTiddler(new $tw.Tiddler(
wiki.getCreationFields(),
{title: '$:/plugins/hoelzro/full-text-search/RelatedTerms.json', text: '["modification change"]', type: 'application/json'},
wiki.getModificationFields(),
));
await waitForNextTick();
}
await setupRelatedTerms();
await buildIndex();
await clearRelatedTerms();
expect(wiki.getTiddlerText('$:/temp/FTS-state')).toBe('uninitialized');
});
it('should rebuild the whole index if the config tiddler is changed and loaded from cache', async function() {
async function setupRelatedTerms() {
wiki.addTiddler(new $tw.Tiddler(
wiki.getCreationFields(),
{title: '$:/plugins/hoelzro/full-text-search/RelatedTerms.json', text: '["modification change"]', type: 'application/json'},
wiki.getModificationFields(),
));
await waitForNextTick();
}
await setupInMemoryDriver();
await localforage.clear();
await setupRelatedTerms();
await buildIndex();
await clearRelatedTerms();
await clearIndex();
await buildIndex();
expect(wiki.getTiddlerText('$:/temp/FTS-state')).toBe('initialized');
var results = wiki.compileFilter('[ftsearch[change]]')();
expect(results).not.toContain('NoModified');
expect(results).not.toContain('JustSomeText');
});
it('should not break the indexer to use Related terms with a number as a member', async function() {
async function setupRelatedTerms() {
let relatedTermList = [
"foobar [[foo 2]]"
];
wiki.addTiddler(new $tw.Tiddler(
wiki.getCreationFields(),
{title: '$:/plugins/hoelzro/full-text-search/RelatedTerms.json', text: JSON.stringify(relatedTermList), type: 'application/json'},
wiki.getModificationFields(),
));
wiki.addTiddler(new $tw.Tiddler(
wiki.getCreationFields(),
{title: 'Empty', text: 'foo', type: 'text/vnd.tiddlywiki', tags: ''},
wiki.getModificationFields(),
));
await waitForNextTick();
}
await setupRelatedTerms();
await buildIndex();
expect(true).toBe(true);
});
});
describe('Wildcard tests', function() {
async function enableFuzzySearch() {
await addTiddler({
title: '$:/plugins/hoelzro/full-text-search/EnableFuzzySearching',
text: 'yes',
type: 'text/vnd.tiddlywiki',
});
}
async function disableFuzzySearch() {
await deleteTiddler('$:/plugins/hoelzro/full-text-search/EnableFuzzySearching');
}
it('should return "formatting" if the user searches for "format*ing"', async function () {
await enableFuzzySearch();
await addTiddler({
title: 'Experiment with Formatting'
});
await buildIndex();
expect(wiki.getTiddlerText('$:/temp/FTS-state')).toBe('initialized');
var results = wiki.filterTiddlers('[ftsearch[format*ing]]');
expect(results).toContain('Experiment with Formatting');
});
it('should not return "formatting" if a fuzzy search is used and fuzzy searching is disabled', async function() {
await disableFuzzySearch();
await addTiddler({
title: 'Experiment with Formatting'
});
await buildIndex();
expect(wiki.getTiddlerText('$:/temp/FTS-state')).toBe('initialized');
var results = wiki.filterTiddlers('[ftsearch[format*ing]]');
expect(results).not.toContain('Experiment with Formatting');
});
it('should invalidate the index if the user changes their fuzzy settings', async function() {
await enableFuzzySearch();
await buildIndex();
expect(wiki.getTiddlerText('$:/temp/FTS-state')).toBe('initialized');
await disableFuzzySearch();
expect(wiki.getTiddlerText('$:/temp/FTS-state')).toBe('uninitialized');
});
it('should detect wildcard queries when fuzzy matching is off and notify the user', async function() {
await disableFuzzySearch();
await addTiddler({
title: 'Experiment with Formatting'
});
await buildIndex();
var results = wiki.filterTiddlers('[ftsearch[format*ing]ftsfeedback[$:/temp/fts-feedback]]');
expect(results).not.toContain('Experiment with Formatting');
let feedback = wiki.getTiddlerData('$:/temp/fts-feedback', []);
expect(feedback).toContain("It looks like you're trying to perform a wildcard search; you'll need to enable wildcard/fuzzy searching in the FTS settings");
});
it('should detect fuzzy queries when fuzzy matching is off and notify the user', async function() {
await disableFuzzySearch();
await addTiddler({
title: 'Experiment with Formatting'
});
await buildIndex();
var results = wiki.filterTiddlers('[ftsearch[formattign~1]ftsfeedback[$:/temp/fts-feedback]]');
expect(results).not.toContain('Experiment with Formatting');
let feedback = wiki.getTiddlerData('$:/temp/fts-feedback', []);
expect(feedback).toContain("It looks like you're trying to perform a fuzzy search; you'll need to enable wildcard/fuzzy searching in the FTS settings");
});
it('should not prevent results from being returned if ftsfeedback is used', async function() {
await disableFuzzySearch();
await addTiddler({
title: 'Experiment with Formatting'
});
await buildIndex();
var results = wiki.filterTiddlers('[ftsearch[formatting]ftsfeedback[$:/temp/fts-feedback]]');
expect(results).toContain('Experiment with Formatting');
await enableFuzzySearch();
await buildIndex();
results = wiki.filterTiddlers('[ftsearch[format*ing]ftsfeedback[$:/temp/fts-feedback]]');
expect(results).toContain('Experiment with Formatting');
});
it('should not populate the feedback tiddler if fuzzy searching is on', async function() {
await enableFuzzySearch();
await addTiddler({
title: 'Experiment with Formatting'
});
await buildIndex();
var results = wiki.filterTiddlers('[ftsearch[format*ing]ftsfeedback[$:/temp/fts-feedback]]');
expect(results).toContain('Experiment with Formatting');
var messages = wiki.getTiddlerData('$:/temp/fts-feedback', []);
expect(messages.length).toBe(0);
});
it('should always clear feedback upon search', async function() {
await disableFuzzySearch();
await addTiddler({
title: 'Experiment with Formatting'
});
await buildIndex();
var results = wiki.filterTiddlers('[ftsearch[format*ing]ftsfeedback[$:/temp/fts-feedback]]');
await enableFuzzySearch();
await buildIndex();
results = wiki.filterTiddlers('[ftsearch[format*ing]ftsfeedback[$:/temp/fts-feedback]]');
var messages = wiki.getTiddlerData('$:/temp/fts-feedback', []);
expect(messages.length).toBe(0);
});
});
})();