@syngrisi/syngrisi 2.2.2 → 2.2.6-alpha.0

package/src/server/controllers/auth.controller.js

@@ -1,156 +0,0 @@
-const httpStatus = require('http-status');
-const passport = require('passport');
-const hasha = require('hasha');
-const uuidAPIKey = require('uuid-apikey');
-const { User } = require('../models');
-const catchAsync = require('../utils/catchAsync');
-
-function getApiKey() {
-    return uuidAPIKey.create().apiKey;
-}
-
-const $this = this;
-$this.logMeta = {
-    scope: 'authentication',
-    msgType: 'AUTHENTICATION',
-};
-// const { authService, userService, tokenService, emailService } = require('../services');
-
-const apikey = catchAsync(async (req, res, next) => {
-    const apiKey = getApiKey();
-    log.debug(
-        `generate API Key for user: '${req.user.username}'`,
-        $this,
-        { user: req.user.username, scope: 'apikey', msgType: 'GENERATE_API' }
-    );
-    const hash = hasha(apiKey);
-    const user = await User.findOne({ username: req.user.username });
-    user.apiKey = hash;
-    await user.save();
-    res.status(200)
-        .json({ apikey: apiKey });
-});
-
-const login = catchAsync(async (req, res, next) => {
-    const logOpts = {
-        scope: 'login',
-        msgType: 'AUTHENTICATION',
-    };
-    passport.authenticate('local',
-        (err, user, info) => {
-            if (err) {
-                log.error(`Authentication error: '${err}'`, this, logOpts);
-                return res.status(httpStatus.UNAUTHORIZED)
-                    .json({ message: 'authentication error' });
-            }
-            if (!user) {
-                log.error(`Authentication error: '${info.message}'`, this, logOpts);
-                return res.status(httpStatus.UNAUTHORIZED)
-                    .json({ message: `Authentication error: '${info.message}'` });
-            }
-
-            req.logIn(user, (e) => {
-                if (e) {
-                    log.error(e.stack || e.toString());
-                    return next(e);
-                }
-                log.info('user is logged in', this, { user: user.username });
-                return res.status(200)
-                    .json({ message: 'success' });
-            });
-        })(req, res, next);
-});
-
-const logout = catchAsync(async (req, res) => {
-    const logOpts = {
-        scope: 'logout',
-        msgType: 'AUTHENTICATION',
-    };
-    try {
-        log.debug(`try to log out user: '${req?.user?.username}'`, $this, logOpts);
-        await req.logout(
-            {},
-            () => res.status(httpStatus.OK)
-                .json({ message: 'success' })
-        );
-    } catch (e) {
-        log.error(e.stack || e.toString());
-        res.status(httpStatus.INTERNAL_SERVER_ERROR)
-            .json({ message: 'fail' });
-    }
-});
-
-const changePassword = catchAsync(async (req, res) => {
-    const logOpts = {
-        scope: 'changePassword',
-        msgType: 'CHANGE_PASSWORD',
-        itemType: 'user',
-        ref: req?.user?.username,
-    };
-
-    const {
-        currentPassword,
-        newPassword,
-        // newPasswordConfirmation,
-    } = req.body;
-
-    const username = req?.user?.username;
-
-    log.debug(`change password for '${username}', params: '${JSON.stringify(req.body)}'`, this, logOpts);
-
-    const user = await User.findOne({ username });
-    if (!user) {
-        log.error('user is not logged in', this, logOpts);
-        return res.status(httpStatus.UNAUTHORIZED)
-            .json({ message: 'user is not logged in' });
-    }
-
-    try {
-        await user.changePassword(currentPassword, newPassword);
-    } catch (e) {
-        log.error(e.stack || e.toString(), this, logOpts);
-        return res.status(httpStatus.INTERNAL_SERVER_ERROR)
-            .json({ message: e.toString() });
-    }
-
-    log.debug(`password was successfully changed for user: ${req.user.username}`, this, logOpts);
-    return res.status(200)
-        .json({ message: 'success' });
-});
-
-const changePasswordFirstRun = catchAsync(async (req, res) => {
-    const logOpts = {
-        scope: 'changePasswordFirstRun',
-        msgType: 'CHANGE_PASSWORD_FIRST_RUN',
-        itemType: 'user',
-        ref: req?.user?.username,
-    };
-
-    const { newPassword } = req.body;
-
-    if ((await global.AppSettings.isAuthEnabled()) && ((await global.AppSettings.isFirstRun()))) {
-        log.debug(`first run, change password for default 'Administrator', params: '${JSON.stringify(req.body)}'`, $this, logOpts);
-        const user = await User.findOne({ username: 'Administrator' })
-            .exec();
-        logOpts.ref = user?.username;
-
-        await user.setPassword(newPassword);
-        await user.save();
-        log.debug('password was successfully changed for default Administrator', $this, logOpts);
-        await global.AppSettings.set('first_run', false);
-        return res.status(200)
-            .json({ message: 'success' });
-    }
-    log.error(`trying to use first run API with no first run state, auth: '${await global.AppSettings.isAuthEnabled()}', `
-        + `global settings: '${(await global.AppSettings.get('first_run'))}'`, $this, logOpts);
-    return res.status(httpStatus.FORBIDDEN)
-        .json({ message: 'forbidden' });
-});
-
-module.exports = {
-    login,
-    changePassword,
-    changePasswordFirstRun,
-    logout,
-    apikey,
-};

