neo4j-driver 4.3.1 → 4.3.5

package/README.md

@@ -4,7 +4,7 @@ This is the official Neo4j driver for JavaScript.
 
 Resources to get you started:
 
-- [API Documentation](https://neo4j.com/docs/api/javascript-driver/4.2/)
+- [API Documentation](https://neo4j.com/docs/api/javascript-driver/4.3/)
 - [Neo4j Manual](https://neo4j.com/docs/)
 - [Neo4j Refcard](https://neo4j.com/docs/cypher-refcard/current/)
 
@@ -490,6 +490,40 @@ See files under `examples/` on how to use.
 
 ## Testing
 
+Tests **require** latest [Testkit 4.3](https://github.com/neo4j-drivers/testkit/tree/4.3), Python3 and Docker.
+
+Testkit is needed to be cloned and configured to run against the Javascript Lite Driver. Use the following steps to configure Testkit.
+
+1. Clone the Testkit repository
+
+```
+git clone https://github.com/neo4j-drivers/testkit.git
+```
+
+2. Under the Testkit folder, install the requirements.
+
+```
+pip3 install -r requirements.txt
+```
+
+3. Define some enviroment variables to configure Testkit
+
+```
+export TEST_DRIVER_NAME=javascript
+export TEST_DRIVER_REPO=<path for the root folder of driver repository>
+unset TEST_DRIVER_LITE
+```
+
+To run test against against some Neo4j version:
+
+```
+python3 main.py
+```
+
+More details about how to use Teskit could be found on [its repository](https://github.com/neo4j-drivers/testkit/tree/4.3)
+
+## Testing (Legacy)
+
 Tests **require** latest [Boltkit](https://github.com/neo4j-contrib/boltkit) and [Firefox](https://www.mozilla.org/firefox/) to be installed in the system.
 
 Boltkit is needed to start, stop and configure local test database. Boltkit can be installed with the following command:

package/lib/browser/neo4j-web.js

@@ -129,6 +129,13 @@ var BoltProtocol = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(BoltProtocol.prototype, "currentFailure", {
+        get: function () {
+            return this._responseHandler.currentFailure;
+        },
+        enumerable: false,
+        configurable: true
+    });
     /**
      * Get the packer.
      * @return {Packer} the protocol's packer.
@@ -1693,6 +1700,13 @@ var ResponseHandler = /** @class */ (function () {
                 this._observer.onError(neo4j_driver_core_1.newError('Unknown Bolt protocol message: ' + msg));
         }
     };
+    Object.defineProperty(ResponseHandler.prototype, "currentFailure", {
+        get: function () {
+            return this._currentFailure;
+        },
+        enumerable: false,
+        configurable: true
+    });
     /*
      * Pop next pending observer form the list of observers and make it current observer.
      * @protected
@@ -3165,6 +3179,15 @@ var WebSocketChannel = /** @class */ (function () {
             }
         });
     };
+    /**
+     * Setup the receive timeout for the channel.
+     *
+     * Not supported for the browser channel.
+     *
+     * @param {number} receiveTimeout The amount of time the channel will keep without receive any data before timeout (ms)
+     * @returns {void}
+     */
+    WebSocketChannel.prototype.setupReceiveTimeout = function (receiveTimeout) { };
     /**
      * Set connection timeout on the given WebSocket, if configured.
      * @return {number} the timeout id or null.
@@ -4762,7 +4785,8 @@ var RoutingConnectionProvider = /** @class */ (function (_super) {
     };
     RoutingConnectionProvider.prototype._createSessionForRediscovery = function (routerAddress, bookmark) {
         return __awaiter(this, void 0, void 0, function () {
-            var connection, connectionProvider, protocolVersion, error_4;
+            var connection, databaseSpecificErrorHandler, connectionProvider, protocolVersion, error_4;
+            var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -4770,7 +4794,11 @@ var RoutingConnectionProvider = /** @class */ (function (_super) {
                         return [4 /*yield*/, this._connectionPool.acquire(routerAddress)];
                     case 1:
                         connection = _a.sent();
-                        connectionProvider = new connection_provider_single_1.default(connection);
+                        databaseSpecificErrorHandler = connection_1.ConnectionErrorHandler.create({
+                            errorCode: SESSION_EXPIRED,
+                            handleAuthorizationExpired: function (error, address) { return _this._handleAuthorizationExpired(error, address); }
+                        });
+                        connectionProvider = new connection_provider_single_1.default(new connection_1.DelegateConnection(connection, databaseSpecificErrorHandler));
                         protocolVersion = connection.protocol().version;
                         if (protocolVersion < 4.0) {
                             return [2 /*return*/, new neo4j_driver_core_1.Session({
@@ -5280,6 +5308,21 @@ var ChannelConnection = /** @class */ (function (_super) {
                         if (!_this.databaseId) {
                             _this.databaseId = dbConnectionId;
                         }
+                        if (metadata.hints) {
+                            var receiveTimeoutRaw = metadata.hints['connection.recv_timeout_seconds'];
+                            if (receiveTimeoutRaw !== null &&
+                                receiveTimeoutRaw !== undefined) {
+                                var receiveTimeoutInSeconds = neo4j_driver_core_1.toNumber(receiveTimeoutRaw);
+                                if (Number.isInteger(receiveTimeoutInSeconds) &&
+                                    receiveTimeoutInSeconds > 0) {
+                                    _this._ch.setupReceiveTimeout(receiveTimeoutInSeconds * 1000);
+                                }
+                                else {
+                                    _this._log.info("Server located at " + _this._address + " supplied an invalid connection receive timeout value (" + receiveTimeoutInSeconds + "). " +
+                                        'Please, verify the server configuration and status because this can be the symptom of a bigger issue.');
+                                }
+                            }
+                        }
                     }
                     resolve(self);
                 }
@@ -5339,7 +5382,7 @@ var ChannelConnection = /** @class */ (function (_super) {
      */
     ChannelConnection.prototype._handleFatalError = function (error) {
         this._isBroken = true;
-        this._error = this.handleAndTransformError(error, this._address);
+        this._error = this.handleAndTransformError(this._protocol.currentFailure || error, this._address);
         if (this._log.isErrorEnabled()) {
             this._log.error("experienced a fatal error " + neo4j_driver_core_1.json.stringify(this._error));
         }
@@ -6811,7 +6854,7 @@ var Unpacker = /** @class */ (function () {
         var prevNode = nodes[0];
         for (var i = 0; i < sequence.length; i += 2) {
             var nextNode = nodes[sequence[i + 1]];
-            var relIndex = sequence[i];
+            var relIndex = neo4j_driver_core_1.toNumber(sequence[i]);
             var rel = void 0;
             if (relIndex > 0) {
                 rel = rels[relIndex - 1];
@@ -7680,7 +7723,7 @@ var Pool = /** @class */ (function () {
                         // request is still pending and needs to be failed
                         var activeCount = _this.activeResourceCount(address);
                         var idleCount = _this.has(address) ? _this._pools[key].length : 0;
-                        request.reject(neo4j_driver_core_1.newError("Connection acquisition timed out in " + _this._acquisitionTimeout + " ms. Poos status: Active conn count = " + activeCount + ", Idle conn count = " + idleCount + "."));
+                        request.reject(neo4j_driver_core_1.newError("Connection acquisition timed out in " + _this._acquisitionTimeout + " ms. Pool status: Active conn count = " + activeCount + ", Idle conn count = " + idleCount + "."));
                     }
                 }, _this._acquisitionTimeout);
                 request = new PendingRequest(key, resolve, reject, timeoutId, _this._log);
@@ -8149,13 +8192,14 @@ var MIN_ROUTERS = 1;
  */
 var RoutingTable = /** @class */ (function () {
     function RoutingTable(_a) {
-        var _b = _a === void 0 ? {} : _a, database = _b.database, routers = _b.routers, readers = _b.readers, writers = _b.writers, expirationTime = _b.expirationTime;
+        var _b = _a === void 0 ? {} : _a, database = _b.database, routers = _b.routers, readers = _b.readers, writers = _b.writers, expirationTime = _b.expirationTime, ttl = _b.ttl;
         this.database = database;
         this.databaseName = database || 'default database';
         this.routers = routers || [];
         this.readers = readers || [];
         this.writers = writers || [];
         this.expirationTime = expirationTime || neo4j_driver_core_1.int(0);
+        this.ttl = ttl;
     }
     /**
      * Create a valid routing table from a raw object
@@ -8234,6 +8278,7 @@ function removeFromArray(array, element) {
  * @param {RoutingTable} The valid Routing Table
  */
 function createValidRoutingTable(database, routerAddress, rawRoutingTable) {
+    var ttl = rawRoutingTable.ttl;
     var expirationTime = calculateExpirationTime(rawRoutingTable, routerAddress);
     var _a = parseServers(rawRoutingTable, routerAddress), routers = _a.routers, readers = _a.readers, writers = _a.writers;
     assertNonEmpty(routers, 'routers', routerAddress);
@@ -8243,7 +8288,8 @@ function createValidRoutingTable(database, routerAddress, rawRoutingTable) {
         routers: routers,
         readers: readers,
         writers: writers,
-        expirationTime: expirationTime
+        expirationTime: expirationTime,
+        ttl: ttl
     });
 }
 exports.createValidRoutingTable = createValidRoutingTable;
@@ -9552,7 +9598,7 @@ var Node = /** @class */ (function () {
      * @protected
      * @param {Integer|number} identity - Unique identity
      * @param {Array<string>} labels - Array for all labels
-     * @param {Object} properties - Map with node properties
+     * @param {Properties} properties - Map with node properties
      */
     function Node(identity, labels, properties) {
         /**
@@ -9567,7 +9613,7 @@ var Node = /** @class */ (function () {
         this.labels = labels;
         /**
          * Properties of the node.
-         * @type {Object}
+         * @type {Properties}
          */
         this.properties = properties;
     }
@@ -9616,7 +9662,7 @@ var Relationship = /** @class */ (function () {
      * @param {Integer|number} start - Identity of start Node
      * @param {Integer|number} end - Identity of end Node
      * @param {string} type - Relationship type
-     * @param {Object} properties - Map with relationship properties
+     * @param {Properties} properties - Map with relationship properties
      */
     function Relationship(identity, start, end, type, properties) {
         /**
@@ -9641,7 +9687,7 @@ var Relationship = /** @class */ (function () {
         this.type = type;
         /**
          * Properties of the relationship.
-         * @type {Object}
+         * @type {Properties}
          */
         this.properties = properties;
     }
@@ -9686,7 +9732,7 @@ var UnboundRelationship = /** @class */ (function () {
      * @protected
      * @param {Integer|number} identity - Unique identity
      * @param {string} type - Relationship type
-     * @param {Object} properties - Map with relationship properties
+     * @param {Properties} properties - Map with relationship properties
      */
     function UnboundRelationship(identity, type, properties) {
         /**
@@ -9701,7 +9747,7 @@ var UnboundRelationship = /** @class */ (function () {
         this.type = type;
         /**
          * Properties of the relationship.
-         * @type {Object}
+         * @type {Properties}
          */
         this.properties = properties;
     }
@@ -10791,7 +10837,14 @@ var Integer = /** @class */ (function () {
      * @expose
      */
     Integer.toNumber = function (val) {
-        return Integer.fromValue(val).toNumber();
+        switch (typeof val) {
+            case 'number':
+                return val;
+            case 'bigint':
+                return Number(val);
+            default:
+                return Integer.fromValue(val).toNumber();
+        }
     };
     /**
      * Converts the specified value to a string.
@@ -27769,7 +27822,7 @@ exports["default"] = void 0;
 // This is set up this way to keep the version in the code in
 // sync with the npm package version, and to allow the build
 // system to control version names at packaging time.
-var _default = '4.3.1';
+var _default = '4.3.5';
 exports["default"] = _default;
 
 },{}]},{},[296])(296)