RocketChat/Rocket.Chat

View on GitHub
packages/livechat/src/widget.ts

Summary

Maintainability
D
3 days
Test Coverage

File widget.ts has 576 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import type { UserStatus } from '@rocket.chat/core-typings';
import type { LivechatRoomEvents } from '@rocket.chat/ddp-client/dist/livechat/types/LivechatSDK';
import mitt from 'mitt';

import { isDefined } from './helpers/isDefined';
Severity: Major
Found in packages/livechat/src/widget.ts - About 1 day to fix

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

    function initialize(initParams: Partial<InitializeParams>) {
        for (const initKey in initParams) {
            if (!initParams.hasOwnProperty(initKey)) {
                continue;
            }
    Severity: Major
    Found in packages/livechat/src/widget.ts - About 2 hrs to fix

      Function updateWidgetStyle has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

      const updateWidgetStyle = (isOpened: boolean) => {
          if (!iframe || !widget) {
              throw new Error('Widget is not initialized');
          }
      
      
      Severity: Minor
      Found in packages/livechat/src/widget.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 createWidget has 36 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      const createWidget = (url: string) => {
          widget = document.createElement('div');
          widget.className = 'rocketchat-widget';
          widget.style.position = 'fixed';
          widget.style.width = `${WIDGET_MARGIN + WIDGET_MINIMIZED_WIDTH + WIDGET_MARGIN}px`;
      Severity: Minor
      Found in packages/livechat/src/widget.ts - About 1 hr to fix

        Function initialize has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

        function initialize(initParams: Partial<InitializeParams>) {
            for (const initKey in initParams) {
                if (!initParams.hasOwnProperty(initKey)) {
                    continue;
                }
        Severity: Minor
        Found in packages/livechat/src/widget.ts - About 35 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

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

        function onNewMessage(event: MessageEvent<LivechatMessageEventData<Omit<InternalWidgetAPI, 'popup'>>>) {
            if (event.source === event.target) {
                return;
            }
        
        
        Severity: Major
        Found in packages/livechat/src/widget.ts and 1 other location - About 5 hrs to fix
        packages/livechat/src/lib/hooks.ts on lines 300..322

        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 145.

        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

            onAssignAgent(
                fn: () => {
                    name: string | undefined;
                    username: string | undefined;
                    status: UserStatus | undefined;
        Severity: Major
        Found in packages/livechat/src/widget.ts and 1 other location - About 1 hr to fix
        packages/livechat/src/widget.ts on lines 601..609

        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 59.

        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

            onAgentStatusChange(
                fn: () => {
                    name: string | undefined;
                    username: string | undefined;
                    status: UserStatus | undefined;
        Severity: Major
        Found in packages/livechat/src/widget.ts and 1 other location - About 1 hr to fix
        packages/livechat/src/widget.ts on lines 592..600

        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 59.

        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

            hideWidget() {
                if (!iframe) {
                    throw new Error('Widget is not initialized');
                }
                iframe.style.display = 'none';
        Severity: Minor
        Found in packages/livechat/src/widget.ts and 1 other location - About 35 mins to fix
        packages/livechat/src/widget.ts on lines 502..508

        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 46.

        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

            showWidget() {
                if (!iframe) {
                    throw new Error('Widget is not initialized');
                }
                iframe.style.display = 'initial';
        Severity: Minor
        Found in packages/livechat/src/widget.ts and 1 other location - About 35 mins to fix
        packages/livechat/src/widget.ts on lines 510..516

        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 46.

        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