package/src/server/controllers/baseline.controller.js

@@ -1,24 +0,0 @@
-const httpStatus = require('http-status');
-const catchAsync = require('../utils/catchAsync');
-const { genericService } = require('../services');
-const { deserializeIfJSON, pick } = require('../utils');
-const ApiError = require('../utils/ApiError');
-
-const get = catchAsync(async (req, res) => {
-    const filter = req.query.filter ? deserializeIfJSON(pick(req.query, ['filter']).filter) : {};
-    const options = pick(req.query, ['sortBy', 'limit', 'page', 'populate']);
-    const result = await genericService.get('VRSBaseline', filter, options);
-    res.send(result);
-});
-
-const put = catchAsync(async (req, res) => {
-    const { id } = req.params;
-    if (!id) throw new ApiError(httpStatus.BAD_REQUEST, 'Cannot update the baseline - Id not found');
-    const result = await genericService.put('VRSBaseline', id, req.body, req?.user);
-    res.send(result);
-});
-
-module.exports = {
-    get,
-    put,
-};

package/src/server/controllers/client.controller.js

@@ -1,173 +0,0 @@
-const httpStatus = require('http-status');
-const ApiError = require('../utils/ApiError');
-const catchAsync = require('../utils/catchAsync');
-const { clientService, genericService } = require('../services');
-const { pick, deserializeIfJSON } = require('../utils');
-const orm = require('../lib/dbItems');
-const prettyCheckParams = require('../utils/prettyCheckParams');
-const { paramsGuard } = require('../../../dist/src/server/utils/paramsGuard');
-const { RequiredIdentOptionsSchema } = require('../../../dist/src/server/schemas/getBaseline.shema');
-
-const { User, Test, App, Suite } = require('../models');
-const { createCheckParamsSchema } = require('../../../dist/src/server/schemas/createCheck.shema');
-
-const $this = this;
-$this.logMeta = {
-    scope: 'client_controller',
-    msgType: 'API',
-};
-
-// exports.createCheck = async (req, res) => ;
-const startSession = catchAsync(async (req, res, next) => {
-    const params = pick(
-        req.body,
-        ['name', 'status', 'app', 'tags', 'branch', 'viewport', 'browser', 'browserVersion', 'browserFullVersion',
-            'os', 'run', 'runident', 'suite']
-    );
-    const result = await clientService.startSession(params, req?.user?.username);
-    res.send(result);
-});
-
-const endSession = catchAsync(async (req, res) => {
-    const testId = req.params.testid;
-    if (!testId || testId === 'undefined') {
-        throw new ApiError(httpStatus.BAD_REQUEST, 'Cannot stop test Session testId is empty');
-    }
-
-    const result = await clientService.endSession(testId, req?.user?.username);
-    res.send(result);
-});
-
-// const lackOfParamsGuard = (req, res) => {
-//     let errMsg = null;
-//     if (!req.body.testid) {
-//         errMsg = 'Cannot create check without \'testid\' parameter, '
-//             + `try to initialize the session at first. parameters: '${JSON.stringify(req.body)}'`;
-//     }
-//     if (!req.body.hashcode) {
-//         errMsg = `Cannot create check without 'hashcode' parameter, parameters: '${JSON.stringify(req.body)}'`;
-//     }
-//
-//     if (!req.body.name) {
-//         errMsg = 'Cannot create check without check name parameter, '
-//             + ` parameters: '${JSON.stringify(req.body)}'`;
-//     }
-//     if (errMsg) {
-//         res.status(400)
-//             .send({
-//                 status: 'paramNotFound',
-//                 message: errMsg,
-//             });
-//         throw new Error(errMsg);
-//     }
-// };
-
-const createCheck = catchAsync(async (req, res) => {
-    const apiKey = req.headers.apikey;
-    const params = req.body;
-    paramsGuard(params, 'createCheck, params', createCheckParamsSchema);
-
-    const logOpts = {
-        scope: 'createCheck',
-        user: req?.user?.username,
-        itemType: 'check',
-        msgType: 'CREATE',
-    };
-
-    const currentUser = await User.findOne({ apiKey })
-        .exec();
-
-    log.info(`start create check: '${prettyCheckParams(params.name)}'`, $this, logOpts);
-
-    /** look for or create test and suite */
-    log.debug(`try to find test with id: '${params.testid}'`, $this, logOpts);
-    const test = await Test.findById(params.testid)
-        .exec();
-    if (!test) {
-        const errMsg = `can't find test with id: '${params.testid}', `
-            + `parameters: '${JSON.stringify(req.body)}', username: '${currentUser.username}', apiKey: ${apiKey}`;
-        res.status(400)
-            .send({ status: 'testNotFound', message: errMsg });
-        throw new Error(errMsg);
-    }
-    const app = await App.findOne({ name: params.appName }).exec();
-    const suite = await Suite.findOne({ name: params.suitename }).exec();
-
-    await orm.updateItem('VRSTest', { _id: test.id }, {
-        suite: suite.id,
-        creatorId: currentUser._id,
-        creatorUsername: currentUser.username,
-    });
-
-    const result = await clientService.createCheck(
-        {
-            branch: params.branch,
-            hashCode: params.hashcode,
-            testId: params.testid,
-            name: params.name,
-            viewport: params.viewport,
-            browserName: params.browserName,
-            browserVersion: params.browserVersion,
-            browserFullVersion: params.browserFullVersion,
-            os: params.os,
-            files: req.files,
-            domDump: params.domdump,
-            vShifting: params.vShifting,
-        },
-        test,
-        suite,
-        app,
-        currentUser
-    );
-    if (result.status === 'needFiles') {
-        res.status(206)
-            .json({
-                status: 'requiredFileData',
-                message: 'could not find a snapshot with such a hash code, please add image file data and resend request',
-                hashCode: params.hashcode,
-            });
-        return;
-    }
-    res.json(result);
-});
-
-const getIdent = catchAsync(async (req, res) => {
-    const result = clientService.getIdent();
-    res.send(result);
-});
-//
-// const checkIfScreenshotHasBaselines = catchAsync(async (req, res) => {
-//     const result = await clientService.checkIfScreenshotHasBaselines(req.query);
-//     res.send(result);
-// });
-
-const getBaselines = catchAsync(async (req, res) => {
-    const filter = pick(
-        (req.query.filter ? deserializeIfJSON(req.query.filter) : {}),
-        ['name', 'viewport', 'browserName', 'os', 'app', 'branch']
-    );
-    paramsGuard(filter, 'getBaseline, filter', RequiredIdentOptionsSchema);
-    const options = pick(req.query, ['sortBy', 'limit', 'page', 'populate']);
-    const result = await clientService.getBaselines(filter, options);
-    res.send(result);
-});
-
-const getSnapshots = catchAsync(async (req, res) => {
-    const filter = pick(
-        (req.query.filter ? deserializeIfJSON(req.query.filter) : {}),
-        ['_id', 'name', 'imghash', 'createdDate', 'filename', 'id']
-    );
-    const options = pick(req.query, ['sortBy', 'limit', 'page', 'populate']);
-    const result = await genericService.get('VRSSnapshot', filter, options);
-    res.send(result);
-});
-
-module.exports = {
-    startSession,
-    endSession,
-    createCheck,
-    getIdent,
-    // checkIfScreenshotHasBaselines,
-    getBaselines,
-    getSnapshots,
-};

