@syngrisi/syngrisi 2.2.1

package/src/ui-app/shared/hooks/user.hooks.ts

@@ -0,0 +1,49 @@
+import { useQuery } from '@tanstack/react-query';
+import { GenericService, UsersService } from '../services';
+import { errorMsg } from '../utils';
+
+export const UserHooks = {
+    useApiKey() {
+        const { isLoading, error, data, isError, refetch, isFetching, isRefetching, isSuccess, status }: any = useQuery(
+            ['apiKey'], () => UsersService.getApiKey(), {
+                enabled: false,
+                onError: (err: unknown) => {
+                    errorMsg({ error: err });
+                },
+            },
+        );
+        return { isLoading, isFetching, isRefetching, isSuccess, error, data, isError, refetch, status };
+    },
+    useCurrentUser() {
+        const { isLoading, error, data, refetch, isSuccess }: any = useQuery(
+            ['currentUser'], () => UsersService.getCurrentUser(), {
+                onError: (err: unknown) => {
+                    errorMsg({ error: err });
+                },
+                refetchOnWindowFocus: false,
+            },
+        );
+        return { isLoading, error, data, refetch, isSuccess };
+    },
+    useUsersByUsername(username: any) {
+        return useQuery(
+            ['useUsersByUsername', username], () => GenericService.get('users', { username }), {
+                onError: (err: unknown) => {
+                    errorMsg({ error: err });
+                },
+                refetchOnWindowFocus: false,
+            },
+        );
+    },
+
+    useAllUsers() {
+        const { isLoading, error, data, refetch, isSuccess, isFetching }: any = useQuery(
+            ['allUsers'], () => GenericService.get('users', {}, { sortBy: 'id: desc', limit: '0' }), {
+                onError: (err: unknown) => {
+                    errorMsg({ error: err });
+                },
+            },
+        );
+        return { isLoading, error, data, refetch, isSuccess, isFetching };
+    },
+};

package/src/ui-app/shared/interfaces/ILog.tsx

@@ -0,0 +1,13 @@
+/* eslint-disable semi */
+interface IObjectKeys {
+    [key: string]: string | undefined;
+}
+
+export default interface ILog extends IObjectKeys {
+    id: string | undefined
+    hostname: string | undefined
+    level: string | undefined
+    message: string | undefined
+    meta: any,
+    timestamp: string | undefined
+}

package/src/ui-app/shared/interfaces/IUser.tsx

@@ -0,0 +1,13 @@
+/* eslint-disable semi */
+export default interface IUser {
+    id: string | undefined
+    username: string | undefined
+    firstName: string | undefined
+    lastName: string | undefined
+    role: string | undefined
+    password: string | undefined
+    apiKey: string | undefined
+    updatedDate: string | undefined
+    createdDate: string | undefined
+    refetch?: any
+}

package/src/ui-app/shared/interfaces/logQueries.tsx

@@ -0,0 +1,31 @@
+export interface IPage<T> {
+    timestamp: string;
+    limit: string
+    page: string
+    totalPages: string
+    totalResults: string
+    results: T[]
+}
+
+export interface IPagesQuery<T> {
+    isLoading: boolean
+    isError: boolean
+    data: {
+        pages: IPage<T>[]
+    }
+    error: any
+    isFetching: boolean
+    isFetchingNextPage: boolean
+    fetchNextPage: () => {}
+    hasNextPage: boolean
+    status: string
+}
+
+export interface IFirstPagesQuery<T> {
+    isLoading: boolean
+    isError: boolean
+    status: string
+    data: IPage<T>
+    error: any
+    refetch: () => {}
+}

package/src/ui-app/shared/navigation/interfaces.tsx

@@ -0,0 +1,7 @@
+export interface INavDataItem {
+    title: string,
+    description: string,
+    group?: string,
+    icon?: any,
+    crumbs: { title: string, href: string }[],
+}

package/src/ui-app/shared/navigation/navigationData.tsx

