RocketChat/Rocket.Chat

View on GitHub
apps/meteor/server/services/nps/service.ts

Summary

Maintainability
C
1 day
Test Coverage

Function sendResults has 69 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    async sendResults(): Promise<void> {
        const npsEnabled = await Settings.getValueById('NPS_survey_enabled');
        if (!npsEnabled) {
            return;
        }
Severity: Major
Found in apps/meteor/server/services/nps/service.ts - About 2 hrs to fix

    Function vote has 36 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        async vote({ userId, npsId, roles, score, comment }: NPSVotePayload): Promise<void> {
            const npsEnabled = await Settings.getValueById('NPS_survey_enabled');
            if (!npsEnabled) {
                return;
            }
    Severity: Minor
    Found in apps/meteor/server/services/nps/service.ts - About 1 hr to fix

      Function create has 26 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          async create(nps: NPSCreatePayload): Promise<boolean> {
              const npsEnabled = await Settings.getValueById('NPS_survey_enabled');
              if (!npsEnabled) {
                  throw new Error('Server opted-out for NPS surveys');
              }
      Severity: Minor
      Found in apps/meteor/server/services/nps/service.ts - About 1 hr to fix

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

            async sendResults(): Promise<void> {
                const npsEnabled = await Settings.getValueById('NPS_survey_enabled');
                if (!npsEnabled) {
                    return;
                }
        Severity: Minor
        Found in apps/meteor/server/services/nps/service.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

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

            async vote({ userId, npsId, roles, score, comment }: NPSVotePayload): Promise<void> {
                const npsEnabled = await Settings.getValueById('NPS_survey_enabled');
                if (!npsEnabled) {
                    return;
                }
        Severity: Minor
        Found in apps/meteor/server/services/nps/service.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

        Avoid too many return statements within this function.
        Open

                    return;
        Severity: Major
        Found in apps/meteor/server/services/nps/service.ts - About 30 mins to fix

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

              async create(nps: NPSCreatePayload): Promise<boolean> {
                  const npsEnabled = await Settings.getValueById('NPS_survey_enabled');
                  if (!npsEnabled) {
                      throw new Error('Server opted-out for NPS surveys');
                  }
          Severity: Minor
          Found in apps/meteor/server/services/nps/service.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 7 locations. Consider refactoring.
          Open

                  const nps = await Nps.findOneById<Pick<INps, 'status' | 'startAt' | 'expireAt'>>(npsId, {
                      projection: { status: 1, startAt: 1, expireAt: 1 },
                  });
          Severity: Major
          Found in apps/meteor/server/services/nps/service.ts and 6 other locations - About 1 hr to fix
          apps/meteor/app/livechat/server/api/v1/agent.ts on lines 76..82
          apps/meteor/app/livechat/server/api/v1/transcript.ts on lines 38..40
          apps/meteor/app/livechat/server/lib/Helper.ts on lines 597..605
          apps/meteor/ee/server/api/audit.ts on lines 54..54
          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 3 locations. Consider refactoring.
          Open

                      const votesWithoutIds = votes.map(({ identifier, roles, score, comment }) => ({
                          identifier,
                          roles,
                          score,
                          comment,
          Severity: Minor
          Found in apps/meteor/server/services/nps/service.ts and 2 other locations - About 40 mins to fix
          apps/meteor/app/livechat/server/api/lib/livechat.ts on lines 20..27
          apps/meteor/app/livechat/server/api/lib/livechat.ts on lines 34..48

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

          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