Skip to content

Wait for bookmark when starting a transaction #303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 5, 2017
+162 −21
Merged

Wait for bookmark when starting a transaction #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 22 additions & 14 deletions driver/src/main/java/org/neo4j/driver/internal/ExplicitTransaction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
import java.util.Collections;
import java.util.Map;

import org.neo4j.driver.internal.spi.Connection;
import org.neo4j.driver.internal.spi.Collector;
import org.neo4j.driver.internal.spi.Connection;
import org.neo4j.driver.internal.types.InternalTypeSystem;
import org.neo4j.driver.v1.Record;
import org.neo4j.driver.v1.Statement;
Expand All @@ -36,7 +36,6 @@

import static java.util.Collections.emptyMap;
import static java.util.Collections.singletonMap;

import static org.neo4j.driver.v1.Values.ofValue;
import static org.neo4j.driver.v1.Values.value;

Expand Down Expand Up @@ -81,18 +80,7 @@ private enum State
{
this.conn = conn;
this.cleanup = cleanup;

final Map<String, Value> parameters;
if ( bookmark == null )
{
parameters = emptyMap();
}
else
{
parameters = singletonMap( "bookmark", value( bookmark ) );
}
conn.run( "BEGIN", parameters, Collector.NO_OP );
conn.pullAll( Collector.NO_OP );
runBeginStatement( conn, bookmark );
}

@Override
Expand Down Expand Up @@ -253,4 +241,24 @@ void setBookmark( String bookmark )
this.bookmark = bookmark;
}

private static void runBeginStatement( Connection connection, String bookmark )
{
Map<String,Value> parameters;
if ( bookmark != null )
{
parameters = singletonMap( "bookmark", value( bookmark ) );
}
else
{
parameters = emptyMap();
}

connection.run( "BEGIN", parameters, Collector.NO_OP );
connection.pullAll( Collector.NO_OP );

if ( bookmark != null )
{
connection.sync();
}
}
}
36 changes: 34 additions & 2 deletions driver/src/test/java/org/neo4j/driver/internal/ExplicitTransactionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,24 @@
*/
package org.neo4j.driver.internal;

import java.util.Collections;

import org.junit.Test;
import org.mockito.InOrder;

import java.util.Collections;
import java.util.Map;

import org.neo4j.driver.internal.spi.Collector;
import org.neo4j.driver.internal.spi.Connection;
import org.neo4j.driver.v1.Value;

import static org.mockito.Matchers.any;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;
import static org.neo4j.driver.v1.Values.value;

public class ExplicitTransactionTest
{
Expand Down Expand Up @@ -111,4 +114,33 @@ public void shouldCommitOnSuccess() throws Throwable
verify( cleanup ).run();
verifyNoMoreInteractions( conn, cleanup );
}

@Test
public void shouldOnlyQueueMessagesWhenNoBookmarkGiven()
{
Connection connection = mock( Connection.class );

new ExplicitTransaction( connection, mock( Runnable.class ), null );

InOrder inOrder = inOrder( connection );
inOrder.verify( connection ).run( "BEGIN", Collections.<String,Value>emptyMap(), Collector.NO_OP );
inOrder.verify( connection ).pullAll( Collector.NO_OP );
inOrder.verify( connection, never() ).sync();
}

@Test
public void shouldSyncWhenBookmarkGiven()
{
String bookmark = "hi, I'm bookmark";
Connection connection = mock( Connection.class );

new ExplicitTransaction( connection, mock( Runnable.class ), bookmark );

Map<String,Value> expectedParams = Collections.singletonMap( "bookmark", value( bookmark ) );

InOrder inOrder = inOrder( connection );
inOrder.verify( connection ).run( "BEGIN", expectedParams, Collector.NO_OP );
inOrder.verify( connection ).pullAll( Collector.NO_OP );
inOrder.verify( connection ).sync();
}
}
51 changes: 46 additions & 5 deletions driver/src/test/java/org/neo4j/driver/v1/integration/BookmarkIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,14 @@
import org.junit.Test;
import org.junit.rules.ExpectedException;

import org.neo4j.driver.v1.Session;
import org.neo4j.driver.v1.Transaction;
import org.neo4j.driver.v1.exceptions.ClientException;
import org.neo4j.driver.v1.exceptions.TransientException;
import org.neo4j.driver.v1.util.TestNeo4jSession;