package/src/server/controllers/index.js

@@ -1,12 +0,0 @@
-module.exports.authController = require('./auth.controller');
-module.exports.userController = require('./users.controller');
-module.exports.logsController = require('./logs.controller');
-module.exports.checksController = require('./check.controller');
-module.exports.baselinesController = require('./baseline.controller');
-module.exports.runsController = require('./runs.controller');
-module.exports.snapshotController = require('./snapshots.controller');
-module.exports.suiteController = require('./suite.controller');
-module.exports.testsController = require('./test.controller');
-module.exports.settingsController = require('./settings.controller');
-module.exports.tasksController = require('./tasks.controller');
-module.exports.clientController = require('./client.controller');

package/src/server/controllers/logs.controller.js

@@ -1,30 +0,0 @@
-const httpStatus = require('http-status');
-const { EJSON } = require('bson');
-const catchAsync = require('../utils/catchAsync');
-const { logsService } = require('../services');
-const pick = require('../utils/pick');
-
-const getLogs = catchAsync(async (req, res) => {
-    const filter = req.query.filter ? EJSON.parse(pick(req.query, ['filter']).filter) : {};
-    const options = pick(req.query, ['sortBy', 'limit', 'page']);
-    const result = await logsService.queryLogs(filter, options);
-    res.send(result);
-});
-
-const distinct = catchAsync(async (req, res) => {
-    const { field } = pick(req.query, ['field']);
-    const result = await logsService.distinct(field);
-    res.send(result);
-});
-
-const createLog = catchAsync(async (req, res) => {
-    const user = await logsService.createLogs(req.body);
-    res.status(httpStatus.CREATED)
-        .send(user);
-});
-
-module.exports = {
-    getLogs,
-    distinct,
-    createLog,
-};

