RocketChat/Rocket.Chat

View on GitHub
apps/meteor/app/file-upload/server/lib/FileUpload.ts

Summary

Maintainability
F
4 days
Test Coverage

File FileUpload.ts has 621 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { Buffer } from 'buffer';
import type { WriteStream } from 'fs';
import fs from 'fs';
import { unlink, rename, writeFile } from 'fs/promises';
import type * as http from 'http';
Severity: Major
Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts - About 1 day to fix

    FileUpload has 22 functions (exceeds 20 allowed). Consider refactoring.
    Open

    export const FileUpload = {
        handlers,
    
        getPath(path = '') {
            return `/file-upload/${path}`;
    Severity: Minor
    Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts - About 2 hrs to fix

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

          async validateFileUpload(file: IUpload, content?: Buffer) {
              if (!Match.test(file.rid, String)) {
                  return false;
              }
      
      
      Severity: Minor
      Found in apps/meteor/app/file-upload/server/lib/FileUpload.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 validateFileUpload has 42 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          async validateFileUpload(file: IUpload, content?: Buffer) {
              if (!Match.test(file.rid, String)) {
                  return false;
              }
      
      
      Severity: Minor
      Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts - About 1 hr to fix

        Function requestCanAccessFiles has 38 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            async requestCanAccessFiles({ headers = {}, url }: http.IncomingMessage, file?: IUpload) {
                if (!url || !settings.get('FileUpload_ProtectFiles')) {
                    return true;
                }
        
        
        Severity: Minor
        Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts - About 1 hr to fix

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

              async requestCanAccessFiles({ headers = {}, url }: http.IncomingMessage, file?: IUpload) {
                  if (!url || !settings.get('FileUpload_ProtectFiles')) {
                      return true;
                  }
          
          
          Severity: Minor
          Found in apps/meteor/app/file-upload/server/lib/FileUpload.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 uploadsOnValidate has 35 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              async uploadsOnValidate(this: Store, file: IUpload) {
                  if (!file.type || !/^image\/((x-windows-)?bmp|p?jpeg|png|gif|webp)$/.test(file.type)) {
                      return;
                  }
          
          
          Severity: Minor
          Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts - About 1 hr to fix

            Function avatarsOnValidate has 33 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                async avatarsOnValidate(this: Store, file: IUpload) {
                    if (settings.get('Accounts_AvatarResize') !== true) {
                        return;
                    }
            
            
            Severity: Minor
            Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts - About 1 hr to fix

              Function createImageThumbnail has 29 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  async createImageThumbnail(fileParam: IUpload) {
                      if (!settings.get('Message_Attachments_Thumbnails_Enabled')) {
                          return;
                      }
              
              
              Severity: Minor
              Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts - About 1 hr to fix

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

                    async uploadsOnValidate(this: Store, file: IUpload) {
                        if (!file.type || !/^image\/((x-windows-)?bmp|p?jpeg|png|gif|webp)$/.test(file.type)) {
                            return;
                        }
                
                
                Severity: Minor
                Found in apps/meteor/app/file-upload/server/lib/FileUpload.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

                Function proxyFile has 6 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                        fileName: string,
                        fileUrl: string,
                        forceDownload: boolean,
                        request: typeof http | typeof https,
                        _req: http.IncomingMessage,
                Severity: Minor
                Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts - About 45 mins to fix

                  Function validateAvatarUpload has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                  Open

                      async validateAvatarUpload(file: IUpload) {
                          if (!Match.test(file.rid, String) && !Match.test(file.userId, String)) {
                              return false;
                          }
                  
                  
                  Severity: Minor
                  Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts - About 45 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/file-upload/server/lib/FileUpload.ts - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                            return false;
                    Severity: Major
                    Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts - About 30 mins to fix

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

                          async avatarsOnValidate(this: Store, file: IUpload) {
                              if (settings.get('Accounts_AvatarResize') !== true) {
                                  return;
                              }
                      
                      
                      Severity: Minor
                      Found in apps/meteor/app/file-upload/server/lib/FileUpload.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

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

                          addExtensionTo(file: IUpload) {
                              if (mime.lookup(file.name || '') === file.type) {
                                  return file;
                              }
                      
                      
                      Severity: Minor
                      Found in apps/meteor/app/file-upload/server/lib/FileUpload.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

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

                          async deleteById(fileId: string) {
                              const file = await this.model.findOneById(fileId);
                      
                              if (!file) {
                                  return;
                      Severity: Major
                      Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts and 2 other locations - About 2 hrs to fix
                      apps/meteor/app/file-upload/server/lib/FileUpload.ts on lines 725..735
                      apps/meteor/app/file-upload/server/lib/FileUpload.ts on lines 737..747

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

                      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 3 locations. Consider refactoring.
                      Open

                          async deleteByRoomId(rid: string) {
                              const file = await this.model.findOneByRoomId(rid);
                      
                              if (!file) {
                                  return;
                      Severity: Major
                      Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts and 2 other locations - About 2 hrs to fix
                      apps/meteor/app/file-upload/server/lib/FileUpload.ts on lines 713..723
                      apps/meteor/app/file-upload/server/lib/FileUpload.ts on lines 725..735

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

                      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 3 locations. Consider refactoring.
                      Open

                          async deleteByName(fileName: string) {
                              const file = await this.model.findOneByName(fileName);
                      
                              if (!file) {
                                  return;
                      Severity: Major
                      Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts and 2 other locations - About 2 hrs to fix
                      apps/meteor/app/file-upload/server/lib/FileUpload.ts on lines 713..723
                      apps/meteor/app/file-upload/server/lib/FileUpload.ts on lines 737..747

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

                      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

                              if (maxFileSize > -1 && (file.size || 0) > maxFileSize) {
                                  const reason = i18n.t('File_exceeds_allowed_size_of_bytes', {
                                      size: filesize(maxFileSize),
                                      lng: language,
                                  });
                      Severity: Major
                      Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts and 1 other location - About 1 hr to fix
                      apps/meteor/app/file-upload/server/lib/FileUpload.ts on lines 165..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 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

                              if (maxFileSize > -1 && (file.size || 0) > maxFileSize) {
                                  const reason = i18n.t('File_exceeds_allowed_size_of_bytes', {
                                      size: filesize(maxFileSize),
                                      lng: language,
                                  });
                      Severity: Major
                      Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts and 1 other location - About 1 hr to fix
                      apps/meteor/app/file-upload/server/lib/FileUpload.ts on lines 207..213

                      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

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

                              try {
                                  await Apps.self?.triggerEvent(AppEvents.IPreFileUpload, { file, content: content || Buffer.from([]) });
                              } catch (error: any) {
                                  if (error.name === AppsEngineException.name) {
                                      throw new Meteor.Error('error-app-prevented', error.message);
                      Severity: Major
                      Found in apps/meteor/app/file-upload/server/lib/FileUpload.ts and 2 other locations - About 45 mins to fix
                      apps/meteor/app/lib/server/functions/addUserToRoom.ts on lines 57..65
                      apps/meteor/app/lib/server/functions/removeUserFromRoom.ts on lines 22..30

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

                      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