@villedemontreal/mongo 6.7.0

package/dist/src/mongoUpdater.js

@@ -0,0 +1,297 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MongoUpdater = void 0;
+const general_utils_1 = require("@villedemontreal/general-utils");
+const fs = require("fs");
+const lodash_1 = require("lodash");
+const semver = require("semver");
+const constants_1 = require("./config/constants");
+const logger_1 = require("./utils/logger");
+const logger = logger_1.createLogger('MongoUpdater');
+class MongoUpdater {
+    constructor(mongoDb, 
+    /**
+     * The *relative* path to the directory where the
+     * update files are.
+     */
+    mongoSchemaUpdatesDirPath, lockMaxAgeSeconds, appSchemaCollectionName) {
+        this.mongoDb = mongoDb;
+        this.mongoSchemaUpdatesDirPath = mongoSchemaUpdatesDirPath;
+        this.lockMaxAgeSeconds = lockMaxAgeSeconds;
+        this.appSchemaCollectionName = appSchemaCollectionName;
+        this.checkUpdates = async () => {
+            logger.info('Checking for db app schema updates:');
+            let lockAcquired = false;
+            const targetVersion = this.findMongoAppSchemaTargetVersion();
+            try {
+                while (true) {
+                    // ==========================================
+                    // Checks if the appSchema version has to be
+                    // updated.
+                    // ==========================================
+                    const currentAppSchemaVersion = 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 + ').');
+                        return;
+                    }
+                    if (lockAcquired) {
+                        logger.info(` > Applying some required updates...`);
+                        await this.applyAppSchemaUpdates(currentAppSchemaVersion, targetVersion);
+                        await this.updateAppSchemaVersion(currentAppSchemaVersion, targetVersion);
+                        return;
+                    }
+                    // ==========================================
+                    // Tries to get the lock. Will do this as long
+                    // as the lock can't be acquired (ie : it is
+                    // released or is too old) or as long as the appSchema
+                    // version still is not up to date.
+                    // ==========================================
+                    lockAcquired = await this.lockAppSchemaDocument();
+                    if (!lockAcquired) {
+                        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...`);
+                        await general_utils_1.utils.sleep(wait);
+                    }
+                    else {
+                        logger.info(` > Lock acquired.`);
+                    }
+                }
+            }
+            finally {
+                if (lockAcquired) {
+                    await this.unlockAppSchemaDocument();
+                }
+            }
+        };
+    }
+    async installAppSchemaCollection() {
+        try {
+            // Installing the "appSchema" collection.
+            // tslint:disable-next-line: prefer-template
+            logger.info(' > Installing the "' + this.appSchemaCollectionName + '" collection.');
+            const collection = await this.mongoDb.createCollection(this.appSchemaCollectionName);
+            // ==========================================
+            // Makes sure only one appSchema document exists.
+            // ==========================================
+            await collection.createIndexes([
+                {
+                    key: {
+                        name: 1
+                    },
+                    name: 'name_1',
+                    unique: true
+                }
+            ]);
+            // ==========================================
+            // Inserts the first version of the AppSchema document
+            // ==========================================
+            await collection.insertOne({
+                name: 'singleton',
+                version: '0.0.0',
+                lock: false,
+                lockTimestamp: 0
+            });
+        }
+        catch (err) {
+            // ==========================================
+            // Maybe the error occured because another app
+            // was also trying to create the collection?
+            // ==========================================
+            const maxWaitMilliseconds = 10 * 1000;
+            const start = new general_utils_1.Timer();
+            while (start.getMillisecondsElapsed() < maxWaitMilliseconds) {
+                await general_utils_1.utils.sleep(1000);
+                const appSchemaCollection = await this.getAppSchemaCollection();
+                if (!appSchemaCollection) {
+                    continue;
+                }
+                const document = await appSchemaCollection.findOne({});
+                if (!document) {
+                    continue;
+                }
+                // ==========================================
+                // We ignore the error!
+                // ==========================================
+                return;
+            }
+            // ==========================================
+            // Throws the error...
+            // ==========================================
+            throw err;
+        }
+    }
+    async updateAppSchemaVersion(currentVersion, newVersion) {
+        const appSchemaCollection = await this.getAppSchemaCollection();
+        await appSchemaCollection.updateOne({}, { $set: { version: newVersion } });
+        // tslint:disable-next-line: prefer-template
+        logger.info(' > MongoDB App Schema updagred from version ' + currentVersion + ' to version ' + newVersion);
+    }
+    async getAppSchemaUpdateFiles(currentAppSchemaVersion, targetAppSchemaVersion) {
+        return new Promise((resolve, reject) => {
+            fs.readdir(this.getAppSchemaFilesDirPath(), (err, files) => {
+                if (err) {
+                    return reject(err);
+                }
+                let filesClean = files;
+                try {
+                    filesClean = filesClean
+                        .filter(name => {
+                        return name.match(/\.js$/) !== null;
+                    })
+                        .map(name => {
+                        return name.split('.js')[0];
+                    })
+                        .filter(updateFileVersion => {
+                        if (semver.gt(updateFileVersion, currentAppSchemaVersion) &&
+                            semver.lte(updateFileVersion, targetAppSchemaVersion)) {
+                            return true;
+                        }
+                        return false;
+                    });
+                }
+                catch (err2) {
+                    return reject(err2);
+                }
+                return resolve(filesClean.sort(semver.compare));
+            });
+        });
+    }
+    async applyAppSchemaUpdates(currentVersion, newVersion) {
+        const updateFileNames = await this.getAppSchemaUpdateFiles(currentVersion, newVersion);
+        if (updateFileNames.length > 0) {
+            for (const updateFileName of updateFileNames) {
+                logger.info(' > Pending app schema update: ' + updateFileName);
+                // tslint:disable-next-line: prefer-template
+                const updateFilePath = this.getAppSchemaFilesDirPath() + '/' + updateFileName;
+                let updateFunction;
+                try {
+                    updateFunction = require(updateFilePath).default;
+                }
+                catch (e) {
+                    return Promise.reject(e);
+                }
+                if (!lodash_1.isFunction(updateFunction)) {
+                    return Promise.reject('The default export for an app schema update file must be a function! Was not for file : ' + updateFilePath);
+                }
+                await updateFunction(this.mongoDb);
+            }
+            logger.info('All app schema updates done');
+        }
+    }
+    async getAppSchemaCollection() {
+        return await this.mongoDb.collection(this.appSchemaCollectionName);
+    }
+    async getAppSchemaVersion() {
+        const appSchemaCollection = await this.getAppSchemaCollection();
+        const documents = await appSchemaCollection.find().toArray();
+        if (documents.length > 0) {
+            return documents[0].version;
+        }
+        return '0.0.0';
+    }
+    /**
+     * Tries to get the lock to modify Mongo's schemas.
+     *
+     * If a lock already exists, checks if it is too old.
+     * If too old, will create a new one... This is to prevents
+     * situations where a lock would have been taken by an app
+     * but that app *crashed* while the lock was on. We don't want
+     * suck lock to be active forever...
+     *
+     */
+    async lockAppSchemaDocument() {
+        const appSchemaCollection = await this.getAppSchemaCollection();
+        let document = await appSchemaCollection.findOneAndUpdate({ lock: false }, {
+            $set: {
+                lock: true,
+                lockTimestamp: new Date().getTime()
+            }
+        });
+        if (document.value !== null) {
+            logger.info(` > Succesfully locked the ${this.appSchemaCollectionName} document`);
+            return true;
+        }
+        document = await appSchemaCollection.findOne({ lock: true });
+        if (document === null) {
+            // try again!
+            return this.lockAppSchemaDocument();
+        }
+        // ==========================================
+        // Checks the existing lock's timestamp
+        // ==========================================
+        const lockTimestamp = document.lockTimestamp;
+        const nowTimestamp = new Date().getTime();
+        const lockAgeMilliSeconds = nowTimestamp - lockTimestamp;
+        // ==========================================
+        // Lock is too old! We overwrite it....
+        // ==========================================
+        if (lockAgeMilliSeconds > this.lockMaxAgeSeconds * 1000) {
+            document = await appSchemaCollection.findOneAndUpdate({ lockTimestamp }, {
+                $set: {
+                    lock: true,
+                    lockTimestamp: new Date().getTime()
+                }
+            });
+            // ==========================================
+            // *Just* taken by another app!
+            // ==========================================
+            if (document.value === null) {
+                return false;
+            }
+            return true;
+        }
+        // ==========================================
+        // The existing lock is still valid...
+        // We can't get it.
+        // ==========================================
+        return false;
+    }
+    async unlockAppSchemaDocument() {
+        const appSchemaCollection = await this.getAppSchemaCollection();
+        const document = await appSchemaCollection.findOneAndUpdate({ lock: true }, {
+            $set: {
+                lock: false,
+                lockTimestamp: 0
+            }
+        });
+        if (document.value !== null) {
+            logger.info(` > Succesfully unlocked the ${this.appSchemaCollectionName} document`);
+            return true;
+        }
+        logger.info(`> The ${this.appSchemaCollectionName} document was not locked`);
+        return false;
+    }
+    async checkInstallation() {
+        logger.info(`Validating that the "${this.appSchemaCollectionName}" collection required by the application has been installed.`);
+        const collections = 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.`);
+            await this.installAppSchemaCollection();
+        }
+        else {
+            logger.info(` > The "${this.appSchemaCollectionName}" collection was found. No installation required.`);
+        }
+    }
+    getAppSchemaFilesDirPath() {
+        return constants_1.constants.appRoot + this.mongoSchemaUpdatesDirPath;
+    }
+    /**
+     * Finds the latest Mongo update file version.
+     */
+    findMongoAppSchemaTargetVersion() {
+        let targetVersion = '0.0.0';
+        fs.readdirSync(this.getAppSchemaFilesDirPath()).forEach(fileName => {
+            if (fileName.endsWith('.js')) {
+                const version = fileName.split('.js')[0];
+                if (semver.gt(version, targetVersion)) {
+                    targetVersion = version;
+                }
+            }
+        });
+        return targetVersion;
+    }
+}
+exports.MongoUpdater = MongoUpdater;
+//# sourceMappingURL=mongoUpdater.js.map

