Implement bookmark flush API

Author: fbiville

neo4j/bookmarks.go

@@ -43,6 +43,10 @@ type BookmarkManager interface {
 	// GetBookmarks returns all the bookmarks associated with the specified database
 	// Note: the order of the returned bookmark slice does not need to be deterministic
 	GetBookmarks(database string) Bookmarks
+
+	// Forget removes all databases' bookmarks
+	// Note: it is the driver user's responsibility to call this
+	Forget(databases ...string)
 }
 
 type BookmarkManagerConfig struct {
@@ -118,6 +122,12 @@ func (b *bookmarkManager) GetBookmarks(database string) Bookmarks {
 	return bookmarks.Values()
 }
 
+func (b *bookmarkManager) Forget(databases ...string) {
+	for _, db := range databases {
+		b.bookmarks.Delete(db)
+	}
+}
+
 func NewBookmarkManager(config BookmarkManagerConfig) BookmarkManager {
 	return &bookmarkManager{
 		bookmarks:       initializeBookmarks(config.InitialBookmarks),

neo4j/bookmarks_test.go

@@ -197,6 +197,42 @@ func TestBookmarkManager(outer *testing.T) {
 			t.Errorf("notify hook should have been called")
 		}
 	})
+
+	outer.Run("forgets bookmarks of specified databases", func(t *testing.T) {
+		bookmarkManager := neo4j.NewBookmarkManager(neo4j.BookmarkManagerConfig{
+			InitialBookmarks: map[string]neo4j.Bookmarks{
+				"db":  {"z", "cooper"},
+				"foo": {"bar", "fighters"},
+				"par": {"rot", "don my French"},
+			},
+		})
+
+		bookmarkManager.Forget("db", "par")
+
+		allBookmarks := bookmarkManager.GetAllBookmarks()
+		AssertEqualsInAnyOrder(t, allBookmarks, []string{"bar", "fighters"})
+		AssertIntEqual(t, len(bookmarkManager.GetBookmarks("db")), 0)
+		AssertEqualsInAnyOrder(t, bookmarkManager.GetBookmarks("foo"),
+			[]string{"bar", "fighters"})
+		AssertIntEqual(t, len(bookmarkManager.GetBookmarks("par")), 0)
+	})
+
+	outer.Run("can forget untracked databases", func(t *testing.T) {
+		bookmarkManager := neo4j.NewBookmarkManager(neo4j.BookmarkManagerConfig{
+			InitialBookmarks: map[string]neo4j.Bookmarks{
+				"db": {"z", "cooper"},
+			},
+		})
+
+		bookmarkManager.Forget("wat", "nope")
+
+		allBookmarks := bookmarkManager.GetAllBookmarks()
+		AssertEqualsInAnyOrder(t, allBookmarks, []string{"z", "cooper"})
+		AssertEqualsInAnyOrder(t, bookmarkManager.GetBookmarks("db"),
+			[]string{"z", "cooper"})
+		AssertIntEqual(t, len(bookmarkManager.GetBookmarks("wat")), 0)
+		AssertIntEqual(t, len(bookmarkManager.GetBookmarks("nope")), 0)
+	})
 }
 
 type simpleBookmarkSupplier struct {

neo4j/session_bookmarks_test.go

@@ -153,6 +153,9 @@ func (f *fakeBookmarkManager) GetAllBookmarks() Bookmarks {
 	return nil
 }
 
+func (f *fakeBookmarkManager) Forget(...string) {
+}
+
 func (f *fakeBookmarkManager) called(times int, function string, args ...any) bool {
 	count := 0
 	for _, call := range f.recordedCalls {