Update BedrockErrors.

Author: dlongley

CHANGELOG.md

@@ -1,5 +1,11 @@
 # bedrock-mongodb ChangeLog
 
+## 11.0.0 - 2025-mm-dd
+
+### Changed
+- **BREAKING**: Use mongodb driver 6.x.
+- **BREAKING**: Update error names to match bedrock best practice.
+
 ## 10.2.0 - 2024-02-28
 
 ### Changed

lib/authn.js

@@ -174,12 +174,13 @@ function _checkServerVersion({serverInfo, config}) {
   });
   if(config.requirements.serverVersion &&
     !semver.satisfies(version, config.requirements.serverVersion)) {
-    throw new BedrockError(
-      'Unsupported database version.',
-      'DatabaseError', {
+    throw new BedrockError('Unsupported database version.', {
+      name: 'VersionError',
+      details: {
         url: urls.sanitize(config.url),
         version,
         required: config.requirements.serverVersion
-      });
+      }
+    });
   }
 }

lib/helpers.js

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2012 - 2024 Digital Bazaar, Inc.
+ * Copyright 2012 - 2025 Digital Bazaar, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,8 +25,6 @@ import {
   MDBE_DUPLICATE_ON_UPDATE
 } from './exceptions.js';
 
-const {util: {BedrockError}} = bedrock;
-
 // load config defaults
 import './config.js';
 
@@ -44,13 +42,9 @@ export const writeOptions = bedrock.config.mongodb.writeOptions;
  */
 export function hash(key) {
   if(typeof key !== 'string') {
-    throw new BedrockError(
-      'Invalid key given to database hash method.',
-      'InvalidKey', {key});
+    throw new TypeError('"key" must be a string.');
   }
-  const md = crypto.createHash('sha256');
-  md.update(key, 'utf8');
-  return md.digest('base64');
+  return crypto.createHash('sha256').update(key, 'utf8').digest('base64');
 }
 
 /**

lib/index.js

@@ -158,11 +158,11 @@ async function _init() {
     }
   } catch(error) {
     logger.error('could not initialize database', {error});
-    throw new BedrockError(
-      'Could not initialize database.',
-      'DatabaseError', {
-        url: urls.sanitize(config.url)
-      }, error);
+    throw new BedrockError('Could not initialize database.', {
+      name: 'OperationError',
+      details: {url: urls.sanitize(config.url)},
+      cause: error
+    });
   }
 }
 
@@ -185,22 +185,21 @@ async function _initDatabase() {
           ' username=' + config.username +
           ' url=' + urls.sanitize(config.url));
       }
-      throw new BedrockError(
-        'Could not initialize database.',
-        'DatabaseError', {
-          url: urls.sanitize(config.url),
-        }, e);
+      throw new BedrockError('Could not initialize database.', {
+        name: 'OperationError',
+        details: {url: urls.sanitize(config.url)},
+        cause: e
+      });
     }
   } finally {
     // force client to close connections (do not reuse connections used to init
     // database as other connections will be used later that may have different
     // credentials)
     if(client) {
       const force = true;
-      client.close(force).catch(error => {
-        logger.error(
-          'failed to close client used to initialize database', {error});
-      });
+      client.close(force).catch(
+        error => logger.error(
+          'failed to close client used to initialize database', {error}));
     }
   }
 }
@@ -210,7 +209,7 @@ async function _dropCollections() {
     throw new BedrockError(
       'If bedrock.config.mongodb.dropCollection.onInit is specified, ' +
       'bedrock.config.mongodb.dropCollection.collections must also ' +
-      'be specified.', 'InvalidConfiguration');
+      'be specified.', {name: 'DataError'});
   }
   // if collectionsToDrop array is empty, all collections should be dropped
   const cArray = bedrock.config.mongodb.dropCollections.collections;

test/mocha/10-api.js

@@ -57,7 +57,7 @@ describe('api', function() {
       should.exist(result);
       result.should.be.a('string');
     });
-    it('should throw InvalidKey error if key is not a string',
+    it('should throw TypeError error if key is not a string',
       async function() {
         let error;
         let result;
@@ -68,7 +68,7 @@ describe('api', function() {
         }
         should.not.exist(result);
         should.exist(error);
-        error.name.should.equal('InvalidKey');
+        error.name.should.equal('TypeError');
       });
   });
   describe('buildUpdate', function() {