keymetrics/pm2-io-agent-node

View on GitHub
src/index.js

Summary

Maintainability
D
2 days
Test Coverage

Function listenForLogs has 48 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  listenForLogs () {
    const send = this.send.bind(this, 'logs')
    let isTemporalyLogging = false // used for startLogging and stopLogging

    // Listen actions
Severity: Minor
Found in src/index.js - About 1 hr to fix

    Function listenForLogs has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

      listenForLogs () {
        const send = this.send.bind(this, 'logs')
        let isTemporalyLogging = false // used for startLogging and stopLogging
    
        // Listen actions
    Severity: Minor
    Found in src/index.js - 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 start has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      start () {
        return new Promise((resolve, reject) => {
          if (this.isStopping) return reject(new Error('Agent is stopping'))
    
          // Trying to check infos
    Severity: Minor
    Found in src/index.js - About 1 hr to fix

      Function constructor has 27 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        constructor (config, proc) {
          // Valid config
          if (!config ||
            typeof config.publicKey !== 'string' ||
            typeof config.secretKey !== 'string' ||
      Severity: Minor
      Found in src/index.js - About 1 hr to fix

        Consider simplifying this complex logical expression.
        Open

            if (!config ||
              typeof config.publicKey !== 'string' ||
              typeof config.secretKey !== 'string' ||
              typeof config.appName !== 'string' ||
              (typeof config.proxy !== 'undefined' && typeof config.proxy !== 'string') ||
        Severity: Major
        Found in src/index.js - About 1 hr to fix

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

            constructor (config, proc) {
              // Valid config
              if (!config ||
                typeof config.publicKey !== 'string' ||
                typeof config.secretKey !== 'string' ||
          Severity: Minor
          Found in src/index.js - 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 cb(null, data.endpoints)
          Severity: Major
          Found in src/index.js - About 30 mins to fix

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

                process.stdout.write = function () {
                  const res = originalStdOut.apply(this, arguments)
                  // Don't send logs if not configured
                  if (self.disableLogs) return res
                  if (!self.sendLogs && isTemporalyLogging === false) return res
            Severity: Major
            Found in src/index.js and 1 other location - About 5 hrs to fix
            src/index.js on lines 295..306

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

            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

                process.stderr.write = function () {
                  const res = originalStdErr.apply(this, arguments)
                  // Don't send logs if not configured
                  if (self.disableLogs) return res
                  if (!self.sendLogs && isTemporalyLogging === false) return res
            Severity: Major
            Found in src/index.js and 1 other location - About 5 hrs to fix
            src/index.js on lines 281..292

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

            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