package/dist/src/mongoUpdater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongoUpdater.js","sourceRoot":"","sources":["../../src/mongoUpdater.ts"],"names":[],"mappings":";;;AAAA,kEAA8D;AAC9D,yBAAyB;AACzB,mCAAoC;AAEpC,iCAAiC;AACjC,kDAAmE;AACnE,2CAA8C;AAE9C,MAAM,MAAM,GAAG,qBAAY,CAAC,cAAc,CAAC,CAAC;AA0E5C,MAAa,YAAY;IACvB,YACU,OAAmB;IAC3B;;;OAGG;IACK,yBAAiC,EACjC,iBAAyB,EACzB,uBAA+B;QAP/B,YAAO,GAAP,OAAO,CAAY;QAKnB,8BAAyB,GAAzB,yBAAyB,CAAQ;QACjC,sBAAiB,GAAjB,iBAAiB,CAAQ;QACzB,4BAAuB,GAAvB,uBAAuB,CAAQ;QAoQlC,iBAAY,GAAG,KAAK,IAAmB,EAAE;YAC9C,MAAM,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;YAEnD,IAAI,YAAY,GAAG,KAAK,CAAC;YACzB,MAAM,aAAa,GAAW,IAAI,CAAC,+BAA+B,EAAE,CAAC;YACrE,IAAI;gBACF,OAAO,IAAI,EAAE;oBACX,6CAA6C;oBAC7C,4CAA4C;oBAC5C,WAAW;oBACX,6CAA6C;oBAC7C,MAAM,uBAAuB,GAAW,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBACzE,IAAI,MAAM,CAAC,GAAG,CAAC,uBAAuB,EAAE,aAAa,CAAC,EAAE;wBACtD,4CAA4C;wBAC5C,MAAM,CAAC,IAAI,CAAC,iDAAiD,GAAG,uBAAuB,GAAG,IAAI,CAAC,CAAC;wBAChG,OAAO;qBACR;oBAED,IAAI,YAAY,EAAE;wBAChB,MAAM,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;wBACpD,MAAM,IAAI,CAAC,qBAAqB,CAAC,uBAAuB,EAAE,aAAa,CAAC,CAAC;wBACzE,MAAM,IAAI,CAAC,sBAAsB,CAAC,uBAAuB,EAAE,aAAa,CAAC,CAAC;wBAC1E,OAAO;qBACR;oBAED,6CAA6C;oBAC7C,8CAA8C;oBAC9C,4CAA4C;oBAC5C,sDAAsD;oBACtD,mCAAmC;oBACnC,6CAA6C;oBAC7C,YAAY,GAAG,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;oBAClD,IAAI,CAAC,YAAY,EAAE;wBACjB,MAAM,IAAI,GAAG,IAAI,CAAC;wBAClB,MAAM,CAAC,OAAO,CACZ,gFAAgF;4BAC9E,oBAAoB,IAAI,CAAC,iBAAiB,yBAAyB,IAAI,kBAAkB,CAC5F,CAAC;wBACF,MAAM,qBAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;qBACzB;yBAAM;wBACL,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;qBAClC;iBACF;aACF;oBAAS;gBACR,IAAI,YAAY,EAAE;oBAChB,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC;iBACtC;aACF;QACH,CAAC,CAAC;IAnTC,CAAC;IAEG,KAAK,CAAC,0BAA0B;QACrC,IAAI;YACF,yCAAyC;YACzC,4CAA4C;YAC5C,MAAM,CAAC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,uBAAuB,GAAG,eAAe,CAAC,CAAC;YACpF,MAAM,UAAU,GAAuB,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAEzG,6CAA6C;YAC7C,iDAAiD;YACjD,6CAA6C;YAC7C,MAAM,UAAU,CAAC,aAAa,CAAC;gBAC7B;oBACE,GAAG,EAAE;wBACH,IAAI,EAAE,CAAC;qBACR;oBACD,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,IAAI;iBACb;aACF,CAAC,CAAC;YAEH,6CAA6C;YAC7C,sDAAsD;YACtD,6CAA6C;YAC7C,MAAM,UAAU,CAAC,SAAS,CAAC;gBACzB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,OAAO;gBAChB,IAAI,EAAE,KAAK;gBACX,aAAa,EAAE,CAAC;aACF,CAAC,CAAC;SACnB;QAAC,OAAO,GAAG,EAAE;YACZ,6CAA6C;YAC7C,8CAA8C;YAC9C,4CAA4C;YAC5C,6CAA6C;YAC7C,MAAM,mBAAmB,GAAG,EAAE,GAAG,IAAI,CAAC;YACtC,MAAM,KAAK,GAAG,IAAI,qBAAK,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC,sBAAsB,EAAE,GAAG,mBAAmB,EAAE;gBAC3D,MAAM,qBAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAExB,MAAM,mBAAmB,GAAuB,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBACpF,IAAI,CAAC,mBAAmB,EAAE;oBACxB,SAAS;iBACV;gBAED,MAAM,QAAQ,GAAG,MAAM,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBACvD,IAAI,CAAC,QAAQ,EAAE;oBACb,SAAS;iBACV;gBAED,6CAA6C;gBAC7C,uBAAuB;gBACvB,6CAA6C;gBAC7C,OAAO;aACR;YAED,6CAA6C;YAC7C,sBAAsB;YACtB,6CAA6C;YAC7C,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,cAAsB,EAAE,UAAkB;QAC5E,MAAM,mBAAmB,GAAuB,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAEpF,MAAM,mBAAmB,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;QAC3E,4CAA4C;QAC5C,MAAM,CAAC,IAAI,CAAC,8CAA8C,GAAG,cAAc,GAAG,cAAc,GAAG,UAAU,CAAC,CAAC;IAC7G,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAClC,uBAA+B,EAC/B,sBAA8B;QAE9B,OAAO,IAAI,OAAO,CAAW,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC/C,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;gBACzD,IAAI,GAAG,EAAE;oBACP,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;iBACpB;gBAED,IAAI,UAAU,GAAG,KAAK,CAAC;gBAEvB,IAAI;oBACF,UAAU,GAAG,UAAU;yBACpB,MAAM,CAAC,IAAI,CAAC,EAAE;wBACb,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;oBACtC,CAAC,CAAC;yBACD,GAAG,CAAC,IAAI,CAAC,EAAE;wBACV,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC9B,CAAC,CAAC;yBACD,MAAM,CAAC,iBAAiB,CAAC,EAAE;wBAC1B,IACE,MAAM,CAAC,EAAE,CAAC,iBAAiB,EAAE,uBAAuB,CAAC;4BACrD,MAAM,CAAC,GAAG,CAAC,iBAAiB,EAAE,sBAAsB,CAAC,EACrD;4BACA,OAAO,IAAI,CAAC;yBACb;wBACD,OAAO,KAAK,CAAC;oBACf,CAAC,CAAC,CAAC;iBACN;gBAAC,OAAO,IAAI,EAAE;oBACb,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;iBACrB;gBACD,OAAO,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAAC,cAAsB,EAAE,UAAkB;QAC3E,MAAM,eAAe,GAAa,MAAM,IAAI,CAAC,uBAAuB,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QACjG,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;YAC9B,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE;gBAC5C,MAAM,CAAC,IAAI,CAAC,gCAAgC,GAAG,cAAc,CAAC,CAAC;gBAE/D,4CAA4C;gBAC5C,MAAM,cAAc,GAAG,IAAI,CAAC,wBAAwB,EAAE,GAAG,GAAG,GAAG,cAAc,CAAC;gBAC9E,IAAI,cAAiD,CAAC;gBACtD,IAAI;oBACF,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC;iBAClD;gBAAC,OAAO,CAAC,EAAE;oBACV,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;iBAC1B;gBAED,IAAI,CAAC,mBAAU,CAAC,cAAc,CAAC,EAAE;oBAC/B,OAAO,OAAO,CAAC,MAAM,CACnB,0FAA0F,GAAG,cAAc,CAC5G,CAAC;iBACH;gBAED,MAAM,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACpC;YACD,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;SAC5C;IACH,CAAC;IAEM,KAAK,CAAC,sBAAsB;QACjC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACrE,CAAC;IAEM,KAAK,CAAC,mBAAmB;QAC9B,MAAM,mBAAmB,GAAuB,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAEpF,MAAM,SAAS,GAAU,MAAM,mBAAmB,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACpE,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;SAC7B;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,qBAAqB;QAChC,MAAM,mBAAmB,GAAuB,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAEpF,IAAI,QAAQ,GAAG,MAAM,mBAAmB,CAAC,gBAAgB,CACvD,EAAE,IAAI,EAAE,KAAK,EAAE,EACf;YACE,IAAI,EAAE;gBACJ,IAAI,EAAE,IAAI;gBACV,aAAa,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;aACpC;SACF,CACF,CAAC;QAEF,IAAI,QAAQ,CAAC,KAAK,KAAK,IAAI,EAAE;YAC3B,MAAM,CAAC,IAAI,CAAC,6BAA6B,IAAI,CAAC,uBAAuB,WAAW,CAAC,CAAC;YAClF,OAAO,IAAI,CAAC;SACb;QAED,QAAQ,GAAG,MAAM,mBAAmB,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,IAAI,QAAQ,KAAK,IAAI,EAAE;YACrB,aAAa;YACb,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC;SACrC;QAED,6CAA6C;QAC7C,uCAAuC;QACvC,6CAA6C;QAC7C,MAAM,aAAa,GAAI,QAAgB,CAAC,aAAa,CAAC;QACtD,MAAM,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAC1C,MAAM,mBAAmB,GAAG,YAAY,GAAG,aAAa,CAAC;QAEzD,6CAA6C;QAC7C,uCAAuC;QACvC,6CAA6C;QAC7C,IAAI,mBAAmB,GAAG,IAAI,CAAC,iBAAiB,GAAG,IAAI,EAAE;YACvD,QAAQ,GAAG,MAAM,mBAAmB,CAAC,gBAAgB,CACnD,EAAE,aAAa,EAAE,EACjB;gBACE,IAAI,EAAE;oBACJ,IAAI,EAAE,IAAI;oBACV,aAAa,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;iBACpC;aACF,CACF,CAAC;YAEF,6CAA6C;YAC7C,+BAA+B;YAC/B,6CAA6C;YAC7C,IAAI,QAAQ,CAAC,KAAK,KAAK,IAAI,EAAE;gBAC3B,OAAO,KAAK,CAAC;aACd;YAED,OAAO,IAAI,CAAC;SACb;QAED,6CAA6C;QAC7C,sCAAsC;QACtC,mBAAmB;QACnB,6CAA6C;QAC7C,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,KAAK,CAAC,uBAAuB;QAClC,MAAM,mBAAmB,GAAuB,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAEpF,MAAM,QAAQ,GAAG,MAAM,mBAAmB,CAAC,gBAAgB,CACzD,EAAE,IAAI,EAAE,IAAI,EAAE,EACd;YACE,IAAI,EAAE;gBACJ,IAAI,EAAE,KAAK;gBACX,aAAa,EAAE,CAAC;aACjB;SACF,CACF,CAAC;QAEF,IAAI,QAAQ,CAAC,KAAK,KAAK,IAAI,EAAE;YAC3B,MAAM,CAAC,IAAI,CAAC,+BAA+B,IAAI,CAAC,uBAAuB,WAAW,CAAC,CAAC;YACpF,OAAO,IAAI,CAAC;SACb;QAED,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,uBAAuB,0BAA0B,CAAC,CAAC;QAC7E,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,MAAM,CAAC,IAAI,CACT,wBAAwB,IAAI,CAAC,uBAAuB,8DAA8D,CACnH,CAAC;QACF,MAAM,WAAW,GAAU,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;QAEhH,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;YAC5B,MAAM,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,uBAAuB,4DAA4D,CAAC,CAAC;YACjH,MAAM,IAAI,CAAC,0BAA0B,EAAE,CAAC;SACzC;aAAM;YACL,MAAM,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,uBAAuB,mDAAmD,CAAC,CAAC;SACzG;IACH,CAAC;IAoDS,wBAAwB;QAChC,OAAO,qBAAgB,CAAC,OAAO,GAAG,IAAI,CAAC,yBAAyB,CAAC;IACnE,CAAC;IAED;;OAEG;IACO,+BAA+B;QACvC,IAAI,aAAa,GAAG,OAAO,CAAC;QAE5B,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YACjE,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAC5B,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACzC,IAAI,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE;oBACrC,aAAa,GAAG,OAAO,CAAC;iBACzB;aACF;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,aAAa,CAAC;IACvB,CAAC;CACF;AApVD,oCAoVC"}

