@syngrisi/syngrisi 2.2.2 → 2.2.6-alpha.0

package/src/server/services/index.js

@@ -1,12 +0,0 @@
-module.exports = {
-    checkService: require('./check.service'),
-    runService: require('./run.service'),
-    suiteService: require('./suite.service'),
-    testService: require('./test.service'),
-    usersService: require('./user.service'),
-    logsService: require('./logs.service'),
-    genericService: require('./generic.service'),
-    appService: require('./app.service'),
-    tasksService: require('./tasks.service'),
-    clientService: require('./client.service'),
-};

package/src/server/services/logs.service.js

@@ -1,38 +0,0 @@
-/* eslint-disable valid-jsdoc */
-const { Log } = require('../models');
-// const ApiError = require('../utils/ApiError');
-
-const $this = this;
-$this.logMeta = {
-    scope: 'logs_service',
-    msgType: 'LOG',
-};
-
-/**
- * Query for users
- * @param {Object} filter - Mongo filter
- * @param {Object} options - Query options
- * @param {string} [options.sortBy] - Sort option in the format: sortField:(desc|asc)
- * @param {number} [options.limit] - Maximum number of results per page (default = 10)
- * @param {number} [options.page] - Current page (default = 1)
- * @returns {Promise<QueryResult>}
- */
-const queryLogs = async (filter, options) => Log.paginate(filter, options);
-
-const distinct = async (field) => Log.distinct(field);
-
-const createLogs = async (body) => {
-    log[body.level || 'debug'](body.message,
-        {
-            user: body.user,
-            scope: body.scope || 'test_scope',
-            msgType: body.msgType || 'TEST_MSG_TYPE',
-        });
-    return { message: 'success' };
-};
-
-module.exports = {
-    queryLogs,
-    distinct,
-    createLogs,
-};

package/src/server/services/run.service.js

@@ -1,40 +0,0 @@
-/* eslint-disable valid-jsdoc,no-restricted-syntax,no-await-in-loop */
-const { Test, Run } = require('../models');
-
-const testService = require('./test.service');
-
-const $this = this;
-$this.logMeta = {
-    scope: 'run_service',
-    msgType: 'RUN',
-};
-
-/**
- * Remove a run
- * @param {String} id - run id
- * @param {Object} user - current user
- * @returns {Promise<Run>}
- */
-const remove = async (id, user) => {
-    const logOpts = {
-        scope: 'removeRun',
-        itemType: 'run',
-        ref: id,
-        user: user?.username,
-        msgType: 'REMOVE',
-    };
-    log.info(`remove run with, id: '${id}', user: '${user.username}'`, $this, logOpts);
-    const tests = await Test.find({ run: id })
-        .exec();
-
-    for (const test of tests) {
-        await testService.remove(test._id, user);
-    }
-    const run = await Run.findByIdAndRemove(id)
-        .exec();
-    return run;
-};
-
-module.exports = {
-    remove,
-};

package/src/server/services/suite.service.js

@@ -1,39 +0,0 @@
-/* eslint-disable valid-jsdoc,no-restricted-syntax,no-await-in-loop */
-const { Test, Suite } = require('../models');
-const testService = require('./test.service');
-
-const $this = this;
-$this.logMeta = {
-    scope: 'suite_service',
-    msgType: 'SUITE',
-};
-
-/**
- * Remove a suite
- * @param {String} id - suite id
- * @param {Object} user - current user
- * @returns {Promise<Run>}
- */
-const remove = async (id, user) => {
-    const logOpts = {
-        scope: 'removeSuite',
-        itemType: 'suite',
-        ref: id,
-        user: user?.username,
-        msgType: 'REMOVE',
-    };
-    log.info(`remove suite with, id: '${id}', user: '${user.username}'`, $this, logOpts);
-    const tests = await Test.find({ suite: id })
-        .exec();
-
-    for (const test of tests) {
-        await testService.remove(test._id, user);
-    }
-    const suite = await Suite.findByIdAndRemove(id)
-        .exec();
-    return suite;
-};
-
-module.exports = {
-    remove,
-};

