yoctore/yocto-mongoose

View on GitHub
src/modules/utils/redis.js

Summary

Maintainability
C
1 day
Test Coverage

Function has a complexity of 10.
Open

RedisUtils.prototype.connect = function (hosts, options, defaultExpireTime, cluster) {
Severity: Minor
Found in src/modules/utils/redis.js by eslint

Limit Cyclomatic Complexity (complexity)

Cyclomatic complexity measures the number of linearly independent paths through a program's source code. This rule allows setting a cyclomatic complexity threshold.

function a(x) {
    if (true) {
        return x; // 1st path
    } else if (false) {
        return x+1; // 2nd path
    } else {
        return 4; // 3rd path
    }
}

Rule Details

This rule is aimed at reducing code complexity by capping the amount of cyclomatic complexity allowed in a program. As such, it will warn when the cyclomatic complexity crosses the configured threshold (default is 20).

Examples of incorrect code for a maximum of 2:

/*eslint complexity: ["error", 2]*/

function a(x) {
    if (true) {
        return x;
    } else if (false) {
        return x+1;
    } else {
        return 4; // 3rd path
    }
}

Examples of correct code for a maximum of 2:

/*eslint complexity: ["error", 2]*/

function a(x) {
    if (true) {
        return x;
    } else {
        return 4;
    }
}

Options

Optionally, you may specify a max object property:

"complexity": ["error", 2]

is equivalent to

"complexity": ["error", { "max": 2 }]

Deprecated: the object property maximum is deprecated. Please use the property max instead.

When Not To Use It

If you can't determine an appropriate complexity limit for your code, then it's best to disable this rule.

Further Reading

Related Rules

  • [max-depth](max-depth.md)
  • [max-len](max-len.md)
  • [max-nested-callbacks](max-nested-callbacks.md)
  • [max-params](max-params.md)
  • [max-statements](max-statements.md) Source: http://eslint.org/docs/rules/

Function connect has 53 lines of code (exceeds 25 allowed). Consider refactoring.
Open

RedisUtils.prototype.connect = function (hosts, options, defaultExpireTime, cluster) {
  // validation schema
  var schema = joi.array().required().items(
    joi.object().keys({
      host      : joi.string().required().empty().default('127.0.0.1'),
Severity: Major
Found in src/modules/utils/redis.js - About 2 hrs to fix

    Function connect has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

    RedisUtils.prototype.connect = function (hosts, options, defaultExpireTime, cluster) {
      // validation schema
      var schema = joi.array().required().items(
        joi.object().keys({
          host      : joi.string().required().empty().default('127.0.0.1'),
    Severity: Minor
    Found in src/modules/utils/redis.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 listenEvents has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    RedisUtils.prototype.listenEvents = function () {
      // default events
      var events = [
        { key : 'connect', message      : 'is connecting' },
        { key : 'ready', message        : 'is ready' },
    Severity: Minor
    Found in src/modules/utils/redis.js - About 1 hr to fix

      Unexpected trailing comma.
      Open

              cert    : joi.string().optional().empty(),
      Severity: Minor
      Found in src/modules/utils/redis.js by eslint

      require or disallow trailing commas (comma-dangle)

      Trailing commas in object literals are valid according to the ECMAScript 5 (and ECMAScript 3!) spec. However, IE8 (when not in IE8 document mode) and below will throw an error when it encounters trailing commas in JavaScript.

      var foo = {
          bar: "baz",
          qux: "quux",
      };

      Trailing commas simplify adding and removing items to objects and arrays, since only the lines you are modifying must be touched. Another argument in favor of trailing commas is that it improves the clarity of diffs when an item is added or removed from an object or array:

      Less clear:

      var foo = {
      -    bar: "baz",
      -    qux: "quux"
      +    bar: "baz"
       };

      More clear:

      var foo = {
           bar: "baz",
      -    qux: "quux",
       };

      Rule Details

      This rule enforces consistent use of trailing commas in object and array literals.

      Options

      This rule has a string option or an object option:

      {
          "comma-dangle": ["error", "never"],
          // or
          "comma-dangle": ["error", {
              "arrays": "never",
              "objects": "never",
              "imports": "never",
              "exports": "never",
              "functions": "ignore",
          }]
      }
      • "never" (default) disallows trailing commas
      • "always" requires trailing commas
      • "always-multiline" requires trailing commas when the last element or property is in a different line than the closing ] or } and disallows trailing commas when the last element or property is on the same line as the closing ] or }
      • "only-multiline" allows (but does not require) trailing commas when the last element or property is in a different line than the closing ] or } and disallows trailing commas when the last element or property is on the same line as the closing ] or }

      Trailing commas in function declarations and function calls are valid syntax since ECMAScript 2017; however, the string option does not check these situations for backwards compatibility.

      You can also use an object option to configure this rule for each type of syntax. Each of the following options can be set to "never", "always", "always-multiline", "only-multiline", or "ignore". The default for each option is "never" unless otherwise specified.

      • arrays is for array literals and array patterns of destructuring. (e.g. let [a,] = [1,];)
      • objects is for object literals and object patterns of destructuring. (e.g. let {a,} = {a: 1};)
      • imports is for import declarations of ES Modules. (e.g. import {a,} from "foo";)
      • exports is for export declarations of ES Modules. (e.g. export {a,};)
      • functions is for function declarations and function calls. (e.g. (function(a,){ })(b,);)
        functions is set to "ignore" by default for consistency with the string option.

      never

      Examples of incorrect code for this rule with the default "never" option:

      /*eslint comma-dangle: ["error", "never"]*/
      
      var foo = {
          bar: "baz",
          qux: "quux",
      };
      
      var arr = [1,2,];
      
      foo({
        bar: "baz",
        qux: "quux",
      });

      Examples of correct code for this rule with the default "never" option:

      /*eslint comma-dangle: ["error", "never"]*/
      
      var foo = {
          bar: "baz",
          qux: "quux"
      };
      
      var arr = [1,2];
      
      foo({
        bar: "baz",
        qux: "quux"
      });

      always

      Examples of incorrect code for this rule with the "always" option:

      /*eslint comma-dangle: ["error", "always"]*/
      
      var foo = {
          bar: "baz",
          qux: "quux"
      };
      
      var arr = [1,2];
      
      foo({
        bar: "baz",
        qux: "quux"
      });

      Examples of correct code for this rule with the "always" option:

      /*eslint comma-dangle: ["error", "always"]*/
      
      var foo = {
          bar: "baz",
          qux: "quux",
      };
      
      var arr = [1,2,];
      
      foo({
        bar: "baz",
        qux: "quux",
      });

      always-multiline

      Examples of incorrect code for this rule with the "always-multiline" option:

      /*eslint comma-dangle: ["error", "always-multiline"]*/
      
      var foo = {
          bar: "baz",
          qux: "quux"
      };
      
      var foo = { bar: "baz", qux: "quux", };
      
      var arr = [1,2,];
      
      var arr = [1,
          2,];
      
      var arr = [
          1,
          2
      ];
      
      foo({
        bar: "baz",
        qux: "quux"
      });

      Examples of correct code for this rule with the "always-multiline" option:

      /*eslint comma-dangle: ["error", "always-multiline"]*/
      
      var foo = {
          bar: "baz",
          qux: "quux",
      };
      
      var foo = {bar: "baz", qux: "quux"};
      var arr = [1,2];
      
      var arr = [1,
          2];
      
      var arr = [
          1,
          2,
      ];
      
      foo({
        bar: "baz",
        qux: "quux",
      });

      only-multiline

      Examples of incorrect code for this rule with the "only-multiline" option:

      /*eslint comma-dangle: ["error", "only-multiline"]*/
      
      var foo = { bar: "baz", qux: "quux", };
      
      var arr = [1,2,];
      
      var arr = [1,
          2,];

      Examples of correct code for this rule with the "only-multiline" option:

      /*eslint comma-dangle: ["error", "only-multiline"]*/
      
      var foo = {
          bar: "baz",
          qux: "quux",
      };
      
      var foo = {
          bar: "baz",
          qux: "quux"
      };
      
      var foo = {bar: "baz", qux: "quux"};
      var arr = [1,2];
      
      var arr = [1,
          2];
      
      var arr = [
          1,
          2,
      ];
      
      var arr = [
          1,
          2
      ];
      
      foo({
        bar: "baz",
        qux: "quux",
      });
      
      foo({
        bar: "baz",
        qux: "quux"
      });

      functions

      Examples of incorrect code for this rule with the {"functions": "never"} option:

      /*eslint comma-dangle: ["error", {"functions": "never"}]*/
      
      function foo(a, b,) {
      }
      
      foo(a, b,);
      new foo(a, b,);

      Examples of correct code for this rule with the {"functions": "never"} option:

      /*eslint comma-dangle: ["error", {"functions": "never"}]*/
      
      function foo(a, b) {
      }
      
      foo(a, b);
      new foo(a, b);

      Examples of incorrect code for this rule with the {"functions": "always"} option:

      /*eslint comma-dangle: ["error", {"functions": "always"}]*/
      
      function foo(a, b) {
      }
      
      foo(a, b);
      new foo(a, b);

      Examples of correct code for this rule with the {"functions": "always"} option:

      /*eslint comma-dangle: ["error", {"functions": "always"}]*/
      
      function foo(a, b,) {
      }
      
      foo(a, b,);
      new foo(a, b,);

      When Not To Use It

      You can turn this rule off if you are not concerned with dangling commas. Source: http://eslint.org/docs/rules/

      unnecessary '.call()'.
      Open

            this.remove.call(this, keys);
      Severity: Minor
      Found in src/modules/utils/redis.js by eslint

      Disallow unnecessary .call() and .apply(). (no-useless-call)

      The function invocation can be written by Function.prototype.call() and Function.prototype.apply(). But Function.prototype.call() and Function.prototype.apply() are slower than the normal function invocation.

      Rule Details

      This rule is aimed to flag usage of Function.prototype.call() and Function.prototype.apply() that can be replaced with the normal function invocation.

      Examples of incorrect code for this rule:

      /*eslint no-useless-call: "error"*/
      
      // These are same as `foo(1, 2, 3);`
      foo.call(undefined, 1, 2, 3);
      foo.apply(undefined, [1, 2, 3]);
      foo.call(null, 1, 2, 3);
      foo.apply(null, [1, 2, 3]);
      
      // These are same as `obj.foo(1, 2, 3);`
      obj.foo.call(obj, 1, 2, 3);
      obj.foo.apply(obj, [1, 2, 3]);

      Examples of correct code for this rule:

      /*eslint no-useless-call: "error"*/
      
      // The `this` binding is different.
      foo.call(obj, 1, 2, 3);
      foo.apply(obj, [1, 2, 3]);
      obj.foo.call(null, 1, 2, 3);
      obj.foo.apply(null, [1, 2, 3]);
      obj.foo.call(otherObj, 1, 2, 3);
      obj.foo.apply(otherObj, [1, 2, 3]);
      
      // The argument list is variadic.
      foo.apply(undefined, args);
      foo.apply(null, args);
      obj.foo.apply(obj, args);

      Known Limitations

      This rule compares code statically to check whether or not thisArg is changed. So if the code about thisArg is a dynamic expression, this rule cannot judge correctly.

      Examples of incorrect code for this rule:

      /*eslint no-useless-call: "error"*/
      
      a[i++].foo.call(a[i++], 1, 2, 3);

      Examples of correct code for this rule:

      /*eslint no-useless-call: "error"*/
      
      a[++i].foo.call(a[i], 1, 2, 3);

      When Not To Use It

      If you don't want to be notified about unnecessary .call() and .apply(), you can safely disable this rule. Source: http://eslint.org/docs/rules/

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

      module.exports = function (l) {
        // is a valid logger ?
        if (_.isUndefined(l) || _.isNull(l)) {
          logger.warning('[ RedisUtils.constructor ] - Invalid logger given. Use internal logger');
          // assign
      Severity: Major
      Found in src/modules/utils/redis.js and 5 other locations - About 2 hrs to fix
      src/index.js on lines 973..982
      src/modules/crud/index.js on lines 441..450
      src/modules/method/index.js on lines 200..209
      src/modules/utils/elastic.js on lines 134..143
      src/modules/validator/index.js on lines 99..108

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

      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 (_.has(this.hosts, 'tls.key')) {
          // define ca
          this.hosts.tls.key = fs.readFileSync(this.hosts.tls.key);
        }
      Severity: Major
      Found in src/modules/utils/redis.js and 1 other location - About 1 hr to fix
      src/modules/utils/redis.js on lines 155..158

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

      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 (_.has(this.hosts, 'tls.cert')) {
          // define ca
          this.hosts.tls.cert = fs.readFileSync(this.hosts.tls.cert);
        }
      Severity: Major
      Found in src/modules/utils/redis.js and 1 other location - About 1 hr to fix
      src/modules/utils/redis.js on lines 149..152

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

      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 (validate.error) {
          // log error message
          this.logger.warning([ '[ RedisUtils.connect ] - Invalid host config given :',
                                validate.error ] .join(' '));
          // default invalid statement
      Severity: Minor
      Found in src/modules/utils/redis.js and 1 other location - About 55 mins to fix
      src/index.js on lines 299..305

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

      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