package/dist/src/mongoUpdater.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/mongoUpdater.test.js

@@ -0,0 +1,232 @@
+"use strict";
+// Ok for test files :
+// tslint:disable:max-func-body-length
+// tslint:disable:no-string-literal
+Object.defineProperty(exports, "__esModule", { value: true });
+const general_utils_1 = require("@villedemontreal/general-utils");
+const chai_1 = require("chai");
+const sinon = require("sinon");
+const constants_1 = require("./config/constants");
+const mongoClient_1 = require("./mongoClient");
+const mongoUpdater_1 = require("./mongoUpdater");
+const mongoUtils_1 = require("./mongoUtils");
+const testingConfigurations_1 = require("./utils/testingConfigurations");
+let mongoDb;
+let mongoUpdater;
+testingConfigurations_1.setTestingConfigurations();
+// ==========================================
+// Mongo Updater
+// ==========================================
+describe('Mongo Updater', () => {
+    // A regular function is *required* to get the proper
+    // "this" value for "MongoUtils.mockMongoose(...)"
+    const testconfig = constants_1.constants.testsConfig;
+    before(async function () {
+        // Makes sure Mongoose is mocked, but not in Jenkins as we will start a dedicated mongodb container.
+        await mongoUtils_1.mongoUtils.mockMongoose(this, testconfig.mockServer.serverVersion);
+        const connection = await mongoClient_1.initMongoose(testconfig);
+        chai_1.assert.isOk(connection);
+        mongoDb = connection.db;
+        // Creates the Updater directly.
+        mongoUpdater = new mongoUpdater_1.MongoUpdater(mongoDb, testconfig.updater.mongoSchemaUpdatesDirPath, testconfig.updater.lockMaxAgeSeconds, testconfig.updater.appSchemaCollectionName);
+    });
+    after(async () => {
+        // ==========================================
+        // Drops the mocked databases
+        // ==========================================
+        await mongoDb.dropDatabase();
+    });
+    describe('getSchemaVersion', async () => {
+        it('should contain schema version 0.0.0', async () => {
+            const version = await mongoUpdater.getAppSchemaVersion();
+            chai_1.assert.strictEqual(version, '0.0.0');
+        });
+    });
+    describe('checkInstall', async () => {
+        let installAppSchemaCollectionSpy;
+        beforeEach(async () => {
+            installAppSchemaCollectionSpy = sinon.spy(mongoUpdater, 'installAppSchemaCollection');
+        });
+        afterEach(async () => {
+            installAppSchemaCollectionSpy.restore();
+        });
+        it('should not contains app schema collection', async () => {
+            const collections = await mongoDb
+                .listCollections({ name: testconfig.updater.appSchemaCollectionName })
+                .toArray();
+            chai_1.assert.strictEqual(collections.length, 0);
+        });
+        it('should call installAppSchemaCollection to create schema collection', async () => {
+            await mongoUpdater.checkInstallation();
+            chai_1.assert.strictEqual(installAppSchemaCollectionSpy.callCount, 1);
+            const collections = await mongoDb
+                .listCollections({ name: testconfig.updater.appSchemaCollectionName })
+                .toArray();
+            chai_1.assert.strictEqual(collections.length, 1);
+        });
+        it('should not call installAppSchemaCollection again', async () => {
+            await mongoUpdater.checkInstallation();
+            chai_1.assert.strictEqual(installAppSchemaCollectionSpy.callCount, 0);
+        });
+        it('should contain schema version 0.0.0', async () => {
+            await mongoUpdater.checkInstallation();
+            const collections = await mongoDb
+                .listCollections({ name: testconfig.updater.appSchemaCollectionName })
+                .toArray();
+            chai_1.assert.strictEqual(collections.length, 1);
+            chai_1.assert.strictEqual(collections[0].name, testconfig.updater.appSchemaCollectionName);
+            const schema = mongoDb.collection(testconfig.updater.appSchemaCollectionName);
+            const schemaDb = await schema.find().toArray();
+            chai_1.assert.strictEqual(schemaDb[0].version, '0.0.0');
+        });
+    });
+    describe('getSchemaVersion', async () => {
+        it('should contain schema version 0.0.0', async () => {
+            const version = await mongoUpdater.getAppSchemaVersion();
+            chai_1.assert.strictEqual(version, '0.0.0');
+        });
+    });
+    describe('lock', async () => {
+        it('lock should be equal to false', async () => {
+            const schema = mongoDb.collection(testconfig.updater.appSchemaCollectionName);
+            const schemaDb = await schema.find().toArray();
+            chai_1.assert.strictEqual(schemaDb[0].lock, false);
+        });
+        it('should success to lock', async () => {
+            const isLocked = await mongoUpdater.lockAppSchemaDocument();
+            chai_1.assert.strictEqual(isLocked, true);
+        });
+        it('lock should be equal to true', async () => {
+            const schema = mongoDb.collection(testconfig.updater.appSchemaCollectionName);
+            const schemaDb = await schema.find().toArray();
+            chai_1.assert.strictEqual(schemaDb[0].lock, true);
+        });
+        it('should fail to lock again', async () => {
+            const isLocked = await mongoUpdater.lockAppSchemaDocument();
+            chai_1.assert.strictEqual(isLocked, false);
+        });
+    });
+    describe('unlock', async () => {
+        it('lock should be equal to true', async () => {
+            const schema = mongoDb.collection(testconfig.updater.appSchemaCollectionName);
+            const schemaDb = await schema.find().toArray();
+            chai_1.assert.strictEqual(schemaDb[0].lock, true);
+        });
+        it('should success to unlock', async () => {
+            const isUnlocked = await mongoUpdater.unlockAppSchemaDocument();
+            chai_1.assert.strictEqual(isUnlocked, true);
+        });
+        it('lock should be equal to false', async () => {
+            const schema = mongoDb.collection(testconfig.updater.appSchemaCollectionName);
+            const schemaDb = await schema.find().toArray();
+            chai_1.assert.strictEqual(schemaDb[0].lock, false);
+        });
+        it('should fail to unlock again', async () => {
+            const isUnlocked = await mongoUpdater.unlockAppSchemaDocument();
+            chai_1.assert.strictEqual(isUnlocked, false);
+            const schema = mongoDb.collection(testconfig.updater.appSchemaCollectionName);
+            const schemaDb = await schema.find().toArray();
+            chai_1.assert.strictEqual(schemaDb[0].lock, false);
+        });
+    });
+    describe('updateSchemaVersion', async () => {
+        it('should contain schema version 0.0.0', async () => {
+            const version = await mongoUpdater.getAppSchemaVersion();
+            chai_1.assert.strictEqual(version, '0.0.0');
+        });
+        it('should success to update the schema version to 6.5.4', async () => {
+            await mongoUpdater.updateAppSchemaVersion('0.0.0', '6.5.4');
+            const version = await mongoUpdater.getAppSchemaVersion();
+            chai_1.assert.strictEqual(version, '6.5.4');
+        });
+        it('should success to update the schema version to 0.0.0', async () => {
+            await mongoUpdater.updateAppSchemaVersion('6.5.4', '0.0.0');
+            const version = await mongoUpdater.getAppSchemaVersion();
+            chai_1.assert.strictEqual(version, '0.0.0');
+        });
+    });
+    describe('checkUpdate', async () => {
+        let lockSpy;
+        let applyUpdateSchemasSpy;
+        let updateSchemaVersionSpy;
+        let unlockSpy;
+        beforeEach(async () => {
+            lockSpy = sinon.spy(mongoUpdater, 'lockAppSchemaDocument');
+            applyUpdateSchemasSpy = sinon.spy(mongoUpdater, 'applyAppSchemaUpdates');
+            updateSchemaVersionSpy = sinon.spy(mongoUpdater, 'updateAppSchemaVersion');
+            unlockSpy = sinon.spy(mongoUpdater, 'unlockAppSchemaDocument');
+        });
+        afterEach(async () => {
+            await mongoDb.dropCollection('test');
+            lockSpy.restore();
+            applyUpdateSchemasSpy.restore();
+            updateSchemaVersionSpy.restore();
+            unlockSpy.restore();
+        });
+        it('should work when not already locked', async () => {
+            const timer = new general_utils_1.Timer();
+            await mongoUpdater.checkUpdates();
+            const elapsed = timer.getMillisecondsElapsed();
+            chai_1.assert.isTrue(elapsed < 2000);
+            chai_1.assert.strictEqual(lockSpy.callCount, 1);
+            chai_1.assert.strictEqual(applyUpdateSchemasSpy.callCount, 1);
+            chai_1.assert.strictEqual(updateSchemaVersionSpy.callCount, 1);
+            chai_1.assert.strictEqual(unlockSpy.callCount, 1);
+        });
+        // ==========================================
+        // A regular function is *required* to get the proper
+        // "this" value to call ".timeout(...)"
+        // ==========================================
+        it('should wait when is already locked and should delete a lock that is too old', async function () {
+            this.timeout(5000);
+            // Resets version to 0.0.0
+            await mongoUpdater.updateAppSchemaVersion('X.X.X', '0.0.0');
+            // ==========================================
+            // Temporarly changes the lock max age.
+            // ==========================================
+            const lockMaxAgeSecondsBackup = testconfig.updater.lockMaxAgeSeconds;
+            mongoUpdater['lockMaxAgeSeconds'] = 3;
+            chai_1.assert.strictEqual(mongoUpdater['lockMaxAgeSeconds'], 3);
+            try {
+                const isLocked = await mongoUpdater.lockAppSchemaDocument();
+                chai_1.assert.strictEqual(isLocked, true);
+                const timer = new general_utils_1.Timer();
+                await mongoUpdater.checkUpdates();
+                const elapsed = timer.getMillisecondsElapsed();
+                chai_1.assert.isTrue(elapsed > 3000);
+            }
+            finally {
+                mongoUpdater['lockMaxAgeSeconds'] = lockMaxAgeSecondsBackup;
+            }
+        });
+    });
+    describe('getUpdateFiles', async () => {
+        it('should not contain files for version between 0.0.0 and 0.0.0', async () => {
+            const files = await mongoUpdater.getAppSchemaUpdateFiles('0.0.0', '0.0.0');
+            chai_1.assert.strictEqual(files.length, 0);
+        });
+        it('should not contain files for version between 1.0.0 and 1.0.0', async () => {
+            const files = await mongoUpdater.getAppSchemaUpdateFiles('1.0.0', '1.0.0');
+            chai_1.assert.strictEqual(files.length, 0);
+        });
+        it('should contain one file for version between 0.0.0 and 1.0.0', async () => {
+            const files = await mongoUpdater.getAppSchemaUpdateFiles('0.0.0', '1.0.0');
+            chai_1.assert.strictEqual(files.length, 1);
+            chai_1.assert.strictEqual(files[0], '1.0.0');
+        });
+    });
+    describe('applyUpdateSchemas', async () => {
+        let getUpdateFilesSpy;
+        beforeEach(async () => {
+            getUpdateFilesSpy = sinon.spy(mongoUpdater, 'getAppSchemaUpdateFiles');
+        });
+        afterEach(async () => {
+            getUpdateFilesSpy.restore();
+        });
+        it('should call getUpdateFilesSpy one time', async () => {
+            await mongoUpdater.applyAppSchemaUpdates('0.0.0', '1.0.0');
+            chai_1.assert.strictEqual(getUpdateFilesSpy.callCount, 1);
+        });
+    });
+});
+//# sourceMappingURL=mongoUpdater.test.js.map

