Replace databaseName with isAbsolute

Author: pluma

CHANGELOG.md

@@ -39,6 +39,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
   The behaviour depends on the load balancing strategy (see API docs).
 
+* The `databaseName` config has been replaced with `isAbsolute`.
+
+  If you previously used `databaseName: false`, the same behaviour can now
+  be achived using `isAbsolute: true`. If you want to use a specific
+  database you can still switch databases with `db.useDatabase` at any time.
+
 * Browser: maximum number of parallel connections behaves differently.
 
   As keep-alive does not work reliably in the browser, the maximum number

README.md

@@ -196,9 +196,9 @@ db.query({
 
 // Using different databases
 const db = new Database({
-  url: "http://localhost:8529",
-  databaseName: "pancakes"
+  url: "http://localhost:8529"
 });
+db.useDatabase("pancakes);
 db.useBasicAuth("root", "");
 // The database can be swapped at any time
 db.useDatabase("waffles");
@@ -207,7 +207,7 @@ db.useBasicAuth("admin", "maplesyrup");
 // Using ArangoDB behind a reverse proxy
 const db = new Database({
   url: "http://myproxy.local:8000",
-  databaseName: false // don't automatically append database path to URL
+  isAbsolute: true // don't automatically append database path to URL
 });
 
 // Trigger ArangoDB 2.8 compatibility mode
@@ -460,13 +460,12 @@ If _config_ is a string, it will be interpreted as _config.url_.
     }
     ```
 
-  * **databaseName**: `string | false` (Default: `_system`)
+  * **isAbsolute**: `boolean` (Default: `false`)
 
-    Name of the active database.
-
-    If this option is explicitly set to `false`, the _url_ is expected to
-    provide the database path and the _useDatabase_ method can not be used to
-    switch databases.
+    If this option is explicitly set to `true`, the _url_ will be treated as the
+    absolute database path. This is an escape hatch to allow using arangojs with
+    database APIs exposed with a reverse proxy and makes it impossible to switch
+    databases with _useDatabase_ or using _acquireHostList_.
 
   * **arangoVersion**: `number` (Default: `30000`)
 
@@ -542,13 +541,17 @@ Updates the URL list by requesting a list of all coordinators in the cluster and
 
 For long-running processes communicating with an ArangoDB cluster it is recommended to run this method repeatedly (e.g. once per hour) to make sure new coordinators are picked up correctly and can be used for fail-over or load balancing.
 
+**Note**: This method can not be used when the arangojs instance was created with `isAbsolute: true`.
+
 #### database.useDatabase
 
 `database.useDatabase(databaseName): this`
 
 Updates the _Database_ instance and its connection string to use the given
 _databaseName_, then returns itself.
 
+**Note**: This method can not be used when the arangojs instance was created with `isAbsolute: true`.
+
 **Arguments**
 
 * **databaseName**: `string`

src/connection.ts

@@ -54,7 +54,7 @@ export type Config =
   | string[]
   | Partial<{
       url: string | string[];
-      databaseName: string | false;
+      isAbsolute: boolean;
       arangoVersion: number;
       loadBalancingStrategy: LoadBalancingStrategy;
       agent: Function;
@@ -84,8 +84,8 @@ export class Connection {
     if (config.arangoVersion !== undefined) {
       this._arangoVersion = config.arangoVersion;
     }
-    if (config.databaseName !== undefined) {
-      this._databaseName = config.databaseName;
+    if (config.isAbsolute) {
+      this._databaseName = false;
     }
     this._agent = config.agent;
     this._agentOptions = isBrowser

src/database.ts

@@ -54,6 +54,9 @@ export class Database {
   }
 
   async acquireHostList() {
+    if (!this._connection.getDatabaseName()) {
+      throw new Error("Cannot acquire host list with absolute URL");
+    }
     const res = await this._api.request({
       path: "/_api/cluster/endpoints"
     });

src/test/00-basics.ts

@@ -8,27 +8,21 @@ import { expect } from "chai";
 
 describe("Creating a Database", () => {
   describe("using the factory", () => {
-    const db = arangojs({ databaseName: "potato" });
+    const db = arangojs({ arangoVersion: 54321 });
     it("returns a Database instance", () => {
       expect(db).to.be.an.instanceof(Database);
     });
     it("passes any configs to the connection", () => {
-      expect((db as any)._connection).to.have.property(
-        "_databaseName",
-        "potato"
-      );
+      expect((db as any)._connection).to.have.property("_arangoVersion", 54321);
     });
   });
   describe("using the constructor", () => {
-    const db = new Database({ databaseName: "banana" });
+    const db = new Database({ arangoVersion: 43210 });
     it("returns a Database instance", () => {
       expect(db).to.be.an.instanceof(Database);
     });
     it("passes any configs to the connection", () => {
-      expect((db as any)._connection).to.have.property(
-        "_databaseName",
-        "banana"
-      );
+      expect((db as any)._connection).to.have.property("_arangoVersion", 43210);
     });
   });
 });

src/test/01-manipulating-databases.ts

@@ -101,7 +101,7 @@ describe("Manipulating databases", () => {
     it("deletes the given database from the server", done => {
       db
         .dropDatabase(name)
-        .then(() => new Database({ databaseName: name }).get())
+        .then(() => new Database().useDatabase(name).get())
         .then(() => Promise.reject(new Error("Should not succeed")), () => null)
         .then(() => void done())
         .catch(done);