Sign upLogin

raveljs/ravel

View on GitHub
Star

Showing 58 of 59 total issues

HTTPCodes has 71 functions (exceeds 20 allowed). Consider refactoring.
Open

class HTTPCodes {
  /**
   * HTTP OK.
   *
   * @returns {number} The HTTP status code 200.
Severity: Major
Found in lib/util/http_codes.js - About 1 day to fix

    Function exports has 106 lines of code (exceeds 30 allowed). Consider refactoring.
    Open

    module.exports = function (Ravel) {
  /**
   * Stores default configuration values, specified at parameter creation-time.
   *
   * @private
    Severity: Major
    Found in lib/core/params.js - About 4 hrs to fix

      Function buildRoute has 97 lines of code (exceeds 30 allowed). Consider refactoring.
      Open

      function buildRoute (ravelInstance, routes, koaRouter, methodName, meta) {
  const basePath = Metadata.getClassMetaValue(routes, '@role', 'name');
  const fullPath = upath.toUnix(upath.posix.join(basePath, meta.path));

  let verb;
      Severity: Major
      Found in lib/core/routes.js - About 3 hrs to fix

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

        module.exports = function (Ravel) {
  /**
   * Recursively register `Module`s, `Resource`s and `Routes` with Ravel.
   * Useful for [testing](#testing-ravel-applications).
   *
        Severity: Minor
        Found in lib/core/scan.js - About 3 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 buildRoute has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
        Open

        function buildRoute (ravelInstance, routes, koaRouter, methodName, meta) {
  const basePath = Metadata.getClassMetaValue(routes, '@role', 'name');
  const fullPath = upath.toUnix(upath.posix.join(basePath, meta.path));

  let verb;
        Severity: Minor
        Found in lib/core/routes.js - About 3 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 exports has 86 lines of code (exceeds 30 allowed). Consider refactoring.
        Open

        module.exports = function (Ravel) {
  /**
   * Retrieve an initialized Ravel `Module` by its injection name, after `app.init()`.
   * Useful for [testing](#testing-ravel-applications).
   *
        Severity: Major
        Found in lib/core/module.js - About 3 hrs to fix

          Function init has 75 lines of code (exceeds 30 allowed). Consider refactoring.
          Open

            async init () {
    // application configuration is completed in constructor
    await this.emit('pre init');

    // log uncaught errors to prevent ES6 promise error swallowing
          Severity: Major
          Found in lib/ravel.js - About 2 hrs to fix

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

            module.exports = function (Ravel) {
  /**
   * Stores default configuration values, specified at parameter creation-time.
   *
   * @private
            Severity: Minor
            Found in lib/core/params.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 match has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
            Open

              match (path, keyValues = {}) {
    if (path.length === 0) {
      if (this.middleware.length > 0) {
        return new RouteTreeResult(keyValues, this.middleware, this.composedMiddleware);
      } else {
            Severity: Minor
            Found in lib/util/route-tree.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 exports has 69 lines of code (exceeds 30 allowed). Consider refactoring.
            Open

            module.exports = function (ravelInstance, router) {
  /**
   * Retrieve the first registered Module which is decorated with `@authconfig`.
   *
   * @returns {object} The first `@authconfig` `Module`.
            Severity: Major
            Found in lib/auth/passport_init.js - About 2 hrs to fix

              Function exports has 54 lines of code (exceeds 30 allowed). Consider refactoring.
              Open

              module.exports = function (Ravel) {
  /**
   * Recursively register `Module`s, `Resource`s and `Routes` with Ravel.
   * Useful for [testing](#testing-ravel-applications).
   *
              Severity: Major
              Found in lib/core/scan.js - About 1 hr to fix

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

                const Routes = function (basePath) {
  if (typeof basePath !== 'string') {
    throw new $err.IllegalValue(
      '@Routes must be used with a basePath, as in @Routes(\'/route/base/path\')');
  }
                Severity: Major
                Found in lib/core/decorators/routes.js and 1 other location - About 1 hr to fix
                lib/core/decorators/resource.js on lines 86..97

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

                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

                const Resource = function (basePath) {
  if (typeof basePath !== 'string') {
    throw new $err.IllegalValue(
      '@Resource must be used with a basePath, as in @Resource(\'/route/base/path\')');
  }
                Severity: Major
                Found in lib/core/decorators/resource.js and 1 other location - About 1 hr to fix
                lib/core/decorators/routes.js on lines 61..72

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

                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 cacheBody has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
                Open

                  async cacheBody (ctx, key, metaKey, options) {
    let body = ctx.response.body;
    if ((ctx.request.method !== 'GET') || (ctx.response.status !== 200) || !body) {
      return;
    }
                Severity: Minor
                Found in lib/util/response_cache.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 createClient has 49 lines of code (exceeds 30 allowed). Consider refactoring.
                Open

                function createClient (ravelInstance, restrict = true) {
  const localRedis = ravelInstance.get('redis port') === undefined || ravelInstance.get('redis host') === undefined;
  ravelInstance.on('post init', () => {
    ravelInstance.$log.info(localRedis
      ? 'Using in-memory key-value store. Please do not scale this app horizontally.'
                Severity: Minor
                Found in lib/util/kvstore.js - About 1 hr to fix

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

                  const autoinject = function (...rest) {
  return function (target) {
    if (rest.length === 0) {
      throw new $err.NotFound(`Empty @autoinject supplied on ${typeof target}`);
    }
                  Severity: Minor
                  Found in lib/core/decorators/autoinject.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 initModule has 44 lines of code (exceeds 30 allowed). Consider refactoring.
                  Open

                  async function initModule (ravelInstance) {
  const self = this;
  const name = Metadata.getClassMetaValue(Object.getPrototypeOf(self), '@role', 'name');
  // run @postinject handlers
  const postInjects = Metadata.getClassMeta(Object.getPrototypeOf(self), '@postinject', Object.create(null));
                  Severity: Minor
                  Found in lib/core/module.js - About 1 hr to fix

                    Function constructor has 42 lines of code (exceeds 30 allowed). Consider refactoring.
                    Open

                      constructor () {
    super();

    this[sUncaughtRejections] = 0;
    this[sInitialized] = false;
                    Severity: Minor
                    Found in lib/ravel.js - About 1 hr to fix

                      Function middleware has 41 lines of code (exceeds 30 allowed). Consider refactoring.
                      Open

                        middleware () {
    const self = this;
    return async function (ctx, next) {
      let promise;
      if (ctx.headers['x-auth-token'] && ctx.headers['x-auth-client']) {
                      Severity: Minor
                      Found in lib/auth/authenticate_request.js - About 1 hr to fix

                        Function buildRestResponse has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
                        Open

                        const buildRestResponse = function (ravelInstance, request, response, options) {
  options = options || {};
  if (options.okCode === undefined) {
    if (response.body && request.method.toUpperCase() === 'POST') {
      options.okCode = httpCodes.CREATED;
                        Severity: Minor
                        Found in lib/util/rest.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

                        Severity
                        Category
                        Status
                        Source
                        Language