Chocobozzz/PeerTube

View on GitHub
server/core/controllers/api/users/index.ts

Summary

Maintainability
B
6 hrs
Test Coverage

File index.ts has 263 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import express from 'express'
import { tokensRouter } from '@server/controllers/api/users/token.js'
import { Hooks } from '@server/lib/plugins/hooks.js'
import { OAuthTokenModel } from '@server/models/oauth/oauth-token.js'
import { MUserAccountDefault } from '@server/types/models/index.js'
Severity: Minor
Found in server/core/controllers/api/users/index.ts - About 2 hrs to fix

    Function createUser has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    async function createUser (req: express.Request, res: express.Response) {
      const body: UserCreate = req.body
    
      const userToCreate = buildUser({
        ...pick(body, [ 'username', 'password', 'email', 'role', 'videoQuota', 'videoQuotaDaily', 'adminFlags' ]),
    Severity: Minor
    Found in server/core/controllers/api/users/index.ts - About 1 hr to fix

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

      async function updateUser (req: express.Request, res: express.Response) {
        const body: UserUpdate = req.body
        const userToUpdate = res.locals.user
        const byUser = res.locals.oauth.token.User
        const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
      Severity: Minor
      Found in server/core/controllers/api/users/index.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 5 locations. Consider refactoring.
      Open

        logger.info(`Removed user ${user.username} by moderator ${byUser.username}.`, lTags(user.username, byUser.username))
      Severity: Major
      Found in server/core/controllers/api/users/index.ts and 4 other locations - About 35 mins to fix
      server/core/controllers/api/users/index.ts on lines 202..202
      server/core/controllers/api/users/index.ts on lines 216..216
      server/core/controllers/api/users/index.ts on lines 292..292
      server/core/lib/job-queue/handlers/video-live-ending.ts on lines 184..187

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

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

        logger.info(`Updated user ${user.username} by moderator ${byUser.username}.`, lTags(user.username, byUser.username))
      Severity: Major
      Found in server/core/controllers/api/users/index.ts and 4 other locations - About 35 mins to fix
      server/core/controllers/api/users/index.ts on lines 202..202
      server/core/controllers/api/users/index.ts on lines 216..216
      server/core/controllers/api/users/index.ts on lines 256..256
      server/core/lib/job-queue/handlers/video-live-ending.ts on lines 184..187

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

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

        logger.info(`Unblocked user ${user.username} by moderator ${byUser.username}.`, lTags(user.username, byUser.username))
      Severity: Major
      Found in server/core/controllers/api/users/index.ts and 4 other locations - About 35 mins to fix
      server/core/controllers/api/users/index.ts on lines 216..216
      server/core/controllers/api/users/index.ts on lines 256..256
      server/core/controllers/api/users/index.ts on lines 292..292
      server/core/lib/job-queue/handlers/video-live-ending.ts on lines 184..187

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

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

        logger.info(`Blocked user ${user.username} by moderator ${byUser.username}.`, lTags(user.username, byUser.username))
      Severity: Major
      Found in server/core/controllers/api/users/index.ts and 4 other locations - About 35 mins to fix
      server/core/controllers/api/users/index.ts on lines 202..202
      server/core/controllers/api/users/index.ts on lines 256..256
      server/core/controllers/api/users/index.ts on lines 292..292
      server/core/lib/job-queue/handlers/video-live-ending.ts on lines 184..187

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

      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