@apostrophecms/emulate-mongo-3-driver

@apostrophecms/emulate-mongo-3-driver

Purpose

You have legacy code that depends on the 3.x version of the MongoDB Node.js driver. You don't want to upgrade to the 6.x driver because of backwards compability problems in v4, v5, v6 but you don't have a choice because of reported vulnerabilities such as those detected by npm audit.

@apostrophecms/emulate-mongo-3-driver aims to be a compatible emulation of the 3.x version of the MongoDB Node.js driver, implemented as a wrapper for the 6.x driver.

It was created for long term support of ApostropheCMS. Of course, ApostropheCMS 3.x and 4.x will use the MongoDB 6.x driver directly.

Usage

If you are using ApostropheCMS, this is standard beginning with versions 3.64.0+ and 4.2.0+. You don't have to do anything.

The example below is for those who wish to use this driver in non-ApostropheCMS projects.

npm install @apostrophecms/emulate-mongo-3-driver

const mongo = require('@apostrophecms/emulate-mongo-3-driver');

// Use it here as if it were the 3.x driver

Goals

This module aims for partial compatibility with the features mentioned as obsolete or changed in v4, v5, v6 but there are omissions.

An emphasis has been placed on features used by ApostropheCMS but PRs for further compatibility are welcome.

What about those warnings?

"What about the warnings re: insert, update and ensureIndex operations being obsolete?"

Although deprecated, some of these operations are still supported by the 6.x driver and work just fine.

However, since the preferred newer operations were also supported by the 3.x driver, the path forward is clear.

We will migrate away from using them gradually, and you should do the same.

It doesn't make sense to provide "deprecation-free" wrappers when doing the right thing is in easy reach.

Changelog

1.0.6 (2024-07-19)

Changes

• Reset sort when using find-cursor.count due to internal code using projection with { _id: 1 }.