@@ -0,0 +1,191 @@
+import React from 'react';
+import {
+    IconBrowser,
+    IconCircleCheck,
+    IconClipboardList,
+    IconDeviceAnalytics,
+    IconList,
+    IconListCheck,
+    IconListDetails,
+    IconRun,
+    IconStatusChange,
+    IconUser,
+    IconUserExclamation,
+} from '@tabler/icons';
+import { INavDataItem } from './interfaces';
+
+// used in spotlight
+export function navigationData(): INavDataItem[] {
+    return [
+        {
+            title: 'Test Results',
+            description: 'Test Results Main Page',
+            group: 'main',
+            icon: <IconListCheck size={18} />,
+            crumbs: [
+                { title: 'Test Results', href: '/' },
+            ],
+        },
+        {
+            title: 'By Runs',
+            description: 'Test Results by Runs',
+            group: 'main',
+            icon: <IconRun size={18} />,
+            crumbs: [
+                { title: 'Test Results', href: '/' },
+                { title: 'By Runs', href: '/?groupBy=runs' },
+            ],
+        },
+        {
+            title: 'By Suites',
+            description: 'Test Results by Suites',
+            group: 'main',
+            icon: <IconClipboardList size={18} />,
+            crumbs: [
+                { title: 'Test Results', href: '/' },
+                { title: 'By Suites', href: '/?groupBy=suites' },
+            ],
+        },
+        {
+            title: 'By Browser',
+            description: 'Test Results by Browser',
+            group: 'main',
+            icon: <IconBrowser size={18} />,
+            crumbs: [
+                { title: 'Test Results', href: '/' },
+                { title: 'By Browser', href: '/?groupBy=test-distinct/browserName' },
+            ],
+        },
+        {
+            title: 'By Platform',
+            description: 'Test Results by Platform',
+            group: 'main',
+            icon: <IconDeviceAnalytics size={18} />,
+            crumbs: [
+                { title: 'Test Results', href: '/' },
+                { title: 'By Platform', href: '/?groupBy=test-distinct/os' },
+            ],
+        },
+        {
+            title: 'By Test Status',
+            description: 'Test Results by Test Status',
+            group: 'main',
+            icon: <IconStatusChange size={18} />,
+            crumbs: [
+                { title: 'Test Results', href: '/' },
+                { title: 'By Test Status', href: '/?groupBy=test-distinct/status' },
+            ],
+        },
+        {
+            title: 'By Accept Status',
+            description: 'Test Results by Accept Status',
+            group: 'main',
+            icon: <IconCircleCheck size={18} />,
+            crumbs: [
+                { title: 'Test Results', href: '/' },
+                { title: 'By Accept Status', href: '/?groupBy=test-distinct/markedAs' },
+            ],
+        },
+        // {
+        //     title: 'Dashboard',
+        //     description: 'Visit the Test Results Dashboard',
+        //     group: 'main',
+        //     icon: <IconDashboard size={18} />,
+        //     crumbs: [
+        //         { title: 'Dashboard', href: '/' },
+        //     ],
+        // },
+        {
+            title: 'Admin Panel',
+            description: 'Visit Admin Panel',
+            group: 'main',
+            icon: <IconUserExclamation size={18} />,
+            crumbs: [
+                { title: 'Admin panel', href: '/admin' },
+            ],
+        },
+        {
+            title: 'Users',
+            description: 'Manage Users',
+            group: 'admin',
+            icon: <IconUser size={18} />,
+            crumbs: [
+                { title: 'Admin', href: '/admin' },
+                { title: 'Users', href: '/admin/users' },
+            ],
+        },
+        {
+            title: 'Logs',
+            description: 'View Logs',
+            group: 'admin',
+            icon: <IconList size={18} />,
+            crumbs: [
+                { title: 'Admin', href: '/admin' },
+                { title: 'Logs', href: '/admin/logs' },
+            ],
+        },
+        // {
+        //     title: 'Tasks',
+        //     description: 'Manage Admin Tasks',
+        //     group: 'tasks',
+        //     onTrigger: () => console.log('Tasks'),
+        //     icon: <IconListDetails size={18} />,
+        //     crumbs: [
+        //         { title: 'Admin', href: '/admin' },
+        //         { title: 'Tasks', href: '/admin/tasks' },
+        //     ],
+        // },
+        {
+            title: 'Task: Handle old Checks',
+            description: 'Old checks statistics and cleaning',
+            group: 'tasks',
+            crumbs: [
+                { title: 'Admin', href: '/admin' },
+                { title: 'Tasks', href: '/admin/tasks' },
+                { title: 'Handle old Checks', href: '/admin/tasks/handle_old_checks' },
+            ],
+        },
+        {
+            title: 'Task: Handle Database Consistency',
+            description: 'Database Consistency statistics and cleaning',
+            group: 'tasks',
+            crumbs: [
+                { title: 'Admin', href: '/admin' },
+                { title: 'Tasks', href: '/admin/tasks' },
+                { title: 'Handle Database Consistency', href: '/admin/tasks/handle_database_consistency' },
+            ],
+        },
+        {
+            title: 'Task: Remove old logs',
+            description: 'Remove logs older certain date',
+            group: 'tasks',
+            crumbs: [
+                { title: 'Admin', href: '/admin' },
+                { title: 'Tasks', href: '/admin/tasks' },
+                { title: 'Remove old logs', href: '/admin/tasks/remove_old_logs' },
+            ],
+        },
+        {
+            title: 'Task: Test',
+            description: 'test',
+            group: 'tasks',
+            crumbs: [
+                { title: 'Admin', href: '/admin' },
+                { title: 'Tasks', href: '/admin/tasks' },
+                { title: 'Test', href: '/admin/tasks/test' },
+            ],
+        },
+        {
+            title: 'Settings',
+            description: 'Manage Admin Settings',
+            group: 'tasks',
+            icon: <IconListDetails size={18} />,
+            crumbs: [
+                { title: 'Admin', href: '/admin' },
+                { title: 'Settings', href: '/admin/settings' },
+            ],
+        },
+    ];
+}
+
+export const getNavigationItem = (title: string) => navigationData().find((x) => x.title === title);

