@villedemontreal/mongo 6.7.1 → 7.0.0-beta

package/src/mongoUpdater.ts

@@ -97,7 +97,9 @@ export class MongoUpdater implements IMongoUpdater {
       // Installing the "appSchema" collection.
       // tslint:disable-next-line: prefer-template
       logger.info(' > Installing the "' + this.appSchemaCollectionName + '" collection.');
-      const collection: MongoDb.Collection = await this.mongoDb.createCollection(this.appSchemaCollectionName);
+      const collection: MongoDb.Collection = await this.mongoDb.createCollection(
+        this.appSchemaCollectionName
+      );
 
       // ==========================================
       // Makes sure only one appSchema document exists.
@@ -105,11 +107,11 @@ export class MongoUpdater implements IMongoUpdater {
       await collection.createIndexes([
         {
           key: {
-            name: 1
+            name: 1,
           },
           name: 'name_1',
-          unique: true
-        }
+          unique: true,
+        },
       ]);
 
       // ==========================================
@@ -119,7 +121,7 @@ export class MongoUpdater implements IMongoUpdater {
         name: 'singleton', // do not change!
         version: '0.0.0',
         lock: false,
-        lockTimestamp: 0
+        lockTimestamp: 0,
       } as ISchemeInfo);
     } catch (err) {
       // ==========================================
@@ -159,7 +161,9 @@ 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);
+    logger.info(
+      ' > MongoDB App Schema updagred from version ' + currentVersion + ' to version ' + newVersion
+    );
   }
 
   public async getAppSchemaUpdateFiles(
@@ -176,13 +180,13 @@ export class MongoUpdater implements IMongoUpdater {
 
         try {
           filesClean = filesClean
-            .filter(name => {
+            .filter((name) => {
               return name.match(/\.js$/) !== null;
             })
-            .map(name => {
+            .map((name) => {
               return name.split('.js')[0];
             })
-            .filter(updateFileVersion => {
+            .filter((updateFileVersion) => {
               if (
                 semver.gt(updateFileVersion, currentAppSchemaVersion) &&
                 semver.lte(updateFileVersion, targetAppSchemaVersion)
@@ -200,7 +204,10 @@ export class MongoUpdater implements IMongoUpdater {
   }
 
   public async applyAppSchemaUpdates(currentVersion: string, newVersion: string): Promise<void> {
-    const updateFileNames: string[] = await this.getAppSchemaUpdateFiles(currentVersion, newVersion);
+    const updateFileNames: string[] = await this.getAppSchemaUpdateFiles(
+      currentVersion,
+      newVersion
+    );
     if (updateFileNames.length > 0) {
       for (const updateFileName of updateFileNames) {
         logger.info(' > Pending app schema update: ' + updateFileName);
@@ -216,7 +223,8 @@ 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
+            'The default export for an app schema update file must be a function! Was not for file : ' +
+              updateFilePath
           );
         }
 
@@ -259,8 +267,8 @@ export class MongoUpdater implements IMongoUpdater {
       {
         $set: {
           lock: true,
-          lockTimestamp: new Date().getTime()
-        }
+          lockTimestamp: new Date().getTime(),
+        },
       }
     );
 
@@ -269,8 +277,8 @@ export class MongoUpdater implements IMongoUpdater {
       return true;
     }
 
-    document = await appSchemaCollection.findOne({ lock: true });
-    if (document === null) {
+    const existingLock = await appSchemaCollection.findOne({ lock: true });
+    if (existingLock === null) {
       // try again!
       return this.lockAppSchemaDocument();
     }
@@ -278,7 +286,7 @@ export class MongoUpdater implements IMongoUpdater {
     // ==========================================
     // Checks the existing lock's timestamp
     // ==========================================
-    const lockTimestamp = (document as any).lockTimestamp;
+    const lockTimestamp = (existingLock as any).lockTimestamp;
     const nowTimestamp = new Date().getTime();
     const lockAgeMilliSeconds = nowTimestamp - lockTimestamp;
 
@@ -291,8 +299,8 @@ export class MongoUpdater implements IMongoUpdater {
         {
           $set: {
             lock: true,
-            lockTimestamp: new Date().getTime()
-          }
+            lockTimestamp: new Date().getTime(),
+          },
         }
       );
 
@@ -321,8 +329,8 @@ export class MongoUpdater implements IMongoUpdater {
       {
         $set: {
           lock: false,
-          lockTimestamp: 0
-        }
+          lockTimestamp: 0,
+        },
       }
     );
 
@@ -339,13 +347,19 @@ export class MongoUpdater implements IMongoUpdater {
     logger.info(
       `Validating that the "${this.appSchemaCollectionName}" collection required by the application has been installed.`
     );
-    const collections: any[] = await this.mongoDb.listCollections({ name: this.appSchemaCollectionName }).toArray();
+    const collections: any[] = await this.mongoDb
+      .listCollections({ name: this.appSchemaCollectionName })
+      .toArray();
 
     if (collections.length === 0) {
-      logger.info(` > The "${this.appSchemaCollectionName}" collection was not found... Starting a new installation.`);
+      logger.info(
+        ` > 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.`);
+      logger.info(
+        ` > The "${this.appSchemaCollectionName}" collection was found. No installation required.`
+      );
     }
   }
 
@@ -363,7 +377,9 @@ export class MongoUpdater implements IMongoUpdater {
         const currentAppSchemaVersion: string = await this.getAppSchemaVersion();
         if (semver.gte(currentAppSchemaVersion, targetVersion)) {
           // tslint:disable-next-line: prefer-template
-          logger.info(' > Current database app schema is up to date : ' + currentAppSchemaVersion + ').');
+          logger.info(
+            ' > Current database app schema is up to date : ' + currentAppSchemaVersion + ').'
+          );
           return;
         }
 
@@ -409,7 +425,7 @@ export class MongoUpdater implements IMongoUpdater {
   protected findMongoAppSchemaTargetVersion(): string {
     let targetVersion = '0.0.0';
 
-    fs.readdirSync(this.getAppSchemaFilesDirPath()).forEach(fileName => {
+    fs.readdirSync(this.getAppSchemaFilesDirPath()).forEach((fileName) => {
       if (fileName.endsWith('.js')) {
         const version = fileName.split('.js')[0];
         if (semver.gt(version, targetVersion)) {

package/src/mongoUtils.ts

@@ -9,7 +9,7 @@ import {
   createServerError,
   globalConstants,
   IApiError,
-  utils
+  utils,
 } from '@villedemontreal/general-utils';
 import { LogLevel } from '@villedemontreal/logger';
 import * as fs from 'fs-extra';
@@ -25,7 +25,7 @@ import { constants } from './config/constants';
  */
 export class MongoUtils {
   private mongoMemServer: MongoMemoryServer | MongoMemoryReplSet;
-  private useReplSet: boolean = false;
+  private useReplSet = false;
 
   private mockgosseMockedFlag = 'mocked';
 
@@ -54,7 +54,7 @@ export class MongoUtils {
   public async mockMongoose(
     mochaInstance: mocha.Context,
     mongoServerVersion: string,
-    useReplSet: boolean = false
+    useReplSet = false
   ): Promise<MongoMemoryServer | MongoMemoryReplSet> {
     // ==========================================
     // We only mock the database if it's
@@ -106,20 +106,20 @@ export class MongoUtils {
       // Voir https://www.npmjs.com/package/mongodb-memory-server pour les options
       const memoryServerOption: any = {
         instance: {
-          dbPath: dataPath // by default create in temp directory,
+          dbPath: dataPath, // by default create in temp directory,
         },
 
         binary: {
           version: mongoServerVersion ? mongoServerVersion : 'latest', // by default 'latest'
-          downloadDir: downloadDirPath // by default node_modules/.cache/mongodb-memory-server/mongodb-binaries
+          downloadDir: downloadDirPath, // by default node_modules/.cache/mongodb-memory-server/mongodb-binaries
         },
-        debug: false
+        debug: false,
       };
 
       if (useReplSet) {
         const replSetOptions: any = {
           ...memoryServerOption,
-          replSet: { count: 3 }
+          replSet: { count: 3 },
         };
         this.mongoMemServer = await MongoMemoryReplSet.create(replSetOptions);
       } else {
@@ -175,7 +175,7 @@ export class MongoUtils {
       return true;
     }
 
-    Object.keys(obj.errors).forEach(errorKey => {
+    Object.keys(obj.errors).forEach((errorKey) => {
       const errorObject = obj.errors[errorKey];
 
       if (!('kind' in errorObject) || !('path' in errorObject) || !('message' in errorObject)) {
@@ -217,7 +217,10 @@ export class MongoUtils {
    * @param publicMessage a public message to be used in the
    * generated error. Fopr example : "The user is invalid".
    */
-  public convertMongoOrMongooseErrorToApiError(err: any, publicMessage: string): ApiErrorAndInfo | any {
+  public convertMongoOrMongooseErrorToApiError(
+    err: any,
+    publicMessage: string
+  ): ApiErrorAndInfo | any {
     if (!err) {
       return createServerError('Empty error object');
     }
@@ -234,7 +237,10 @@ export class MongoUtils {
       // code.
       // ==========================================
       if (errClean.code === constants.mongo.mongoErrorCodes.DUPLICATE_KEY) {
-        return createError(globalConstants.errors.apiGeneralErrors.codes.DUPLICATE_KEY, publicMessage)
+        return createError(
+          globalConstants.errors.apiGeneralErrors.codes.DUPLICATE_KEY,
+          publicMessage
+        )
           .httpStatus(HttpStatusCodes.CONFLICT)
           .publicMessage(publicMessage)
           .logLevel(LogLevel.INFO)
@@ -263,7 +269,7 @@ export class MongoUtils {
         } else {
           const error = errClean;
           errClean = {
-            errors: [error]
+            errors: [error],
           };
         }
       }
@@ -271,13 +277,13 @@ export class MongoUtils {
       let errorDetails: IApiError[];
       if (errClean.errors && !_.isEmpty(errClean.errors)) {
         errorDetails = [];
-        Object.keys(errClean.errors).forEach(errorKey => {
+        Object.keys(errClean.errors).forEach((errorKey) => {
           const errorMessage = errClean.errors[errorKey];
 
           const errorDetail: IApiError = {
             code: errorMessage.kind,
             target: errorMessage.path,
-            message: errorMessage.message
+            message: errorMessage.message,
           };
           errorDetails.push(errorDetail);
         });
@@ -319,4 +325,4 @@ export class MongoUtils {
     return pojo;
   }
 }
-export let mongoUtils: MongoUtils = new MongoUtils();
+export const mongoUtils: MongoUtils = new MongoUtils();

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

@@ -18,34 +18,37 @@ const bookSchema = new mongoose.Schema({
   date: Date,
   author: {
     type: String,
-    ref: 'Author'
-  }
+    ref: 'Author',
+  },
 });
 
 bookSchema.plugin(mongoosePaginate);
 const bookModel: any = mongoose.model('Book', bookSchema);
 
 describe('plugin pagination', () => {
-  before(async function() {
+  before(async function () {
     this.timeout(120000);
 
     // 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);
+    const mockedDb = await mongoUtils.mockMongoose(
+      this,
+      constants.testsConfig.mockServer.serverVersion
+    );
     const connString = mockedDb.getUri();
-    await mongoose.connect(connString, { useNewUrlParser: true });
+    await mongoose.connect(connString);
   });
 
-  before(async function() {
+  before(async function () {
     this.timeout(10000);
     let book;
     const books: any = [];
     const date = new Date();
-    return authorModel.create({ name: 'Arthur Conan Doyle' }).then(author => {
+    return authorModel.create({ name: 'Arthur Conan Doyle' }).then((author) => {
       for (let i = 1; i <= 100; i++) {
         book = new bookModel({
           title: 'Book #' + i,
           date: new Date(date.getTime() + i),
-          author: author._id
+          author: author._id,
         });
         books.push(book);
       }
@@ -58,7 +61,7 @@ describe('plugin pagination', () => {
     expect(promise.then).to.be.an.instanceof(Function);
   });
 
-  it('calls callback', done => {
+  it('calls callback', (done) => {
     bookModel.paginate({}, {}, (err: Error, result: IPaginatedResult<any>) => {
       expect(err).to.be.null;
       expect(result).to.be.an.instanceOf(Object);
@@ -83,12 +86,14 @@ describe('plugin pagination', () => {
       });
     });
     it('with offset and limit', () => {
-      return bookModel.paginate({}, { offset: 30, limit: 20 }).then((result: IPaginatedResult<any>) => {
-        expect(result.items).to.have.length(20);
-        expect(result.paging.totalCount).to.equal(100);
-        expect(result.paging.limit).to.equal(20);
-        expect(result.paging.offset).to.equal(30);
-      });
+      return bookModel
+        .paginate({}, { offset: 30, limit: 20 })
+        .then((result: IPaginatedResult<any>) => {
+          expect(result.items).to.have.length(20);
+          expect(result.paging.totalCount).to.equal(100);
+          expect(result.paging.limit).to.equal(20);
+          expect(result.paging.offset).to.equal(30);
+        });
     });
     it('with zero limit', () => {
       return bookModel.paginate({}, { page: 1, limit: 0 }).then((result: IPaginatedResult<any>) => {
@@ -104,14 +109,18 @@ describe('plugin pagination', () => {
       });
     });
     it('with sort', () => {
-      return bookModel.paginate({}, { sort: { date: -1 } }).then((result: IPaginatedResult<any>) => {
-        expect(result.items[0].title).to.equal('Book #100');
-      });
+      return bookModel
+        .paginate({}, { sort: { date: -1 } })
+        .then((result: IPaginatedResult<any>) => {
+          expect(result.items[0].title).to.equal('Book #100');
+        });
     });
     it('with populate', () => {
-      return bookModel.paginate({}, { populate: 'author' }).then((result: IPaginatedResult<any>) => {
-        expect(result.items[0].author.name).to.equal('Arthur Conan Doyle');
-      });
+      return bookModel
+        .paginate({}, { populate: 'author' })
+        .then((result: IPaginatedResult<any>) => {
+          expect(result.items[0].author.name).to.equal('Arthur Conan Doyle');
+        });
     });
     describe('with lean', () => {
       it('with default leanWithId=true', () => {
@@ -122,19 +131,21 @@ describe('plugin pagination', () => {
         });
       });
       it('with leanWithId=false', () => {
-        return bookModel.paginate({}, { lean: true, leanWithId: false }).then((result: IPaginatedResult<any>) => {
-          expect(result.items[0]).to.not.be.an.instanceof((mongoose as any).Document);
-          expect(result.items[0]).to.not.have.property('id');
-        });
+        return bookModel
+          .paginate({}, { lean: true, leanWithId: false })
+          .then((result: IPaginatedResult<any>) => {
+            expect(result.items[0]).to.not.be.an.instanceof((mongoose as any).Document);
+            expect(result.items[0]).to.not.have.property('id');
+          });
       });
     });
   });
 
-  after(done => {
+  after((done) => {
     mongoose.connection.db.dropDatabase(done);
   });
 
-  after(done => {
+  after((done) => {
     mongoose.disconnect(done);
   });
 });

package/src/plugins/pagination/index.ts

@@ -1,6 +1,10 @@
 import { IPaginateOptions } from './specs/IPaginateOptions';
 
-function paginate(q: any, options: IPaginateOptions, callback: (error: Error, result: any) => void) {
+function paginate(
+  q: any,
+  options: IPaginateOptions,
+  callback: (error: Error, result: any) => void
+) {
   const optionsClean = PaginateBuilder.getOptions((paginate as any).options, options);
 
   const query = q || {};
@@ -22,14 +26,18 @@ export class PaginateBuilder {
     lean: false,
     leanWithId: true,
     limit: 10,
-    offset: 0
+    offset: 0,
   });
 
   public static getOptions(...options: IPaginateOptions[]): IPaginateOptions {
     return Object.assign({}, PaginateBuilder.defaultOptions, ...options);
   }
 
-  public static executeQueries(model: any, query: any, options: IPaginateOptions): [Promise<any[]>, Promise<number>] {
+  public static executeQueries(
+    model: any,
+    query: any,
+    options: IPaginateOptions
+  ): [Promise<any[]>, Promise<number>] {
     const { select, sort, populate, lean, leanWithId, limit, offset } = options;
     let itemsQuery: any;
 
@@ -38,20 +46,17 @@ export class PaginateBuilder {
     }
 
     if (limit > 0) {
-      itemsQuery = model
-        .find(query)
-        .select(select)
-        .sort(sort)
-        .skip(offset)
-        .limit(limit)
-        .lean(lean);
+      itemsQuery = model.find(query).select(select).sort(sort).skip(offset).limit(limit).lean(lean);
 
       if (populate) {
-        [].concat(populate).forEach(item => itemsQuery.populate(item));
+        [].concat(populate).forEach((item) => itemsQuery.populate(item));
       }
     }
 
-    return [itemsQuery && limit > 0 ? itemsQuery.exec() : Promise.resolve([]), model.countDocuments(query).exec()];
+    return [
+      itemsQuery && limit > 0 ? itemsQuery.exec() : Promise.resolve([]),
+      model.countDocuments(query).exec(),
+    ];
   }
 
   public static processResult(
@@ -62,7 +67,7 @@ export class PaginateBuilder {
     const { lean, leanWithId, limit, offset } = options;
     return new Promise((resolve, reject) => {
       Promise.all(promises).then(
-        data => {
+        (data) => {
           const items = data[0] as any[];
           const count = data[1] as number;
           const result: any = { paging: { limit, offset, totalCount: count } };
@@ -84,7 +89,7 @@ export class PaginateBuilder {
 
           resolve(result);
         },
-        error => {
+        (error) => {
           if (typeof callback === 'function') {
             return callback(error, null);
           }

package/src/utils/logger.ts

@@ -1,4 +1,11 @@
-import { ILogger, initLogger, LazyLogger, Logger, LoggerConfigs, LogLevel } from '@villedemontreal/logger';
+import {
+  ILogger,
+  initLogger,
+  LazyLogger,
+  Logger,
+  LoggerConfigs,
+  LogLevel,
+} from '@villedemontreal/logger';
 import { configs } from '../config/configs';
 
 let testingLoggerLibInitialised = false;