Sign upLogin

RocketChat/Rocket.Chat

View on GitHub
Star
apps/meteor/app/api/server/v1/commands.ts

Summary

Maintainability
F
3 days
Test Coverage

Function processQueryOptionsOnResult has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
Open

const processQueryOptionsOnResult = <T extends { _id?: string } & Record<string, any>, F extends keyof T>(
    result: T[],
    options: {
        fields?: {
            [key in F]?: 1 | 0;
Severity: Minor
Found in apps/meteor/app/api/server/v1/commands.ts - About 3 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 processQueryOptionsOnResult has 79 lines of code (exceeds 25 allowed). Consider refactoring.
Open

const processQueryOptionsOnResult = <T extends { _id?: string } & Record<string, any>, F extends keyof T>(
    result: T[],
    options: {
        fields?: {
            [key in F]?: 1 | 0;
Severity: Major
Found in apps/meteor/app/api/server/v1/commands.ts - About 3 hrs to fix

    File commands.ts has 275 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    import { Messages } from '@rocket.chat/models';
import { Random } from '@rocket.chat/random';
import { Meteor } from 'meteor/meteor';
import objectPath from 'object-path';
    Severity: Minor
    Found in apps/meteor/app/api/server/v1/commands.ts - About 2 hrs to fix

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

              async post() {
            const body = this.bodyParams;

            if (typeof body.command !== 'string') {
                return API.v1.failure('You must provide a command to run the preview item on.');
      Severity: Minor
      Found in apps/meteor/app/api/server/v1/commands.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 post has 51 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

              async post() {
            const body = this.bodyParams;

            if (typeof body.command !== 'string') {
                return API.v1.failure('You must provide a command to run the preview item on.');
      Severity: Major
      Found in apps/meteor/app/api/server/v1/commands.ts - About 2 hrs to fix

        Function post has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
        Open

                async post() {
            const body = this.bodyParams;

            if (typeof body.command !== 'string') {
                return API.v1.failure('You must provide a command to run.');
        Severity: Minor
        Found in apps/meteor/app/api/server/v1/commands.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 post has 36 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

                async post() {
            const body = this.bodyParams;

            if (typeof body.command !== 'string') {
                return API.v1.failure('You must provide a command to run.');
        Severity: Minor
        Found in apps/meteor/app/api/server/v1/commands.ts - About 1 hr to fix

          Avoid deeply nested control flow statements.
          Open

                                  if (valueA > valueB) {
                            r = direction;
                            break;
                        }
          Severity: Major
          Found in apps/meteor/app/api/server/v1/commands.ts - About 45 mins to fix

            Avoid deeply nested control flow statements.
            Open

                                    if (field.indexOf('.') > -1) {
                            valueA = objectPath.get(a, field);
                            valueB = objectPath.get(b, field);
                        } else {
                            valueA = a[field];
            Severity: Major
            Found in apps/meteor/app/api/server/v1/commands.ts - About 45 mins to fix

              Avoid deeply nested control flow statements.
              Open

                                      if (valueA < valueB) {
                            r = -direction;
                            break;
                        }
              Severity: Major
              Found in apps/meteor/app/api/server/v1/commands.ts - About 45 mins to fix

                Avoid too many return statements within this function.
                Open

                                return API.v1.failure('The preview item being executed is in the wrong format.');
                Severity: Major
                Found in apps/meteor/app/api/server/v1/commands.ts - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                                  return API.v1.unauthorized();
                  Severity: Major
                  Found in apps/meteor/app/api/server/v1/commands.ts - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                                        return API.v1.failure('Invalid thread.');
                    Severity: Major
                    Found in apps/meteor/app/api/server/v1/commands.ts - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                                      return API.v1.failure('The tmid parameter when provided must be a string.');
                      Severity: Major
                      Found in apps/meteor/app/api/server/v1/commands.ts - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                    return API.v1.success();
                        Severity: Major
                        Found in apps/meteor/app/api/server/v1/commands.ts - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                                      return API.v1.success({ preview });
                          Severity: Major
                          Found in apps/meteor/app/api/server/v1/commands.ts - About 30 mins to fix

                            Avoid too many return statements within this function.
                            Open

                                            return API.v1.failure('The triggerId parameter when provided must be a string.');
                            Severity: Major
                            Found in apps/meteor/app/api/server/v1/commands.ts - About 30 mins to fix

                              Avoid too many return statements within this function.
                              Open

                                              return API.v1.failure('The command provided does not exist (or is disabled).');
                              Severity: Major
                              Found in apps/meteor/app/api/server/v1/commands.ts - About 30 mins to fix

                                Avoid too many return statements within this function.
                                Open

                                                return API.v1.unauthorized();
                                Severity: Major
                                Found in apps/meteor/app/api/server/v1/commands.ts - About 30 mins to fix

                                  Avoid too many return statements within this function.
                                  Open

                                              return API.v1.success({ result });
                                  Severity: Major
                                  Found in apps/meteor/app/api/server/v1/commands.ts - About 30 mins to fix

                                    Avoid too many return statements within this function.
                                    Open

                                                    return API.v1.failure('The command provided does not exist (or is disabled).');
                                    Severity: Major
                                    Found in apps/meteor/app/api/server/v1/commands.ts - About 30 mins to fix

                                      Avoid too many return statements within this function.
                                      Open

                                                      return API.v1.unauthorized();
                                      Severity: Major
                                      Found in apps/meteor/app/api/server/v1/commands.ts - About 30 mins to fix

                                        Avoid too many return statements within this function.
                                        Open

                                                            return API.v1.failure('Invalid thread.');
                                        Severity: Major
                                        Found in apps/meteor/app/api/server/v1/commands.ts - About 30 mins to fix

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

                                                  async get() {
            const query = this.queryParams;
            const user = await getLoggedInUser(this.request);

            if (typeof query.command !== 'string') {
                                          Severity: Minor
                                          Found in apps/meteor/app/api/server/v1/commands.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

                                                      if (typeof body.tmid === 'string') {
                const thread = await Messages.findOneById(body.tmid);
                if (!thread || thread.rid !== body.roomId) {
                    return API.v1.failure('Invalid thread.');
                }
                                          Severity: Major
                                          Found in apps/meteor/app/api/server/v1/commands.ts and 1 other location - About 1 hr to fix
                                          apps/meteor/app/api/server/v1/commands.ts on lines 311..316

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

                                          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 (body.tmid) {
                const thread = await Messages.findOneById(body.tmid);
                if (!thread || thread.rid !== body.roomId) {
                    return API.v1.failure('Invalid thread.');
                }
                                          Severity: Major
                                          Found in apps/meteor/app/api/server/v1/commands.ts and 1 other location - About 1 hr to fix
                                          apps/meteor/app/api/server/v1/commands.ts on lines 205..210

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

                                          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