RocketChat/Rocket.Chat

View on GitHub
apps/meteor/app/push/server/push.ts

Summary

Maintainability
D
2 days
Test Coverage

File push.ts has 412 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import type { IAppsTokens, RequiredField, Optional, IPushNotificationConfig } from '@rocket.chat/core-typings';
import { AppsTokens } from '@rocket.chat/models';
import { serverFetch as fetch } from '@rocket.chat/server-fetch';
import { pick } from '@rocket.chat/tools';
import Ajv from 'ajv';
Severity: Minor
Found in apps/meteor/app/push/server/push.ts - About 5 hrs to fix

    Function sendNotification has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
    Open

        private async sendNotification(notification: PendingPushNotification): Promise<{ apn: string[]; gcm: string[] }> {
            logger.debug('Sending notification', notification);
    
            const countApn: string[] = [];
            const countGcm: string[] = [];
    Severity: Minor
    Found in apps/meteor/app/push/server/push.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 sendNotification has 46 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private async sendNotification(notification: PendingPushNotification): Promise<{ apn: string[]; gcm: string[] }> {
            logger.debug('Sending notification', notification);
    
            const countApn: string[] = [];
            const countGcm: string[] = [];
    Severity: Minor
    Found in apps/meteor/app/push/server/push.ts - About 1 hr to fix

      Function sendGatewayPush has 42 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private async sendGatewayPush(
              gateway: string,
              service: 'apn' | 'gcm',
              token: string,
              notification: Optional<GatewayNotification, 'uniqueId'>,
      Severity: Minor
      Found in apps/meteor/app/push/server/push.ts - About 1 hr to fix

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

            private async sendNotificationNative(
                app: IAppsTokens,
                notification: PendingPushNotification,
                countApn: string[],
                countGcm: string[],
        Severity: Minor
        Found in apps/meteor/app/push/server/push.ts - About 1 hr to fix

          Function send has 28 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public async send(options: IPushNotificationConfig) {
                  const notification: PendingPushNotification = {
                      createdAt: new Date(),
                      // createdBy is no longer used, but the gateway still expects it
                      createdBy: '<SERVER>',
          Severity: Minor
          Found in apps/meteor/app/push/server/push.ts - About 1 hr to fix

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

                private _validateDocument(notification: PendingPushNotification): void {
                    // Check the general notification
                    check(notification, {
                        from: String,
                        title: String,
            Severity: Minor
            Found in apps/meteor/app/push/server/push.ts - About 1 hr to fix

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

                  private async sendNotificationNative(
                      app: IAppsTokens,
                      notification: PendingPushNotification,
                      countApn: string[],
                      countGcm: string[],
              Severity: Minor
              Found in apps/meteor/app/push/server/push.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

              Avoid deeply nested control flow statements.
              Open

                              if ((await AppsTokens.countGcmTokens()) === 0) {
                                  logger.debug('GUIDE: The "AppsTokens" - No GCM clients have registered on the server yet...');
                              }
              Severity: Major
              Found in apps/meteor/app/push/server/push.ts - About 45 mins to fix

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

                    private async sendNotificationGateway(
                        app: IAppsTokens,
                        notification: PendingPushNotification,
                        countApn: string[],
                        countGcm: string[],
                Severity: Minor
                Found in apps/meteor/app/push/server/push.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 2 locations. Consider refactoring.
                Open

                    private hasGcmOptions(options: IPushNotificationConfig): options is RequiredField<IPushNotificationConfig, 'gcm'> {
                        return Match.test(options.gcm, Object);
                    }
                Severity: Minor
                Found in apps/meteor/app/push/server/push.ts and 1 other location - About 50 mins to fix
                apps/meteor/app/push/server/push.ts on lines 464..466

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

                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

                    private hasApnOptions(options: IPushNotificationConfig): options is RequiredField<IPushNotificationConfig, 'apn'> {
                        return Match.test(options.apn, Object);
                    }
                Severity: Minor
                Found in apps/meteor/app/push/server/push.ts and 1 other location - About 50 mins to fix
                apps/meteor/app/push/server/push.ts on lines 468..470

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

                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