adapt-authoring-mongodb 3.1.0 → 3.3.0

package/.github/workflows/releases.yml

@@ -1,32 +1,17 @@
 name: Release
+
 on:
   push:
     branches:
       - master
 
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+  id-token: write
+  packages: write
+
 jobs:
   release:
-    name: Release
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write # to be able to publish a GitHub release
-      issues: write # to be able to comment on released issues
-      pull-requests: write # to be able to comment on released pull requests
-      id-token: write # to enable use of OIDC for trusted publishing and npm provenance
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: 'lts/*'
-      - name: Update npm
-        run: npm install -g npm@latest
-      - name: Install dependencies
-        run: npm install
-      - name: Release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npx semantic-release
+    uses: adaptlearning/semantic-release-config/.github/workflows/release.yml@master

package/lib/MongoDBModule.js

@@ -12,7 +12,6 @@ import { parseObjectId } from './utils/parseObjectId.js'
 class MongoDBModule extends AbstractModule {
   /** @override */
   async init () {
-    await this.app.waitForModule('config')
     /**
      * Reference to the MongDB client
      * @type {external:MongoDBMongoClient}
@@ -159,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/lib/utils/findDuplicates.js

@@ -1,6 +1,6 @@
 /**
  * Finds documents with duplicate values for the given index fields.
- * @param {import('mongodb').Collection} collection The MongoDB collection to search
+ * @param {external:MongoDBCollection} collection The MongoDB collection to search
  * @param {String|Object} fieldOrSpec The index field spec (string key or object with field:direction pairs)
  * @returns {Promise<Array<{keyValue: Object, _ids: Array}>>} Array of duplicate groups
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-mongodb",
-  "version": "3.1.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",
@@ -8,46 +8,19 @@
   "main": "index.js",
   "repository": "github:adapt-security/adapt-authoring-mongodb",
   "dependencies": {
-    "adapt-authoring-core": "^2.0.0",
+    "adapt-authoring-core": "^3.0.0",
     "mongodb": "^7.0.0"
   },
   "peerDependencies": {
-    "adapt-authoring-config": "^1.3.0",
-    "adapt-authoring-core": "^2.0.0",
+    "adapt-authoring-core": "^3.0.0",
     "adapt-authoring-jsonschema": "^1.2.2"
   },
   "devDependencies": {
-    "@semantic-release/git": "^10.0.1",
-    "conventional-changelog-eslint": "^6.0.0",
-    "semantic-release": "^25.0.2",
+    "@adaptlearning/semantic-release-config": "^1.0.0",
     "standard": "^17.1.0"
   },
   "release": {
-    "plugins": [
-      [
-        "@semantic-release/commit-analyzer",
-        {
-          "preset": "eslint"
-        }
-      ],
-      [
-        "@semantic-release/release-notes-generator",
-        {
-          "preset": "eslint"
-        }
-      ],
-      "@semantic-release/npm",
-      "@semantic-release/github",
-      [
-        "@semantic-release/git",
-        {
-          "assets": [
-            "package.json"
-          ],
-          "message": "Chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-        }
-      ]
-    ]
+    "extends": "@adaptlearning/semantic-release-config"
   },
   "scripts": {
     "test": "node --test 'tests/**/*.spec.js'"

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')
+    })
+  })
 })