package/src/server/services/test.service.js

@@ -1,72 +0,0 @@
-/* eslint-disable no-restricted-syntax,no-await-in-loop */
-const testUtil = require('../utils/tests');
-const checkService = require('./check.service');
-const { Test, Check } = require('../models');
-
-const $this = this;
-$this.logMeta = {
-    scope: 'test_service',
-    msgType: 'TEST',
-};
-
-/**
- * Query for test
- * @param {Object} filter - Mongo filter
- * @param {Object} options - Query options
- * @param {string} [options.sortBy] - Sort option in the format: sortField:(desc|asc)
- * @param {number} [options.limit] - Maximum number of results per page (default = 10)
- * @param {number} [options.page] - Current page (default = 1)
- * @returns {Promise<QueryResult>} - result
- */
-const queryTests = async (filter, options) => {
-    const tests = await Test.paginate(filter, options);
-    return tests;
-};
-const queryTestsDistinct = async (filter, options) => {
-    const tests = await Test.paginateDistinct(filter, options);
-    return tests;
-};
-
-/**
- * Remove a test
- * @param {String} id - test id
- * @param {Object} user - current user
- * @returns {Promise<Check>} - removed test
- */
-const remove = async (id, user) => {
-    const logOpts = {
-        scope: 'removeTest',
-        itemType: 'test',
-        ref: id,
-        user: user?.username,
-        msgType: 'REMOVE',
-    };
-    log.info(`remove test with, id: '${id}', user: '${user.username}'`, $this, logOpts);
-    return testUtil.removeTest(id);
-};
-
-const accept = async (id, user) => {
-    const logOpts = {
-        scope: 'acceptTest',
-        itemType: 'test',
-        ref: id,
-        user: user?.username,
-        msgType: 'ACCEPT',
-    };
-    log.info(`accept test with, id: '${id}', user: '${user.username}'`, $this, logOpts);
-
-    const checks = await Check.find({ test: id })
-        .exec();
-
-    for (const check of checks) {
-        await checkService.accept(check._id, check.actualSnapshotId, user);
-    }
-    return { message: 'success' };
-};
-
-module.exports = {
-    queryTests,
-    queryTestsDistinct,
-    remove,
-    accept,
-};

package/src/server/services/user.service.js