package/dist/src/mongoUpdater.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongoUpdater.test.js","sourceRoot":"","sources":["../../src/mongoUpdater.test.ts"],"names":[],"mappings":";AAAA,sBAAsB;AACtB,sCAAsC;AACtC,mCAAmC;;AAEnC,kEAAuD;AACvD,+BAA8B;AAE9B,+BAA+B;AAC/B,kDAAmE;AAEnE,+CAA6C;AAC7C,iDAA6D;AAC7D,6CAA0C;AAC1C,yEAAyE;AAEzE,IAAI,OAAmB,CAAC;AACxB,IAAI,YAA2B,CAAC;AAEhC,gDAAwB,EAAE,CAAC;AAE3B,6CAA6C;AAC7C,gBAAgB;AAChB,6CAA6C;AAC7C,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,qDAAqD;IACrD,kDAAkD;IAClD,MAAM,UAAU,GAAqB,qBAAgB,CAAC,WAAW,CAAC;IAElE,MAAM,CAAC,KAAK;QACV,oGAAoG;QACpG,MAAM,uBAAU,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QACzE,MAAM,UAAU,GAAG,MAAM,0BAAY,CAAC,UAAU,CAAC,CAAC;QAElD,aAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxB,OAAO,GAAG,UAAU,CAAC,EAAE,CAAC;QAExB,gCAAgC;QAChC,YAAY,GAAG,IAAI,2BAAY,CAC7B,OAAO,EACP,UAAU,CAAC,OAAO,CAAC,yBAAyB,EAC5C,UAAU,CAAC,OAAO,CAAC,iBAAiB,EACpC,UAAU,CAAC,OAAO,CAAC,uBAAuB,CAC3C,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,KAAK,IAAI,EAAE;QACf,6CAA6C;QAC7C,6BAA6B;QAC7B,6CAA6C;QAC7C,MAAM,OAAO,CAAC,YAAY,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,KAAK,IAAI,EAAE;QACtC,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,OAAO,GAAW,MAAM,YAAY,CAAC,mBAAmB,EAAE,CAAC;YACjE,aAAM,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;QAClC,IAAI,6BAA6C,CAAC;QAElD,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,6BAA6B,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,4BAA4B,CAAC,CAAC;QACxF,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,6BAA6B,CAAC,OAAO,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YACzD,MAAM,WAAW,GAAU,MAAM,OAAO;iBACrC,eAAe,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;iBACrE,OAAO,EAAE,CAAC;YACb,aAAM,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;YAClF,MAAM,YAAY,CAAC,iBAAiB,EAAE,CAAC;YAEvC,aAAM,CAAC,WAAW,CAAC,6BAA6B,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YAE/D,MAAM,WAAW,GAAU,MAAM,OAAO;iBACrC,eAAe,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;iBACrE,OAAO,EAAE,CAAC;YACb,aAAM,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;YAChE,MAAM,YAAY,CAAC,iBAAiB,EAAE,CAAC;YACvC,aAAM,CAAC,WAAW,CAAC,6BAA6B,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,YAAY,CAAC,iBAAiB,EAAE,CAAC;YAEvC,MAAM,WAAW,GAAU,MAAM,OAAO;iBACrC,eAAe,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;iBACrE,OAAO,EAAE,CAAC;YACb,aAAM,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC1C,aAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;YAEpF,MAAM,MAAM,GAAuB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;YAClG,MAAM,QAAQ,GAAU,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YACtD,aAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,KAAK,IAAI,EAAE;QACtC,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,OAAO,GAAW,MAAM,YAAY,CAAC,mBAAmB,EAAE,CAAC;YACjE,aAAM,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;QAC1B,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;YAC7C,MAAM,MAAM,GAAuB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;YAClG,MAAM,QAAQ,GAAU,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YACtD,aAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;YACtC,MAAM,QAAQ,GAAY,MAAM,YAAY,CAAC,qBAAqB,EAAE,CAAC;YACrE,aAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,MAAM,GAAuB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;YAClG,MAAM,QAAQ,GAAU,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YACtD,aAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;YACzC,MAAM,QAAQ,GAAY,MAAM,YAAY,CAAC,qBAAqB,EAAE,CAAC;YACrE,aAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE;QAC5B,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,MAAM,GAAuB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;YAClG,MAAM,QAAQ,GAAU,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YACtD,aAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;YACxC,MAAM,UAAU,GAAY,MAAM,YAAY,CAAC,uBAAuB,EAAE,CAAC;YACzE,aAAM,CAAC,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;YAC7C,MAAM,MAAM,GAAuB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;YAClG,MAAM,QAAQ,GAAU,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YACtD,aAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;YAC3C,MAAM,UAAU,GAAY,MAAM,YAAY,CAAC,uBAAuB,EAAE,CAAC;YACzE,aAAM,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YAEtC,MAAM,MAAM,GAAuB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;YAClG,MAAM,QAAQ,GAAU,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YACtD,aAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACzC,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,OAAO,GAAW,MAAM,YAAY,CAAC,mBAAmB,EAAE,CAAC;YACjE,aAAM,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,YAAY,CAAC,sBAAsB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAE5D,MAAM,OAAO,GAAW,MAAM,YAAY,CAAC,mBAAmB,EAAE,CAAC;YACjE,aAAM,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,YAAY,CAAC,sBAAsB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAE5D,MAAM,OAAO,GAAW,MAAM,YAAY,CAAC,mBAAmB,EAAE,CAAC;YACjE,aAAM,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE;QACjC,IAAI,OAAuB,CAAC;QAC5B,IAAI,qBAAqC,CAAC;QAC1C,IAAI,sBAAsC,CAAC;QAC3C,IAAI,SAAyB,CAAC;QAC9B,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,uBAAuB,CAAC,CAAC;YAC3D,qBAAqB,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,uBAAuB,CAAC,CAAC;YACzE,sBAAsB,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,wBAAwB,CAAC,CAAC;YAC3E,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,yBAAyB,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YACrC,OAAO,CAAC,OAAO,EAAE,CAAC;YAClB,qBAAqB,CAAC,OAAO,EAAE,CAAC;YAChC,sBAAsB,CAAC,OAAO,EAAE,CAAC;YACjC,SAAS,CAAC,OAAO,EAAE,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,KAAK,GAAG,IAAI,qBAAK,EAAE,CAAC;YAC1B,MAAM,YAAY,CAAC,YAAY,EAAE,CAAC;YAClC,MAAM,OAAO,GAAG,KAAK,CAAC,sBAAsB,EAAE,CAAC;YAE/C,aAAM,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;YAE9B,aAAM,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACzC,aAAM,CAAC,WAAW,CAAC,qBAAqB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACvD,aAAM,CAAC,WAAW,CAAC,sBAAsB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACxD,aAAM,CAAC,WAAW,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,6CAA6C;QAC7C,qDAAqD;QACrD,uCAAuC;QACvC,6CAA6C;QAC7C,EAAE,CAAC,6EAA6E,EAAE,KAAK;YACrF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAEnB,0BAA0B;YAC1B,MAAM,YAAY,CAAC,sBAAsB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAE5D,6CAA6C;YAC7C,uCAAuC;YACvC,6CAA6C;YAC7C,MAAM,uBAAuB,GAAG,UAAU,CAAC,OAAO,CAAC,iBAAiB,CAAC;YACrE,YAAY,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;YACtC,aAAM,CAAC,WAAW,CAAC,YAAY,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC;YAEzD,IAAI;gBACF,MAAM,QAAQ,GAAY,MAAM,YAAY,CAAC,qBAAqB,EAAE,CAAC;gBACrE,aAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;gBAEnC,MAAM,KAAK,GAAG,IAAI,qBAAK,EAAE,CAAC;gBAC1B,MAAM,YAAY,CAAC,YAAY,EAAE,CAAC;gBAClC,MAAM,OAAO,GAAG,KAAK,CAAC,sBAAsB,EAAE,CAAC;gBAE/C,aAAM,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;aAC/B;oBAAS;gBACR,YAAY,CAAC,mBAAmB,CAAC,GAAG,uBAAuB,CAAC;aAC7D;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;QACpC,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;YAC5E,MAAM,KAAK,GAAa,MAAM,YAAY,CAAC,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACrF,aAAM,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;YAC5E,MAAM,KAAK,GAAa,MAAM,YAAY,CAAC,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACrF,aAAM,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;YAC3E,MAAM,KAAK,GAAa,MAAM,YAAY,CAAC,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAErF,aAAM,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YACpC,aAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;QACxC,IAAI,iBAAiC,CAAC;QACtC,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,iBAAiB,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,yBAAyB,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,iBAAiB,CAAC,OAAO,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,YAAY,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC3D,aAAM,CAAC,WAAW,CAAC,iBAAiB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/mongoUtils.d.ts