package/src/ui-app/shared/services/checks.service.ts

@@ -0,0 +1,39 @@
+/* eslint-disable no-underscore-dangle */
+import ky from 'ky';
+import config from '../../config';
+
+export const ChecksService = {
+    // eslint-disable-next-line consistent-return
+    async acceptCheck({ check, newBaselineId }: { check: any, newBaselineId: string }) {
+        try {
+            const resp = await ky(`${config.baseUri}/v1/checks/accept/${check._id}`, {
+                headers: { 'Content-Type': 'application/json' },
+                body: JSON.stringify({
+                    baselineId: newBaselineId,
+                }),
+                method: 'PUT',
+            });
+            if (resp.ok) {
+                return resp.json();
+            }
+        } catch (e) {
+            throw new Error(`cannot accept check: '${JSON.stringify(check, null, '/t')}',`
+                + `\nbaseline: '${newBaselineId}', error: '${e}'}`);
+        }
+    },
+
+    // eslint-disable-next-line consistent-return
+    async removeCheck({ id }: { id: string }) {
+        try {
+            const resp = await ky(`${config.baseUri}/v1/checks/${id}`, {
+                headers: { 'Content-Type': 'application/json' },
+                method: 'DELETE',
+            });
+            if (resp.ok) {
+                return resp.json();
+            }
+        } catch (e) {
+            throw new Error(`Cannot remove check: '${id}', error: '${e}'`);
+        }
+    },
+};

package/src/ui-app/shared/services/generic.service.ts

