Sign upLogin

raveljs/ravel

View on GitHub
Star

Showing 58 of 59 total issues

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

Function match has 38 lines of code (exceeds 30 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 1 hr to fix

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

      middleware () {
    this[sRouteTree].sort();
    return async (ctx, next) => {
      if (ctx.method === 'OPTIONS') {
        ctx.status = 200;
    Severity: Minor
    Found in lib/core/router.js - About 1 hr to fix

      Function scan has 33 lines of code (exceeds 30 allowed). Consider refactoring.
      Open

        Ravel.prototype.scan = function (...basePaths) {
    for (const basePath of basePaths) {
      const absPath = upath.toUnix(upath.isAbsolute(basePath)
        ? basePath
        : upath.toUnix(upath.posix.join(this.cwd, basePath)));
      Severity: Minor
      Found in lib/core/scan.js - About 1 hr to fix

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

          init () {
    // set up websocket on server, with session cookie generation
    this.wss = new WebSocket.Server({
      noServer: true,
      maxPayload: this.ravelApp.get('max websocket payload bytes')
        Severity: Minor
        Found in lib/core/websocket.js - About 1 hr to fix

          Function getModule has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
          Open

            getModule (moduleMap, moduleName) {
    if (moduleMap[moduleName] !== undefined) {
      // if the requested module is in our map of predefined valid stuff
      return moduleMap[moduleName];
    } else if (this[sRavelInstance][coreSymbols.moduleFactories][moduleName] !== undefined) {
          Severity: Minor
          Found in lib/core/injector.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 compare has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
          Open

            static compare (lNode, rNode) {
    // catch-all routes have the lowest priority
    if (!lNode.catchAll && rNode.catchAll) {
      return -1;
    } else if (lNode.catchAll && !rNode.catchAll) {
          Severity: Minor
          Found in lib/util/route-tree.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 sOpenConnections has 32 lines of code (exceeds 30 allowed). Consider refactoring.
          Open

          TransactionFactory.prototype[sOpenConnections] = function (providerNames, closers) {
  // guarantee provider names are unique
  let uniqueProviderNames = new Set();
  providerNames.forEach(n => uniqueProviderNames.add(n));
  uniqueProviderNames = Array.from(uniqueProviderNames);
          Severity: Minor
          Found in lib/db/database.js - About 1 hr to fix

            Function authconfig has 31 lines of code (exceeds 30 allowed). Consider refactoring.
            Open

            function authconfig (target) {
  Metadata.putClassMeta(target.prototype, '@authconfig', 'enabled', true);

  if (!target.prototype.serializeUser) {
    target.prototype.serializeUser = function (profile) { // eslint-disable-line no-unused-vars
            Severity: Minor
            Found in lib/auth/decorators/authconfig.js - About 1 hr to fix

              Function createClient has a Cognitive Complexity of 8 (exceeds 5 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 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

              Consider simplifying this complex logical expression.
              Open

                } else if (options.okCode === httpCodes.PARTIAL_CONTENT && response.body !== undefined &&
             options !== undefined && options.start !== undefined &&
             options.end !== undefined && options.count !== undefined) {
    response.set('Content-Range', 'items ' + options.start + '-' + options.end + '/' + options.count);
  }
              Severity: Major
              Found in lib/util/rest.js - About 40 mins to fix

                Function buildRoute has 5 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                function buildRoute (ravelInstance, routes, koaRouter, methodName, meta) {
                Severity: Minor
                Found in lib/core/routes.js - About 35 mins to fix

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

                      this[symbols.resourceFactories][basePath] = (koaRouter) => {
      const resource = this[symbols.injector].inject(coreServices(this, basePath), resourceClass);
      initResource.call(resource, this, koaRouter);
      this[symbols.resource][basePath] = resource;
      return resource;
                  Severity: Minor
                  Found in lib/core/resource.js and 1 other location - About 35 mins to fix
                  lib/core/routes.js on lines 224..229

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

                  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

                      this[symbols.routesFactories][basePath] = (koaRouter) => {
      const routes = this[symbols.injector].inject(coreServices(this, basePath), routesClass);
      initRoutes.call(routes, this, koaRouter);
      this[symbols.routes][basePath] = routes;
      return routes;
                  Severity: Minor
                  Found in lib/core/routes.js and 1 other location - About 35 mins to fix
                  lib/core/resource.js on lines 122..127

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

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

                  function authenticated (...args) {
  if (args.length === 3 && typeof args[0].constructor === 'function') {
    Metadata.putMethodMeta(args[0], args[1], '@authenticated', 'config', Object.create(null));
  } else if (args.length === 1 && typeof args[0] === 'function') {
    // handle @authenticated at the class-level without arguments
                  Severity: Minor
                  Found in lib/auth/decorators/authenticated.js - About 35 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 exports has a Cognitive Complexity of 7 (exceeds 5 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: Minor
                  Found in lib/auth/passport_init.js - About 35 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 inject has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                  Open

                  const inject = function (...rest) {
  return function (target) {
    if (rest.length === 0) {
      throw new $err.NotFound(`Empty @inject supplied on ${typeof target}`);
    }
                  Severity: Minor
                  Found in lib/core/decorators/inject.js - About 35 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;
                  Severity: Major
                  Found in lib/util/response_cache.js - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                          return -1;
                    Severity: Major
                    Found in lib/util/route-tree.js - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                          return null;
                      Severity: Major
                      Found in lib/util/route-tree.js - About 30 mins to fix
                        Severity
                        Category
                        Status
                        Source
                        Language