spice-couchbase 2.0.62 → 2.0.63

package/build/index.js

@@ -29,6 +29,11 @@ var {
   extractStatementResources
 } = require("./utility");
 
+var {
+  createHealthMonitor,
+  openHandles
+} = require("./connectionHealth");
+
 if (!Promise.allSettled) {
   Promise.allSettled = promises => Promise.all(promises.map((promise, i) => promise.then(value => ({
     status: "fulfilled",
@@ -74,7 +79,26 @@ var optimizeState = {
 //      `auto_optimize_resources`.
 
 var OPTIMIZE_ENABLED_RESOURCES = parseResourceList(process.env.SPICE_COUCHBASE_OPTIMIZE_RESOURCES);
-var autoOptimizePolicy = null;
+var autoOptimizePolicy = null; // One health monitor per process, shared by every copy of this module that
+// ends up loaded. See connectionHealth.js.
+
+var HEALTH_MONITOR_KEY = Symbol.for("spice-couchbase.health-monitor");
+var health = globalThis[HEALTH_MONITOR_KEY] || (globalThis[HEALTH_MONITOR_KEY] = createHealthMonitor()); // Cluster handles live on the `spice.database` globals, which a reconnect
+// replaces. Instances read them at call time instead of copying them.
+
+var HANDLE_GLOBALS = {
+  cluster: "clusters",
+  connection: "connections",
+  scope: "scopes",
+  bucket_handle: "buckets"
+};
+
+function globalHandle(kind, connection_name) {
+  var _spice, _spice$database, _spice$database$HANDL;
+
+  if (typeof spice === "undefined") return undefined;
+  return (_spice = spice) === null || _spice === void 0 ? void 0 : (_spice$database = _spice.database) === null || _spice$database === void 0 ? void 0 : (_spice$database$HANDL = _spice$database[HANDLE_GLOBALS[kind]]) === null || _spice$database$HANDL === void 0 ? void 0 : _spice$database$HANDL[connection_name];
+}
 
 function requestedAutoOptimize(query_options) {
   var _query_options$auto_o;
@@ -163,15 +187,12 @@ module.exports = class Database {
     } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
 
     if (connection) {
-      var _spice, _spice$db;
+      var _spice2, _spice2$db;
 
       this.connection_name = connection;
-      this.connection = spice.database.connections[connection];
       this.query_scope = query_scope;
-      this.cluster = spice.database.clusters[connection];
       this.bucket = this.connection._scope._bucket._name;
       this.db_config = spice.config.database.connections[connection];
-      this.collection_manager = spice.database.buckets[connection].collections();
       this.auto_create_collection = auto_create_collection || (collection || spice.config.database.connections[connection].collection) != undefined && (collection || spice.config.database.connections[connection].collection) != "default" && (scope || spice.config.database.connections[connection].scope) != "_default";
       this.collection_name = collection || spice.config.database.connections[connection].collection || "_default";
       /* console.log(
@@ -182,14 +203,11 @@ module.exports = class Database {
       );*/
 
       this.scope_name = scope || spice.config.database.connections[connection].scope || "_default";
-      this.scope = spice.database.scopes[connection];
       this.full_text_index = spice.config.database.connections[connection].full_text_index || full_text_index;
       this.N1qlQuery = couchbase.N1qlQuery;
       this.SearchQuery = couchbase.SearchQuery;
-      this.collection = this.scope.collection(this.collection_name);
-      this.userManager = this.getUserManager(connection);
 
-      if (!((_spice = spice) === null || _spice === void 0 ? void 0 : (_spice$db = _spice.db) === null || _spice$db === void 0 ? void 0 : _spice$db.collections)) {
+      if (!((_spice2 = spice) === null || _spice2 === void 0 ? void 0 : (_spice2$db = _spice2.db) === null || _spice2$db === void 0 ? void 0 : _spice2$db.collections)) {
         spice.db = spice.db || {};
         spice.db.collections = new Set();
       }
@@ -204,6 +222,168 @@ module.exports = class Database {
       this.auto_optimize = typeof configured_auto_optimize === "boolean" ? configured_auto_optimize : undefined;
       this.enabled_resources = parseResourceList([...parseResourceList(this.db_config.auto_optimize_resources), ...parseResourceList(auto_optimize_resources)]);
     }
+  } // Handles resolve from the globals on every access, so an instance created
+  // before a reconnect uses the new cluster afterwards. Assigning one pins it
+  // on that instance instead (tests, custom wiring).
+
+
+  pinHandle(kind, value) {
+    if (!Object.prototype.hasOwnProperty.call(this, "_pinned_handles")) {
+      Object.defineProperty(this, "_pinned_handles", {
+        value: {},
+        enumerable: false,
+        writable: true
+      });
+    }
+
+    this._pinned_handles[kind] = value;
+  }
+
+  pinnedHandle(kind) {
+    var pinned = this._pinned_handles;
+    return pinned && kind in pinned ? {
+      value: pinned[kind]
+    } : null;
+  }
+
+  handle(kind) {
+    var pinned = this.pinnedHandle(kind);
+    return pinned ? pinned.value : globalHandle(kind, this.connection_name);
+  }
+
+  get cluster() {
+    return this.handle("cluster");
+  }
+
+  set cluster(value) {
+    this.pinHandle("cluster", value);
+  }
+
+  get connection() {
+    return this.handle("connection");
+  }
+
+  set connection(value) {
+    this.pinHandle("connection", value);
+  }
+
+  get scope() {
+    return this.handle("scope");
+  }
+
+  set scope(value) {
+    this.pinHandle("scope", value);
+  }
+
+  get collection() {
+    var _this$_collection_cac;
+
+    var pinned = this.pinnedHandle("collection");
+    if (pinned) return pinned.value;
+    var scope = this.scope;
+    if (!scope) return undefined; // Collection handles are cheap but not free; cache one per scope object,
+    // which changes exactly when the connection is replaced.
+
+    if (((_this$_collection_cac = this._collection_cache) === null || _this$_collection_cac === void 0 ? void 0 : _this$_collection_cac.scope) !== scope) {
+      Object.defineProperty(this, "_collection_cache", {
+        value: {
+          scope,
+          collection: scope.collection(this.collection_name)
+        },
+        enumerable: false,
+        writable: true,
+        configurable: true
+      });
+    }
+
+    return this._collection_cache.collection;
+  }
+
+  set collection(value) {
+    this.pinHandle("collection", value);
+  }
+
+  get collection_manager() {
+    var _this$handle;
+
+    var pinned = this.pinnedHandle("collection_manager");
+    if (pinned) return pinned.value;
+    return (_this$handle = this.handle("bucket_handle")) === null || _this$handle === void 0 ? void 0 : _this$handle.collections();
+  }
+
+  set collection_manager(value) {
+    this.pinHandle("collection_manager", value);
+  }
+
+  get userManager() {
+    var _this$cluster;
+
+    var pinned = this.pinnedHandle("userManager");
+    if (pinned) return pinned.value;
+    return (_this$cluster = this.cluster) === null || _this$cluster === void 0 ? void 0 : _this$cluster.users();
+  }
+
+  set userManager(value) {
+    this.pinHandle("userManager", value);
+  }
+  /**
+   * Reports a finished operation to the health monitor. Only connectivity
+   * errors (timeouts, cancelled requests, service not available) count.
+   */
+
+
+  recordOutcome(error) {
+    health.recordOutcome(this.connection_name, error);
+  }
+
+  recordSettled(results) {
+    for (var result of results) {
+      if ((result === null || result === void 0 ? void 0 : result.status) === "rejected") this.recordOutcome(result.reason);
+    }
+  }
+
+  observe(operation) {
+    var _this = this;
+
+    return _asyncToGenerator(function* () {
+      try {
+        return yield operation;
+      } catch (error) {
+        _this.recordOutcome(error);
+
+        throw error;
+      }
+    })();
+  }
+  /** Per-connection health: healthy, reconnecting, generation, last error. */
+
+
+  static healthStatus() {
+    return health.status();
+  }
+  /** Probes a connection now and reconnects it if the probe fails. */
+
+
+  static checkHealth() {
+    var connection_name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "default";
+    return health.check(connection_name);
+  }
+  /** Opens a fresh cluster for a connection and swaps it in. */
+
+
+  static forceReconnect() {
+    var connection_name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "default";
+    return health.reconnect(connection_name);
+  }
+  /**
+   * Stops probing and reconnecting and closes replaced clusters still in
+   * their grace period. Call before closing `spice.database.clusters` on
+   * shutdown so a reconnect cannot race it.
+   */
+
+
+  static stopHealthMonitor() {
+    return health.stop();
   }
   /**
    * Lets the application decide per resource whether slow statements may
@@ -309,25 +489,15 @@ module.exports = class Database {
   }
 
   connect(connection_name, config) {
-    var _this = this;
-
     return _asyncToGenerator(function* () {
-      var connectOptions = {
-        username: config.username,
-        password: config.password
-      };
-
-      if (config.configProfile) {
-        connectOptions.configProfile = config.configProfile;
-      }
+      var {
+        cluster,
+        bucket,
+        scope,
+        collection
+      } = yield openHandles(config); // Watch the connection from here on and replace it if it wedges.
 
-      var cluster = yield couchbase.connect(config.nodes, connectOptions);
-      var bucket = cluster.bucket(config.bucket);
-      var collection;
-      var scope_name = _this.scope_name || config.scope || "_default";
-      var collection_name = _this.collection_name || config.collection || "_default";
-      var scope = bucket.scope(scope_name);
-      collection = bucket.scope(scope_name).collection(collection_name || "_default");
+      health.register(connection_name, config);
       return {
         connection: connection_name,
         bucket,
@@ -339,7 +509,7 @@ module.exports = class Database {
   }
 
   getUserManager(connection) {
-    return spice.database.clusters[connection].users();
+    return globalHandle("cluster", connection).users();
   }
 
   assignUserPermission() {
@@ -412,9 +582,9 @@ module.exports = class Database {
 
     return _asyncToGenerator(function* () {
       try {
-        var _spice2, _spice2$db, _spice2$db$collection;
+        var _spice3, _spice3$db, _spice3$db$collection;
 
-        if ((_spice2 = spice) === null || _spice2 === void 0 ? void 0 : (_spice2$db = _spice2.db) === null || _spice2$db === void 0 ? void 0 : (_spice2$db$collection = _spice2$db.collections) === null || _spice2$db$collection === void 0 ? void 0 : _spice2$db$collection.has(collection_name)) {
+        if ((_spice3 = spice) === null || _spice3 === void 0 ? void 0 : (_spice3$db = _spice3.db) === null || _spice3$db === void 0 ? void 0 : (_spice3$db$collection = _spice3$db.collections) === null || _spice3$db$collection === void 0 ? void 0 : _spice3$db$collection.has(collection_name)) {
           return true;
         } else {
           var response = yield _this4.cluster.query("SELECT RAW keyspace_id\n           FROM system:keyspaces\n           WHERE bucket_id = ?\n             AND scope_id = ?\n             AND keyspace_id = ?\n           LIMIT 1", {
@@ -525,7 +695,7 @@ module.exports = class Database {
         var collection = _this9.use_bucket_name ? _this9.connection : _this9.collection;
 
         if (!useLookupIn) {
-          var response = yield collection.get(doc_id);
+          var response = yield _this9.observe(collection.get(doc_id));
           return _objectSpread({
             id: doc_id
           }, response.content);
@@ -543,7 +713,10 @@ module.exports = class Database {
           var specs = batch.map(col => couchbase.LookupInSpec.get(col));
           return collection.lookupIn(doc_id, specs);
         });
-        var batchResults = yield Promise.allSettled(batchPromises); // Merge results from all batches
+        var batchResults = yield Promise.allSettled(batchPromises);
+
+        _this9.recordSettled(batchResults); // Merge results from all batches
+
 
         batchResults.forEach((result, batchIndex) => {
           if (result.status === "fulfilled" && result.value) {
@@ -567,9 +740,9 @@ module.exports = class Database {
 
     return _asyncToGenerator(function* () {
       try {
-        yield (_this10.use_bucket_name ? _this10.connection : _this10.collection).insert(doc_id, document, {
+        yield _this10.observe((_this10.use_bucket_name ? _this10.connection : _this10.collection).insert(doc_id, document, {
           expiry: expiry
-        });
+        }));
       } catch (e) {
         console.log(e.message, e, doc_id);
       }
@@ -583,7 +756,7 @@ module.exports = class Database {
 
     var expiry = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
     return _asyncToGenerator(function* () {
-      yield (_this11.use_bucket_name ? _this11.connection : _this11.collection).touch(doc_id, expiry);
+      yield _this11.observe((_this11.use_bucket_name ? _this11.connection : _this11.collection).touch(doc_id, expiry));
       return yield _this11.get(doc_id);
     })();
   }
@@ -592,9 +765,9 @@ module.exports = class Database {
     var _this12 = this;
 
     return _asyncToGenerator(function* () {
-      var res = yield (_this12.use_bucket_name ? _this12.connection : _this12.collection).counter(doc_id, adjustment, {
+      var res = yield _this12.observe((_this12.use_bucket_name ? _this12.connection : _this12.collection).counter(doc_id, adjustment, {
         initial: initial_value
-      });
+      }));
       return res.value;
     })();
   }
@@ -603,9 +776,9 @@ module.exports = class Database {
     var _this13 = this;
 
     return _asyncToGenerator(function* () {
-      var res = yield (_this13.use_bucket_name ? _this13.connection : _this13.collection).replace(doc_id, document, {
+      var res = yield _this13.observe((_this13.use_bucket_name ? _this13.connection : _this13.collection).replace(doc_id, document, {
         expiry: expiry
-      });
+      }));
       return res.value;
     })();
   }
@@ -614,7 +787,7 @@ module.exports = class Database {
     var _this14 = this;
 
     return _asyncToGenerator(function* () {
-      var res = yield (_this14.use_bucket_name ? _this14.connection : _this14.collection).remove(doc_id);
+      var res = yield _this14.observe((_this14.use_bucket_name ? _this14.connection : _this14.collection).remove(doc_id));
       return res.value;
     })();
   }
@@ -641,6 +814,8 @@ module.exports = class Database {
 
           var returned_all = yield Promise.allSettled(functions);
 
+          _this15.recordSettled(returned_all);
+
           var responses = _.flatten(_.map(returned_all, returned_obj => returned_obj === null || returned_obj === void 0 ? void 0 : returned_obj.value));
 
           var _final_responses = _.compact(_.map(responses, (res, index) => {
@@ -679,7 +854,10 @@ module.exports = class Database {
                 var specs = batch.map(col => couchbase.LookupInSpec.get(col));
                 return collection.lookupIn(key, specs);
               });
-              var batchResults = yield Promise.allSettled(batchPromises); // Merge results from all batches
+              var batchResults = yield Promise.allSettled(batchPromises);
+
+              _this15.recordSettled(batchResults); // Merge results from all batches
+
 
               batchResults.forEach((result, batchIndex) => {
                 if (result.status === "fulfilled" && result.value) {
@@ -1106,7 +1284,7 @@ module.exports = class Database {
 
       var startTime = process.hrtime.bigint();
       var options = buildQueryOptions(query_options);
-      var response = yield exec_scope.query(sanitizedQuery, options); // End time
+      var response = yield _this20.observe(exec_scope.query(sanitizedQuery, options)); // End time
 
       var endTime = process.hrtime.bigint(); // Calculate duration in microseconds
 

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "spice-couchbase",
-  "version": "2.0.62",
+  "version": "2.0.63",
   "description": "",
   "main": "build/index.js",
   "scripts": {
     "test": "node src/utility.test.js",
     "test:auto-optimize": "node --test src/index.auto-optimize.test.js",
     "test:query-consistency": "node src/index.query-consistency.test.js",
-    "test:count-query": "node src/index.count-query.test.js"
+    "test:count-query": "node src/index.count-query.test.js",
+    "test:connection-health": "node --test src/connectionHealth.test.js"
   },
   "author": "Chad Fraser <chad@sonover.com> (http://sonover.com)",
   "license": "ISC",