RocketChat/Rocket.Chat

View on GitHub
apps/meteor/app/meteor-accounts-saml/server/lib/SAML.ts

Summary

Maintainability
D
3 days
Test Coverage

File SAML.ts has 409 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import type { ServerResponse } from 'http';

import type { IUser, IIncomingMessage, IPersonalAccessToken } from '@rocket.chat/core-typings';
import { CredentialTokens, Rooms, Users } from '@rocket.chat/models';
import { Random } from '@rocket.chat/random';
Severity: Minor
Found in apps/meteor/app/meteor-accounts-saml/server/lib/SAML.ts - About 5 hrs to fix

    Function insertOrUpdateSAMLUser has a Cognitive Complexity of 35 (exceeds 5 allowed). Consider refactoring.
    Open

        public static async insertOrUpdateSAMLUser(userObject: ISAMLUser): Promise<{ userId: string; token: string }> {
            const {
                generateUsername,
                immutableProperty,
                nameOverwrite,
    Severity: Minor
    Found in apps/meteor/app/meteor-accounts-saml/server/lib/SAML.ts - About 5 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 insertOrUpdateSAMLUser has 115 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public static async insertOrUpdateSAMLUser(userObject: ISAMLUser): Promise<{ userId: string; token: string }> {
            const {
                generateUsername,
                immutableProperty,
                nameOverwrite,
    Severity: Major
    Found in apps/meteor/app/meteor-accounts-saml/server/lib/SAML.ts - About 4 hrs to fix

      Function processLogoutRequest has 50 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private static async processLogoutRequest(req: IIncomingMessage, res: ServerResponse, service: IServiceProviderOptions): Promise<void> {
              const serviceProvider = new SAMLServiceProvider(service);
              await serviceProvider.validateLogoutRequest(req.query.SAMLRequest, async (err, result) => {
                  if (err) {
                      SystemLogger.error({ err });
      Severity: Minor
      Found in apps/meteor/app/meteor-accounts-saml/server/lib/SAML.ts - About 2 hrs to fix

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

            private static async subscribeToSAMLChannels(channels: Array<string>, user: IUser): Promise<void> {
                const { includePrivateChannelsInUpdate } = SAMLUtils.globalSettings;
                try {
                    for await (let roomName of channels) {
                        roomName = roomName.trim();
        Severity: Minor
        Found in apps/meteor/app/meteor-accounts-saml/server/lib/SAML.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 processLogoutResponse has 32 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private static async processLogoutResponse(req: IIncomingMessage, res: ServerResponse, service: IServiceProviderOptions): Promise<void> {
                if (!req.query.SAMLResponse) {
                    SAMLUtils.error('Invalid LogoutResponse, missing SAMLResponse', req.query);
                    throw new Error('Invalid LogoutResponse received.');
                }
        Severity: Minor
        Found in apps/meteor/app/meteor-accounts-saml/server/lib/SAML.ts - About 1 hr to fix

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

              private static processValidateAction(
                  req: IIncomingMessage,
                  res: ServerResponse,
                  service: IServiceProviderOptions,
                  _samlObject: ISAMLAction,
          Severity: Minor
          Found in apps/meteor/app/meteor-accounts-saml/server/lib/SAML.ts - About 1 hr to fix

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

                private static async subscribeToSAMLChannels(channels: Array<string>, user: IUser): Promise<void> {
                    const { includePrivateChannelsInUpdate } = SAMLUtils.globalSettings;
                    try {
                        for await (let roomName of channels) {
                            roomName = roomName.trim();
            Severity: Minor
            Found in apps/meteor/app/meteor-accounts-saml/server/lib/SAML.ts - About 1 hr to fix

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

                      return username
                          .replace(/\W/g, ' ')
                          .replace(/\s(.)/g, (u) => u.toUpperCase())
                          .replace(/^(.)/, (u) => u.toLowerCase())
                          .replace(/^\w/, (u) => u.toUpperCase());
              Severity: Major
              Found in apps/meteor/app/meteor-accounts-saml/server/lib/SAML.ts and 1 other location - About 1 hr to fix
              apps/meteor/app/importer/server/classes/ImportDataConverter.ts on lines 71..75

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

              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