lib6/bookmark-manager.js
/**
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [https://neo4j.com]
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
/**
* Interface for the piece of software responsible for keeping track of current active bookmarks accross the driver.
* @interface
* @since 5.0
*/
export default class BookmarkManager {
/**
* @constructor
* @private
*/
constructor() {
throw new Error('Not implemented');
}
/**
* Method called when the bookmarks get updated when a transaction finished.
*
* This method will be called when auto-commit queries finish and when explicit transactions
* get committed.
*
* @param {Iterable<string>} previousBookmarks The bookmarks used when starting the transaction
* @param {Iterable<string>} newBookmarks The new bookmarks received at the end of the transaction.
* @returns {void}
*/
updateBookmarks(previousBookmarks, newBookmarks) {
return __awaiter(this, void 0, void 0, function* () {
throw new Error('Not implemented');
});
}
/**
* Method called by the driver to get the bookmarks.
*
* @returns {Iterable<string>} The set of bookmarks
*/
getBookmarks() {
return __awaiter(this, void 0, void 0, function* () {
throw new Error('Not implemented');
});
}
}
/**
* @typedef {Object} BookmarkManagerConfig
*
* @since 5.0
* @property {Iterable<string>} [initialBookmarks] Defines the initial set of bookmarks. The key is the database name and the values are the bookmarks.
* @property {function():Promise<Iterable<string>>} [bookmarksSupplier] Called for supplying extra bookmarks to the BookmarkManager
* @property {function(bookmarks: Iterable<string>): Promise<void>} [bookmarksConsumer] Called when the set of bookmarks get updated
*/
/**
* Provides an configured {@link BookmarkManager} instance.
*
* @since 5.0
* @param {BookmarkManagerConfig} [config={}]
* @returns {BookmarkManager}
*/
export function bookmarkManager(config = {}) {
const initialBookmarks = new Set(config.initialBookmarks);
return new Neo4jBookmarkManager(initialBookmarks, config.bookmarksSupplier, config.bookmarksConsumer);
}
class Neo4jBookmarkManager {
constructor(_bookmarks, _bookmarksSupplier, _bookmarksConsumer) {
this._bookmarks = _bookmarks;
this._bookmarksSupplier = _bookmarksSupplier;
this._bookmarksConsumer = _bookmarksConsumer;
}
updateBookmarks(previousBookmarks, newBookmarks) {
return __awaiter(this, void 0, void 0, function* () {
const bookmarks = this._bookmarks;
for (const bm of previousBookmarks) {
bookmarks.delete(bm);
}
for (const bm of newBookmarks) {
bookmarks.add(bm);
}
if (typeof this._bookmarksConsumer === 'function') {
yield this._bookmarksConsumer([...bookmarks]);
}
});
}
getBookmarks() {
var _a;
return __awaiter(this, void 0, void 0, function* () {
const bookmarks = new Set(this._bookmarks);
if (typeof this._bookmarksSupplier === 'function') {
const suppliedBookmarks = (_a = yield this._bookmarksSupplier()) !== null && _a !== void 0 ? _a : [];
for (const bm of suppliedBookmarks) {
bookmarks.add(bm);
}
}
return [...bookmarks];
});
}
}