Chocobozzz/PeerTube

View on GitHub
server/core/middlewares/validators/users/users.ts

Summary

Maintainability
F
4 days
Test Coverage

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

import { forceNumber } from '@peertube/peertube-core-utils'
import { HttpStatusCode, ServerErrorCode, UserRight, UserRole } from '@peertube/peertube-models'
import express from 'express'
import { body, param, query } from 'express-validator'
import { exists, isBooleanValid, isIdValid, toBooleanOrNull, toIntOrNull } from '../../../helpers/custom-validators/misc.js'
Severity: Minor
Found in server/core/middlewares/validators/users/users.ts - About 5 hrs to fix

    Function usersCheckCurrentPasswordFactory has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

    export const usersCheckCurrentPasswordFactory = (targetUserIdGetter: (req: express.Request) => number | string) => {
      return [
        body('currentPassword').optional().custom(exists),
    
        async (req: express.Request, res: express.Response, next: express.NextFunction) => {
    Severity: Minor
    Found in server/core/middlewares/validators/users/users.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 usersCheckCurrentPasswordFactory has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export const usersCheckCurrentPasswordFactory = (targetUserIdGetter: (req: express.Request) => number | string) => {
      return [
        body('currentPassword').optional().custom(exists),
    
        async (req: express.Request, res: express.Response, next: express.NextFunction) => {
    Severity: Minor
    Found in server/core/middlewares/validators/users/users.ts - About 1 hr to fix

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

        async (req: express.Request, res: express.Response, next: express.NextFunction) => {
          const user = res.locals.oauth.token.User
      
          if (req.body.password || req.body.email) {
            if (user.pluginAuth !== null) {
      Severity: Minor
      Found in server/core/middlewares/validators/users/users.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 usersAddValidator has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

        async (req: express.Request, res: express.Response, next: express.NextFunction) => {
          if (areValidationErrors(req, res, { omitBodyLog: true })) return
          if (!await checkUserNameOrEmailDoNotAlreadyExist(req.body.username, req.body.email, res)) return
      
          const authUser = res.locals.oauth.token.User
      Severity: Minor
      Found in server/core/middlewares/validators/users/users.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

      Avoid too many return statements within this function.
      Open

              return res.fail({
                status: HttpStatusCode.CONFLICT_409,
                message: `Channel with name ${req.body.channelName} already exists.`
              })
      Severity: Major
      Found in server/core/middlewares/validators/users/users.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

            return next()
        Severity: Major
        Found in server/core/middlewares/validators/users/users.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                return next()
          Severity: Major
          Found in server/core/middlewares/validators/users/users.ts - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                return next()
            Severity: Major
            Found in server/core/middlewares/validators/users/users.ts - About 30 mins to fix

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

                async (req: express.Request, res: express.Response, next: express.NextFunction) => {
                  if (areValidationErrors(req, res)) return
                  if (!await checkUserIdExist(req.params.id, res)) return
              
                  const user = res.locals.user
              Severity: Major
              Found in server/core/middlewares/validators/users/users.ts and 2 other locations - About 6 hrs to fix
              server/core/middlewares/validators/users/user-email-verification.ts on lines 48..60
              server/core/middlewares/validators/users/user-email-verification.ts on lines 72..84

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

              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

                async (req: express.Request, res: express.Response, next: express.NextFunction) => {
                  if (areValidationErrors(req, res)) return
                  if (!await checkUserIdExist(req.params.id, res)) return
              
                  const user = res.locals.user
              Severity: Major
              Found in server/core/middlewares/validators/users/users.ts and 1 other location - About 4 hrs to fix
              server/core/middlewares/validators/users/users.ts on lines 139..149

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

              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

                async (req: express.Request, res: express.Response, next: express.NextFunction) => {
                  if (areValidationErrors(req, res)) return
                  if (!await checkUserIdExist(req.params.id, res)) return
              
                  const user = res.locals.user
              Severity: Major
              Found in server/core/middlewares/validators/users/users.ts and 1 other location - About 4 hrs to fix
              server/core/middlewares/validators/users/users.ts on lines 119..129

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

              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

              export const usersListValidator = [
                query('blocked')
                  .optional()
                  .customSanitizer(toBooleanOrNull)
                  .isBoolean().withMessage('Should be a valid blocked boolean'),
              Severity: Major
              Found in server/core/middlewares/validators/users/users.ts and 1 other location - About 3 hrs to fix
              server/core/middlewares/validators/users/user-notifications.ts on lines 7..18

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

              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 (await user.isPasswordMatch(req.body.currentPassword) !== true) {
                      return res.fail({
                        status: HttpStatusCode.UNAUTHORIZED_401,
                        message: 'currentPassword is invalid.',
                        type: ServerErrorCode.CURRENT_PASSWORD_IS_INVALID
              Severity: Major
              Found in server/core/middlewares/validators/users/users.ts and 1 other location - About 1 hr to fix
              server/core/middlewares/validators/users/users.ts on lines 404..410

              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

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

                    if (await user.isPasswordMatch(req.body.currentPassword) !== true) {
                      return res.fail({
                        status: HttpStatusCode.FORBIDDEN_403,
                        message: 'currentPassword is invalid.',
                        type: ServerErrorCode.CURRENT_PASSWORD_IS_INVALID
              Severity: Major
              Found in server/core/middlewares/validators/users/users.ts and 1 other location - About 1 hr to fix
              server/core/middlewares/validators/users/users.ts on lines 269..275

              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

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

                    if (existing) {
                      return res.fail({
                        status: HttpStatusCode.CONFLICT_409,
                        message: `Channel with name ${req.body.channelName} already exists.`
                      })
              Severity: Minor
              Found in server/core/middlewares/validators/users/users.ts and 1 other location - About 45 mins to fix
              server/core/middlewares/validators/users/user-registrations.ts on lines 197..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

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

                  if (!exists) {
                    logger.debug('User with email %s does not exist (asking reset password).', req.body.email)
                    // Do not leak our emails
                    return res.status(HttpStatusCode.NO_CONTENT_204).end()
                  }
              Severity: Minor
              Found in server/core/middlewares/validators/users/users.ts and 1 other location - About 45 mins to fix
              server/core/middlewares/validators/users/user-email-verification.ts on lines 21..25

              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

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

                  if (res.locals.user.pluginAuth) {
                    return res.fail({
                      status: HttpStatusCode.CONFLICT_409,
                      message: 'Cannot recover password of a user that uses a plugin authentication.'
                    })
              Severity: Minor
              Found in server/core/middlewares/validators/users/users.ts and 1 other location - About 30 mins to fix
              server/core/middlewares/validators/videos/video-stats.ts on lines 35..40

              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