package/src/server/controllers/runs.controller.js

@@ -1,25 +0,0 @@
-// eslint-disable-next-line no-unused-vars
-const httpStatus = require('http-status');
-const { EJSON } = require('bson');
-const catchAsync = require('../utils/catchAsync');
-const { genericService } = require('../services');
-const { runService } = require('../services');
-const pick = require('../utils/pick');
-
-const get = catchAsync(async (req, res) => {
-    const filter = req.query.filter ? EJSON.parse(pick(req.query, ['filter']).filter) : {};
-    const options = pick(req.query, ['sortBy', 'limit', 'page']);
-    const result = await genericService.get('VRSRun', filter, options);
-    res.send(result);
-});
-
-const remove = catchAsync(async (req, res) => {
-    const { id } = req.params;
-    const result = await runService.remove(id, req?.user);
-    res.send(result);
-});
-
-module.exports = {
-    get,
-    remove,
-};

package/src/server/controllers/settings.controller.js

@@ -1,23 +0,0 @@
-const catchAsync = require('../utils/catchAsync');
-
-const getSettings = catchAsync(async (req, res) => {
-    const result = global.AppSettings.cache;
-    res.json(result);
-});
-
-const updateSetting = catchAsync(async (req, res) => {
-    const { name } = req.params;
-    // console.log(req.body, name);
-    await global.AppSettings.set(name, req.body.value);
-    if (req.body.enabled === false) {
-        await global.AppSettings.disable(name);
-    } else {
-        await global.AppSettings.enable(name);
-    }
-    res.json({ message: 'success' });
-});
-
-module.exports = {
-    getSettings,
-    updateSetting,
-};

