@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

History / Auditing

The module provides support for history / auditing tables to keep track of changes made to documents. The ResourceStorageHistory component can be used as an extension of a storage instance e.g. SimpleResourceStorage. An instance of ResourceStorageHistory can listen to storage events of another storage instance and populate a ${resourceName}_history collection with timestamp, change type, and the full resource state.

const { MongoClient } = require('mongodb')
const { EventEmiter } = require('events')
const { OneToFewResourceStorage, ResourceStorageHistory } = require('@discue/mongodb-resource-client')

const eventEmitter = new EventEmitter()
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
})

const history = new ResourceStorageHistory({
  client,
  collectionName,
  usageEventPrefix: oneToFewResourceStorage.usageEventPrefix
  eventEmitter
})
history.listenForStorageEvents()

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