arangojs 7.8.0 → 8.0.0

package/connection.js

@@ -1,31 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Connection = exports.isArangoConnection = void 0;
-const querystring_1 = require("querystring");
 const x3_linkedlist_1 = require("x3-linkedlist");
 const error_1 = require("./error");
 const btoa_1 = require("./lib/btoa");
 const codes_1 = require("./lib/codes");
 const normalizeUrl_1 = require("./lib/normalizeUrl");
+const querystringify_1 = require("./lib/querystringify");
 const request_1 = require("./lib/request");
 const MIME_JSON = /\/(json|javascript)(\W|$)/;
 const LEADER_ENDPOINT_HEADER = "x-arango-endpoint";
-function clean(obj) {
-    const result = {};
-    for (const key of Object.keys(obj)) {
-        const value = obj[key];
-        if (value === undefined)
-            continue;
-        result[key] = value;
-    }
-    return result;
-}
 function isBearerAuth(auth) {
     return auth.hasOwnProperty("token");
 }
 /**
  * @internal
- * @hidden
  */
 function generateStackTrace() {
     let err = new Error();
@@ -45,7 +34,6 @@ function generateStackTrace() {
  * @param connection - A value that might be a connection.
  *
  * @internal
- * @hidden
  */
 function isArangoConnection(connection) {
     return Boolean(connection && connection.isArangoConnection);
@@ -55,7 +43,6 @@ exports.isArangoConnection = isArangoConnection;
  * Represents a connection pool shared by one or more databases.
  *
  * @internal
- * @hidden
  */
 class Connection {
     /**
@@ -65,23 +52,21 @@ class Connection {
      *
      * @param config - An object with configuration options.
      *
-     * @hidden
      */
     constructor(config = {}) {
-        var _a, _b, _c;
         this._activeTasks = 0;
-        this._arangoVersion = 30400;
+        this._arangoVersion = 30900;
         this._queue = new x3_linkedlist_1.LinkedList();
         this._databases = new Map();
         this._hosts = [];
-        this._urls = [];
+        this._hostUrls = [];
         this._transactionId = null;
         this._queueTimes = new x3_linkedlist_1.LinkedList();
         const URLS = config.url
             ? Array.isArray(config.url)
                 ? config.url
                 : [config.url]
-            : ["http://localhost:8529"];
+            : ["http://127.0.0.1:8529"];
         const MAX_SOCKETS = 3 * (config.loadBalancingStrategy === "ROUND_ROBIN" ? URLS.length : 1);
         if (config.arangoVersion !== undefined) {
             this._arangoVersion = config.arangoVersion;
@@ -98,20 +83,18 @@ class Connection {
             };
         this._maxTasks = this._agentOptions.maxSockets;
         this._headers = { ...config.headers };
-        this._loadBalancingStrategy = (_a = config.loadBalancingStrategy) !== null && _a !== void 0 ? _a : "NONE";
-        this._useFailOver = this._loadBalancingStrategy !== "ROUND_ROBIN";
+        this._loadBalancingStrategy = config.loadBalancingStrategy ?? "NONE";
         this._precaptureStackTraces = Boolean(config.precaptureStackTraces);
-        this._responseQueueTimeSamples = (_b = config.responseQueueTimeSamples) !== null && _b !== void 0 ? _b : 10;
+        this._responseQueueTimeSamples = config.responseQueueTimeSamples ?? 10;
+        this._retryOnConflict = config.retryOnConflict ?? 0;
         if (this._responseQueueTimeSamples < 0) {
             this._responseQueueTimeSamples = Infinity;
         }
         if (config.maxRetries === false) {
-            this._shouldRetry = false;
-            this._maxRetries = 0;
+            this._maxRetries = false;
         }
         else {
-            this._shouldRetry = true;
-            this._maxRetries = (_c = config.maxRetries) !== null && _c !== void 0 ? _c : 0;
+            this._maxRetries = Number(config.maxRetries ?? 0);
         }
         this.addToHostList(URLS);
         if (config.auth) {
@@ -123,12 +106,14 @@ class Connection {
             }
         }
         if (this._loadBalancingStrategy === "ONE_RANDOM") {
-            this._activeHost = Math.floor(Math.random() * this._hosts.length);
-            this._activeDirtyHost = Math.floor(Math.random() * this._hosts.length);
+            this._activeHostUrl =
+                this._hostUrls[Math.floor(Math.random() * this._hostUrls.length)];
+            this._activeDirtyHostUrl =
+                this._hostUrls[Math.floor(Math.random() * this._hostUrls.length)];
         }
         else {
-            this._activeHost = 0;
-            this._activeDirtyHost = 0;
+            this._activeHostUrl = this._hostUrls[0];
+            this._activeDirtyHostUrl = this._hostUrls[0];
         }
     }
     /**
@@ -141,7 +126,7 @@ class Connection {
     }
     get queueTime() {
         return {
-            getLatest: () => { var _a; return (_a = this._queueTimes.last) === null || _a === void 0 ? void 0 : _a.value[1]; },
+            getLatest: () => this._queueTimes.last?.value[1],
             getValues: () => Array.from(this._queueTimes.values()),
             getAvg: () => {
                 let avg = 0;
@@ -156,40 +141,109 @@ class Connection {
         if (!this._queue.length || this._activeTasks >= this._maxTasks)
             return;
         const task = this._queue.shift();
-        let host = this._activeHost;
-        if (task.host !== undefined) {
-            host = task.host;
+        let hostUrl = this._activeHostUrl;
+        if (task.hostUrl !== undefined) {
+            hostUrl = task.hostUrl;
         }
         else if (task.allowDirtyRead) {
-            host = this._activeDirtyHost;
-            this._activeDirtyHost = (this._activeDirtyHost + 1) % this._hosts.length;
+            hostUrl = this._activeDirtyHostUrl;
+            this._activeDirtyHostUrl =
+                this._hostUrls[(this._hostUrls.indexOf(this._activeDirtyHostUrl) + 1) %
+                    this._hostUrls.length];
             task.options.headers["x-arango-allow-dirty-read"] = "true";
         }
         else if (this._loadBalancingStrategy === "ROUND_ROBIN") {
-            this._activeHost = (this._activeHost + 1) % this._hosts.length;
+            this._activeHostUrl =
+                this._hostUrls[(this._hostUrls.indexOf(this._activeHostUrl) + 1) %
+                    this._hostUrls.length];
         }
         this._activeTasks += 1;
         const callback = (err, res) => {
             this._activeTasks -= 1;
+            if (!err && res) {
+                if (res.statusCode === 503 && res.headers[LEADER_ENDPOINT_HEADER]) {
+                    const url = res.headers[LEADER_ENDPOINT_HEADER];
+                    const [cleanUrl] = this.addToHostList(url);
+                    task.hostUrl = cleanUrl;
+                    if (this._activeHostUrl === hostUrl) {
+                        this._activeHostUrl = cleanUrl;
+                    }
+                    this._queue.push(task);
+                }
+                else {
+                    res.arangojsHostUrl = hostUrl;
+                    const contentType = res.headers["content-type"];
+                    const queueTime = res.headers["x-arango-queue-time-seconds"];
+                    if (queueTime) {
+                        this._queueTimes.push([Date.now(), Number(queueTime)]);
+                        while (this._responseQueueTimeSamples < this._queueTimes.length) {
+                            this._queueTimes.shift();
+                        }
+                    }
+                    let parsedBody = undefined;
+                    if (res.body.length && contentType && contentType.match(MIME_JSON)) {
+                        try {
+                            parsedBody = res.body;
+                            parsedBody = JSON.parse(parsedBody);
+                        }
+                        catch (e) {
+                            if (!task.options.expectBinary) {
+                                if (typeof parsedBody !== "string") {
+                                    parsedBody = res.body.toString("utf-8");
+                                }
+                                e.res = res;
+                                if (task.stack) {
+                                    e.stack += task.stack();
+                                }
+                                callback(e);
+                                return;
+                            }
+                        }
+                    }
+                    else if (res.body && !task.options.expectBinary) {
+                        parsedBody = res.body.toString("utf-8");
+                    }
+                    else {
+                        parsedBody = res.body;
+                    }
+                    if ((0, error_1.isArangoErrorResponse)(parsedBody)) {
+                        res.body = parsedBody;
+                        err = new error_1.ArangoError(res);
+                    }
+                    else if (res.statusCode && res.statusCode >= 400) {
+                        res.body = parsedBody;
+                        err = new error_1.HttpError(res);
+                    }
+                    else {
+                        if (!task.options.expectBinary)
+                            res.body = parsedBody;
+                        task.resolve(task.transform ? task.transform(res) : res);
+                    }
+                }
+            }
             if (err) {
                 if (!task.allowDirtyRead &&
                     this._hosts.length > 1 &&
-                    this._activeHost === host &&
-                    this._useFailOver) {
-                    this._activeHost = (this._activeHost + 1) % this._hosts.length;
+                    this._activeHostUrl === hostUrl &&
+                    this._loadBalancingStrategy !== "ROUND_ROBIN") {
+                    this._activeHostUrl =
+                        this._hostUrls[(this._hostUrls.indexOf(this._activeHostUrl) + 1) %
+                            this._hostUrls.length];
                 }
-                if (error_1.isArangoError(err) &&
+                if ((0, error_1.isArangoError)(err) &&
                     err.errorNum === codes_1.ERROR_ARANGO_CONFLICT &&
                     task.retryOnConflict > 0) {
                     task.retryOnConflict -= 1;
                     this._queue.push(task);
                 }
-                else if (!task.host &&
-                    this._shouldRetry &&
-                    task.retries < (this._maxRetries || this._hosts.length - 1) &&
-                    error_1.isSystemError(err) &&
+                else if ((((0, error_1.isSystemError)(err) &&
                     err.syscall === "connect" &&
-                    err.code === "ECONNREFUSED") {
+                    err.code === "ECONNREFUSED") ||
+                    ((0, error_1.isArangoError)(err) &&
+                        err.errorNum === codes_1.ERROR_ARANGO_MAINTENANCE_MODE)) &&
+                    task.hostUrl === undefined &&
+                    this._maxRetries !== false &&
+                    task.retries < (this._maxRetries || this._hosts.length - 1)) {
                     task.retries += 1;
                     this._queue.push(task);
                 }
@@ -200,27 +254,10 @@ class Connection {
                     task.reject(err);
                 }
             }
-            else {
-                const response = res;
-                if (response.statusCode === 503 &&
-                    response.headers[LEADER_ENDPOINT_HEADER]) {
-                    const url = response.headers[LEADER_ENDPOINT_HEADER];
-                    const [index] = this.addToHostList(url);
-                    task.host = index;
-                    if (this._activeHost === host) {
-                        this._activeHost = index;
-                    }
-                    this._queue.push(task);
-                }
-                else {
-                    response.arangojsHostId = host;
-                    task.resolve(response);
-                }
-            }
             this._runQueue();
         };
         try {
-            this._hosts[host](task.options, callback);
+            this._hosts[this._hostUrls.indexOf(hostUrl)](task.options, callback);
         }
         catch (e) {
             callback(e);
@@ -233,7 +270,7 @@ class Connection {
             if (typeof qs === "string")
                 search = `?${qs}`;
             else
-                search = `?${querystring_1.stringify(clean(qs))}`;
+                search = `?${(0, querystringify_1.querystringify)(qs)}`;
         }
         return search ? { pathname, search } : { pathname };
     }
@@ -241,7 +278,7 @@ class Connection {
         this.setHeader("authorization", `Bearer ${auth.token}`);
     }
     setBasicAuth(auth) {
-        this.setHeader("authorization", `Basic ${btoa_1.btoa(`${auth.username}:${auth.password}`)}`);
+        this.setHeader("authorization", `Basic ${(0, btoa_1.base64Encode)(`${auth.username}:${auth.password}`)}`);
     }
     setResponseQueueTimeSamples(responseQueueTimeSamples) {
         if (responseQueueTimeSamples < 0) {
@@ -263,21 +300,40 @@ class Connection {
         this._databases.set(databaseName, database);
         return database;
     }
+    /**
+     * @internal
+     *
+     * Replaces the host list with the given URLs.
+     *
+     * See {@link Connection#acquireHostList}.
+     *
+     * @param urls - URLs to use as host list.
+     */
+    setHostList(urls) {
+        const cleanUrls = urls.map((url) => (0, normalizeUrl_1.normalizeUrl)(url));
+        this._hosts.splice(0, this._hosts.length, ...cleanUrls.map((url) => {
+            const i = this._hostUrls.indexOf(url);
+            if (i !== -1)
+                return this._hosts[i];
+            return (0, request_1.createRequest)(url, this._agentOptions, this._agent);
+        }));
+        this._hostUrls.splice(0, this._hostUrls.length, ...cleanUrls);
+    }
     /**
      * @internal
      *
      * Adds the given URL or URLs to the host list.
      *
-     * See {@link Connection.acquireHostList}.
+     * See {@link Connection#acquireHostList}.
      *
      * @param urls - URL or URLs to add.
      */
     addToHostList(urls) {
-        const cleanUrls = (Array.isArray(urls) ? urls : [urls]).map((url) => normalizeUrl_1.normalizeUrl(url));
-        const newUrls = cleanUrls.filter((url) => this._urls.indexOf(url) === -1);
-        this._urls.push(...newUrls);
-        this._hosts.push(...newUrls.map((url) => request_1.createRequest(url, this._agentOptions, this._agent)));
-        return cleanUrls.map((url) => this._urls.indexOf(url));
+        const cleanUrls = (Array.isArray(urls) ? urls : [urls]).map((url) => (0, normalizeUrl_1.normalizeUrl)(url));
+        const newUrls = cleanUrls.filter((url) => this._hostUrls.indexOf(url) === -1);
+        this._hostUrls.push(...newUrls);
+        this._hosts.push(...newUrls.map((url) => (0, request_1.createRequest)(url, this._agentOptions, this._agent)));
+        return cleanUrls;
     }
     /**
      * @internal
@@ -288,7 +344,7 @@ class Connection {
      * within the transaction if possible. Setting the ID manually may cause
      * unexpected behavior.
      *
-     * See also {@link Connection.clearTransactionId}.
+     * See also {@link Connection#clearTransactionId}.
      *
      * @param transactionId - ID of the active transaction.
      */
@@ -325,7 +381,7 @@ class Connection {
      *
      * Closes all open connections.
      *
-     * See {@link Database.close}.
+     * See {@link database.Database#close}.
      */
     close() {
         for (const host of this._hosts) {
@@ -338,7 +394,7 @@ class Connection {
      *
      * Waits for propagation.
      *
-     * See {@link Database.waitForPropagation}.
+     * See {@link database.Database#waitForPropagation}.
      *
      * @param request - Request to perform against each coordinator.
      * @param timeout - Maximum number of milliseconds to wait for propagation.
@@ -347,16 +403,17 @@ class Connection {
         const numHosts = this._hosts.length;
         const propagated = [];
         const started = Date.now();
-        let host = 0;
+        let index = 0;
         while (true) {
             if (propagated.length === numHosts) {
                 return;
             }
-            while (propagated.includes(host)) {
-                host = (host + 1) % numHosts;
+            while (propagated.includes(this._hostUrls[index])) {
+                index = (index + 1) % numHosts;
             }
+            const hostUrl = this._hostUrls[index];
             try {
-                await this.request({ ...request, host });
+                await this.request({ ...request, hostUrl });
             }
             catch (e) {
                 if (started + timeout < Date.now()) {
@@ -365,8 +422,8 @@ class Connection {
                 await new Promise((resolve) => setTimeout(resolve, 1000));
                 continue;
             }
-            if (!propagated.includes(host)) {
-                propagated.push(host);
+            if (!propagated.includes(hostUrl)) {
+                propagated.push(hostUrl);
             }
         }
     }
@@ -375,7 +432,7 @@ class Connection {
      *
      * Performs a request using the arangojs connection pool.
      */
-    request({ host, method = "GET", body, expectBinary = false, isBinary = false, allowDirtyRead = false, retryOnConflict = 0, timeout = 0, headers, ...urlInfo }, transform) {
+    request({ hostUrl, method = "GET", body, expectBinary = false, isBinary = false, allowDirtyRead = false, retryOnConflict = this._retryOnConflict, timeout = 0, headers, ...urlInfo }, transform) {
         return new Promise((resolve, reject) => {
             let contentType = "text/plain";
             if (isBinary) {
@@ -400,7 +457,7 @@ class Connection {
             }
             const task = {
                 retries: 0,
-                host,
+                hostUrl,
                 allowDirtyRead,
                 retryOnConflict,
                 options: {
@@ -412,63 +469,8 @@ class Connection {
                     body,
                 },
                 reject,
-                resolve: (res) => {
-                    const contentType = res.headers["content-type"];
-                    const queueTime = res.headers["x-arango-queue-time-seconds"];
-                    if (queueTime) {
-                        this._queueTimes.push([Date.now(), Number(queueTime)]);
-                        while (this._responseQueueTimeSamples < this._queueTimes.length) {
-                            this._queueTimes.shift();
-                        }
-                    }
-                    let parsedBody = undefined;
-                    if (res.body.length && contentType && contentType.match(MIME_JSON)) {
-                        try {
-                            parsedBody = res.body;
-                            parsedBody = JSON.parse(parsedBody);
-                        }
-                        catch (e) {
-                            if (!expectBinary) {
-                                if (typeof parsedBody !== "string") {
-                                    parsedBody = res.body.toString("utf-8");
-                                }
-                                e.response = res;
-                                if (task.stack) {
-                                    e.stack += task.stack();
-                                }
-                                reject(e);
-                                return;
-                            }
-                        }
-                    }
-                    else if (res.body && !expectBinary) {
-                        parsedBody = res.body.toString("utf-8");
-                    }
-                    else {
-                        parsedBody = res.body;
-                    }
-                    if (error_1.isArangoErrorResponse(parsedBody)) {
-                        res.body = parsedBody;
-                        const err = new error_1.ArangoError(res);
-                        if (task.stack) {
-                            err.stack += task.stack();
-                        }
-                        reject(err);
-                    }
-                    else if (res.statusCode && res.statusCode >= 400) {
-                        res.body = parsedBody;
-                        const err = new error_1.HttpError(res);
-                        if (task.stack) {
-                            err.stack += task.stack();
-                        }
-                        reject(err);
-                    }
-                    else {
-                        if (!expectBinary)
-                            res.body = parsedBody;
-                        resolve(transform ? transform(res) : res);
-                    }
-                },
+                resolve,
+                transform,
             };
             if (this._precaptureStackTraces) {
                 if (typeof Error.captureStackTrace === "function") {