-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
BloomIT.java
526 lines (458 loc) · 19.2 KB
/
BloomIT.java
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
/*
* Copyright (c) 2002-2017 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.kernel.api.impl.fulltext.integrations.bloom;
import org.apache.lucene.analysis.en.EnglishAnalyzer;
import org.apache.lucene.analysis.sv.SwedishAnalyzer;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import java.util.Date;
import org.neo4j.consistency.ConsistencyCheckService;
import org.neo4j.consistency.checking.full.ConsistencyFlags;
import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.Relationship;
import org.neo4j.graphdb.RelationshipType;
import org.neo4j.graphdb.Result;
import org.neo4j.graphdb.Transaction;
import org.neo4j.graphdb.config.InvalidSettingException;
import org.neo4j.graphdb.factory.GraphDatabaseBuilder;
import org.neo4j.graphdb.factory.GraphDatabaseFactory;
import org.neo4j.helpers.collection.Iterators;
import org.neo4j.helpers.progress.ProgressMonitorFactory;
import org.neo4j.kernel.api.exceptions.KernelException;
import org.neo4j.kernel.api.impl.fulltext.FulltextProvider;
import org.neo4j.kernel.configuration.Config;
import org.neo4j.kernel.impl.proc.Procedures;
import org.neo4j.kernel.internal.GraphDatabaseAPI;
import org.neo4j.logging.NullLogProvider;
import org.neo4j.test.mockito.matcher.RootCauseMatcher;
import org.neo4j.test.rule.TestDirectory;
import org.neo4j.test.rule.fs.DefaultFileSystemRule;
import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.neo4j.kernel.api.impl.fulltext.integrations.bloom.BloomFulltextConfig.bloom_enabled;
import static org.neo4j.kernel.api.impl.fulltext.integrations.bloom.BloomFulltextConfig.bloom_indexed_properties;
public class BloomIT
{
private static final String NODES = "CALL db.fulltext.bloomFulltextNodes([\"%s\"], %b, %b)";
private static final String RELS = "CALL db.fulltext.bloomFulltextRelationships([\"%s\"], %b, %b)";
private static final String ENTITYID = "entityid";
@Rule
public final DefaultFileSystemRule fs = new DefaultFileSystemRule();
@Rule
public final TestDirectory testDirectory = TestDirectory.testDirectory();
@Rule
public final ExpectedException expectedException = ExpectedException.none();
private GraphDatabaseService db;
private GraphDatabaseBuilder builder;
@Before
public void before() throws Exception
{
GraphDatabaseFactory factory = new GraphDatabaseFactory();
builder = factory.newEmbeddedDatabaseBuilder( testDirectory.graphDbDir() );
builder.setConfig( bloom_enabled, "true" );
}
private GraphDatabaseService getDb() throws KernelException
{
GraphDatabaseService db = builder.newGraphDatabase();
((GraphDatabaseAPI) db).getDependencyResolver().resolveDependency( Procedures.class ).registerProcedure( BloomProcedures.class );
return db;
}
@Test
public void shouldPopulateAndQueryIndexes() throws Exception
{
builder.setConfig( bloom_indexed_properties, "prop, relprop" );
db = getDb();
try ( Transaction transaction = db.beginTx() )
{
Node node1 = db.createNode();
node1.setProperty( "prop", "This is a integration test." );
Node node2 = db.createNode();
node2.setProperty( "prop", "This is a related integration test" );
Relationship relationship = node1.createRelationshipTo( node2, RelationshipType.withName( "type" ) );
relationship.setProperty( "relprop", "They relate" );
transaction.success();
}
Result result = db.execute( String.format( NODES, "integration", true, false ) );
assertEquals( 0L, result.next().get( ENTITYID ) );
assertEquals( 1L, result.next().get( ENTITYID ) );
assertFalse( result.hasNext() );
result = db.execute( String.format( RELS, "relate", true, false ) );
assertEquals( 0L, result.next().get( ENTITYID ) );
assertFalse( result.hasNext() );
}
@Test
public void exactQueryShouldBeExact() throws Exception
{
builder.setConfig( bloom_indexed_properties, "prop" );
db = getDb();
try ( Transaction transaction = db.beginTx() )
{
Node node1 = db.createNode();
node1.setProperty( "prop", "This is a integration test." );
Node node2 = db.createNode();
node2.setProperty( "prop", "This is a related integration test" );
transaction.success();
}
Result result = db.execute( String.format( NODES, "integration", false, false ) );
assertEquals( 0L, result.next().get( ENTITYID ) );
assertEquals( 1L, result.next().get( ENTITYID ) );
assertFalse( result.hasNext() );
result = db.execute( String.format( NODES, "integratiun", false, false ) );
assertFalse( result.hasNext() );
}
@Test
public void matchAllQueryShouldMatchAll() throws Exception
{
builder.setConfig( bloom_indexed_properties, "prop" );
db = getDb();
try ( Transaction transaction = db.beginTx() )
{
Node node1 = db.createNode();
node1.setProperty( "prop", "This is a integration test." );
Node node2 = db.createNode();
node2.setProperty( "prop", "This is a related integration test" );
transaction.success();
}
Result result = db.execute( String.format( NODES, "integration, related", false, true ) );
assertEquals( 1L, result.next().get( ENTITYID ) );
assertFalse( result.hasNext() );
}
@Test
public void shouldBeAbleToConfigureAnalyzer() throws Exception
{
builder.setConfig( bloom_indexed_properties, "prop" );
builder.setConfig( BloomFulltextConfig.bloom_analyzer, "org.apache.lucene.analysis.sv.SwedishAnalyzer" );
db = getDb();
try ( Transaction transaction = db.beginTx() )
{
Node node1 = db.createNode();
node1.setProperty( "prop", "Det finns en mening" );
Node node2 = db.createNode();
node2.setProperty( "prop", "There is a sentance" );
transaction.success();
}
Result result = db.execute( String.format( NODES, "is", true, false ) );
assertEquals( 1L, result.next().get( ENTITYID ) );
assertFalse( result.hasNext() );
result = db.execute( String.format( NODES, "a", true, false ) );
assertEquals( 1L, result.next().get( ENTITYID ) );
assertFalse( result.hasNext() );
result = db.execute( String.format( NODES, "det", true, false ) );
assertFalse( result.hasNext() );
result = db.execute( String.format( NODES, "en", true, false ) );
assertFalse( result.hasNext() );
}
@Test
public void shouldPopulateIndexWithExistingDataOnIndexCreate() throws Exception
{
builder.setConfig( bloom_indexed_properties, "something" );
db = getDb();
long nodeId;
try ( Transaction tx = db.beginTx() )
{
Node node = db.createNode();
node.setProperty( "prop", "Roskildevej 32" ); // Copenhagen Zoo is important to find.
nodeId = node.getId();
tx.success();
}
Result result = db.execute( String.format( NODES, "Roskildevej", true, false ) );
assertFalse( result.hasNext() );
db.shutdown();
builder.setConfig( bloom_indexed_properties, "prop" );
builder.setConfig( BloomFulltextConfig.bloom_analyzer, "org.apache.lucene.analysis.da.DanishAnalyzer" );
db = getDb();
db.execute( "CALL db.fulltext.bloomAwaitPopulation" ).close();
result = db.execute( String.format( NODES, "Roskildevej", true, false ) );
assertTrue( result.hasNext() );
assertEquals( nodeId, result.next().get( ENTITYID ) );
assertFalse( result.hasNext() );
}
@Test
public void startupPopulationShouldNotCauseDuplicates() throws Exception
{
builder.setConfig( bloom_indexed_properties, "prop" );
db = getDb();
long nodeId;
try ( Transaction tx = db.beginTx() )
{
Node node = db.createNode();
nodeId = node.getId();
node.setProperty( "prop", "Jyllingevej" );
tx.success();
}
// Verify it's indexed exactly once
db.execute( "CALL db.fulltext.bloomAwaitPopulation" ).close();
Result result = db.execute( String.format( NODES, "Jyllingevej", true, false ) );
assertTrue( result.hasNext() );
assertEquals( nodeId, result.next().get( ENTITYID ) );
assertFalse( result.hasNext() );
db.shutdown();
db = getDb();
// Verify it's STILL indexed exactly once
db.execute( "CALL db.fulltext.bloomAwaitPopulation" ).close();
result = db.execute( String.format( NODES, "Jyllingevej", true, false ) );
assertTrue( result.hasNext() );
assertEquals( nodeId, result.next().get( ENTITYID ) );
assertFalse( result.hasNext() );
}
@Test
public void staleDataFromEntityDeleteShouldNotBeAccessibleAfterConfigurationChange() throws Exception
{
builder.setConfig( bloom_indexed_properties, "prop" );
db = getDb();
long nodeId;
try ( Transaction tx = db.beginTx() )
{
Node node = db.createNode();
nodeId = node.getId();
node.setProperty( "prop", "Esplanaden" );
tx.success();
}
db.shutdown();
builder.setConfig( bloom_indexed_properties, "not-prop" );
db = getDb();
try ( Transaction tx = db.beginTx() )
{
// This should no longer be indexed
db.getNodeById( nodeId ).delete();
tx.success();
}
db.shutdown();
builder.setConfig( bloom_indexed_properties, "prop" );
db = getDb();
// Verify that the node is no longer indexed
db.execute( "CALL db.fulltext.bloomAwaitPopulation" ).close();
Result result = db.execute( String.format( NODES, "Esplanaden", true, false ) );
assertFalse( result.hasNext() );
result.close();
}
@Test
public void staleDataFromPropertyRemovalShouldNotBeAccessibleAfterConfigurationChange() throws Exception
{
builder.setConfig( bloom_indexed_properties, "prop" );
db = getDb();
long nodeId;
try ( Transaction tx = db.beginTx() )
{
Node node = db.createNode();
nodeId = node.getId();
node.setProperty( "prop", "Esplanaden" );
tx.success();
}
db.shutdown();
builder.setConfig( bloom_indexed_properties, "not-prop" );
db = getDb();
try ( Transaction tx = db.beginTx() )
{
// This should no longer be indexed
db.getNodeById( nodeId ).removeProperty( "prop" );
tx.success();
}
db.shutdown();
builder.setConfig( bloom_indexed_properties, "prop" );
db = getDb();
// Verify that the node is no longer indexed
db.execute( "CALL db.fulltext.bloomAwaitPopulation" ).close();
Result result = db.execute( String.format( NODES, "Esplanaden", true, false ) );
assertFalse( result.hasNext() );
result.close();
}
@Test
public void updatesAreAvailableToConcurrentReadTransactions() throws Exception
{
builder.setConfig( bloom_indexed_properties, "prop" );
db = getDb();
try ( Transaction tx = db.beginTx() )
{
db.createNode().setProperty( "prop", "Langelinie Pavillinen" );
tx.success();
}
try ( Transaction ignore = db.beginTx() )
{
try ( Result result = db.execute( String.format( NODES, "Langelinie", true, false ) ) )
{
assertThat( Iterators.count( result ), is( 1L ) );
}
Thread th = new Thread( () ->
{
try ( Transaction tx1 = db.beginTx() )
{
db.createNode().setProperty( "prop", "Den Lille Havfrue, Langelinie" );
tx1.success();
}
} );
th.start();
th.join();
try ( Result result = db.execute( String.format( NODES, "Langelinie", true, false ) ) )
{
assertThat( Iterators.count( result ), is( 2L ) );
}
}
}
@Test
public void shouldNotBeAbleToStartWithoutConfiguringProperties() throws Exception
{
expectedException.expect( new RootCauseMatcher<>( RuntimeException.class, "Properties to index must be configured for bloom fulltext" ) );
db = getDb();
}
@Test
public void shouldNotBeAbleToStartWithIllegalPropertyKey() throws Exception
{
expectedException.expect( InvalidSettingException.class );
builder.setConfig( bloom_indexed_properties, "prop, " + FulltextProvider.FIELD_ENTITY_ID + ", hello" );
db = getDb();
}
@Test
public void shouldBeAbleToRunConsistencyCheck() throws Exception
{
builder.setConfig( bloom_indexed_properties, "prop" );
db = getDb();
try ( Transaction tx = db.beginTx() )
{
db.createNode().setProperty( "prop", "Langelinie Pavillinen" );
tx.success();
}
db.shutdown();
Config config = Config.defaults( bloom_indexed_properties, "prop" );
ConsistencyCheckService consistencyCheckService = new ConsistencyCheckService( new Date() );
ConsistencyFlags consistencyFlags = new ConsistencyFlags( true, true, true, true );
ConsistencyCheckService.Result result =
consistencyCheckService.runFullConsistencyCheck( testDirectory.graphDbDir(), config, ProgressMonitorFactory.NONE, NullLogProvider.getInstance(),
true, consistencyFlags );
assertTrue( result.isSuccessful() );
}
@Test
public void shouldReindexNodesWhenAnalyzerIsChanged() throws Exception
{
String ENGLISH = EnglishAnalyzer.class.getCanonicalName();
String SWEDISH = SwedishAnalyzer.class.getCanonicalName();
builder.setConfig( bloom_indexed_properties, "prop" );
builder.setConfig( BloomFulltextConfig.bloom_analyzer, ENGLISH );
db = getDb();
try ( Transaction tx = db.beginTx() )
{
db.createNode().setProperty( "prop", "Hello and hello again." );
db.createNode().setProperty( "prop", "En tomte bodde i ett hus." );
tx.success();
}
try ( Transaction ignore = db.beginTx() )
{
try ( Result result = db.execute( String.format( NODES, "and", false, false ) ) )
{
assertThat( Iterators.count( result ), is( 0L ) );
}
try ( Result result = db.execute( String.format( NODES, "ett", false, false ) ) )
{
assertThat( Iterators.count( result ), is( 1L ) );
}
}
db.shutdown();
builder.setConfig( BloomFulltextConfig.bloom_analyzer, SWEDISH );
db = getDb();
db.execute( "CALL db.fulltext.bloomAwaitPopulation" ).close();
try ( Transaction ignore = db.beginTx() )
{
try ( Result result = db.execute( String.format( NODES, "and", false, false ) ) )
{
assertThat( Iterators.count( result ), is( 1L ) );
}
try ( Result result = db.execute( String.format( NODES, "ett", false, false ) ) )
{
assertThat( Iterators.count( result ), is( 0L ) );
}
}
}
@Test
public void shouldReindexAfterBeingTemporarilyDisabled() throws Exception
{
builder.setConfig( bloom_indexed_properties, "prop" );
// Create a node while the index is enabled.
db = getDb();
try ( Transaction tx = db.beginTx() )
{
db.createNode().setProperty( "prop", "Hello and hello again." );
tx.success();
}
// Shut down, disable the index, start up again and create a node that would have been indexed had the index
// been enabled.
db.shutdown();
builder.setConfig( bloom_enabled, "false" );
db = builder.newGraphDatabase();
try ( Transaction tx = db.beginTx() )
{
db.createNode().setProperty( "prop", "En tomte bodde i ett hus." );
tx.success();
}
// Re-enable the index and restart. Wait for the index to rebuild.
db.shutdown();
builder.setConfig( bloom_enabled, "true" );
db = getDb();
db.execute( "CALL db.fulltext.bloomAwaitPopulation" ).close();
// Now we should be able to find the node that was added while the index was disabled.
try ( Transaction ignore = db.beginTx() )
{
try ( Result result = db.execute( String.format( NODES, "hello", false, false ) ) )
{
assertThat( Iterators.count( result ), is( 1L ) );
}
try ( Result result = db.execute( String.format( NODES, "tomte", false, false ) ) )
{
assertThat( Iterators.count( result ), is( 1L ) );
}
}
}
@Test
public void shouldBeAbleToQueryForIndexedProperties() throws Exception
{
builder.setConfig( bloom_indexed_properties, "prop, otherprop, proppmatt" );
db = getDb();
Result result = db.execute( "CALL db.fulltext.bloomFulltextProperties" );
assertEquals( "otherprop", result.next().get( "propertyKey" ) );
assertEquals( "prop", result.next().get( "propertyKey" ) );
assertEquals( "proppmatt", result.next().get( "propertyKey" ) );
assertFalse( result.hasNext() );
}
@Test
public void onlineIndexShouldBeReportedAsOnline() throws Exception
{
builder.setConfig( bloom_indexed_properties, "prop, otherprop, proppmatt" );
db = getDb();
db.execute( "CALL db.fulltext.bloomAwaitPopulation" );
Result result = db.execute( "CALL db.fulltext.bloomFulltextStatus" );
assertEquals( "ONLINE", result.next().get( "state" ) );
assertEquals( "ONLINE", result.next().get( "state" ) );
assertFalse( result.hasNext() );
}
@After
public void after() throws Exception
{
if ( db != null )
{
db.shutdown();
}
}
}