RocketChat/Rocket.Chat

View on GitHub
apps/meteor/server/models/raw/LivechatVisitors.ts

Summary

Maintainability
D
2 days
Test Coverage

File LivechatVisitors.ts has 375 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import type { ILivechatVisitor, ISetting, RocketChatRecordDeleted } from '@rocket.chat/core-typings';
import type { FindPaginated, ILivechatVisitorsModel } from '@rocket.chat/model-typings';
import { Settings } from '@rocket.chat/models';
import { escapeRegExp } from '@rocket.chat/string-helpers';
import type {
Severity: Minor
Found in apps/meteor/server/models/raw/LivechatVisitors.ts - About 5 hrs to fix

    LivechatVisitorsRaw has 26 functions (exceeds 20 allowed). Consider refactoring.
    Open

    export class LivechatVisitorsRaw extends BaseRaw<ILivechatVisitor> implements ILivechatVisitorsModel {
        constructor(db: Db, trash?: Collection<RocketChatRecordDeleted<ILivechatVisitor>>) {
            super(db, 'livechat_visitor', trash);
        }
    
    
    Severity: Minor
    Found in apps/meteor/server/models/raw/LivechatVisitors.ts - About 3 hrs to fix

      Function saveGuestById has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
      Open

          saveGuestById(
              _id: string,
              data: { name?: string; username?: string; email?: string; phone?: string; livechatData: { [k: string]: any } },
          ): Promise<UpdateResult | Document | boolean> {
              const setData: DeepWriteable<UpdateFilter<ILivechatVisitor>['$set']> = {};
      Severity: Minor
      Found in apps/meteor/server/models/raw/LivechatVisitors.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 saveGuestById has 41 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          saveGuestById(
              _id: string,
              data: { name?: string; username?: string; email?: string; phone?: string; livechatData: { [k: string]: any } },
          ): Promise<UpdateResult | Document | boolean> {
              const setData: DeepWriteable<UpdateFilter<ILivechatVisitor>['$set']> = {};
      Severity: Minor
      Found in apps/meteor/server/models/raw/LivechatVisitors.ts - About 1 hr to fix

        Function findPaginatedVisitorsByEmailOrPhoneOrNameOrUsernameOrCustomField has 30 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            async findPaginatedVisitorsByEmailOrPhoneOrNameOrUsernameOrCustomField(
                emailOrPhone?: string,
                nameOrUsername?: RegExp,
                allowedCustomFields: string[] = [],
                options?: FindOptions<ILivechatVisitor>,
        Severity: Minor
        Found in apps/meteor/server/models/raw/LivechatVisitors.ts - About 1 hr to fix

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

                  if (data.email) {
                      if (data.email?.trim()) {
                          setData.visitorEmails = [{ address: data.email.trim() }];
                      } else {
                          unsetData.visitorEmails = 1;
          Severity: Major
          Found in apps/meteor/server/models/raw/LivechatVisitors.ts and 1 other location - About 1 hr to fix
          apps/meteor/server/models/raw/LivechatVisitors.ts on lines 316..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 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 (data.phone) {
                      if (data.phone?.trim()) {
                          setData.phone = [{ phoneNumber: data.phone.trim() }];
                      } else {
                          unsetData.phone = 1;
          Severity: Major
          Found in apps/meteor/server/models/raw/LivechatVisitors.ts and 1 other location - About 1 hr to fix
          apps/meteor/server/models/raw/LivechatVisitors.ts on lines 308..314

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

              getVisitorByToken(token: string, options: FindOptions<ILivechatVisitor>): Promise<ILivechatVisitor | null> {
                  const query = {
                      token,
                  };
          
          
          Severity: Major
          Found in apps/meteor/server/models/raw/LivechatVisitors.ts and 3 other locations - About 1 hr to fix
          apps/meteor/ee/server/models/raw/CannedResponse.ts on lines 68..72
          apps/meteor/ee/server/models/raw/CannedResponse.ts on lines 74..80
          apps/meteor/ee/server/models/raw/LivechatTag.ts on lines 23..27

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

          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

              updateById(_id: string, update: UpdateFilter<ILivechatVisitor>): Promise<Document | UpdateResult> {
                  return this.updateOne({ _id }, update);
              }
          Severity: Major
          Found in apps/meteor/server/models/raw/LivechatVisitors.ts and 1 other location - About 1 hr to fix
          apps/meteor/server/models/raw/LivechatDepartment.ts on lines 272..274

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

          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

              removeDepartmentById(_id: string): Promise<UpdateResult> {
                  return this.updateOne({ _id }, { $unset: { department: 1 } });
              }
          Severity: Major
          Found in apps/meteor/server/models/raw/LivechatVisitors.ts and 5 other locations - About 1 hr to fix
          apps/meteor/ee/server/models/raw/LivechatRooms.ts on lines 108..110
          apps/meteor/server/models/raw/Messages.ts on lines 659..661
          apps/meteor/server/models/raw/Messages.ts on lines 1548..1559
          apps/meteor/server/models/raw/NotificationQueue.ts on lines 22..31
          apps/meteor/server/models/raw/Subscriptions.ts on lines 556..558

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

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

                  data: { name?: string; username?: string; email?: string; phone?: string; livechatData: { [k: string]: any } },
          Severity: Minor
          Found in apps/meteor/server/models/raw/LivechatVisitors.ts and 1 other location - About 55 mins to fix
          packages/model-typings/src/models/ILivechatVisitorsModel.ts on lines 65..65

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

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

                          if (value) {
                              setData[`livechatData.${key}`] = value;
                          } else {
                              unsetData[`livechatData.${key}`] = 1;
                          }
          Severity: Minor
          Found in apps/meteor/server/models/raw/LivechatVisitors.ts and 1 other location - About 50 mins to fix
          apps/meteor/server/models/raw/LivechatRooms.ts on lines 1706..1710

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

          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