Chocobozzz/PeerTube

View on GitHub
server/core/lib/auth/oauth-model.ts

Summary

Maintainability
C
1 day
Test Coverage

Function getUser has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
Open

async function getUser (usernameOrEmail?: string, password?: string, bypassLogin?: BypassLogin) {
  // Special treatment coming from a plugin
  if (bypassLogin && bypassLogin.bypass === true) {
    logger.info('Bypassing oauth login by plugin %s.', bypassLogin.pluginName)

Severity: Minor
Found in server/core/lib/auth/oauth-model.ts - About 2 hrs 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 getUser has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

async function getUser (usernameOrEmail?: string, password?: string, bypassLogin?: BypassLogin) {
  // Special treatment coming from a plugin
  if (bypassLogin && bypassLogin.bypass === true) {
    logger.info('Bypassing oauth login by plugin %s.', bypassLogin.pluginName)

Severity: Minor
Found in server/core/lib/auth/oauth-model.ts - About 1 hr to fix

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

    async function saveToken (
      token: TokenInfo,
      client: MOAuthClient,
      user: MUser,
      options: {
    Severity: Minor
    Found in server/core/lib/auth/oauth-model.ts - About 1 hr to fix

      Function updateUserFromExternal has 29 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      async function updateUserFromExternal (
        user: MUserDefault,
        userOptions: ExternalUser,
        userUpdater: RegisterServerAuthenticatedResult['userUpdater']
      ) {
      Severity: Minor
      Found in server/core/lib/auth/oauth-model.ts - About 1 hr to fix

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

        async function getAccessToken (bearerToken: string) {
          logger.debug('Getting access token.')
        
          if (!bearerToken) return undefined
        
        
        Severity: Minor
        Found in server/core/lib/auth/oauth-model.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 user
        Severity: Major
        Found in server/core/lib/auth/oauth-model.ts - About 30 mins to fix

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

            if (tokenModel.User.pluginAuth) {
              const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'access')
          
              if (valid !== true) return undefined
            }
          Severity: Minor
          Found in server/core/lib/auth/oauth-model.ts and 1 other location - About 40 mins to fix
          server/core/lib/auth/oauth-model.ts on lines 76..80

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

          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 (tokenModel.User.pluginAuth) {
              const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'refresh')
          
              if (valid !== true) return undefined
            }
          Severity: Minor
          Found in server/core/lib/auth/oauth-model.ts and 1 other location - About 40 mins to fix
          server/core/lib/auth/oauth-model.ts on lines 53..57

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

          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