cosa 6.1.0 → 6.3.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Losant IoT, Inc.
+Copyright (c) 2022 Losant IoT, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/db.js

@@ -3,7 +3,7 @@ const { ObjectId } = require('bson');
 const { EventEmitter } = require('events');
 const { MongoClient } = require('mongodb');
 const {
-  curry, split, last, pipe, isEmpty, clamp, isPlainObject
+  curry, split, last, pipe, clamp, isPlainObject, isNilOrEmpty
 } = require('omnibelt');
 const Immutable = require('./immutable');
 const RESULT_FIELDS = [ 'insertedId', 'insertedCount', 'insertedIds', 'matchedCount', 'modifiedCount', 'upsertedCount', 'upsertedId', 'deletedCount', 'upsertedIds' ];
@@ -182,6 +182,7 @@ class Database extends EventEmitter {
    * @param {number} [options.batchSize] - number of items per batch (default in mongo driver is 1000)
    * @param {boolean} [options.noCursorTimeout] - boolan, if the cursor can time out after being idle, mongo driver default is false
    * @param {number} [options.maxTimeMS] - maximum amount of time (in ms) this cursor is allowed to live
+   * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Cursor} returns Cursor object
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html}
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#find}
@@ -195,8 +196,9 @@ class Database extends EventEmitter {
   async find(collectionName, query, options = {}) {
     query = deserialize(query);
     const collection = await this.collection(collectionName);
+    const session = options.session?.mongoSession || options.session;
     if (options.count) {
-      if (!query || isEmpty(query)) {
+      if (isNilOrEmpty(query) && !session) {
         const countOptions = {
           readPreference: options.readPreference,
           maxTimeMS: options.maxTimeMS
@@ -209,7 +211,8 @@ class Database extends EventEmitter {
           limit: options.limit,
           skip: options.skip,
           readPreference: options.readPreference,
-          maxTimeMS: options.maxTimeMS
+          maxTimeMS: options.maxTimeMS,
+          session
         };
         debug(`db.${collection.collectionName}.countDocuments`, query, countOptions);
         return collection.countDocuments(query, countOptions);
@@ -221,10 +224,11 @@ class Database extends EventEmitter {
         sort: options.sort,
         readPreference: options.readPreference,
         noCursorTimeout: options.noCursorTimeout,
-        maxTimeMS: options.maxTimeMS
+        maxTimeMS: options.maxTimeMS,
+        session
       };
       debug(`db.${collection.collectionName}.findOne`, query, findOptions);
-      return collection.findOne(query, options);
+      return collection.findOne(query, findOptions);
     } else {
       const findOptions = {
         projection: options.projection || options.fields,
@@ -234,10 +238,11 @@ class Database extends EventEmitter {
         readPreference: options.readPreference,
         batchSize: options.batchSize,
         noCursorTimeout: options.noCursorTimeout,
-        maxTimeMS: options.maxTimeMS
+        maxTimeMS: options.maxTimeMS,
+        session
       };
       debug(`db.${collection.collectionName}.find`, query, findOptions);
-      return collection.find(query, options);
+      return collection.find(query, findOptions);
     }
   }
 
@@ -247,15 +252,19 @@ class Database extends EventEmitter {
    * @param {(object|Array)} docs - Documents objects to insert.
    * @param {object} options - options on insert
    * @param {object} [options.writeConcern] - the write concern
+   * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Promise} resolves with an object with results, and ops as keys
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#insertmany}
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#insertOne}
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/insertoneoptions.html#writeconcern}
    */
-  async insert(collectionName, docs, { writeConcern } = {}) {
+  async insert(collectionName, docs, { writeConcern, session } = {}) {
     docs = deserialize(docs);
     const collection = await this.collection(collectionName);
-    const results = await insertOneOrMany(collection, Array.isArray(docs), docs, { writeConcern });
+    const results = await insertOneOrMany(collection, Array.isArray(docs), docs, {
+      writeConcern,
+      session: session?.mongoSession || session
+    });
 
     if (Array.isArray(docs)) {
       docs.forEach((doc, i) => {
@@ -278,6 +287,7 @@ class Database extends EventEmitter {
    * @param {boolean} [options.multiple=false] - Should multiple documents be updated.
    * @param {boolean} [options.upsert=false] - Should documents be inserted if they don't already exist.
    * @param {object} [options.writeConcern] - the write concern options
+   * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Promise} resolves with an object with results, and ops as keys
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#updateMany}
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#updateOne}
@@ -289,7 +299,8 @@ class Database extends EventEmitter {
     const collection = await this.collection(collectionName);
     return updateOneOrMany(collection, options.multiple, query, update, {
       upsert: options.upsert,
-      writeConcern: options.writeConcern
+      writeConcern: options.writeConcern,
+      session: options.session?.mongoSession || options.session
     });
   }
 
@@ -300,6 +311,7 @@ class Database extends EventEmitter {
    * @param {object} [options] - Optional settings see mongo documentation
    * @param {boolean} [options.multiple=false] - Should multiple documents be removed.
    * @param {object} [options.writeConcern] - the write concern options
+   * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Promise} resolves with an object with results, and ops as keys
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#deleteMany}
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#deleteOne}
@@ -308,7 +320,10 @@ class Database extends EventEmitter {
   async remove(collectionName, query, options = {}) {
     query = deserialize(query);
     const collection = await this.collection(collectionName);
-    return deleteOneOrMany(collection, options.multiple, query, { writeConcern: options.writeConcern });
+    return deleteOneOrMany(collection, options.multiple, query, {
+      writeConcern: options.writeConcern,
+      session: options.session?.mongoSession || options.session
+    });
   }
 
   /**
@@ -319,6 +334,7 @@ class Database extends EventEmitter {
    * @param {object} [options.readPreference] - the read preference for the query with one of the read constants
    * @param {number} [options.batchSize] - number of items per batch (default in mongo driver is 1000)
    * @param {number} [options.maxTimeMS] - maximum amount of time (in ms) this cursor is allowed to live
+   * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Promise} resolves with the result of the aggregation from mongo
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#aggregate}
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/aggregateoptions.html#readpreference}
@@ -330,7 +346,8 @@ class Database extends EventEmitter {
     return collection.aggregate(pipeline, {
       readPreference: options.readPreference,
       batchSize: options.batchSize,
-      maxTimeMS: options.maxTimeMS
+      maxTimeMS: options.maxTimeMS,
+      session: options.session?.mongoSession || options.session
     });
   }
 
@@ -342,6 +359,7 @@ class Database extends EventEmitter {
    * @param {object} [options] - Optional settings see mongo documentation
    * @param {string} [options.readPreference] - the read preference for the query
    * @param {number} [options.maxTimeMS] - maximum amount of time (in ms) this cursor is allowed to live
+   * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Promise} resolves with the result of the distinct query from mongo
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#distinct}
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/commandoperationoptions.html#readpreference}
@@ -352,7 +370,8 @@ class Database extends EventEmitter {
     const collection = await this.collection(collectionName);
     return collection.distinct(key, query, {
       readPreference: options.readPreference,
-      maxTimeMS: options.maxTimeMS
+      maxTimeMS: options.maxTimeMS,
+      session: options.session?.mongoSession || options.session
     });
   }
 
@@ -363,16 +382,20 @@ class Database extends EventEmitter {
    * @param {object} replace - doc to save on the collection
    * @param {object} [options] - Optional settings see mongo documentation
    * @param {object} [options.writeConcern] - the write concern options
+   * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Promise} resolves with the result of the distinct query from mongo
    * @see {@link http://mongodb.github.io/node-mongodb-native/3.0/api/Collection.html#replace}
    * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/replaceoptions.html#writeconcern}
    */
-  async replace(collectionName, query, replace, { writeConcern } = {}) {
+  async replace(collectionName, query, replace, { writeConcern, session } = {}) {
     const collection = await this.collection(collectionName);
     query = deserialize(query);
     replace = deserialize(replace);
     debug(`db.${collection.collectionName}.replaceOne`, query, replace);
-    const r = await collection.replaceOne(query, replace, { writeConcern });
+    const r = await collection.replaceOne(query, replace, {
+      writeConcern,
+      session: session?.mongoSession || session
+    });
     r.ops = replace;
     return normalizeResult(r);
   }

package/lib/model.js

@@ -116,7 +116,7 @@ const _create = (data, definition) => {
       await context.beforeSave.apply(obj, [options]);
     }
     obj = await context._validate(obj, options);
-    const original = obj.__original;
+    const original = obj.__original || null;
     obj = removeMeta(obj);
     const newEtag = etag(JSON.stringify(obj));
     const collection = definition.collection;
@@ -159,10 +159,27 @@ const _create = (data, definition) => {
       obj = Array.isArray(result.ops) ? result.ops[0] : result.ops;
       newOrUpdatedModel = _create(obj, definition);
     }
-    if ('function' === typeof newOrUpdatedModel.afterSave) {
-      // should not be awaited
-      const afterSave = newOrUpdatedModel.afterSave(original || null, options);
-      if (options.waitAfterSave) { await afterSave; }
+    if (options.session) {
+      if ('function' === typeof newOrUpdatedModel.afterSave) {
+        await newOrUpdatedModel.afterSave(original, options);
+      }
+      if ('function' === typeof newOrUpdatedModel.afterSaveCommit) {
+        options.session.afterCommits.push(() => newOrUpdatedModel.afterSaveCommit(original, options));
+      }
+      if ('function' === typeof newOrUpdatedModel.afterSaveAbort) {
+        options.session.afterAborts.push(() => newOrUpdatedModel.afterSaveAbort(original, options));
+      }
+    } else {
+      let chain = Promise.resolve();
+      if ('function' === typeof newOrUpdatedModel.afterSave) {
+        chain = chain.then(() => newOrUpdatedModel.afterSave(original, options));
+      }
+      if ('function' === typeof newOrUpdatedModel.afterSaveCommit) {
+        chain = chain.then(() => newOrUpdatedModel.afterSaveCommit(original, options));
+      }
+      if (options.waitAfterSave) {
+        await chain;
+      }
     }
     return newOrUpdatedModel;
   };
@@ -297,10 +314,30 @@ const _create = (data, definition) => {
       throw errors.Conflict({ message: 'Document remove conflict' });
     }
     debug(`remove from ${collection} successful`);
-    if ('function' === typeof this.afterRemove) {
-      const afterRemove = this.afterRemove(options);
-      if (options.waitAfterRemove) { await afterRemove; }
+
+    if (options.session) {
+      if ('function' === typeof this.afterRemove) {
+        await this.afterRemove(options);
+      }
+      if ('function' === typeof this.afterRemoveCommit) {
+        options.session.afterCommits.push(() => this.afterRemoveCommit(options));
+      }
+      if ('function' === typeof this.afterRemoveAbort) {
+        options.session.afterAborts.push(() => this.afterRemoveAbort(options));
+      }
+    } else {
+      let chain = Promise.resolve();
+      if ('function' === typeof this.afterRemove) {
+        chain = chain.then(() => this.afterRemove(options));
+      }
+      if ('function' === typeof this.afterRemoveCommit) {
+        chain = chain.then(() => this.afterRemoveCommit(options));
+      }
+      if (options.waitAfterRemove) {
+        await chain;
+      }
     }
+
     return result;
   };
 

package/lib/session.js

@@ -0,0 +1,54 @@
+const db = require('./db');
+const { forEachSerialP } = require('omnibelt');
+
+const createSession = async () => {
+  const afterCommits = [];
+  const afterAborts = [];
+  if (!db._client) {
+    await db.init();
+  }
+  const session = await db._client.startSession();
+
+  const abortTransaction = async () => {
+    const errors = [];
+    await session.abortTransaction();
+    await session.endSession();
+    await forEachSerialP(async (afterAborted) => {
+      try {
+        await afterAborted();
+      } catch (err) {
+        errors.push(err);
+      }
+    }, afterAborts);
+    return { errors };
+  };
+
+  return {
+    get mongoSession() {
+      return session;
+    },
+    startTransaction: () => {
+      return session.startTransaction();
+    },
+    commitTransaction: async () => {
+      const errors = [];
+      await session.commitTransaction();
+      await session.endSession();
+      await forEachSerialP(async (afterCommitFunc) => {
+        try {
+          await afterCommitFunc();
+        } catch (err) {
+          errors.push(err);
+        }
+      }, afterCommits);
+      return { errors };
+    },
+    abortTransaction,
+    afterCommits,
+    afterAborts
+  };
+};
+
+module.exports = {
+  createSession
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cosa",
-  "version": "6.1.0",
+  "version": "6.3.0",
   "description": "Cosa Models for MongoDB",
   "main": "lib/index.js",
   "engines": {
@@ -35,25 +35,25 @@
     "lib"
   ],
   "dependencies": {
-    "bson": "~4.5.2",
+    "bson": "~4.7.0",
     "clone": "^2.1.2",
-    "debug": "^4.3.2",
+    "debug": "^4.3.4",
     "error": "^7.0.2",
     "etag": "^1.8.1",
     "@hapi/joi": "^17.1.1",
-    "mongodb": "~4.1.2",
+    "mongodb": "~4.10.0",
     "object-path": "^0.11.8",
     "omnibelt": "^2.1.0"
   },
   "devDependencies": {
-    "@losant/eslint-config-losant": "^1.4.3",
-    "husky": "^7.0.2",
-    "lint-staged": "^11.1.2",
-    "chai": "^4.3.4",
+    "@losant/eslint-config-losant": "^1.4.4",
+    "husky": "^8.0.1",
+    "lint-staged": "^13.0.3",
+    "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
     "chai-datetime": "^1.8.0",
-    "documentation": "^13.2.5",
-    "mocha": "^9.1.1",
+    "documentation": "^14.0.0",
+    "mocha": "^10.0.0",
     "string-template": "^1.0.0"
   },
   "eslintConfig": {