@villedemontreal/mongo 7.1.1 → 7.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@villedemontreal/mongo",
-  "version": "7.1.1",
+  "version": "7.1.2",
   "description": "Utilities for Mongo / Mongoose",
   "main": "dist/src/index.js",
   "typings": "dist/src",
@@ -29,15 +29,15 @@
   "author": "Ville de Montréal",
   "license": "MIT",
   "dependencies": {
-    "@villedemontreal/general-utils": "5.16.8",
-    "@villedemontreal/logger": "6.5.9",
+    "@villedemontreal/general-utils": "5.17.4",
+    "@villedemontreal/logger": "6.6.2",
     "app-root-path": "3.1.0",
     "fs-extra": "10.1.0",
     "http-status-codes": "2.2.0",
     "lodash": "4.17.21",
-    "mongodb": "4.16.0",
+    "mongodb": "4.17.2",
     "mongodb-memory-server-core": "8.6.1",
-    "mongoose": "6.11.3",
+    "mongoose": "6.12.6",
     "semver": "7.5.2"
   },
   "devDependencies": {
@@ -50,11 +50,11 @@
     "@types/sinon": "10.0.13",
     "@typescript-eslint/eslint-plugin": "5.59.2",
     "@typescript-eslint/parser": "5.59.2",
-    "@villedemontreal/scripting": "2.1.6",
+    "@villedemontreal/scripting": "2.1.8",
     "chai": "4.3.7",
     "eslint": "8.40.0",
     "eslint-config-prettier": "8.8.0",
-    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-prettier": "5.1.3",
     "mocha": "9.2.2",
     "mocha-jenkins-reporter": "0.4.8",
     "nyc": "15.1.0",

package/src/config/mongooseConfigs.ts

@@ -126,7 +126,7 @@ export class MongooseConfigs implements IMongooseConfigs {
     if (!_.isNil(overridingConfigs.updater.lockMaxAgeSeconds)) {
       if (!utils.isIntegerValue(overridingConfigs.updater.lockMaxAgeSeconds, true, false)) {
         throw new Error(
-          `The updater.lockMaxAgeSeconds config is not valid : ${overridingConfigs.updater.lockMaxAgeSeconds}`
+          `The updater.lockMaxAgeSeconds config is not valid : ${overridingConfigs.updater.lockMaxAgeSeconds}`,
         );
       }
       this.updater.lockMaxAgeSeconds = Number(overridingConfigs.updater.lockMaxAgeSeconds);
@@ -138,7 +138,7 @@ export class MongooseConfigs implements IMongooseConfigs {
         utils.isBlank(overridingConfigs.updater.appSchemaCollectionName)
       ) {
         throw new Error(
-          `The appSchemaCollectionName config is not valid : ${overridingConfigs.updater.appSchemaCollectionName}`
+          `The appSchemaCollectionName config is not valid : ${overridingConfigs.updater.appSchemaCollectionName}`,
         );
       }
       this.updater.appSchemaCollectionName = overridingConfigs.updater.appSchemaCollectionName;
@@ -147,7 +147,7 @@ export class MongooseConfigs implements IMongooseConfigs {
     if (!_.isNil(overridingConfigs.applyUpdates)) {
       if (!_.isBoolean(overridingConfigs.applyUpdates)) {
         throw new Error(
-          `The applyUpdates config must be a boolean: ${overridingConfigs.applyUpdates}`
+          `The applyUpdates config must be a boolean: ${overridingConfigs.applyUpdates}`,
         );
       }
       this.applyUpdates = overridingConfigs.applyUpdates;
@@ -159,20 +159,20 @@ export class MongooseConfigs implements IMongooseConfigs {
         utils.isBlank(overridingConfigs.connectionString)
       ) {
         throw new Error(
-          `The connectionString config is not valid : ${overridingConfigs.connectionString}`
+          `The connectionString config is not valid : ${overridingConfigs.connectionString}`,
         );
       }
       this.connectionString = overridingConfigs.connectionString;
     } else {
       logger.warning(
-        `No "connectionString" config was provided: a *mocked* Mongo server will be used!`
+        `No "connectionString" config was provided: a *mocked* Mongo server will be used!`,
       );
     }
 
     if (!_.isNil(overridingConfigs.connectionOptions)) {
       if (!_.isObject(overridingConfigs.connectionOptions)) {
         throw new Error(
-          `The connectionOptions config is not valid : ${overridingConfigs.connectionString}`
+          `The connectionOptions config is not valid : ${overridingConfigs.connectionString}`,
         );
       }
       this.connectionOptions = overridingConfigs.connectionOptions;
@@ -187,7 +187,7 @@ export class MongooseConfigs implements IMongooseConfigs {
         utils.isBlank(overridingConfigs.mockServer.serverVersion)
       ) {
         throw new Error(
-          `The mockServer.serverVersion config is not valid : ${overridingConfigs.mockServer.serverVersion}`
+          `The mockServer.serverVersion config is not valid : ${overridingConfigs.mockServer.serverVersion}`,
         );
       }
       this.mockServer.serverVersion = overridingConfigs.mockServer.serverVersion;

package/src/mongoClient.ts

@@ -13,7 +13,7 @@ let mongooseConnection: mongoose.Connection;
 async function doInitMongoose(
   mongooseConfigClean: MongooseConfigs,
   resolve: (value: mongoose.Connection) => void,
-  reject: (reason?: any) => void
+  reject: (reason?: any) => void,
 ): Promise<void> {
   let connectionString = mongooseConfigClean.connectionString;
 
@@ -26,7 +26,7 @@ async function doInitMongoose(
     // ==========================================
     const mongoServer = await mongoUtils.mockMongoose(
       null,
-      mongooseConfigClean.mockServer.serverVersion
+      mongooseConfigClean.mockServer.serverVersion,
     );
 
     connectionString = mongoServer.getUri();
@@ -113,7 +113,7 @@ async function checkForUpdates(mongooseConfig: IMongooseConfigs): Promise<void>
     connection.db,
     mongooseConfig.updater.mongoSchemaUpdatesDirPath,
     mongooseConfig.updater.lockMaxAgeSeconds,
-    mongooseConfig.updater.appSchemaCollectionName
+    mongooseConfig.updater.appSchemaCollectionName,
   );
   await updater.checkInstallation();
   await updater.checkUpdates();

package/src/mongoUpdater.test.ts

@@ -39,7 +39,7 @@ describe('Mongo Updater', () => {
       mongoDb,
       testconfig.updater.mongoSchemaUpdatesDirPath,
       testconfig.updater.lockMaxAgeSeconds,
-      testconfig.updater.appSchemaCollectionName
+      testconfig.updater.appSchemaCollectionName,
     );
   });
 
@@ -101,7 +101,7 @@ describe('Mongo Updater', () => {
       assert.strictEqual(collections[0].name, testconfig.updater.appSchemaCollectionName);
 
       const schema: MongoDb.Collection = mongoDb.collection(
-        testconfig.updater.appSchemaCollectionName
+        testconfig.updater.appSchemaCollectionName,
       );
       const schemaDb: any[] = await schema.find().toArray();
       assert.strictEqual(schemaDb[0].version, '0.0.0');
@@ -118,7 +118,7 @@ describe('Mongo Updater', () => {
   describe('lock', () => {
     it('lock should be equal to false', async () => {
       const schema: MongoDb.Collection = mongoDb.collection(
-        testconfig.updater.appSchemaCollectionName
+        testconfig.updater.appSchemaCollectionName,
       );
       const schemaDb: any[] = await schema.find().toArray();
       assert.strictEqual(schemaDb[0].lock, false);
@@ -131,7 +131,7 @@ describe('Mongo Updater', () => {
 
     it('lock should be equal to true', async () => {
       const schema: MongoDb.Collection = mongoDb.collection(
-        testconfig.updater.appSchemaCollectionName
+        testconfig.updater.appSchemaCollectionName,
       );
       const schemaDb: any[] = await schema.find().toArray();
       assert.strictEqual(schemaDb[0].lock, true);
@@ -146,7 +146,7 @@ describe('Mongo Updater', () => {
   describe('unlock', () => {
     it('lock should be equal to true', async () => {
       const schema: MongoDb.Collection = mongoDb.collection(
-        testconfig.updater.appSchemaCollectionName
+        testconfig.updater.appSchemaCollectionName,
       );
       const schemaDb: any[] = await schema.find().toArray();
       assert.strictEqual(schemaDb[0].lock, true);
@@ -159,7 +159,7 @@ describe('Mongo Updater', () => {
 
     it('lock should be equal to false', async () => {
       const schema: MongoDb.Collection = mongoDb.collection(
-        testconfig.updater.appSchemaCollectionName
+        testconfig.updater.appSchemaCollectionName,
       );
       const schemaDb: any[] = await schema.find().toArray();
       assert.strictEqual(schemaDb[0].lock, false);
@@ -170,7 +170,7 @@ describe('Mongo Updater', () => {
       assert.strictEqual(isUnlocked, false);
 
       const schema: MongoDb.Collection = mongoDb.collection(
-        testconfig.updater.appSchemaCollectionName
+        testconfig.updater.appSchemaCollectionName,
       );
       const schemaDb: any[] = await schema.find().toArray();
       assert.strictEqual(schemaDb[0].lock, false);

package/src/mongoUpdater.ts

@@ -89,7 +89,7 @@ export class MongoUpdater implements IMongoUpdater {
      */
     private mongoSchemaUpdatesDirPath: string,
     private lockMaxAgeSeconds: number,
-    private appSchemaCollectionName: string
+    private appSchemaCollectionName: string,
   ) {}
 
   public async installAppSchemaCollection(): Promise<any> {
@@ -98,7 +98,7 @@ export class MongoUpdater implements IMongoUpdater {
       // tslint:disable-next-line: prefer-template
       logger.info(' > Installing the "' + this.appSchemaCollectionName + '" collection.');
       const collection: MongoDb.Collection = await this.mongoDb.createCollection(
-        this.appSchemaCollectionName
+        this.appSchemaCollectionName,
       );
 
       // ==========================================
@@ -162,13 +162,13 @@ export class MongoUpdater implements IMongoUpdater {
     await appSchemaCollection.updateOne({}, { $set: { version: newVersion } });
     // tslint:disable-next-line: prefer-template
     logger.info(
-      ' > MongoDB App Schema updagred from version ' + currentVersion + ' to version ' + newVersion
+      ' > MongoDB App Schema updagred from version ' + currentVersion + ' to version ' + newVersion,
     );
   }
 
   public async getAppSchemaUpdateFiles(
     currentAppSchemaVersion: string,
-    targetAppSchemaVersion: string
+    targetAppSchemaVersion: string,
   ): Promise<string[]> {
     return new Promise<string[]>((resolve, reject) => {
       fs.readdir(this.getAppSchemaFilesDirPath(), (err, files) => {
@@ -206,7 +206,7 @@ export class MongoUpdater implements IMongoUpdater {
   public async applyAppSchemaUpdates(currentVersion: string, newVersion: string): Promise<void> {
     const updateFileNames: string[] = await this.getAppSchemaUpdateFiles(
       currentVersion,
-      newVersion
+      newVersion,
     );
     if (updateFileNames.length > 0) {
       for (const updateFileName of updateFileNames) {
@@ -224,7 +224,7 @@ export class MongoUpdater implements IMongoUpdater {
         if (!isFunction(updateFunction)) {
           return Promise.reject(
             'The default export for an app schema update file must be a function! Was not for file : ' +
-              updateFilePath
+              updateFilePath,
           );
         }
 
@@ -269,7 +269,7 @@ export class MongoUpdater implements IMongoUpdater {
           lock: true,
           lockTimestamp: new Date().getTime(),
         },
-      }
+      },
     );
 
     if (document.value !== null) {
@@ -301,7 +301,7 @@ export class MongoUpdater implements IMongoUpdater {
             lock: true,
             lockTimestamp: new Date().getTime(),
           },
-        }
+        },
       );
 
       // ==========================================
@@ -331,7 +331,7 @@ export class MongoUpdater implements IMongoUpdater {
           lock: false,
           lockTimestamp: 0,
         },
-      }
+      },
     );
 
     if (document.value !== null) {
@@ -345,7 +345,7 @@ export class MongoUpdater implements IMongoUpdater {
 
   public async checkInstallation(): Promise<void> {
     logger.info(
-      `Validating that the "${this.appSchemaCollectionName}" collection required by the application has been installed.`
+      `Validating that the "${this.appSchemaCollectionName}" collection required by the application has been installed.`,
     );
     const collections: any[] = await this.mongoDb
       .listCollections({ name: this.appSchemaCollectionName })
@@ -353,12 +353,12 @@ export class MongoUpdater implements IMongoUpdater {
 
     if (collections.length === 0) {
       logger.info(
-        ` > The "${this.appSchemaCollectionName}" collection was not found... Starting a new installation.`
+        ` > The "${this.appSchemaCollectionName}" collection was not found... Starting a new installation.`,
       );
       await this.installAppSchemaCollection();
     } else {
       logger.info(
-        ` > The "${this.appSchemaCollectionName}" collection was found. No installation required.`
+        ` > The "${this.appSchemaCollectionName}" collection was found. No installation required.`,
       );
     }
   }
@@ -379,7 +379,7 @@ export class MongoUpdater implements IMongoUpdater {
         if (semver.gte(currentAppSchemaVersion, targetVersion)) {
           // tslint:disable-next-line: prefer-template
           logger.info(
-            ' > Current database app schema is up to date : ' + currentAppSchemaVersion + ').'
+            ' > Current database app schema is up to date : ' + currentAppSchemaVersion + ').',
           );
           return;
         }
@@ -395,7 +395,7 @@ export class MongoUpdater implements IMongoUpdater {
           const wait = 1000;
           logger.warning(
             `The lock can't be acquired. The maximum age it can be before being considered ` +
-              `to be too old is ${this.lockMaxAgeSeconds} seconds. Waiting for ${wait} milliseconds...`
+              `to be too old is ${this.lockMaxAgeSeconds} seconds. Waiting for ${wait} milliseconds...`,
           );
           await utils.sleep(wait);
         } else {

package/src/mongoUtils.ts

@@ -54,7 +54,7 @@ export class MongoUtils {
   public async mockMongoose(
     mochaInstance: mocha.Context,
     mongoServerVersion: string,
-    useReplSet = false
+    useReplSet = false,
   ): Promise<MongoMemoryServer | MongoMemoryReplSet> {
     // ==========================================
     // We only mock the database if it's
@@ -96,7 +96,7 @@ export class MongoUtils {
             `The "mocha" parameter passed to the "mockMongoose(...)" method ` +
               `doesn't seems to be of the correct type. Make sure the function in which you ` +
               `call "mockMongoose(...)" is itself a *regular* function, not an *arrow* function. ` +
-              `Have a look at https://github.com/mochajs/mocha/issues/2018 for more infos.`
+              `Have a look at https://github.com/mochajs/mocha/issues/2018 for more infos.`,
           );
         }
 
@@ -219,7 +219,7 @@ export class MongoUtils {
    */
   public convertMongoOrMongooseErrorToApiError(
     err: any,
-    publicMessage: string
+    publicMessage: string,
   ): ApiErrorAndInfo | any {
     if (!err) {
       return createServerError('Empty error object');
@@ -239,7 +239,7 @@ export class MongoUtils {
       if (errClean.code === constants.mongo.mongoErrorCodes.DUPLICATE_KEY) {
         return createError(
           globalConstants.errors.apiGeneralErrors.codes.DUPLICATE_KEY,
-          publicMessage
+          publicMessage,
         )
           .httpStatus(HttpStatusCodes.CONFLICT)
           .publicMessage(publicMessage)

package/src/plugins/pagination/index.test.ts

@@ -32,7 +32,7 @@ describe('plugin pagination', () => {
     // Makes sure Mongoose is mocked, but not in Jenkins as we will start a dedicated mongodb container.
     const mockedDb = await mongoUtils.mockMongoose(
       this,
-      constants.testsConfig.mockServer.serverVersion
+      constants.testsConfig.mockServer.serverVersion,
     );
     const connString = mockedDb.getUri();
     await mongoose.connect(connString);

package/src/plugins/pagination/index.ts

@@ -3,7 +3,7 @@ import { IPaginateOptions } from './specs/IPaginateOptions';
 function paginate(
   q: any,
   options: IPaginateOptions,
-  callback: (error: Error, result: any) => void
+  callback: (error: Error, result: any) => void,
 ) {
   const optionsClean = PaginateBuilder.getOptions((paginate as any).options, options);
 
@@ -36,7 +36,7 @@ export class PaginateBuilder {
   public static executeQueries(
     model: any,
     query: any,
-    options: IPaginateOptions
+    options: IPaginateOptions,
   ): [Promise<any[]>, Promise<number>] {
     const { select, sort, populate, lean, leanWithId, limit, offset } = options;
     let itemsQuery: any;
@@ -62,7 +62,7 @@ export class PaginateBuilder {
   public static processResult(
     promises: any[],
     options: IPaginateOptions,
-    callback: (error: Error, result: any) => void
+    callback: (error: Error, result: any) => void,
   ): Promise<any> {
     const { lean, leanWithId, limit, offset } = options;
     return new Promise((resolve, reject) => {
@@ -94,7 +94,7 @@ export class PaginateBuilder {
             return callback(error, null);
           }
           reject(error);
-        }
+        },
       );
     });
   }