@@ -0,0 +1,115 @@
+import ky from 'ky';
+
+import queryString from 'query-string';
+import config from '../../config';
+import ILog from '../interfaces/ILog';
+import { log } from '../utils';
+
+export interface IApiResult {
+    results: ILog[]
+    page: number
+    limit: number
+    totalPages: number
+    totalResults: number
+    timestamp: string
+}
+
+interface IRequestOptions {
+    sortBy?: string
+    limit?: string
+    page?: string
+    populate?: string
+    sortOrder?: string | number
+}
+
+export const GenericService = {
+    async get(resource: string, filter: any = {}, options: IRequestOptions = {}, queryID = ''): Promise<IApiResult> {
+        const queryOptions = { ...options, limit: options.limit || 10 };
+        const queryOptionsString = queryString.stringify(queryOptions);
+        // if (resource === 'checks') {
+        // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+        // await new Promise(resolve => setTimeout(resolve, 2000));
+        // }
+        // eslint-disable-next-line max-len
+        const uri = `${config.baseUri}/v1/${resource}?${queryOptionsString}&filter=${JSON.stringify(filter)}&queryID=${queryID}`;
+        const resp = await ky(uri);
+        const result: IApiResult = await resp.json();
+        if (resp.ok) {
+            return result;
+        }
+        throw new Error(`cannot get resource: ${uri}, resp: '${JSON.stringify(resp)}'`);
+    },
+
+    // eslint-disable-next-line consistent-return
+    async get_via_post(resource: string, filter: any = {}, options: IRequestOptions = {}, queryID = '') {
+        try {
+            const resp = await ky(`${config.baseUri}/v1/${resource}/get_via_post`, {
+                headers: { 'Content-Type': 'application/json' },
+                body: JSON.stringify({
+                    filter,
+                    options,
+                    queryID,
+                }),
+                method: 'POST',
+            });
+            if (resp.ok) {
+                return resp.json();
+            }
+        } catch (e) {
+            log.error(`cannot get (get_via_post) ${resource},`
+                + `\noptions: '${JSON.stringify(options)}', error: '${e.stack || e.toString()}'}`);
+
+            throw new Error(`cannot get (get_via_post) ${resource},`
+                + `\noptions: '${JSON.stringify(options)}', error: '${e}'}`);
+        }
+    },
+
+    async create<ResType>(resource: string, data: ResType): Promise<ResType[]> {
+        const url = `${config.baseUri}/v1/${resource}`;
+        const resp = await ky.post(
+            url,
+            { json: data },
+        );
+        if (resp.ok) {
+            return resp.json();
+        }
+        throw new Error(`cannot create resource:
+         '${url}', data: '${JSON.parse(data as any)}' resp: '${JSON.stringify(resp)}'`);
+    },
+
+    async update(resource: string, data: { [key: string]: any }) {
+        const url = `${config.baseUri}/v1/${resource}/${data.name || data.id}`;
+        const resp = await ky.patch(
+            url,
+            { json: data },
+        );
+        if (resp.ok) {
+            return resp.json();
+        }
+        throw new Error(`cannot update resource:
+         '${url}', data: '${JSON.stringify(data)}' resp: '${JSON.stringify(resp)}'`);
+    },
+
+    async delete(resource: string, id: string) {
+        const url = `${config.baseUri}/v1/${resource}/${id}`;
+        const resp = await ky.delete(
+            url,
+        );
+        if (resp.ok) {
+            return;
+        }
+        throw new Error(`cannot delete resource:
+        '${url}', id: '${id}' resp: '${JSON.stringify(resp)}'`);
+    },
+
+    async distinct(resource: string, field: string): Promise<string[]> {
+        const uri = `${config.baseUri}/v1/${resource}/distinct?field=${field}`;
+        const resp = await ky(uri);
+        const result: string[] = await resp.json();
+        if (resp.ok) {
+            return result;
+        }
+        throw new Error(`cannot get distinct values: resource:
+        '${uri}', field: '${field}', resp: '${JSON.stringify(resp)}'`);
+    },
+};

package/src/ui-app/shared/services/index.ts

@@ -0,0 +1,6 @@
+export { ChecksService } from './checks.service';
+export { RunsService } from './runs.service';
+export { SuitesService } from './suites.service';
+export { TestsService } from './tests.service';
+export { UsersService } from './users.service';
+export { GenericService } from './generic.service';

package/src/ui-app/shared/services/runs.service.ts

@@ -0,0 +1,20 @@
+/* eslint-disable no-underscore-dangle */
+import ky from 'ky';
+import config from '../../config';
+
+export const RunsService = {
+    // eslint-disable-next-line consistent-return
+    async remove({ id }: { id: string }) {
+        try {
+            const resp = await ky(`${config.baseUri}/v1/runs/${id}`, {
+                headers: { 'Content-Type': 'application/json' },
+                method: 'DELETE',
+            });
+            if (resp.ok) {
+                return resp.json();
+            }
+        } catch (e) {
+            throw new Error(`Cannot remove run: '${id}', error: '${e}'`);
+        }
+    },
+};

package/src/ui-app/shared/services/suites.service.ts

@@ -0,0 +1,20 @@
+/* eslint-disable no-underscore-dangle */
+import ky from 'ky';
+import config from '../../config';
+
+export const SuitesService = {
+    // eslint-disable-next-line consistent-return
+    async remove({ id }: { id: string }) {
+        try {
+            const resp = await ky(`${config.baseUri}/v1/suites/${id}`, {
+                headers: { 'Content-Type': 'application/json' },
+                method: 'DELETE',
+            });
+            if (resp.ok) {
+                return resp.json();
+            }
+        } catch (e) {
+            throw new Error(`Cannot remove suite: '${id}', error: '${e}'`);
+        }
+    },
+};

package/src/ui-app/shared/services/tests.service.ts

