adapt-authoring-mongodb 3.2.0 → 3.3.0

package/lib/MongoDBModule.js

@@ -158,6 +158,24 @@ class MongoDBModule extends AbstractModule {
     }
   }
 
+  /**
+   * Counts the documents matching a query. Normalises ObjectId strings the same way as {@link MongoDBModule#find} so callers get a count consistent with the documents a find would return.
+   * @param {String} collectionName The name of the MongoDB collection
+   * @param {Object} query
+   * @param {external:MongoDBCountDocumentsOptions} options Options to pass to the MongoDB driver
+   * @return {Promise} Resolves with the document count
+   * @see https://mongodb.github.io/node-mongodb-native/4.2/classes/Collection.html#countDocuments
+   */
+  async count (collectionName, query, options) {
+    convertObjectIds(query)
+    try {
+      return await this.getCollection(collectionName).countDocuments(query, options)
+    } catch (e) {
+      this.log('error', `failed to count docs, ${e.message}`)
+      throw this.getError(collectionName, 'count', e)
+    }
+  }
+
   /**
    * Updates an existing object in the database
    * @param {String} collectionName The name of the MongoDB collection

package/lib/typedefs.js

@@ -7,6 +7,12 @@
  * @external MongoDBCollection
  * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/api/classes/Collection.html}
  */
+/**
+ * Options passed to the countDocuments function
+ * @memberof mongodb
+ * @external MongoDBCountDocumentsOptions
+ * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/CountDocumentsOptions.html}
+ */
 /**
  * Options passed to the createIndex function
  * @memberof mongodb

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-mongodb",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Module for saving to a MongoDB instance",
   "homepage": "https://github.com/adapt-security/adapt-authoring-mongodb",
   "license": "GPL-3.0",

package/tests/MongoDBModule.spec.js

@@ -101,4 +101,26 @@ describe('MongoDBModule', () => {
       assert.equal(result.code, 'MONGO_ERROR')
     })
   })
+
+  describe('#count()', () => {
+    it('should convert ObjectId strings in the query before counting', async () => {
+      const { instance } = createInstance()
+      const countDocuments = mock.fn(async () => 3)
+      instance.getCollection = mock.fn(() => ({ countDocuments }))
+      const query = { _id: '507f1f77bcf86cd799439011' }
+      const result = await instance.count('courses', query)
+      assert.equal(result, 3)
+      const [received] = countDocuments.mock.calls[0].arguments
+      assert.equal(received._id.constructor.name, 'ObjectId')
+      assert.equal(received._id.toString(), '507f1f77bcf86cd799439011')
+    })
+
+    it('should wrap driver errors via getError', async () => {
+      const { instance } = createInstance()
+      instance.getCollection = mock.fn(() => ({
+        countDocuments: mock.fn(async () => { throw new Error('boom') })
+      }))
+      await assert.rejects(() => instance.count('courses', {}), e => e.code === 'MONGO_ERROR')
+    })
+  })
 })