haraka/haraka-plugin-geoip

View on GitHub
index.js

Summary

Maintainability
C
1 day
Test Coverage

File index.js has 320 lines of code (exceeds 250 allowed). Consider refactoring.
Open

const fs        = require('fs')
const net       = require('net')
const path      = require('path')

const net_utils = require('haraka-net-utils')
Severity: Minor
Found in index.js - About 3 hrs to fix

    Function get_geoip has a Cognitive Complexity of 25 (exceeds 10 allowed). Consider refactoring.
    Open

    exports.get_geoip = function (ip) {
    
      switch (true) {
        case (!ip):
        case (!net.isIPv4(ip) && !net.isIPv6(ip)):
    Severity: Minor
    Found in index.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 calculate_distance has a Cognitive Complexity of 13 (exceeds 10 allowed). Consider refactoring.
    Open

    exports.calculate_distance = function (connection, rll, done) {
      const plugin = this
    
      function cb (err, l_ip) {
        if (err) {
    Severity: Minor
    Found in index.js - About 45 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 add_headers has a Cognitive Complexity of 11 (exceeds 10 allowed). Consider refactoring.
    Open

    exports.add_headers = function (next, connection) {
      const txn = connection.transaction
      if (!txn) return
    
      txn.remove_header('X-Haraka-GeoIP')
    Severity: Minor
    Found in index.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 2 locations. Consider refactoring.
    Open

      if (loc.continent && loc.continent.code && loc.continent.code !== '--') {
        agg_res.continent = loc.continent.code
        show.push(loc.continent.code)
      }
    Severity: Major
    Found in index.js and 1 other location - About 2 hrs to fix
    index.js on lines 115..118

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

    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 (loc.country && loc.country.iso_code && loc.country.iso_code !== '--') {
        agg_res.country = loc.country.iso_code
        show.push(loc.country.iso_code)
      }
    Severity: Major
    Found in index.js and 1 other location - About 2 hrs to fix
    index.js on lines 110..113

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

    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