Sign upLogin

dominiklessel/node-restify-boilerplate

View on GitHub
Star

Showing 10 of 10 total issues

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

routes.push({
  meta: {
    name: 'getSecret',
    method: 'GET',
    paths: [
Severity: Major
Found in middleware/secret/index.js and 1 other location - About 2 hrs to fix
middleware/root/index.js on lines 15..30

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

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

routes.push({
  meta: {
    name: 'getRoot',
    method: 'GET',
    paths: [
Severity: Major
Found in middleware/root/index.js and 1 other location - About 2 hrs to fix
middleware/secret/index.js on lines 15..30

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

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

Function exports has 51 lines of code (exceeds 25 allowed). Consider refactoring.
Open

module.exports = function() {

  var parseAuthorization = function(req, res, next) {

    var credentialList = nconf.get('Security:Users');
Severity: Major
Found in plugins/customAuthorizationParser.js - About 2 hrs to fix

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

      var parseAuthorization = function(req, res, next) {

    var credentialList = nconf.get('Security:Users');
    var allowAnon = nconf.get('Security:AllowAnonymous');
    var authorizationHeader;
    Severity: Minor
    Found in plugins/customAuthorizationParser.js - About 1 hr to fix

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

      module.exports = function() {

  var parseAuthorization = function(req, res, next) {

    var credentialList = nconf.get('Security:Users');
      Severity: Minor
      Found in plugins/customAuthorizationParser.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

      Avoid too many return statements within this function.
      Open

            return next(new restify.NotAuthorizedError('Authorization key unknown.'));
      Severity: Major
      Found in plugins/customAuthorizationParser.js - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

              return next(new restify.InvalidHeaderError('Authorization scheme is invalid.'));
        Severity: Major
        Found in plugins/customAuthorizationParser.js - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                return next(new restify.NotAuthorizedError('Authorization signature is invalid.'));
          Severity: Major
          Found in plugins/customAuthorizationParser.js - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                return next();
            Severity: Major
            Found in plugins/customAuthorizationParser.js - About 30 mins to fix

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

              var CORSHelper = function(options) {

  var allowedOrigins = options.origins || [];
  var allowedHeaders = restify.CORS.ALLOW_HEADERS.concat(options.headers || []);
              Severity: Minor
              Found in helpers/corsHelper.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

              Severity
              Category
              Status
              Source
              Language