msimerson/Haraka

View on GitHub
plugins/greylist.js

Summary

Maintainability
F
3 days
Test Coverage

File greylist.js has 457 lines of code (exceeds 250 allowed). Consider refactoring.
Open

// Greylisting plugin for Haraka

// version 0.1.4

// node builtins
Severity: Minor
Found in plugins/greylist.js - About 7 hrs to fix

    Function craft_hostid has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
    Open

    exports.craft_hostid = function (connection) {
        const plugin = this;
        const { transaction, remote } = connection ?? {};
        if (!transaction || !remote) return null;
    
    
    Severity: Minor
    Found in plugins/greylist.js - 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 hook_rcpt_ok has 62 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    exports.hook_rcpt_ok = function (next, connection, rcpt) {
    
        if (this.should_skip_check(connection)) return next();
        if (this.was_whitelisted_in_session(connection)) {
            this.logdebug(connection, 'host already whitelisted in this session');
    Severity: Major
    Found in plugins/greylist.js - About 2 hrs to fix

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

      exports.load_config_lists = function () {
          const plugin = this;
      
          plugin.whitelist = {};
          plugin.list = {};
      Severity: Minor
      Found in plugins/greylist.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 craft_hostid has 47 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      exports.craft_hostid = function (connection) {
          const plugin = this;
          const { transaction, remote } = connection ?? {};
          if (!transaction || !remote) return null;
      
      
      Severity: Minor
      Found in plugins/greylist.js - About 1 hr to fix

        Function load_config_lists has 37 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        exports.load_config_lists = function () {
            const plugin = this;
        
            plugin.whitelist = {};
            plugin.list = {};
        Severity: Minor
        Found in plugins/greylist.js - About 1 hr to fix

          Function should_skip_check has 28 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          exports.should_skip_check = function (connection) {
              const { transaction, relaying, remote } = connection ?? {}
          
              if (!transaction) return true;
          
          
          Severity: Minor
          Found in plugins/greylist.js - About 1 hr to fix

            Function update_grey has 28 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

            exports.update_grey = function (key, create, cb) {
                const multi = this.db.multi();
            
                const ts_now = Math.round(Date.now() / 1000);
                let new_record;
            Severity: Minor
            Found in plugins/greylist.js - About 1 hr to fix

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

              exports.db_lookup = function (key, cb) {
              
                  this.db.hgetall(key, (err, result) => {
                      if (err) {
                          this.lognotice(`DB error: ${util.inspect(err)}`, key);
              Severity: Minor
              Found in plugins/greylist.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

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

              exports.should_skip_check = function (connection) {
                  const { transaction, relaying, remote } = connection ?? {}
              
                  if (!transaction) return true;
              
              
              Severity: Minor
              Found in plugins/greylist.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 true;
              Severity: Major
              Found in plugins/greylist.js - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                    if (special_case_info) return chsit(null, special_case_info.why);
                Severity: Major
                Found in plugins/greylist.js - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                      return false;
                  Severity: Major
                  Found in plugins/greylist.js - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                            return chsit(null, 'FcrDNS failed');
                    Severity: Major
                    Found in plugins/greylist.js - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                              return chsit(null, 'rDNS is a generic record');
                      Severity: Major
                      Found in plugins/greylist.js - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                return chsit(null, 'multiple PTR returned');
                        Severity: Major
                        Found in plugins/greylist.js - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                              return chsit(stripped_dom);
                          Severity: Major
                          Found in plugins/greylist.js - About 30 mins to fix

                            Avoid too many return statements within this function.
                            Open

                                    return chsit(null, 'invalid org domain in rDNS');
                            Severity: Major
                            Found in plugins/greylist.js - About 30 mins to fix

                              Avoid too many return statements within this function.
                              Open

                                          return chsit(null, 'decimal IP');
                              Severity: Major
                              Found in plugins/greylist.js - About 30 mins to fix

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

                                exports.hook_mail = function (next, connection, params) {
                                    if (!connection.transaction) return next();
                                
                                    const mail_from = params[0];
                                
                                
                                Severity: Minor
                                Found in plugins/greylist.js - 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

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

                                exports.process_skip_rules = function (connection) {
                                    const cr = connection.results;
                                
                                    const skip_cfg = this.cfg.skip;
                                    if (skip_cfg) {
                                Severity: Minor
                                Found in plugins/greylist.js - 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

                                    this.cfg = this.config.get('greylist.ini', {
                                        booleans : [
                                            '+skip.dnswlorg',
                                            '-skip.mailspikewl'
                                        ]
                                Severity: Major
                                Found in plugins/greylist.js and 4 other locations - About 40 mins to fix
                                plugins/avg.js on lines 20..27
                                plugins/dnsbl.js on lines 22..26
                                plugins/mail_from.is_resolvable.js on lines 14..21
                                plugins/queue/smtp_proxy.js on lines 20..28

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

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

                                        if (err) {
                                            this.lognotice(`DB error: ${util.inspect(err)}`);
                                            err.what = 'db_error';
                                            throw err;
                                        }
                                Severity: Major
                                Found in plugins/greylist.js and 3 other locations - About 40 mins to fix
                                plugins/greylist.js on lines 456..460
                                plugins/greylist.js on lines 521..525
                                plugins/greylist.js on lines 549..553

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

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

                                        if (err) {
                                            this.lognotice(`DB error: ${util.inspect(err)}`);
                                            err.what = 'db_error';
                                            throw err;
                                        }
                                Severity: Major
                                Found in plugins/greylist.js and 3 other locations - About 40 mins to fix
                                plugins/greylist.js on lines 456..460
                                plugins/greylist.js on lines 492..496
                                plugins/greylist.js on lines 549..553

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

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

                                        if (err) {
                                            this.lognotice(`DB error: ${util.inspect(err)}`);
                                            err.what = 'db_error';
                                            throw err;
                                        }
                                Severity: Major
                                Found in plugins/greylist.js and 3 other locations - About 40 mins to fix
                                plugins/greylist.js on lines 492..496
                                plugins/greylist.js on lines 521..525
                                plugins/greylist.js on lines 549..553

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

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

                                        if (err2) {
                                            this.lognotice(`DB error: ${util.inspect(err2)}`);
                                            err2.what = 'db_error';
                                            throw err2;
                                        }
                                Severity: Major
                                Found in plugins/greylist.js and 3 other locations - About 40 mins to fix
                                plugins/greylist.js on lines 456..460
                                plugins/greylist.js on lines 492..496
                                plugins/greylist.js on lines 521..525

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

                                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