@@ -1,128 +0,0 @@
-/* eslint-disable valid-jsdoc */
-const httpStatus = require('http-status');
-const { User } = require('../models');
-const ApiError = require('../utils/ApiError');
-
-const $this = this;
-$this.logMeta = {
-    scope: 'user_service',
-    msgType: 'USER',
-};
-
-/**
- * Create a user
- * @param {Object} userBody
- * @returns {Promise<User>}
- */
-const createUser = async (userBody) => {
-    if (await User.isEmailTaken(userBody.username)) {
-        throw new ApiError(httpStatus.BAD_REQUEST, 'Email already taken');
-    }
-    const logOpts = {
-        msgType: 'CREATE',
-        itemType: 'user',
-        ref: userBody.username,
-        scope: 'createUser',
-    };
-    log.debug(`create the user with name '${userBody.username}', params: '${JSON.stringify(userBody)}'`, $this, logOpts);
-
-    const user = await User.create({ ...userBody, createdDate: Date.now() });
-
-    const updatedUser = await user.setPassword(userBody.password);
-    await updatedUser.save();
-
-    log.debug(`password for user: '${userBody.username}' set successfully`, $this, logOpts);
-    return updatedUser;
-};
-
-/**
- * Query for users
- * @param {Object} filter - Mongo filter
- * @param {Object} options - Query options
- * @param {string} [options.sortBy] - Sort option in the format: sortField:(desc|asc)
- * @param {number} [options.limit] - Maximum number of results per page (default = 10)
- * @param {number} [options.page] - Current page (default = 1)
- * @returns {Promise<QueryResult>}
- */
-const queryUsers = async (filter, options) => {
-    const users = await User.paginate(filter, options);
-    return users;
-};
-
-/**
- * Get user by id
- * @param {ObjectId} id
- * @returns {Promise<User>}
- */
-const getUserById = async (id) => User.findById(id);
-
-/**
- * Get user by email
- * @param {string} email
- * @returns {Promise<User>}
- */
-const getUserByEmail = async (email) => User.findOne({ email });
-
-/**
- * Update user by id
- * @param {ObjectId} userId
- * @param {Object} updateBody
- * @returns {Promise<User>}
- */
-const updateUserById = async (userId, updateBody) => {
-    const logOpts = {
-        msgType: 'UPDATE',
-        itemType: 'user',
-        scope: 'updateUserById',
-    };
-
-    log.info(
-        `update user with id: '${userId}' name '${updateBody.username}', params: '${JSON.stringify(updateBody)}'`,
-        $this,
-        logOpts
-    );
-    const user = await getUserById(userId);
-    if (!user) {
-        throw new ApiError(httpStatus.NOT_FOUND, 'User not found');
-    }
-    if (updateBody.email && (await User.isEmailTaken(updateBody.email, userId))) {
-        throw new ApiError(httpStatus.BAD_REQUEST, 'Email already taken');
-    }
-    if (updateBody.password) {
-        log.debug(`update password for '${updateBody.username}'`, $this, logOpts);
-        await user.setPassword(updateBody.password);
-        await user.save();
-        log.debug(`password for '${updateBody.username}' was updated`, $this, logOpts);
-    }
-    log.debug(`user '${updateBody.username}' was updated successfully`, $this, logOpts);
-
-    // remove password
-    const { password, ...newupdateBody } = updateBody;
-    Object.assign(user, {
-        ...newupdateBody, updatedDate: Date.now(),
-    });
-    await user.save();
-    return user;
-};
-
-/**
- * Delete user by id
- * @param {ObjectId} userId
- * @returns {Promise<User>}
- */
-const deleteUserById = async (userId) => User.findByIdAndDelete(userId).exec();
-// const user = await getUserById(userId);
-// if (!user) {
-//     throw new ApiError(httpStatus.NOT_FOUND, 'User not found');
-// }
-// await user.remove();
-// return user;
-
-module.exports = {
-    createUser,
-    queryUsers,
-    getUserById,
-    getUserByEmail,
-    updateUserById,
-    deleteUserById,
-};

package/src/server/utils/catchAsync.js

@@ -1,8 +0,0 @@
-const catchAsync = (fn) => (req, res, next) => {
-    Promise.resolve(fn(req, res, next)).catch((err) => {
-        log.error(err.stack || err.toString());
-        return next(err);
-    });
-};
-
-module.exports = catchAsync;

package/src/server/utils/check.js

