Sign upLogin

RocketChat/Rocket.Chat

View on GitHub
Star
packages/rest-typings/src/v1/users.ts

Summary

Maintainability
D
1 day
Test Coverage

File users.ts has 337 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import type { IExportOperation, ISubscription, ITeam, IUser, IPersonalAccessToken, UserStatus } from '@rocket.chat/core-typings';
import Ajv from 'ajv';

import type { PaginatedRequest } from '../helpers/PaginatedRequest';
import type { PaginatedResult } from '../helpers/PaginatedResult';
Severity: Minor
Found in packages/rest-typings/src/v1/users.ts - About 4 hrs to fix

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

    const UsersSetAvatarSchema = {
    type: 'object',
    properties: {
        userId: {
            type: 'string',
    Severity: Major
    Found in packages/rest-typings/src/v1/users.ts and 1 other location - About 2 hrs to fix
    packages/rest-typings/src/v1/users/UsersSetAvatarParamsPOST.ts on lines 13..31

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

    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

    export type UserPresence = Readonly<
    Partial<Pick<IUser, 'name' | 'status' | 'utcOffset' | 'statusText' | 'avatarETag' | 'roles' | 'username'>> & Required<Pick<IUser, '_id'>>
>;
    Severity: Major
    Found in packages/rest-typings/src/v1/users.ts and 1 other location - About 1 hr to fix
    apps/meteor/client/lib/presence.ts on lines 25..27

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

    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

    const UsersInfoSchema = {
    type: 'object',
    properties: {
        userId: {
            type: 'string',
    Severity: Major
    Found in packages/rest-typings/src/v1/users.ts and 1 other location - About 1 hr to fix
    packages/rest-typings/src/v1/users.ts on lines 86..100

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

    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

    const UsersResetAvatarSchema = {
    type: 'object',
    properties: {
        userId: {
            type: 'string',
    Severity: Major
    Found in packages/rest-typings/src/v1/users.ts and 1 other location - About 1 hr to fix
    packages/rest-typings/src/v1/users.ts on lines 27..41

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

    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

        '/v1/users.list': {
        GET: (params: PaginatedRequest<{ fields: string }>) => PaginatedResult<{
            users: DefaultUserInfo[];
        }>;
    };
    Severity: Major
    Found in packages/rest-typings/src/v1/users.ts and 1 other location - About 1 hr to fix
    packages/rest-typings/src/v1/dm/im.ts on lines 67..69

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

    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

        '/v1/users.resetTOTP': {
        POST: (
            params:
                | {
                        userId: string;
    Severity: Minor
    Found in packages/rest-typings/src/v1/users.ts and 1 other location - About 55 mins to fix
    packages/rest-typings/src/v1/users.ts on lines 189..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 53.

    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

        '/v1/users.resetE2EKey': {
        POST: (
            params:
                | {
                        userId: string;
    Severity: Minor
    Found in packages/rest-typings/src/v1/users.ts and 1 other location - About 55 mins to fix
    packages/rest-typings/src/v1/users.ts on lines 204..217

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

    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 39 locations. Consider refactoring.
    Open

        '/v1/users.listByStatus': {
        GET: (params: UsersListStatusParamsGET) => PaginatedResult<{
            users: DefaultUserInfo[];
        }>;
    };
    Severity: Major
    Found in packages/rest-typings/src/v1/users.ts and 38 other locations - About 30 mins to fix
    packages/rest-typings/src/v1/channels/channels.ts on lines 42..46
    packages/rest-typings/src/v1/channels/channels.ts on lines 56..60
    packages/rest-typings/src/v1/channels/channels.ts on lines 133..137
    packages/rest-typings/src/v1/channels/channels.ts on lines 161..165
    packages/rest-typings/src/v1/customSounds.ts on lines 39..43
    packages/rest-typings/src/v1/customUserStatus.ts on lines 39..43
    packages/rest-typings/src/v1/dm/im.ts on lines 43..47
    packages/rest-typings/src/v1/dm/im.ts on lines 59..63
    packages/rest-typings/src/v1/email-inbox.ts on lines 160..162
    packages/rest-typings/src/v1/federation/rooms.ts on lines 17..21
    packages/rest-typings/src/v1/groups/groups.ts on lines 43..47
    packages/rest-typings/src/v1/groups/groups.ts on lines 56..60
    packages/rest-typings/src/v1/groups/groups.ts on lines 101..105
    packages/rest-typings/src/v1/omnichannel.ts on lines 3518..3522
    packages/rest-typings/src/v1/omnichannel.ts on lines 3526..3530
    packages/rest-typings/src/v1/omnichannel.ts on lines 3557..3561
    packages/rest-typings/src/v1/omnichannel.ts on lines 3578..3582
    packages/rest-typings/src/v1/omnichannel.ts on lines 3583..3587
    packages/rest-typings/src/v1/omnichannel.ts on lines 3589..3593
    packages/rest-typings/src/v1/omnichannel.ts on lines 3605..3609
    packages/rest-typings/src/v1/omnichannel.ts on lines 3613..3617
    packages/rest-typings/src/v1/omnichannel.ts on lines 3747..3749
    packages/rest-typings/src/v1/omnichannel.ts on lines 3848..3850
    packages/rest-typings/src/v1/omnichannel.ts on lines 3851..3853
    packages/rest-typings/src/v1/omnichannel.ts on lines 3854..3858
    packages/rest-typings/src/v1/omnichannel.ts on lines 3882..3884
    packages/rest-typings/src/v1/omnichannel.ts on lines 3905..3907
    packages/rest-typings/src/v1/omnichannel.ts on lines 3911..3913
    packages/rest-typings/src/v1/omnichannel.ts on lines 3914..3916
    packages/rest-typings/src/v1/omnichannel.ts on lines 4015..4019
    packages/rest-typings/src/v1/omnichannel.ts on lines 4020..4024
    packages/rest-typings/src/v1/rooms.ts on lines 744..748
    packages/rest-typings/src/v1/rooms.ts on lines 762..766
    packages/rest-typings/src/v1/teams/index.ts on lines 190..192
    packages/rest-typings/src/v1/videoConference/index.ts on lines 33..35
    packages/rest-typings/src/v1/voip.ts on lines 543..545
    packages/rest-typings/src/v1/voip.ts on lines 558..560
    packages/rest-typings/src/v1/voip.ts on lines 576..578

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

    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