@discue/mongodb-resource-client

mongodb-resource-client

Light wrapper around MongoDB client library to allow for easier management of resources and documents. All storage modules are based on the best practices described in the article 6 Rules of Thumb for MongoDB Schema Design from the official MongoDB blog.

Please read the installation instructions mentioned below.

Installation

This module has built-in support for tracing via Open Telemetry. The necessary dependencies are not declared in the module's package.json to allow applications to enable or disable the tracing feature.

Install with support for tracing

npm i @discue/mongodb-resource-client @discue/open-telemetry-tracing

Install without tracing features

npm i @discue/mongodb-resource-client @discue/open-telemetry-tracing@npm:@discue/open-telemetry-tracing-noop

Component References

• Aggregations
• EventEmitter
• OneToFewRefStorage
• OneToFewResourceStorage
• OneToManyResourceStorage
• ResourceStorageHistory
• ResourceLock
• SimpleResourceStorage
• SimpleTimeseriesStorage

History / Auditing

The module provides support for history / auditing tables to keep track of changes made to documents by calling the enableHistory method.

import { MongoClient } from ('mongodb')
import { OneToFewResourceStorage, ResourceStorageHistory } from ('@discue/mongodb-resource-client')

const collectionName = 'api_clients'
const url = 'mongodb://127.0.0.1:27017'

const client = new MongoClient(url, {
  serverApi: { version: '1', strict: true, deprecationErrors: true }, // https://www.mongodb.com/docs/manual/reference/stable-api/
})

const oneToFewResourceStorage = new OneToFewResourceStorage({
  client,
  collectionName,
  eventEmitter
})

oneToFewResourceStorage.enableHistory()

Transactions

The module supports transactions for atomic updates of multiple collections. However, as only MongoDB replica sets support transactions, transaction support needs to be explicitly enabled via setting the environment variable DSQ_MONGOD_ENABLE_TRANSACTIONS with value true.

Locks

The module supports creating locks. Meaning: A way to synchronize application functionality e.g. for rate limiting. Check out the ResourceLock documentation to find out more.

Database name

The database name can be configured via environment variable: DSQ_MONGODB_RESOURCE_CLIENT_DB_NAME

Tracing

This module has built-in support for tracing via Open Telemetry. Under the hood it uses @discue/open-telemetry-tracing.

Please read the installation instructions mentioned above.

Run tests

To run tests, run the following command

./test.sh

License

MIT

Changelog

1.0.0 (2024-08-13)

Features

• use es6 imports and new event listener interface (3c57fdf)

Refactorings

• add newline before each top-level describe (3e81549)
• do not destructure chai.expect twice (b85d32e)
• move tracing related method to base class (e4a311a)
• remove all use strict statements (e5a0fce)
• remove duplicate method (b1a0095)
• send close event from base class (598b24b)

Chores

• add eslint rules (f6bbad3)
• add jsdocs for history module (7a06f1b)
• convert to esm (60450af)
• deps-dev: bump @types/node from 20.14.10 to 22.0.2 (3ada0ca)
• deps-dev: bump eslint from 9.6.0 to 9.8.0 (7ce0d82)
• deps-dev: bump mocha from 10.6.0 to 10.7.0 (4fb1345)
• deps-dev: bump typescript from 5.4.5 to 5.5.2 (52c6183)
• deps-dev: bump typescript from 5.5.3 to 5.5.4 (c8eff71)
• deps: install emitter supporting to await listeners (4c18422)
• deps: update open telemetry tracing (64aa2d9)
• docs: add jsdoch for safe cursor methods (0e7b039)
• docs: mark private methods as private (45d32d4)
• docs: update readme (254b159)
• docs: use correct notation to specify options object for DATE_TRUNC (389194b)
• fail on error, do not generate md for missing files (7fa4b8e)
• lock: update jsdoc to enable better docs (355ee4d)
• remove docs of deleted component (3e83e58)
• update mongodb hostname for express gui (10caef5)
• use docker compose without hyphen to run compose commands (1781bb4)