Replace Session.LastBookmark() with Session.LastBookmarks()

 * Returns `[]string` instead of string.
 * Returns all (not just the last) initial bookmarks if no bookmark has been
   received from the server.

Author: robsdedude

neo4j/session.go

@@ -35,9 +35,10 @@ type TransactionWork func(tx Transaction) (interface{}, error)
 // Session represents a logical connection (which is not tied to a physical connection)
 // to the server
 type Session interface {
-	// LastBookmark returns the bookmark received following the last successfully completed transaction.
-	// If no bookmark was received or if this transaction was rolled back, the bookmark value will not be changed.
-	LastBookmark() string
+	// LastBookmarks returns the bookmark received following the last successfully completed transaction.
+	// If no bookmark was received or if this transaction was rolled back, the initial set of bookmarks will be
+	// returned.
+	LastBookmarks() []string
 	// BeginTransaction starts a new explicit transaction on this session
 	BeginTransaction(configurers ...func(*TransactionConfig)) (Transaction, error)
 	// ReadTransaction executes the given unit of work in a AccessModeRead transaction with
@@ -169,18 +170,14 @@ func newSession(config *Config, sessConfig SessionConfig, router sessionRouter,
 	}
 }
 
-func (s *session) LastBookmark() string {
+func (s *session) LastBookmarks() []string {
 	// Pick up bookmark from pending auto-commit if there is a bookmark on it
 	if s.txAuto != nil {
 		s.retrieveBookmarks(s.txAuto.conn)
 	}
 
-	// Report bookmark from previously closed connection or from initial set
-	if len(s.bookmarks) > 0 {
-		return s.bookmarks[len(s.bookmarks)-1]
-	}
-
-	return ""
+	// Report bookmarks from previously closed connection or from initial set
+	return s.bookmarks
 }
 
 func (s *session) BeginTransaction(configurers ...func(*TransactionConfig)) (Transaction, error) {
@@ -501,8 +498,8 @@ type sessionWithError struct {
 	err error
 }
 
-func (s *sessionWithError) LastBookmark() string {
-	return ""
+func (s *sessionWithError) LastBookmarks() []string {
+	return []string{}
 }
 
 func (s *sessionWithError) BeginTransaction(configurers ...func(*TransactionConfig)) (Transaction, error) {

neo4j/session_test.go

@@ -165,9 +165,9 @@ func TestSession(st *testing.T) {
 	})
 
 	st.Run("Bookmarking", func(bt *testing.T) {
-		bt.Run("Initial bookmark is used for LastBookmark", func(t *testing.T) {
+		bt.Run("Initial bookmarks are returned from LastBookmarks", func(t *testing.T) {
 			_, _, sess := createSessionWithBookmarks([]string{"b1", "b2"})
-			AssertStringEqual(t, sess.LastBookmark(), "b2")
+			AssertDeepEquals(t, sess.LastBookmarks(), []string{"b1", "b2"})
 		})
 
 		bt.Run("Initial bookmarks are used and cleaned up before usage", func(t *testing.T) {
@@ -194,9 +194,9 @@ func TestSession(st *testing.T) {
 			}
 		})
 
-		bt.Run("LastBookmark is empty when no initial bookmark", func(t *testing.T) {
+		bt.Run("LastBookmarks is empty when no initial bookmark", func(t *testing.T) {
 			_, _, sess := createSession()
-			AssertStringEqual(t, sess.LastBookmark(), "")
+			AssertLen(t, sess.LastBookmarks(), 0)
 		})
 	})
 
@@ -256,17 +256,17 @@ func TestSession(st *testing.T) {
 
 			sess.Run("cypher", nil)
 			AssertIntEqual(t, bufferCalls, 0)
-			AssertStringEqual(t, sess.LastBookmark(), "")
+			AssertLen(t, sess.LastBookmarks(), 0)
 			// Should call Buffer on connection to ensure that first Run is buffered and
 			// it's bookmark retrieved
 			sess.Run("cypher", nil)
-			AssertStringEqual(t, sess.LastBookmark(), "1")
+			AssertDeepEquals(t, sess.LastBookmarks(), []string{"1"})
 			result, _ := sess.Run("cypher", nil)
-			AssertStringEqual(t, sess.LastBookmark(), "2")
+			AssertDeepEquals(t, sess.LastBookmarks(), []string{"2"})
 			// And finally consuming the last result should give a new bookmark
 			AssertIntEqual(t, consumeCalls, 0)
 			result.Consume()
-			AssertStringEqual(t, sess.LastBookmark(), "1")
+			AssertDeepEquals(t, sess.LastBookmarks(), []string{"1"})
 		})
 
 		bt.Run("Pending and invoke tx function", func(t *testing.T) {
@@ -291,7 +291,7 @@ func TestSession(st *testing.T) {
 			if !reflect.DeepEqual([]string{"1"}, rtx.Bookmarks) {
 				t.Errorf("Using unclean or no bookmarks: %+v", rtx)
 			}
-			AssertStringEqual(t, sess.LastBookmark(), "1")
+			AssertDeepEquals(t, sess.LastBookmarks(), []string{"1"})
 			AssertIntEqual(t, bufferCalls, 1)
 		})
 
@@ -315,7 +315,7 @@ func TestSession(st *testing.T) {
 			if !reflect.DeepEqual([]string{"1"}, rtx.Bookmarks) {
 				t.Errorf("Using unclean or no bookmarks: %+v", rtx)
 			}
-			AssertStringEqual(t, sess.LastBookmark(), "1")
+			AssertDeepEquals(t, sess.LastBookmarks(), []string{"1"})
 			AssertIntEqual(t, bufferCalls, 1)
 		})
 
@@ -477,7 +477,7 @@ func TestSession(st *testing.T) {
 			// Begin and commit a transaction on the session
 			tx, _ := sess.BeginTransaction()
 			tx.Commit()
-			AssertStringEqual(t, sess.LastBookmark(), bookmark)
+			AssertDeepEquals(t, sess.LastBookmarks(), []string{bookmark})
 			// The bookmark should be used in next transaction
 			tx, _ = sess.BeginTransaction()
 			AssertLen(t, conn.RecordedTxs, 2)

test-stress/executors.go

@@ -66,7 +66,7 @@ func newStressSession(driver neo4j.Driver, useBookmark bool, accessMode neo4j.Ac
 	var err error
 
 	if useBookmark {
-		session, err = driver.Session(accessMode, ctx.getBookmark())
+		session, err = driver.Session(accessMode, ctx.getBookmarks()...)
 	} else {
 		session, err = driver.Session(accessMode)
 	}
@@ -181,7 +181,7 @@ func WriteQueryExecutor(driver neo4j.Driver, useBookmark bool) func(ctx *TestCon
 		ExpectNoError(err)
 		ExpectInt(summary.Counters().NodesCreated(), 1)
 
-		ctx.setBookmark(session.LastBookmark())
+		ctx.setBookmarks(session.LastBookmarks())
 
 		ctx.addCreated()
 	}
@@ -207,7 +207,7 @@ func WriteQueryInTxExecutor(driver neo4j.Driver, useBookmark bool) func(ctx *Tes
 		err = tx.Commit()
 		ExpectNoError(err)
 
-		ctx.setBookmark(session.LastBookmark())
+		ctx.setBookmarks(session.LastBookmarks())
 
 		ctx.addCreated()
 	}
@@ -229,7 +229,7 @@ func WriteQueryWithWriteTransactionExecutor(driver neo4j.Driver, useBookmark boo
 		ExpectNoError(err)
 		ExpectNotNil(summary)
 		ExpectInt(summary.(neo4j.ResultSummary).Counters().NodesCreated(), 1)
-		ctx.setBookmark(session.LastBookmark())
+		ctx.setBookmarks(session.LastBookmarks())
 		ctx.addCreated()
 	}
 }

test-stress/testcontext.go

@@ -31,7 +31,7 @@ import (
 type TestContext struct {
 	driver   neo4j.Driver
 	stop     int32
-	bookmark atomic.Value
+	bookmarks atomic.Value
 
 	readNodeCountsByServer sync.Map
 
@@ -45,13 +45,13 @@ func NewTestContext(driver neo4j.Driver) *TestContext {
 	result := &TestContext{
 		driver:                 driver,
 		stop:                   0,
-		bookmark:               atomic.Value{},
+		bookmarks:              atomic.Value{},
 		readNodeCountsByServer: sync.Map{},
 		readNodeCount:          0,
 		createdNodeCount:       0,
 	}
 
-	result.bookmark.Store("")
+	result.bookmarks.Store([]string{""})
 
 	return result
 }
@@ -74,12 +74,12 @@ func (ctx *TestContext) addRead() {
 	atomic.AddInt32(&ctx.readNodeCount, 1)
 }
 
-func (ctx *TestContext) getBookmark() string {
-	return ctx.bookmark.Load().(string)
+func (ctx *TestContext) getBookmarks() []string {
+	return ctx.bookmarks.Load().([]string)
 }
 
-func (ctx *TestContext) setBookmark(bookmark string) {
-	ctx.bookmark.Store(bookmark)
+func (ctx *TestContext) setBookmarks(bookmarks []string) {
+	ctx.bookmarks.Store(bookmarks)
 }
 
 func (ctx *TestContext) processSummary(summary neo4j.ResultSummary) {

testkit-backend/backend.go

@@ -493,10 +493,9 @@ func (b *backend) handleRequest(req map[string]interface{}) {
 
 	case "SessionLastBookmarks":
 		sessionState := b.sessionStates[data["sessionId"].(string)]
-		bookmark := sessionState.session.LastBookmark()
-		bookmarks := []string{}
-		if bookmark != "" {
-			bookmarks = append(bookmarks, bookmark)
+		bookmarks := sessionState.session.LastBookmarks()
+		if (bookmarks == nil) {
+			bookmarks = []string{}
 		}
 		b.writeResponse("Bookmarks", map[string]interface{}{"bookmarks": bookmarks})