import static org.hamcrest.Matchers.instanceOf;
import static org.hamcrest.core.StringStartsWith.startsWith;
import static org.hamcrest.Matchers.startsWith;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertThat;
Expand Down Expand Up @@ -58,15 +60,54 @@ public void shouldReceiveBookmarkOnSuccessfulCommit() throws Throwable
assertNull( session.lastBookmark() );

// When
createNodeInTx( session );

// Then
assertNotNull( session.lastBookmark() );
assertThat( session.lastBookmark(), startsWith( "neo4j:bookmark:v1:tx" ) );
}

@Test
public void shouldThrowForInvalidBookmark()
{
String invalidBookmark = "hi, this is an invalid bookmark";

try
{
session.beginTransaction( invalidBookmark );
fail( "Exception expected" );
}
catch ( Exception e )
{
assertThat( e, instanceOf( ClientException.class ) );
}
}

@Test
public void shouldThrowForUnreachableBookmark()
{
createNodeInTx( session );

try
{
// todo: configure bookmark wait timeout to be lower than default 30sec when neo4j supports this
session.beginTransaction( session.lastBookmark() + 42 );
fail( "Exception expected" );
}
catch ( Exception e )
{
assertThat( e, instanceOf( TransientException.class ) );
assertThat( e.getMessage(), startsWith( "Database not up to the requested version" ) );
}
}

private static void createNodeInTx( Session session )
{
try ( Transaction tx = session.beginTransaction() )
{
tx.run( "CREATE (a:Person)" );
tx.success();
}

// Then
assertNotNull( session.lastBookmark() );
assertThat( session.lastBookmark(), startsWith( "neo4j:bookmark:v1:tx" ) );
}

@Test
Expand Down
60 changes: 60 additions & 0 deletions driver/src/test/java/org/neo4j/driver/v1/integration/CausalClusteringIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,21 @@
import org.neo4j.driver.v1.Session;
import org.neo4j.driver.v1.Transaction;
import org.neo4j.driver.v1.Values;
import org.neo4j.driver.v1.exceptions.ClientException;
import org.neo4j.driver.v1.exceptions.ServiceUnavailableException;
import org.neo4j.driver.v1.exceptions.SessionExpiredException;
import org.neo4j.driver.v1.exceptions.TransientException;
import org.neo4j.driver.v1.util.Function;
import org.neo4j.driver.v1.util.cc.Cluster;
import org.neo4j.driver.v1.util.cc.ClusterMember;
import org.neo4j.driver.v1.util.cc.ClusterRule;

import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.instanceOf;
import static org.hamcrest.Matchers.startsWith;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

Expand Down Expand Up @@ -233,6 +239,60 @@ public void shouldDropBrokenOldSessions() throws Exception
}
}

@Test
public void beginTransactionThrowsForInvalidBookmark()
{
String invalidBookmark = "hi, this is an invalid bookmark";
ClusterMember leader = clusterRule.getCluster().leader();

try ( Driver driver = createDriver( leader.getBoltUri() );
Session session = driver.session() )
{
try
{
session.beginTransaction( invalidBookmark );
fail( "Exception expected" );
}
catch ( Exception e )
{
assertThat( e, instanceOf( ClientException.class ) );
assertThat( e.getMessage(), containsString( invalidBookmark ) );
}
}
}

@Test
public void beginTransactionThrowsForUnreachableBookmark()
{
ClusterMember leader = clusterRule.getCluster().leader();

try ( Driver driver = createDriver( leader.getBoltUri() );
Session session = driver.session() )
{
try ( Transaction tx = session.beginTransaction() )
{
tx.run( "CREATE ()" );
tx.success();
}

String bookmark = session.lastBookmark();
assertNotNull( bookmark );
String newBookmark = bookmark + "0";

try
{
// todo: configure bookmark wait timeout to be lower than default 30sec when neo4j supports this
session.beginTransaction( newBookmark );
fail( "Exception expected" );
}
catch ( Exception e )
{
assertThat( e, instanceOf( TransientException.class ) );
assertThat( e.getMessage(), startsWith( "Database not up to the requested version" ) );
}
}
}

private int executeWriteAndReadThroughBolt( ClusterMember member ) throws TimeoutException, InterruptedException
{
try ( Driver driver = createDriver( member.getRoutingUri() ) )
Expand Down