package/src/server/controllers/snapshots.controller.js

@@ -1,17 +0,0 @@
-// eslint-disable-next-line no-unused-vars
-const httpStatus = require('http-status');
-const { EJSON } = require('bson');
-const catchAsync = require('../utils/catchAsync');
-const { genericService } = require('../services');
-const pick = require('../utils/pick');
-
-const get = catchAsync(async (req, res) => {
-    const filter = req.query.filter ? EJSON.parse(pick(req.query, ['filter']).filter) : {};
-    const options = pick(req.query, ['sortBy', 'limit', 'page']);
-    const result = await genericService.get('VRSSnapshot', filter, options);
-    res.send(result);
-});
-
-module.exports = {
-    get,
-};

package/src/server/controllers/suite.controller.js

@@ -1,24 +0,0 @@
-// eslint-disable-next-line no-unused-vars
-const httpStatus = require('http-status');
-const { EJSON } = require('bson');
-const catchAsync = require('../utils/catchAsync');
-const { genericService, suiteService } = require('../services');
-const pick = require('../utils/pick');
-
-const get = catchAsync(async (req, res) => {
-    const filter = req.query.filter ? EJSON.parse(pick(req.query, ['filter']).filter) : {};
-    const options = pick(req.query, ['sortBy', 'limit', 'page']);
-    const result = await genericService.get('VRSSuite', filter, options);
-    res.send(result);
-});
-
-const remove = catchAsync(async (req, res) => {
-    const { id } = req.params;
-    const result = await suiteService.remove(id, req?.user);
-    res.send(result);
-});
-
-module.exports = {
-    get,
-    remove,
-};

package/src/server/controllers/tasks.controller.js

@@ -1,47 +0,0 @@
-/* eslint-disable camelcase */
-// const httpStatus = require('http-status');
-const catchAsync = require('../utils/catchAsync');
-const pick = require('../utils/pick');
-const { tasksService } = require('../services');
-
-const task_test = catchAsync(async (req, res) => {
-    const { options } = pick(req.query, ['options']);
-    await tasksService.task_test(options, req, res);
-});
-
-const task_handle_old_checks = catchAsync(async (req, res) => {
-    const options = pick(req.query, ['days', 'remove']);
-    await tasksService.task_handle_old_checks(options, res);
-});
-
-const task_handle_database_consistency = catchAsync(async (req, res) => {
-    const options = pick(req.query, ['days', 'clean']);
-    await tasksService.task_handle_database_consistency(options, res);
-});
-
-const task_remove_old_logs = catchAsync(async (req, res) => {
-    const options = pick(req.query, ['days', 'statistics']);
-    await tasksService.task_remove_old_logs(options, res);
-});
-
-const status = catchAsync(async (req, res) => {
-    res.send(await tasksService.status(req.user));
-});
-
-const screenshots = catchAsync(async (req, res) => {
-    res.send(await tasksService.screenshots(req.user));
-});
-
-const loadTestUser = catchAsync(async (req, res) => {
-    res.send(await tasksService.loadTestUser(req.user));
-});
-
-module.exports = {
-    task_test,
-    task_handle_old_checks,
-    task_handle_database_consistency,
-    task_remove_old_logs,
-    status,
-    loadTestUser,
-    screenshots,
-};

package/src/server/controllers/test.controller.js

