-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
BoltFailuresIT.java
461 lines (396 loc) · 15.6 KB
/
BoltFailuresIT.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
/*
* 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.bolt;
import org.junit.After;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.RuleChain;
import org.junit.rules.Timeout;
import java.time.Clock;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeoutException;
import java.util.function.Consumer;
import java.util.function.Supplier;
import org.neo4j.bolt.v1.runtime.BoltFactory;
import org.neo4j.bolt.v1.runtime.MonitoredWorkerFactory.SessionMonitor;
import org.neo4j.bolt.v1.runtime.WorkerFactory;
import org.neo4j.bolt.v1.transport.BoltMessagingProtocolV1Handler;
import org.neo4j.driver.v1.Config;
import org.neo4j.driver.v1.Driver;
import org.neo4j.driver.v1.GraphDatabase;
import org.neo4j.driver.v1.Session;
import org.neo4j.driver.v1.Transaction;
import org.neo4j.driver.v1.exceptions.ServiceUnavailableException;
import org.neo4j.function.Predicates;
import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.Result;
import org.neo4j.graphdb.TransactionTerminatedException;
import org.neo4j.graphdb.factory.GraphDatabaseFactory;
import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.io.IOUtils;
import org.neo4j.kernel.impl.enterprise.configuration.OnlineBackupSettings;
import org.neo4j.kernel.impl.logging.LogService;
import org.neo4j.kernel.monitoring.Monitors;
import org.neo4j.logging.AssertableLogProvider;
import org.neo4j.logging.AssertableLogProvider.LogMatcher;
import org.neo4j.logging.LogProvider;
import org.neo4j.ports.allocation.PortAuthority;
import org.neo4j.scheduler.JobScheduler;
import org.neo4j.test.TestEnterpriseGraphDatabaseFactory;
import org.neo4j.test.rule.TestDirectory;
import static java.util.concurrent.CompletableFuture.runAsync;
import static java.util.concurrent.TimeUnit.MINUTES;
import static java.util.concurrent.TimeUnit.SECONDS;
import static org.hamcrest.Matchers.instanceOf;
import static org.hamcrest.Matchers.startsWith;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.fail;
import static org.mockito.Matchers.anyObject;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.when;
import static org.neo4j.graphdb.Label.label;
import static org.neo4j.graphdb.factory.GraphDatabaseSettings.Connector.ConnectorType.BOLT;
import static org.neo4j.graphdb.factory.GraphDatabaseSettings.boltConnector;
import static org.neo4j.helpers.collection.Iterators.count;
import static org.neo4j.helpers.collection.Iterators.single;
import static org.neo4j.kernel.configuration.Settings.FALSE;
import static org.neo4j.kernel.configuration.Settings.TRUE;
import static org.neo4j.logging.AssertableLogProvider.inLog;
public class BoltFailuresIT
{
private static final int TEST_TIMEOUT_SECONDS = 120;
private static final int PREDICATE_AWAIT_TIMEOUT_SECONDS = TEST_TIMEOUT_SECONDS / 2;
private final TestDirectory dir = TestDirectory.testDirectory();
@Rule
public final RuleChain ruleChain = RuleChain.outerRule( Timeout.seconds( TEST_TIMEOUT_SECONDS ) ).around( dir );
private GraphDatabaseService db;
private Driver driver;
@After
public void shutdownDb()
{
if ( db != null )
{
db.shutdown();
}
IOUtils.closeAllSilently( driver );
}
@Test
public void throwsWhenWorkerCreationFails()
{
WorkerFactory workerFactory = mock( WorkerFactory.class );
when( workerFactory.newWorker( anyObject() ) ).thenThrow( new IllegalStateException( "Oh!" ) );
BoltKernelExtension extension = new BoltKernelExtensionWithWorkerFactory( workerFactory );
int port = PortAuthority.allocatePort();
db = startDbWithBolt( new GraphDatabaseFactoryWithCustomBoltKernelExtension( extension ), port );
try
{
// attempt to create a driver when server is unavailable
driver = createDriver( port );
fail( "Exception expected" );
}
catch ( Exception e )
{
assertThat( e, instanceOf( ServiceUnavailableException.class ) );
}
}
@Test
public void throwsWhenMonitoredWorkerCreationFails()
{
ThrowingSessionMonitor sessionMonitor = new ThrowingSessionMonitor();
sessionMonitor.throwInSessionStarted();
Monitors monitors = newMonitorsSpy( sessionMonitor );
int port = PortAuthority.allocatePort();
db = startDbWithBolt( new GraphDatabaseFactory().setMonitors( monitors ), port );
try
{
// attempt to create a driver when server is unavailable
driver = createDriver( port );
fail( "Exception expected" );
}
catch ( Exception e )
{
assertThat( e, instanceOf( ServiceUnavailableException.class ) );
}
}
@Test
public void throwsWhenInitMessageReceiveFails()
{
throwsWhenInitMessageFails( ThrowingSessionMonitor::throwInMessageReceived, false );
}
@Test
public void throwsWhenInitMessageProcessingFailsToStart()
{
throwsWhenInitMessageFails( ThrowingSessionMonitor::throwInProcessingStarted, false );
}
@Test
public void throwsWhenInitMessageProcessingFailsToComplete()
{
throwsWhenInitMessageFails( ThrowingSessionMonitor::throwInProcessingDone, true );
}
@Test
public void throwsWhenRunMessageReceiveFails()
{
throwsWhenRunMessageFails( ThrowingSessionMonitor::throwInMessageReceived );
}
@Test
public void throwsWhenRunMessageProcessingFailsToStart()
{
throwsWhenRunMessageFails( ThrowingSessionMonitor::throwInProcessingStarted );
}
@Test
public void throwsWhenRunMessageProcessingFailsToComplete()
{
throwsWhenRunMessageFails( ThrowingSessionMonitor::throwInProcessingDone );
}
@Test
public void boltServerLogsRealErrorWhenDriverIsClosedWithRunningTransactions() throws Exception
{
AssertableLogProvider internalLogProvider = new AssertableLogProvider();
int port = PortAuthority.allocatePort();
db = startTestDb( internalLogProvider, port );
// create a dummy node
db.execute( "CREATE (:Node)" ).close();
// lock that dummy node to make all subsequent writes wait on an exclusive lock
org.neo4j.graphdb.Transaction tx = db.beginTx();
Node node = single( db.findNodes( label( "Node" ) ) );
tx.acquireWriteLock( node );
Driver driver = createDriver( port );
// try to execute write query for the same node through the driver
Future<?> writeThroughDriverFuture = updateAllNodesAsync( driver );
// make sure this query is executing and visible in query listing
awaitNumberOfActiveQueriesToBe( 1 );
// close driver while it has ongoing transaction, it should get terminated
driver.close();
// driver transaction should fail
expectFailure( writeThroughDriverFuture );
// make sure there are no active queries
awaitNumberOfActiveQueriesToBe( 0 );
// verify that closing of the driver resulted in transaction termination on the server and correct log message
awaitLogToContainMessage( internalLogProvider, inLog( BoltMessagingProtocolV1Handler.class ).warn(
startsWith( "Unable to send error back to the client" ),
instanceOf( TransactionTerminatedException.class ) ) );
}
private void throwsWhenInitMessageFails( Consumer<ThrowingSessionMonitor> monitorSetup,
boolean shouldBeAbleToBeginTransaction )
{
ThrowingSessionMonitor sessionMonitor = new ThrowingSessionMonitor();
monitorSetup.accept( sessionMonitor );
Monitors monitors = newMonitorsSpy( sessionMonitor );
int port = PortAuthority.allocatePort();
db = startTestDb( monitors, port );
try
{
driver = GraphDatabase.driver( "bolt://localhost:" + port, Config.build().withoutEncryption().toConfig() );
if ( shouldBeAbleToBeginTransaction )
{
try ( Session session = driver.session();
Transaction tx = session.beginTransaction() )
{
tx.run( "CREATE ()" ).consume();
}
}
else
{
fail( "Exception expected" );
}
}
catch ( Exception e )
{
assertThat( e, instanceOf( ServiceUnavailableException.class ) );
}
}
private void throwsWhenRunMessageFails( Consumer<ThrowingSessionMonitor> monitorSetup )
{
ThrowingSessionMonitor sessionMonitor = new ThrowingSessionMonitor();
Monitors monitors = newMonitorsSpy( sessionMonitor );
int port = PortAuthority.allocatePort();
db = startTestDb( monitors, port );
driver = createDriver( port );
// open a session and start a transaction, this will force driver to obtain
// a network connection and bind it to the transaction
Session session = driver.session();
Transaction tx = session.beginTransaction();
// at this point driver holds a valid initialize connection
// setup monitor to throw before running the query to make processing of the RUN message fail
monitorSetup.accept( sessionMonitor );
tx.run( "CREATE ()" );
try
{
tx.close();
session.close();
fail( "Exception expected" );
}
catch ( Exception e )
{
assertThat( e, instanceOf( ServiceUnavailableException.class ) );
}
}
private GraphDatabaseService startTestDb( Monitors monitors, int port )
{
return startDbWithBolt( newDbFactory().setMonitors( monitors ), port );
}
private GraphDatabaseService startTestDb( LogProvider internalLogProvider, int port )
{
return startDbWithBolt( newDbFactory().setInternalLogProvider( internalLogProvider ), port );
}
private GraphDatabaseService startDbWithBolt( GraphDatabaseFactory dbFactory, int port )
{
return dbFactory.newEmbeddedDatabaseBuilder( dir.graphDbDir() )
.setConfig( boltConnector( "0" ).type, BOLT.name() )
.setConfig( boltConnector( "0" ).enabled, TRUE )
.setConfig( boltConnector( "0" ).listen_address, "localhost:" + port )
.setConfig( GraphDatabaseSettings.auth_enabled, FALSE )
.setConfig( OnlineBackupSettings.online_backup_enabled, FALSE )
.newGraphDatabase();
}
private void awaitNumberOfActiveQueriesToBe( int value ) throws TimeoutException
{
await( () ->
{
Result listQueriesResult = db.execute( "CALL dbms.listQueries()" );
return count( listQueriesResult ) == value + 1; // procedure call itself is also listed
} );
}
private void awaitLogToContainMessage( AssertableLogProvider logProvider, LogMatcher matcher )
throws TimeoutException
{
try
{
await( () -> logProvider.containsMatchingLogCall( matcher ) );
}
catch ( TimeoutException e )
{
System.err.println( "Expected log call did not happen. Full log:" );
System.err.println( logProvider.serialize() );
throw e;
}
}
private Future<?> updateAllNodesAsync( Driver driver )
{
return runAsync( () ->
{
try ( Session session = driver.session() )
{
session.run( "MATCH (n) SET n.prop = 42" ).consume();
}
} );
}
private static void expectFailure( Future<?> future ) throws TimeoutException, InterruptedException
{
try
{
future.get( 1, MINUTES );
fail( "Exception expected" );
}
catch ( ExecutionException e )
{
// expected
e.printStackTrace();
}
}
private static TestEnterpriseGraphDatabaseFactory newDbFactory()
{
return new TestEnterpriseGraphDatabaseFactory();
}
private static Driver createDriver( int port )
{
return GraphDatabase.driver( "bolt://localhost:" + port, Config.build().withoutEncryption().toConfig() );
}
private static Monitors newMonitorsSpy( ThrowingSessionMonitor sessionMonitor )
{
Monitors monitors = spy( new Monitors() );
// it is not allowed to throw exceptions from monitors
// make the given sessionMonitor be returned as is, without any proxying
when( monitors.newMonitor( SessionMonitor.class ) ).thenReturn( sessionMonitor );
when( monitors.hasListeners( SessionMonitor.class ) ).thenReturn( true );
return monitors;
}
private static void await( Supplier<Boolean> condition ) throws TimeoutException
{
Predicates.await( condition, PREDICATE_AWAIT_TIMEOUT_SECONDS, SECONDS );
}
private static class BoltKernelExtensionWithWorkerFactory extends BoltKernelExtension
{
final WorkerFactory workerFactory;
BoltKernelExtensionWithWorkerFactory( WorkerFactory workerFactory )
{
this.workerFactory = workerFactory;
}
@Override
protected WorkerFactory createWorkerFactory( BoltFactory boltFactory, JobScheduler scheduler,
Dependencies dependencies, LogService logService, Clock clock )
{
return workerFactory;
}
}
private static class ThrowingSessionMonitor implements SessionMonitor
{
volatile boolean throwInSessionStarted;
volatile boolean throwInMessageReceived;
volatile boolean throwInProcessingStarted;
volatile boolean throwInProcessingDone;
@Override
public void sessionStarted()
{
throwIfNeeded( throwInSessionStarted );
}
@Override
public void messageReceived()
{
throwIfNeeded( throwInMessageReceived );
}
@Override
public void processingStarted( long queueTime )
{
throwIfNeeded( throwInProcessingStarted );
}
@Override
public void processingDone( long processingTime )
{
throwIfNeeded( throwInProcessingDone );
}
void throwInSessionStarted()
{
throwInSessionStarted = true;
}
void throwInMessageReceived()
{
throwInMessageReceived = true;
}
void throwInProcessingStarted()
{
throwInProcessingStarted = true;
}
void throwInProcessingDone()
{
throwInProcessingDone = true;
}
void throwIfNeeded( boolean shouldThrow )
{
if ( shouldThrow )
{
throw new RuntimeException();
}
}
}
}