teamdigitale/digital-citizenship-functions

View on GitHub
lib/controllers/messages.ts

Summary

Maintainability
F
3 days
Test Coverage

File messages.ts has 563 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/*
 * Implements the API handlers for the Message resource.
 */
import * as express from "express";
import * as t from "io-ts";
Severity: Major
Found in lib/controllers/messages.ts - About 1 day to fix

    Function CreateMessageHandler has 138 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export function CreateMessageHandler(
      getCustomTelemetryClient: CustomTelemetryClientFactory,
      messageModel: MessageModel,
      generateObjectId: ObjectIdGenerator
    ): ICreateMessageHandler {
    Severity: Major
    Found in lib/controllers/messages.ts - About 5 hrs to fix

      Function GetMessageHandler has 82 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export function GetMessageHandler(
        messageModel: MessageModel,
        messageStatusModel: MessageStatusModel,
        notificationModel: NotificationModel,
        notificationStatusModel: NotificationStatusModel,
      Severity: Major
      Found in lib/controllers/messages.ts - About 3 hrs to fix

        Function getMessageNotificationStatuses has 44 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        async function getMessageNotificationStatuses(
          notificationModel: NotificationModel,
          notificationStatusModel: NotificationStatusModel,
          messageId: NonEmptyString
        ): Promise<Either<Error, Option<NotificationStatusHolder>>> {
        Severity: Minor
        Found in lib/controllers/messages.ts - About 1 hr to fix

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

            serviceModel: ServiceModel,
            messageModel: MessageModel,
            messageStatusModel: MessageStatusModel,
            notificationModel: NotificationModel,
            notificationStatusModel: NotificationStatusModel,
          Severity: Minor
          Found in lib/controllers/messages.ts - About 45 mins to fix

            Function GetMessageHandler has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

              messageModel: MessageModel,
              messageStatusModel: MessageStatusModel,
              notificationModel: NotificationModel,
              notificationStatusModel: NotificationStatusModel,
              blobService: BlobService
            Severity: Minor
            Found in lib/controllers/messages.ts - About 35 mins to fix

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

              async function getMessageNotificationStatuses(
                notificationModel: NotificationModel,
                notificationStatusModel: NotificationStatusModel,
                messageId: NonEmptyString
              ): Promise<Either<Error, Option<NotificationStatusHolder>>> {
              Severity: Minor
              Found in lib/controllers/messages.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 ResponseSuccessRedirectToResource(
                    newMessageWithoutContent,
                    `/api/v1/messages/${fiscalCode}/${newMessageWithoutContent.id}`,
                    { id: newMessageWithoutContent.id }
                  );
              Severity: Major
              Found in lib/controllers/messages.ts - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                      return ResponseErrorValidation(
                        "Unable to decode CreatedMessageEvent",
                        readableReport(createdMessageEventOrError.value)
                      );
                Severity: Major
                Found in lib/controllers/messages.ts - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                        return ResponseErrorQuery(
                          "Error while creating Message",
                          errorOrMessage.value
                        );
                  Severity: Major
                  Found in lib/controllers/messages.ts - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                        return ResponseSuccessJson(returnedMessage);
                    Severity: Major
                    Found in lib/controllers/messages.ts - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                            return ResponseErrorInternal(
                              `Error retrieving NotificationStatus: ${
                                errorOrNotificationStatuses.value.name
                              }|${errorOrNotificationStatuses.value.message}`
                            );
                      Severity: Major
                      Found in lib/controllers/messages.ts - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                              return ResponseErrorInternal(
                                `Error retrieving MessageStatus: ${
                                  errorOrMaybeMessageStatus.value.code
                                }|${errorOrMaybeMessageStatus.value.body}`
                              );
                        Severity: Major
                        Found in lib/controllers/messages.ts - About 30 mins to fix

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

                          type IGetMessagesHandler = (
                            auth: IAzureApiAuthorization,
                            clientIp: ClientIp,
                            attrs: IAzureUserAttributes,
                            fiscalCode: FiscalCode
                          Severity: Major
                          Found in lib/controllers/messages.ts and 1 other location - About 1 hr to fix
                          lib/controllers/profiles.ts on lines 128..137

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

                          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 (isLeft(errorOrMaybeMessageStatus)) {
                                return ResponseErrorInternal(
                                  `Error retrieving MessageStatus: ${
                                    errorOrMaybeMessageStatus.value.code
                                  }|${errorOrMaybeMessageStatus.value.body}`
                          Severity: Minor
                          Found in lib/controllers/messages.ts and 1 other location - About 35 mins to fix
                          lib/controllers/messages.ts on lines 660..666

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

                          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 (isLeft(errorOrNotificationStatuses)) {
                                return ResponseErrorInternal(
                                  `Error retrieving NotificationStatus: ${
                                    errorOrNotificationStatuses.value.name
                                  }|${errorOrNotificationStatuses.value.message}`
                          Severity: Minor
                          Found in lib/controllers/messages.ts and 1 other location - About 35 mins to fix
                          lib/controllers/messages.ts on lines 673..679

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

                          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