@@ -1,58 +0,0 @@
-const snapshotUtil = require('./snapshots');
-const { calculateAcceptedStatus } = require('./utils');
-const testUtil = require('./tests');
-const orm = require('../lib/dbItems');
-const { Check, Test } = require('../models');
-
-const $this = this;
-
-$this.logMeta = {
-    scope: 'check_helper',
-    msgType: 'API',
-};
-
-module.exports.removeCheck = async function removeCheck(id) {
-    const logOpts = {
-        scope: 'removeCheck',
-        itemType: 'check',
-        ref: id,
-        msgType: 'REMOVE',
-    };
-
-    try {
-        const check = await Check.findByIdAndDelete(id)
-            .exec();
-
-        log.debug(`check with id: '${id}' was removed, update test: ${check.test}`, $this, logOpts);
-
-        const test = await Test.findById(check.test)
-            .exec();
-        const testCalculatedStatus = await testUtil.calculateTestStatus(check.test);
-        const testCalculatedAcceptedStatus = await calculateAcceptedStatus(check.test);
-        test.status = testCalculatedStatus;
-        test.markedAs = testCalculatedAcceptedStatus;
-        test.updatedDate = new Date();
-        await orm.updateItemDate('VRSSuite', check.suite);
-        await test.save();
-
-        if ((check.baselineId) && (check.baselineId !== 'undefined')) {
-            log.debug(`try to remove the snapshot, baseline: ${check.baselineId}`, $this, logOpts);
-            await snapshotUtil.removeSnapshot(check.baselineId?.toString());
-        }
-
-        if ((check.actualSnapshotId) && (check.baselineId !== 'undefined')) {
-            log.debug(`try to remove the snapshot, actual: ${check.actualSnapshotId}`, $this, logOpts);
-            await snapshotUtil.removeSnapshot(check.actualSnapshotId?.toString());
-        }
-
-        if ((check.diffId) && (check.baselineId !== 'undefined')) {
-            log.debug(`try to remove snapshot, diff: ${check.diffId}`, $this, logOpts);
-            await snapshotUtil.removeSnapshot(check.diffId?.toString());
-        }
-        return check;
-    } catch (e) {
-        const errMsg = `cannot remove a check with id: '${id}', error: '${e.stack || e.toString()}'`;
-        log.error(errMsg, $this, logOpts);
-        throw new Error(errMsg);
-    }
-};

package/src/server/utils/dateToISO8601.js

@@ -1,2 +0,0 @@
-const dateToISO8601 = (date) => new Date(new Date(date)).toISOString().split('T')[0];
-module.exports = dateToISO8601;

package/src/server/utils/deserializeIfJSON.js

@@ -1,9 +0,0 @@
-const { EJSON } = require('bson');
-const isJSON = require('./isJSON');
-
-const deserializeIfJSON = (text) => {
-    if (isJSON(text)) return EJSON.parse(text || null) || undefined;
-    return text;
-};
-
-module.exports = deserializeIfJSON;

package/src/server/utils/index.js

@@ -1,10 +0,0 @@
-module.exports = {
-    pick: require('./pick'),
-    catchAsync: require('./catchAsync'),
-    ApiError: require('./ApiError'),
-    isJSON: require('./isJSON'),
-    deserializeIfJSON: require('./deserializeIfJSON'),
-    subDays: require('./subDays'),
-    dateToISO8601: require('./dateToISO8601'),
-    formatISOToDateTime: require('./formatISOToDateTime'),
-};

package/src/server/utils/isJSON.js

