REST server that indexes search documents within an Atlas cluster and handles user search requests, deployed via Kanopy

REST server that exposes endpoints to run queries against Atlas DB.

Module to invoke Atlas Admin commands via the Atlas Admin API, specifically manages the Atlas Search Index for Search DB.

Service to read and write from Atlas DB. Transports input manifest documents into Atlas DB. Also reads DB results for server requests and returns formatted responses.

Query class that builds aggregation operations based off request query parameters.

npm install

Create a .env file and copy over the contents of sample.env. Some values may have to be added or replaced. If adding a new environment variable, please add the name and a sample value to the sample.env.

$ npm run build
$ npm run search-transport

The server will be running on port 8080. To make a query, make a request to localhost:8080/search?q=<your query here> using the browser, Postman, etc.

Available query parameters:

• (required) q - string to be queried (e.g. findbyidandupdate)
• (optional) searchProperty - which docs property the query should be refined by (e.g. manual)
• (optional) page - which page of results to display (e.g. 2)
• (optional) facets.target_product>product>sub_product or facets.target_product - a list of selected facets/subfacets

A request might look like http://localhost:8080/search/?q=filter&facets.target_product=atlas&facets.target_product>atlas>sub_product=atlas-app-services.

A node debugger (ie. chrome developer tools) can be connected to the built JS files.

All commits pushed to a branch with branchname DOP-* will be deployed to the dev instance of search transport. The dev instance is viewable at https://docs-search-transport-dev.docs.staging.corp.mongodb.com/status

All commits merged to main deploy via Kanopy to a staging instance. The staging instance is viewable at https://docs-search-transport.docs.staging.corp.mongodb.com/status.

New release tags automatically begin deployment via Kanopy to production instances.

Cutting a release with a new tag via the Github UI is the recommended method of deploying to production. As a matter of practice, release tags should be cut from main.

Tests can be run using:

npm test  # alias for npm run test

Tests are located in the tests directory, and run via mocha.

npm run test

We use ESLint and Prettier to help with linting and style.

npm run lint:fix

To format code using Prettier, run the following command:

npm run format:fix

We have set up a precommit hook that will format staged files. Prettier also offers a variety of editor integrations to automatically format your code.