npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sengi-docstore-mongodb

v14.0.0

Published

A document store for Sengi based on Mongo DB.

Downloads

5

Readme

Sengi DocStore MongoDB

This package is part of the Sengi family.

npm

A wrapper for Mongo DB that implements the Sengi document store interface.

Installation

npm install sengi-docstore-mongodb

Usage

The MongoDbDocStore implements the DocStore interface defined in sengi-interfaces.

To instantiate a MongoDbDocStore you have to provide the following parameters:

  • mongoUrl - A url that identifies your MongoDB instance. This should be prefixed with mongo://.

  • mongoOptions - An object that describes how to connect to mongo. This is passed directly to the MongoClient constructor. See the example below for connecting with a username and password.

  • generateDocVersionFunc - A function () => string that returns a string of random characters.

  • getDatabaseNameFunc - A function (docTypeName: string, docTypePluralName: string, options: DocStoreOptions) => string that returns the name of a database.

  • getCollectionNameFunc - A function (databaseName: string, docTypeName: string, docTypePluralName: string, options: DocStoreOptions) => string that returns the name of a collection.

const mongoDbDocStore = new MongoDbDocStore({
    mongoUrl: 'mongodb://localhost:27017',
    mongoOptions: {
      auth: { user: 'sengi', password: 'sengi' },
      useUnifiedTopology: true
    },
    generateDocVersionFunc: () => crypto.randomBytes(Math.ceil(10)).toString('hex').slice(0, 20),
    getDatabaseNameFunc = (docTypeName, docTypePluralName, options) => 'myDatabase',
    getCollectionNameFunc: (databaseName, docTableName, docTypePluralName, options) => docTypePluralName
  })

This example uses the standard NodeJs crypto library to produce a string of 20 random hex characters for generateDocVersionFunc.

Filters

Filter expressions are expected to be a FilterQuery<Doc> object.

The Mongo documentation explains how to specify filter objects in more detail.

This is an example filter expression returned from a DocType filter implementation:

const filter = {
  heightInCms: { $gt: 200 }
}

Indexes

See the Mongo documentation for setting up secondary indexes on Mongo collections.

Ensure any DocType filters will hit a specific index to ensure performant responses.

Limitations

The current MongoDB client library is connection-based rather than connection-less.

This can lead to some problems determining when to connect and how to handle interruptions to that connection.

Hopefully a connection-less version of the client library will be available in the future.

Setup

To run the tests locally you will need MongoDB listening at mongodb://127.0.0.1:27017 with an admin/root user named sengi and with password sengi.

The database sengi and collection trees, that are used by the automated tests, will be created automatically.

The following command sets up an appropriate local instance of Mongo via docker.

docker run -d --name test-mongo-with-sengi -p 127.0.0.1:27017:27017 \
  -e MONGO_INITDB_ROOT_USERNAME=sengi \
  -e MONGO_INITDB_ROOT_PASSWORD=sengi \
  mongo:4.2.9

You can connect to the server by using the Mongo SH client (mongosh) as per the example below. There is also a GUI tool you can download.

mongosh mongodb://127.0.0.1:27017 -u sengi -p sengi

You can issue the following commands, using Mongo SH client, to work with databases and collections. This is not required.

show databases
use sengi
show collections
db.createCollection('trees')
db.trees.drop()

Development

Tests are written using Jest with 100% coverage.

npm test

Note that the tests run sequentially (jest --runInBand) so that only one test can access the database at a time.

Continuous Deployment

Any pushes or pull-requests on non-master branches will trigger the test runner.

Any pushes to master will cause the family of libraries to be re-published.