Sign upLogin

RocketChat/Rocket.Chat

View on GitHub
Star
apps/meteor/server/lib/ldap/Manager.ts

Summary

Maintainability
D
2 days
Test Coverage

File Manager.ts has 425 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import type { ILDAPEntry, LDAPLoginResult, ILDAPUniqueIdentifierField, IUser, LoginUsername, IImportUser } from '@rocket.chat/core-typings';
import { Users as UsersRaw } from '@rocket.chat/models';
import { SHA256 } from '@rocket.chat/sha256';
import ldapEscape from 'ldap-escape';
import limax from 'limax';
Severity: Minor
Found in apps/meteor/server/lib/ldap/Manager.ts - About 6 hrs to fix

    LDAPManager has 28 functions (exceeds 20 allowed). Consider refactoring.
    Open

    export class LDAPManager {
    public static async login(username: string, password: string): Promise<LDAPLoginResult> {
        logger.debug({ msg: 'Init LDAP login', username });

        if (settings.get('LDAP_Enable') !== true) {
    Severity: Minor
    Found in apps/meteor/server/lib/ldap/Manager.ts - About 3 hrs to fix

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

          public static async login(username: string, password: string): Promise<LDAPLoginResult> {
        logger.debug({ msg: 'Init LDAP login', username });

        if (settings.get('LDAP_Enable') !== true) {
            return this.fallbackToDefaultLogin(username, password);
      Severity: Minor
      Found in apps/meteor/server/lib/ldap/Manager.ts - About 1 hr to fix

        Function getLdapEmails has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

            private static getLdapEmails(ldapUser: ILDAPEntry, username?: string): string[] {
        const emailAttributes = getLDAPConditionalSetting<string>('LDAP_Email_Field');
        if (emailAttributes) {
            const attributeList: string[] = emailAttributes.replace(/\s/g, '').split(',');
            const key = attributeList.find((field) => this.ldapKeyExists(ldapUser, field));
        Severity: Minor
        Found in apps/meteor/server/lib/ldap/Manager.ts - About 45 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 syncUserForLogin has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

            private static async syncUserForLogin(
        ldapUser: ILDAPEntry,
        existingUser?: IUser,
        usedUsername?: string | undefined,
    ): Promise<IUser | undefined> {
        Severity: Minor
        Found in apps/meteor/server/lib/ldap/Manager.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

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

            private static async findUser(ldap: LDAPConnection, username: string, password: string): Promise<ILDAPEntry | undefined> {
        const escapedUsername = ldapEscape.filter`${username}`;

        try {
            const users = await ldap.searchByUsername(escapedUsername);
        Severity: Minor
        Found in apps/meteor/server/lib/ldap/Manager.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

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

            private static getLdapUserUniqueID(ldapUser: ILDAPEntry): ILDAPUniqueIdentifierField | undefined {
        let uniqueIdentifierField: string | string[] | undefined = settings.get<string>('LDAP_Unique_Identifier_Field');

        if (uniqueIdentifierField) {
            uniqueIdentifierField = uniqueIdentifierField.replace(/\s/g, '').split(',');
        Severity: Minor
        Found in apps/meteor/server/lib/ldap/Manager.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

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

            private static async findAuthenticatedUser(ldap: LDAPConnection, username: string): Promise<ILDAPEntry | undefined> {
        const escapedUsername = ldapEscape.filter`${username}`;

        try {
            const users = await ldap.searchByUsername(escapedUsername);
        Severity: Minor
        Found in apps/meteor/server/lib/ldap/Manager.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

                    if (settings.get<boolean>('LDAP_Find_User_After_Login')) {
                // Do a search as the user and check if they have any result
                authLogger.debug('User authenticated successfully, performing additional search.');
                if ((await ldap.searchAndCount(ldapUser.dn, {})) === 0) {
                    authLogger.debug(`Bind successful but user ${ldapUser.dn} was not found via search`);
        Severity: Major
        Found in apps/meteor/server/lib/ldap/Manager.ts and 1 other location - About 2 hrs to fix
        apps/meteor/server/lib/ldap/Manager.ts on lines 214..220

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

        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 (settings.get<boolean>('LDAP_Find_User_After_Login')) {
                // Do a search as the user and check if they have any result
                authLogger.debug('User authenticated successfully, performing additional search.');
                if ((await ldap.searchAndCount(ldapUser.dn, {})) === 0) {
                    authLogger.debug(`Bind successful but user ${ldapUser.dn} was not found via search`);
        Severity: Major
        Found in apps/meteor/server/lib/ldap/Manager.ts and 1 other location - About 2 hrs to fix
        apps/meteor/server/lib/ldap/Manager.ts on lines 240..246

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

        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 (typeof username === 'string') {
            if (username.indexOf('@') === -1) {
                username = { username };
            } else {
                username = { email: username };
        Severity: Major
        Found in apps/meteor/server/lib/ldap/Manager.ts and 1 other location - About 1 hr to fix
        apps/meteor/app/crowd/server/crowd.ts on lines 20..26

        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

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

                    if (users.length !== 1) {
                logger.debug(`Search returned ${users.length} records for ${escapedUsername}`);
                throw new Error('User not found');
            }
        Severity: Minor
        Found in apps/meteor/server/lib/ldap/Manager.ts and 1 other location - About 45 mins to fix
        apps/meteor/server/lib/ldap/Manager.ts on lines 112..115

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

        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 (users.length !== 1) {
                logger.debug(`Search returned ${users.length} records for ${escapedUsername}`);
                throw new Error('User not found');
            }
        Severity: Minor
        Found in apps/meteor/server/lib/ldap/Manager.ts and 1 other location - About 45 mins to fix
        apps/meteor/server/lib/ldap/Manager.ts on lines 199..202

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

        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