@@ -0,0 +1,39 @@
+/* eslint-disable no-underscore-dangle */
+import ky from 'ky';
+import config from '../../config';
+
+export const TestsService = {
+    // eslint-disable-next-line consistent-return
+    async removeTest({ id }: { id: string }) {
+        try {
+            const resp = await ky(`${config.baseUri}/v1/tests/${id}`, {
+                headers: { 'Content-Type': 'application/json' },
+                method: 'DELETE',
+            });
+            if (resp.ok) {
+                return resp.json();
+            }
+        } catch (e) {
+            throw new Error(`Cannot remove test: '${id}', error: '${e}'`);
+        }
+    },
+
+    // eslint-disable-next-line consistent-return
+    async acceptTest({ id }: { id: string }) {
+        // console.log({ id })
+        try {
+            const resp = await ky(`${config.baseUri}/v1/tests/accept/${id}`, {
+                headers: { 'Content-Type': 'application/json' },
+                method: 'PUT',
+            });
+            if (resp.ok) {
+                return {
+                    response: resp.json(),
+                    id,
+                };
+            }
+        } catch (e) {
+            throw new Error(`Cannot accept test: '${id}', error: '${e}'`);
+        }
+    },
+};

package/src/ui-app/shared/services/users.service.ts

@@ -0,0 +1,29 @@
+import ky from 'ky';
+
+import config from '../../config';
+import IUser from '../interfaces/IUser';
+
+export interface IApiResult {
+    results: IUser[],
+    page: number,
+    limit: number,
+    totalPages: number,
+    totalResults: number,
+}
+
+export const UsersService = {
+    async getApiKey(): Promise<{ apikey: string }> {
+        const resp = await ky(`${config.baseUri}/v1/auth/apikey`);
+        if (resp.ok) {
+            return resp.json();
+        }
+        throw new Error(`cannot get resource, resp: '${JSON.stringify(resp)}'`);
+    },
+    async getCurrentUser(): Promise<IUser> {
+        const resp = await ky(`${config.baseUri}/v1/users/current`);
+        if (resp.ok) {
+            return resp.json();
+        }
+        throw new Error(`cannot get resource, resp: '${JSON.stringify(resp)}'`);
+    },
+};

package/src/ui-app/shared/utils/Logger.ts

@@ -0,0 +1,12 @@
+/* eslint-disable no-console */
+const Logger: any = function Logger() {
+};
+
+Logger.prototype.debug = (...msg: any): void => console.debug(...msg);
+Logger.prototype.info = (...msg: any): void => console.info(...msg);
+Logger.prototype.warn = (...msg: any): void => console.warn(...msg);
+Logger.prototype.error = (...msg: any): void => console.error(...msg);
+
+const log = new Logger();
+export { log };
+export default log;

package/src/ui-app/shared/utils/SearchParams.ts

@@ -0,0 +1,17 @@
+import queryString from 'query-string';
+
+/* eslint-enable no-unused-vars, no-shadow */
+
+const getSearchParamsObject = (params: any) => queryString.parse(params.toString());
+
+export const SearchParams = {
+    changeSorting: (searchParams: URLSearchParams, setParams: any, sortItemName: string, sortDirection: string) => {
+        const currentObj = getSearchParamsObject(searchParams);
+        setParams(queryString.stringify({ ...currentObj, sortBy: `${sortItemName}:${sortDirection}` }));
+    },
+    changeFiltering: (searchParams: URLSearchParams, setParams: any, filter: any) => {
+        const currentObj = getSearchParamsObject(searchParams);
+        const newParamsObj = { ...currentObj, filter };
+        setParams(queryString.stringify(newParamsObj));
+    },
+};

package/src/ui-app/shared/utils/filters.tsx

@@ -0,0 +1,14 @@
+import { escapeRegExp } from './utils';
+
+export function generateItemFilter(label: string, operator: string, value: string) {
+    const transform: any = {
+        eq: () => ({ $eq: value }),
+        ne: () => ({ $ne: value }),
+        lt: () => ({ $lt: value }),
+        gt: () => ({ $gt: value }),
+        contains: () => ({ $regex: escapeRegExp(value), $options: 'im' }),
+        not_contains: () => ({ $regex: `^((?!${escapeRegExp(value)}).)*$`, $options: 'im' }),
+    };
+
+    return { [label]: transform[operator]() };
+}

package/src/ui-app/shared/utils/index.ts

@@ -0,0 +1,5 @@
+// eslint-disable-next-line import/extensions
+export { SearchParams } from './SearchParams';
+export { uuid, errorMsg } from './utils';
+export { generateItemFilter } from './filters';
+export * from './Logger';