@@ -0,0 +1,68 @@
+import { ApiErrorAndInfo } from '@villedemontreal/general-utils';
+import * as mocha from 'mocha';
+import { MongoMemoryReplSet, MongoMemoryServer } from 'mongodb-memory-server-core';
+import * as mongoose from 'mongoose';
+/**
+ * Mongo utilities
+ */
+export declare class MongoUtils {
+    private mongoMemServer;
+    private useReplSet;
+    private mockgosseMockedFlag;
+    /**
+     * Mocks the Mongo databases created through Mongoose.
+     *
+     * IMPORTANT!!
+     * For the "mochaInstance" parameter to be the proper
+     * one, this function must be called from a *regular function* in a
+     * test file, not from an *arrow function*! For more informations,
+     * see : https://github.com/mochajs/mocha/issues/2018
+     *
+     * Note that, currently, once this mocking is in place,
+     * it can't be removed. You should only call this function
+     * during testing!
+     *
+     * If Mongoose is already mocked, the function does nothing.
+     *
+     * @param mocha from a Mocha test file, pass "this" as the value
+     * for this parameter or "null" from elsewhere.
+     *
+     * @param mongoServerVersion the Mongo version to use.
+     * Pass null (or undefined) to use the default version
+     * downloaded by mongodb-memory-server.
+     */
+    mockMongoose(mochaInstance: mocha.Context, mongoServerVersion: string, useReplSet?: boolean): Promise<MongoMemoryServer | MongoMemoryReplSet>;
+    /**
+     * Drop all mocked Mongo databases.
+     *
+     */
+    dropMockedDatabases(): Promise<void>;
+    getMockedServerPort(): Promise<number>;
+    /**
+     * Validates if an object is a Mongoose
+     * error.
+     */
+    isMongooseError(obj: any): boolean;
+    /**
+     * Validates if an object is a plain
+     * Mongo error.
+     */
+    isPlainMongoError(errorObject: any): boolean;
+    /**
+     * Creates an Api eror from an error thrown
+     * by Mongoose.
+     *
+     * If the specified error is not a Mongo/Mongoose error, it
+     * will be returned as is.
+     *
+     * @param error the Mongo/Mongoose error object
+     * @param publicMessage a public message to be used in the
+     * generated error. Fopr example : "The user is invalid".
+     */
+    convertMongoOrMongooseErrorToApiError(err: any, publicMessage: string): ApiErrorAndInfo | any;
+    /**
+     * Converts a Mongoose Document to a plain Pojo.
+     */
+    convertMongooseDocumentToPlainObject<T>(document: T & mongoose.Document): T;
+}
+export declare let mongoUtils: MongoUtils;