Sign upLogin

RocketChat/Rocket.Chat

View on GitHub
Star
apps/meteor/server/methods/browseChannels.ts

Summary

Maintainability
D
2 days
Test Coverage

File browseChannels.ts has 349 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { Team } from '@rocket.chat/core-services';
import type { IRoom, IUser } from '@rocket.chat/core-typings';
import { Rooms, Users, Subscriptions } from '@rocket.chat/models';
import { escapeRegExp } from '@rocket.chat/string-helpers';
import type { ServerMethods } from '@rocket.chat/ui-contexts';
Severity: Minor
Found in apps/meteor/server/methods/browseChannels.ts - About 4 hrs to fix

    Function getChannelsAndGroups has 51 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    const getChannelsAndGroups = async (
    user: IUser & { __rooms?: IRoom['_id'][] },
    canViewAnon: boolean,
    searchTerm: string,
    sort: Record<string, number>,
    Severity: Major
    Found in apps/meteor/server/methods/browseChannels.ts - About 2 hrs to fix

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

      const getTeams = async (
    user: IUser,
    searchTerm: string,
    sort: Record<string, number>,
    pagination: {
      Severity: Minor
      Found in apps/meteor/server/methods/browseChannels.ts - About 1 hr to fix

        Function getChannelsAndGroups has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
        Open

        const getChannelsAndGroups = async (
    user: IUser & { __rooms?: IRoom['_id'][] },
    canViewAnon: boolean,
    searchTerm: string,
    sort: Record<string, number>,
        Severity: Minor
        Found in apps/meteor/server/methods/browseChannels.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 browseChannels has 33 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            async browseChannels({
        text = '',
        workspace = '',
        type = 'channels',
        sortBy = 'name',
        Severity: Minor
        Found in apps/meteor/server/methods/browseChannels.ts - About 1 hr to fix

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

              async browseChannels({
        text = '',
        workspace = '',
        type = 'channels',
        sortBy = 'name',
          Severity: Minor
          Found in apps/meteor/server/methods/browseChannels.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 getUsers has 26 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          const getUsers = async (
    user: IUser | undefined,
    text: string,
    workspace: string,
    sort: Record<string, number>,
          Severity: Minor
          Found in apps/meteor/server/methods/browseChannels.ts - About 1 hr to fix

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

            const getUsers = async (
    user: IUser | undefined,
    text: string,
    workspace: string,
    sort: Record<string, number>,
            Severity: Minor
            Found in apps/meteor/server/methods/browseChannels.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

            Consider simplifying this complex logical expression.
            Open

                    if (
            !['channels', 'users', 'teams'].includes(type) ||
            !['asc', 'desc'].includes(sortDirection) ||
            (!page && page !== 0 && !offset && offset !== 0)
        ) {
            Severity: Major
            Found in apps/meteor/server/methods/browseChannels.ts - About 40 mins to fix

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

              const sortChannels = (field: string, direction: 'asc' | 'desc'): Record<string, 1 | -1> => {
    switch (field) {
        case 'createdAt':
            return {
                ts: direction === 'asc' ? 1 : -1,
              Severity: Minor
              Found in apps/meteor/server/methods/browseChannels.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 sortUsers has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
              Open

              const sortUsers = (field: string, direction: 'asc' | 'desc') => {
    switch (field) {
        case 'email':
            return {
                'emails.address': direction === 'asc' ? 1 : -1,
              Severity: Minor
              Found in apps/meteor/server/methods/browseChannels.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

                      {
            ...pagination,
            sort: {
                featured: -1,
                ...sort,
              Severity: Major
              Found in apps/meteor/server/methods/browseChannels.ts and 1 other location - About 3 hrs to fix
              apps/meteor/server/methods/browseChannels.ts on lines 141..163

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

              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

                      {
            ...pagination,
            sort: {
                featured: -1,
                ...sort,
              Severity: Major
              Found in apps/meteor/server/methods/browseChannels.ts and 1 other location - About 3 hrs to fix
              apps/meteor/server/methods/browseChannels.ts on lines 73..95

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

              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