Sign upLogin

RocketChat/Rocket.Chat

View on GitHub
Star
apps/meteor/app/livechat/server/lib/Helper.ts

Summary

Maintainability
F
5 days
Test Coverage

File Helper.ts has 646 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { Apps, AppEvents } from '@rocket.chat/apps';
import { LivechatTransferEventType } from '@rocket.chat/apps-engine/definition/livechat';
import { api, Message, Omnichannel } from '@rocket.chat/core-services';
import type {
    ILivechatVisitor,
Severity: Major
Found in apps/meteor/app/livechat/server/lib/Helper.ts - About 1 day to fix

    Function forwardRoomToDepartment has 113 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export const forwardRoomToDepartment = async (room: IOmnichannelRoom, guest: ILivechatVisitor, transferData: TransferData) => {
    if (!room?.open) {
        return false;
    }
    logger.debug(`Attempting to forward room ${room._id} to department ${transferData.departmentId}`);
    Severity: Major
    Found in apps/meteor/app/livechat/server/lib/Helper.ts - About 4 hrs to fix

      Function forwardRoomToDepartment has a Cognitive Complexity of 28 (exceeds 5 allowed). Consider refactoring.
      Open

      export const forwardRoomToDepartment = async (room: IOmnichannelRoom, guest: ILivechatVisitor, transferData: TransferData) => {
    if (!room?.open) {
        return false;
    }
    logger.debug(`Attempting to forward room ${room._id} to department ${transferData.departmentId}`);
      Severity: Minor
      Found in apps/meteor/app/livechat/server/lib/Helper.ts - About 4 hrs to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function updateDepartmentAgents has 55 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export const updateDepartmentAgents = async (
    departmentId: string,
    agents: {
        upsert?: Pick<ILivechatDepartmentAgents, 'agentId' | 'count' | 'order'>[];
        remove?: Pick<ILivechatDepartmentAgents, 'agentId'>[];
      Severity: Major
      Found in apps/meteor/app/livechat/server/lib/Helper.ts - About 2 hrs to fix

        Function dispatchInquiryQueued has 54 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        export const dispatchInquiryQueued = async (inquiry: ILivechatInquiryRecord, agent?: SelectedAgent | null) => {
    if (!inquiry?._id) {
        return;
    }
    logger.debug(`Notifying agents of new inquiry ${inquiry._id} queued`);
        Severity: Major
        Found in apps/meteor/app/livechat/server/lib/Helper.ts - About 2 hrs to fix

          Function createLivechatRoom has 53 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          export const createLivechatRoom = async (
    rid: string,
    name: string,
    guest: ILivechatVisitor,
    roomInfo: Partial<IOmnichannelRoom> = {},
          Severity: Major
          Found in apps/meteor/app/livechat/server/lib/Helper.ts - About 2 hrs to fix

            Function forwardRoomToAgent has 51 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

            export const forwardRoomToAgent = async (room: IOmnichannelRoom, transferData: TransferData) => {
    if (!room?.open) {
        return false;
    }
            Severity: Major
            Found in apps/meteor/app/livechat/server/lib/Helper.ts - About 2 hrs to fix

              Function createLivechatSubscription has 51 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

              export const createLivechatSubscription = async (
    rid: string,
    name: string,
    guest: Pick<ILivechatVisitor, '_id' | 'username' | 'status' | 'name' | 'token' | 'phone'>,
    agent: SelectedAgent,
              Severity: Major
              Found in apps/meteor/app/livechat/server/lib/Helper.ts - About 2 hrs to fix

                Function updateDepartmentAgents has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
                Open

                export const updateDepartmentAgents = async (
    departmentId: string,
    agents: {
        upsert?: Pick<ILivechatDepartmentAgents, 'agentId' | 'count' | 'order'>[];
        remove?: Pick<ILivechatDepartmentAgents, 'agentId'>[];
                Severity: Minor
                Found in apps/meteor/app/livechat/server/lib/Helper.ts - About 1 hr to fix

                Cognitive Complexity

                Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                A method's cognitive complexity is based on a few simple rules:

                • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                • Code is considered more complex for each "break in the linear flow of the code"
                • Code is considered more complex when "flow breaking structures are nested"

                Further reading

                Function forwardRoomToAgent has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
                Open

                export const forwardRoomToAgent = async (room: IOmnichannelRoom, transferData: TransferData) => {
    if (!room?.open) {
        return false;
    }
                Severity: Minor
                Found in apps/meteor/app/livechat/server/lib/Helper.ts - About 1 hr to fix

                Cognitive Complexity

                Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                A method's cognitive complexity is based on a few simple rules:

                • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                • Code is considered more complex for each "break in the linear flow of the code"
                • Code is considered more complex when "flow breaking structures are nested"

                Further reading

                Function dispatchInquiryQueued has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
                Open

                export const dispatchInquiryQueued = async (inquiry: ILivechatInquiryRecord, agent?: SelectedAgent | null) => {
    if (!inquiry?._id) {
        return;
    }
    logger.debug(`Notifying agents of new inquiry ${inquiry._id} queued`);
                Severity: Minor
                Found in apps/meteor/app/livechat/server/lib/Helper.ts - About 55 mins to fix

                Cognitive Complexity

                Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                A method's cognitive complexity is based on a few simple rules:

                • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                • Code is considered more complex for each "break in the linear flow of the code"
                • Code is considered more complex when "flow breaking structures are nested"

                Further reading

                Avoid too many return statements within this function.
                Open

                    return true;
                Severity: Major
                Found in apps/meteor/app/livechat/server/lib/Helper.ts - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                          return true;
                  Severity: Major
                  Found in apps/meteor/app/livechat/server/lib/Helper.ts - About 30 mins to fix

                    Similar blocks of code found in 2 locations. Consider refactoring.
                    Open

                            upsert: Match.Maybe([
            Match.ObjectIncluding({
                agentId: String,
                username: Match.Maybe(String),
                count: Match.Maybe(Match.Integer),
                    Severity: Major
                    Found in apps/meteor/app/livechat/server/lib/Helper.ts and 1 other location - About 2 hrs to fix
                    apps/meteor/app/livechat/server/lib/Helper.ts on lines 689..696

                    Duplicated Code

                    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                    Tuning

                    This issue has a mass of 76.

                    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                    Refactorings

                    Further Reading

                    Similar blocks of code found in 2 locations. Consider refactoring.
                    Open

                            remove: Match.Maybe([
            Match.ObjectIncluding({
                agentId: String,
                username: Match.Maybe(String),
                count: Match.Maybe(Match.Integer),
                    Severity: Major
                    Found in apps/meteor/app/livechat/server/lib/Helper.ts and 1 other location - About 2 hrs to fix
                    apps/meteor/app/livechat/server/lib/Helper.ts on lines 681..688

                    Duplicated Code

                    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                    Tuning

                    This issue has a mass of 76.

                    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                    Refactorings

                    Further Reading

                    Similar blocks of code found in 6 locations. Consider refactoring.
                    Open

                        const department = await LivechatDepartment.findOneById<
        Pick<ILivechatDepartment, 'allowReceiveForwardOffline' | 'fallbackForwardDepartment' | 'name'>
    >(departmentId, {
        projection: {
            allowReceiveForwardOffline: 1,
                    Severity: Major
                    Found in apps/meteor/app/livechat/server/lib/Helper.ts and 5 other locations - About 1 hr to fix
                    apps/meteor/app/livechat/server/api/v1/agent.ts on lines 75..81
                    apps/meteor/app/livechat/server/api/v1/transcript.ts on lines 37..39
                    apps/meteor/server/services/nps/service.ts on lines 150..152
                    ee/packages/presence/src/Presence.ts on lines 186..188
                    apps/meteor/app/api/server/v1/moderation.ts on lines 130..132

                    Duplicated Code

                    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                    Tuning

                    This issue has a mass of 63.

                    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                    Refactorings

                    Further Reading

                    Similar blocks of code found in 2 locations. Consider refactoring.
                    Open

                        logger.debug({
        msg: `Creating livechat room for visitor ${_id}`,
        visitor: { _id, username, departmentId, status, activity },
    });
                    Severity: Major
                    Found in apps/meteor/app/livechat/server/lib/Helper.ts and 1 other location - About 1 hr to fix
                    apps/meteor/app/livechat/server/lib/Helper.ts on lines 168..171

                    Duplicated Code

                    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                    Tuning

                    This issue has a mass of 57.

                    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                    Refactorings

                    Further Reading

                    Similar blocks of code found in 2 locations. Consider refactoring.
                    Open

                        logger.debug({
        msg: `Creating livechat inquiry for visitor ${_id}`,
        visitor: { _id, username, department, status, activity },
    });
                    Severity: Major
                    Found in apps/meteor/app/livechat/server/lib/Helper.ts and 1 other location - About 1 hr to fix
                    apps/meteor/app/livechat/server/lib/Helper.ts on lines 80..83

                    Duplicated Code

                    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                    Tuning

                    This issue has a mass of 57.

                    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                    Refactorings

                    Further Reading

                    Similar blocks of code found in 2 locations. Consider refactoring.
                    Open

                    export const checkServiceStatus = async ({ guest, agent }: { guest: Pick<ILivechatVisitor, 'department'>; agent?: SelectedAgent }) => {
    if (!agent) {
        return LivechatTyped.online(guest.department);
    }
                    Severity: Minor
                    Found in apps/meteor/app/livechat/server/lib/Helper.ts and 1 other location - About 30 mins to fix
                    apps/meteor/ee/app/livechat-enterprise/server/services/omnichannel.internalService.ts on lines 157..177

                    Duplicated Code

                    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                    Tuning

                    This issue has a mass of 45.

                    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                    Refactorings

                    Further Reading

                    There are no issues that match your filters.

                    Category
                    Status