@@ -1,70 +0,0 @@
-/* eslint-disable indent,no-useless-escape */
-const httpStatus = require('http-status');
-const pick = require('../utils/pick');
-// eslint-disable-next-line no-unused-vars
-const ApiError = require('../utils/ApiError');
-const catchAsync = require('../utils/catchAsync');
-const { testService } = require('../services');
-const { deserializeIfJSON } = require('../utils');
-
-const getTest = catchAsync(async (req, res) => {
-    const filter = {
-        ...deserializeIfJSON(req.query.base_filter),
-        ...deserializeIfJSON(req.query.filter),
-    };
-
-    if (req.user?.role === 'user') {
-        filter.creatorUsername = req.user?.username;
-    }
-
-    const options = pick(req.query, ['sortBy', 'limit', 'page', 'populate']);
-    const result = await testService.queryTests(filter, options);
-    res.status(httpStatus.OK)
-        .send(result);
-});
-
-const distinct = catchAsync(async (req, res) => {
-    const filter = pick(req.query, [
-        'suite',
-        'run',
-        'markedAs',
-        'creatorId',
-        'creatorUsername',
-        'name',
-        'status',
-        'browserName',
-        'browserVersion',
-        'branch',
-        'tags',
-        'viewport',
-        'os',
-        'app',
-        'startDate',
-        'filter',
-    ]);
-    const options = { ...pick(req.query, ['sortBy', 'limit', 'page', 'populate']), field: req.params.id };
-    const result = await testService.queryTestsDistinct(filter, options);
-    res.status(httpStatus.OK)
-        .send(result);
-});
-
-const remove = catchAsync(async (req, res) => {
-    const { id } = req.params;
-    if (!id) throw new ApiError(httpStatus.BAD_REQUEST, 'Cannot remove the test - Id not found');
-    const result = await testService.remove(id, req?.user);
-    res.send(result);
-});
-
-const accept = catchAsync(async (req, res) => {
-    const { id } = req.params;
-    if (!id) throw new ApiError(httpStatus.BAD_REQUEST, 'Cannot accept the check - Id not found');
-    const result = await testService.accept(id, req?.user);
-    res.send(result);
-});
-
-module.exports = {
-    getTest,
-    distinct,
-    remove,
-    accept,
-};

package/src/server/controllers/users.controller.js

@@ -1,79 +0,0 @@
-const httpStatus = require('http-status');
-const { EJSON } = require('bson');
-const catchAsync = require('../utils/catchAsync');
-const { usersService } = require('../services');
-const pick = require('../utils/pick');
-
-const $this = this;
-$this.logMeta = {
-    scope: 'users',
-};
-
-const current = catchAsync(async (req, res) => {
-    const logOpts = {
-        scope: 'users',
-        msgType: 'GET_CURRENT_USER',
-    };
-    log.debug(`current user is: '${req?.user?.username || 'not_logged'}'`, $this, logOpts);
-    res.status(httpStatus.OK)
-        .json({
-            id: req?.user?.id,
-            username: req?.user?.username,
-            firstName: req?.user?.firstName,
-            lastName: req?.user?.lastName,
-            role: req?.user?.role,
-        });
-});
-
-const getUsers = catchAsync(async (req, res) => {
-    const filter = req.query.filter ? EJSON.parse(pick(req.query, ['filter']).filter) : {};
-    const options = pick(req.query, ['sortBy', 'limit', 'page']);
-    const result = await usersService.queryUsers(filter, options);
-    res.send(result);
-});
-
-const createUser = catchAsync(async (req, res) => {
-    try {
-        const userData = pick(req.body, [
-            // 'id',
-            'username',
-            'firstName',
-            'lastName',
-            'role',
-            'password',
-            'apiKey',
-            'expiration',
-            'meta',
-        ]);
-        const user = await usersService.createUser(userData);
-        res.status(httpStatus.CREATED)
-            .send(user);
-    } catch (e) {
-        if (e.statusCode) {
-            log.error(e.stack || e.toString(), $this);
-            res.status(e.statusCode)
-                .json({ message: e.message });
-        } else {
-            throw e;
-        }
-    }
-});
-
-const updateUser = catchAsync(async (req, res) => {
-    const user = await usersService.updateUserById(req.params.userId, req.body);
-    res.send(user);
-});
-
-const deleteUser = catchAsync(async (req, res) => {
-    await usersService.deleteUserById(req.params.userId);
-    res.status(httpStatus.NO_CONTENT)
-        .send();
-});
-
-module.exports = {
-    current,
-    createUser,
-    updateUser,
-    deleteUser,
-    getUsers,
-};