RocketChat/Rocket.Chat

View on GitHub
apps/meteor/server/lib/dataExport/exportRoomMessagesToFile.ts

Summary

Maintainability
D
1 day
Test Coverage

Function getMessageData has 87 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export const getMessageData = (
    msg: IMessage,
    hideUsers: boolean,
    userData: Pick<IUser, 'username'> | undefined,
    usersMap: { userNameTable: Record<string, string> },
Severity: Major
Found in apps/meteor/server/lib/dataExport/exportRoomMessagesToFile.ts - About 3 hrs to fix

    File exportRoomMessagesToFile.ts has 266 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    import { mkdir, writeFile } from 'fs/promises';
    
    import type { IMessage, IRoom, IUser, MessageAttachment, FileProp, RoomType } from '@rocket.chat/core-typings';
    import { Messages } from '@rocket.chat/models';
    
    
    Severity: Minor
    Found in apps/meteor/server/lib/dataExport/exportRoomMessagesToFile.ts - About 2 hrs to fix

      Function getAttachmentData has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
      Open

      const getAttachmentData = (attachment: MessageAttachment, message: IMessage) => {
          return {
              type: 'type' in attachment ? attachment.type : undefined,
              title: attachment.title,
              title_link: attachment.title_link,
      Severity: Minor
      Found in apps/meteor/server/lib/dataExport/exportRoomMessagesToFile.ts - About 2 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 exportRoomMessagesToFile has 37 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export const exportRoomMessagesToFile = async function (
          exportPath: string,
          assetsPath: string,
          exportType: 'json' | 'html',
          roomList: (
      Severity: Minor
      Found in apps/meteor/server/lib/dataExport/exportRoomMessagesToFile.ts - About 1 hr to fix

        Function exportRoomMessagesToFile has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
        Open

        export const exportRoomMessagesToFile = async function (
            exportPath: string,
            assetsPath: string,
            exportType: 'json' | 'html',
            roomList: (
        Severity: Minor
        Found in apps/meteor/server/lib/dataExport/exportRoomMessagesToFile.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 exportRoomMessagesToFile has 8 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            exportPath: string,
            assetsPath: string,
            exportType: 'json' | 'html',
            roomList: (
                | {
        Severity: Major
        Found in apps/meteor/server/lib/dataExport/exportRoomMessagesToFile.ts - About 1 hr to fix

          Function hideUserName has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

          const hideUserName = (
              username: string,
              userData: Pick<IUser, 'username'> | undefined,
              usersMap: { userNameTable: Record<string, string> },
          ) => {
          Severity: Minor
          Found in apps/meteor/server/lib/dataExport/exportRoomMessagesToFile.ts - About 25 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

              roomList: (
                  | {
                          roomId: string;
                          roomName: string;
                          userId: string | undefined;
          apps/meteor/server/lib/dataExport/processDataDownloads.ts on lines 23..34

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

          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

                  case 'ru':
                      messageObject.msg = i18n.t('User_has_been_removed', {
                          user_removed: hideUserName(msg.msg, userData, usersMap),
                          user_by: username,
                      });
          Severity: Minor
          Found in apps/meteor/server/lib/dataExport/exportRoomMessagesToFile.ts and 1 other location - About 35 mins to fix
          apps/meteor/server/lib/dataExport/exportRoomMessagesToFile.ts on lines 121..126

          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

                  case 'au':
                      messageObject.msg = i18n.t('User_added_to', {
                          user_added: hideUserName(msg.msg, userData, usersMap),
                          user_by: username,
                      });
          Severity: Minor
          Found in apps/meteor/server/lib/dataExport/exportRoomMessagesToFile.ts and 1 other location - About 35 mins to fix
          apps/meteor/server/lib/dataExport/exportRoomMessagesToFile.ts on lines 138..143

          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