RocketChat/Rocket.Chat

View on GitHub
ee/packages/license/src/license.ts

Summary

Maintainability
D
2 days
Test Coverage

File license.ts has 396 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import type {
    ILicenseTag,
    LicenseEvents,
    ILicenseV2,
    ILicenseV3,
Severity: Minor
Found in ee/packages/license/src/license.ts - About 5 hrs to fix

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

    export class LicenseManager extends Emitter<LicenseEvents> {
        dataCounters = new Map<LicenseLimitKind, (context?: LimitContext<LicenseLimitKind>) => Promise<number>>();
    
        pendingLicense = '';
    
    
    Severity: Minor
    Found in ee/packages/license/src/license.ts - About 3 hrs to fix

      Function shouldPreventAction has 53 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public async shouldPreventAction<T extends LicenseLimitKind>(
              action: T,
              extraCount = 0,
              context: Partial<LimitContext<T>> = {},
              { suppressLog }: Pick<LicenseValidationOptions, 'suppressLog'> = {
      Severity: Major
      Found in ee/packages/license/src/license.ts - About 2 hrs to fix

        Function validateLicense has 39 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private async validateLicense(
                options: LicenseValidationOptions = {
                    triggerSync: true,
                },
            ): Promise<void> {
        Severity: Minor
        Found in ee/packages/license/src/license.ts - About 1 hr to fix

          Function setLicense has 32 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public async setLicense(encryptedLicense: string, isNewLicense = true): Promise<boolean> {
                  if (!(await validateFormat(encryptedLicense))) {
                      throw new InvalidLicenseError();
                  }
          
          
          Severity: Minor
          Found in ee/packages/license/src/license.ts - About 1 hr to fix

            Function validateLicense has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
            Open

                private async validateLicense(
                    options: LicenseValidationOptions = {
                        triggerSync: true,
                    },
                ): Promise<void> {
            Severity: Minor
            Found in ee/packages/license/src/license.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 shouldPreventActionResultsMap has 31 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public async shouldPreventActionResultsMap(): Promise<{
                    [key in LicenseLimitKind]: boolean;
                }> {
                    const keys: LicenseLimitKind[] = [
                        'activeUsers',
            Severity: Minor
            Found in ee/packages/license/src/license.ts - About 1 hr to fix

              Function getInfo has 27 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  public async getInfo({
                      limits: includeLimits,
                      currentValues: loadCurrentValues,
                      license: includeLicense,
                  }: {
              Severity: Minor
              Found in ee/packages/license/src/license.ts - About 1 hr to fix

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

                    public async setLicense(encryptedLicense: string, isNewLicense = true): Promise<boolean> {
                        if (!(await validateFormat(encryptedLicense))) {
                            throw new InvalidLicenseError();
                        }
                
                
                Severity: Minor
                Found in ee/packages/license/src/license.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

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

                    private async setLicenseV3(
                        newLicense: ILicenseV3,
                        encryptedLicense: string,
                        originalLicense?: ILicenseV2 | ILicenseV3,
                        isNewLicense?: boolean,
                Severity: Minor
                Found in ee/packages/license/src/license.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

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

                    private triggerBehaviorEvents(validationResult: BehaviorWithContext[]): void {
                        for (const { ...options } of validationResult) {
                            behaviorTriggered.call(this, { ...options });
                        }
                    }
                Severity: Minor
                Found in ee/packages/license/src/license.ts and 1 other location - About 55 mins to fix
                ee/packages/license/src/license.ts on lines 309..313

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

                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 triggerBehaviorEventsToggled(validationResult: BehaviorWithContext[]): void {
                        for (const { ...options } of validationResult) {
                            behaviorTriggeredToggled.call(this, { ...options });
                        }
                    }
                Severity: Minor
                Found in ee/packages/license/src/license.ts and 1 other location - About 55 mins to fix
                ee/packages/license/src/license.ts on lines 303..307

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

                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