@@ -1,6 +0,0 @@
-/* eslint-disable */
-const isJSON = (text) => (!text ? '' : (/^[\],:{}\s]*$/.test(text.replace(/\\["\\\/bfnrtu]/g, '@')
-    .replace(/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, ']')
-    .replace(/(?:^|:|,)(?:\s*\[)+/g, ''))));
-
-module.exports = isJSON;

package/src/server/utils/pick.js

@@ -1,15 +0,0 @@
-/**
- * Create an object composed of the picked object properties
- * @param {Object} object input object
- * @param {string[]} keys fields to pick
- * @returns {Object} new object
- */
-const pick = (object, keys) => keys.reduce((obj, key) => {
-    if (object && Object.prototype.hasOwnProperty.call(object, key)) {
-        // eslint-disable-next-line no-param-reassign
-        if (object[key] !== undefined) obj[key] = object[key];
-    }
-    return obj;
-}, {});
-
-module.exports = pick;

package/src/server/utils/prettyCheckParams.js

@@ -1,13 +0,0 @@
-const prettyCheckParams = (result) => {
-    if (!result.domDump) {
-        return JSON.stringify(result);
-    }
-    const dump = JSON.parse(result.domDump);
-    const resObs = { ...result };
-    delete resObs.domDump;
-    resObs.domDump = `${JSON.stringify(dump)
-        .substr(0, 20)}... and about ${dump.length} items]`;
-    return JSON.stringify(resObs);
-};
-
-module.exports = prettyCheckParams;

package/src/server/utils/snapshots.js

@@ -1,73 +0,0 @@
-const fss = require('fs');
-const { config } = require('../../../config');
-
-const { Baseline, Snapshot } = require('../models');
-
-const $this = this;
-
-$this.logMeta = {
-    scope: 'snapshot_helper',
-    msgType: 'API',
-};
-
-const removeSnapshotFile = async (snapshot) => {
-    let relatedSnapshots;
-    if (snapshot.filename) {
-        relatedSnapshots = await Snapshot.find({ filename: snapshot.filename });
-        log.debug(`there is '${relatedSnapshots.length}' snapshots with such filename: '${snapshot.filename}'`, $this);
-    }
-
-    // eslint-disable-next-line arrow-body-style
-    const isLastSnapshotFile = () => {
-        if (snapshot.filename === undefined) {
-            return true;
-        }
-        return (relatedSnapshots.length === 0);
-    };
-    log.debug({ isLastSnapshotFile: isLastSnapshotFile() });
-    if (isLastSnapshotFile()) {
-        const path = `${config.defaultImagesPath}${snapshot.filename}`;
-        log.silly(`path: ${path}`, $this);
-        if (fss.existsSync(path)) {
-            log.debug(`remove file: '${path}'`, $this, {
-                msgType: 'REMOVE',
-                itemType: 'file',
-            });
-            fss.unlinkSync(path);
-        }
-    }
-};
-
-module.exports.removeSnapshot = async (id) => {
-    const logOpts = {
-        scope: 'removeSnapshot',
-        msgType: 'REMOVE',
-        itemType: 'snapshot',
-        ref: id,
-    };
-    log.silly(`delete snapshot with id: '${id}'`, logOpts);
-    if (!id) {
-        log.warn('id is empty');
-        return;
-    }
-    const snapshot = await Snapshot.findById(id);
-
-    if (snapshot === null) {
-        log.warn(`cannot find the snapshot with id: '${id}'`);
-        return;
-    }
-    const baseline = await Baseline.findOne({ snapshootId: id });
-
-    if (baseline) {
-        log.debug(`snapshot: '${id}' related to baseline baseline, skip`, logOpts);
-        return;
-    }
-
-    log.debug(`snapshot: '${id}' is not related to baseline, try to remove it`, logOpts);
-    await Snapshot.findByIdAndDelete(id);
-    log.debug(`snapshot: '${id}' was removed`, logOpts);
-    const path = `${config.defaultImagesPath}${snapshot.filename}`;
-
-    log.debug(`try to remove snapshot file, id: '${snapshot._id}', filename: '${path}'`, logOpts);
-    await removeSnapshotFile(snapshot);
-};

package/src/server/utils/tests.js

@@ -1,36 +0,0 @@
-const checkUtil = require('./check');
-const { Check, Test } = require('../models');
-
-module.exports.calculateTestStatus = async function calculateTestStatus(testId) {
-    const checksInTest = await Check.find({ test: testId });
-    const statuses = checksInTest.map((x) => x.status[0]);
-    let testCalculatedStatus = 'Failed';
-    if (statuses.every((x) => (x === 'new') || (x === 'passed'))) {
-        testCalculatedStatus = 'Passed';
-    }
-    if (statuses.every((x) => (x === 'new'))) {
-        testCalculatedStatus = 'New';
-    }
-    return testCalculatedStatus;
-};
-
-module.exports.removeTest = async function removeTest(id) {
-    const logOpts = {
-        itemType: 'test',
-        msgType: 'REMOVE',
-        ref: id,
-    };
-    try {
-        log.debug(`try to delete all checks associated to test with ID: '${id}'`, logOpts);
-        const checks = await Check.find({ test: id });
-        // eslint-disable-next-line no-restricted-syntax
-        for (const check of checks) {
-            // eslint-disable-next-line no-await-in-loop
-            await checkUtil.removeCheck(check._id);
-        }
-        return Test.findByIdAndDelete(id);
-    } catch (e) {
-        log.error(`cannot remove test with id: ${id} error: ${e.stack || e.toString()}`, logOpts);
-        throw new Error();
-    }
-};