mimani/mongoose-diff-history

View on GitHub

Showing 15 of 15 total issues

Function lastModifiedPlugin has 70 lines of code (exceeds 25 allowed). Consider refactoring.
Open

const plugin = function lastModifiedPlugin(schema, opts = {}) {
    if (opts.uri) {
        const mongoVersion = parseInt(mongoose.version);
        if (mongoVersion < 5) {
            mongoose.connect(opts.uri, { useMongoClient: true }).catch(e => {
Severity: Major
Found in diffHistory.js - About 2 hrs to fix

    File diffHistory.js has 282 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    const mongoose = require('mongoose');
    
    const omit = require('omit-deep');
    const pick = require('lodash.pick');
    const empty = require('deep-empty-object');
    Severity: Minor
    Found in diffHistory.js - About 2 hrs to fix

      Function getHistories has 43 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      const getHistories = (modelName, id, expandableFields, cb) => {
          expandableFields = expandableFields || [];
          if (typeof expandableFields === 'function') {
              cb = expandableFields;
              expandableFields = [];
      Severity: Minor
      Found in diffHistory.js - About 1 hr to fix

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

            schema.pre('update', function (next) {
                if (checkRequired(opts, this)) {
                    return next();
                }
                saveDiffs(this, opts)
        Severity: Major
        Found in diffHistory.js and 2 other locations - About 1 hr to fix
        diffHistory.js on lines 286..293
        diffHistory.js on lines 304..311

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

        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 3 locations. Consider refactoring.
        Open

            schema.pre('updateOne', function (next) {
                if (checkRequired(opts, this)) {
                    return next();
                }
                saveDiffs(this, opts)
        Severity: Major
        Found in diffHistory.js and 2 other locations - About 1 hr to fix
        diffHistory.js on lines 286..293
        diffHistory.js on lines 295..302

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

        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 3 locations. Consider refactoring.
        Open

            schema.pre('findOneAndUpdate', function (next) {
                if (checkRequired(opts, this)) {
                    return next();
                }
                saveDiffs(this, opts)
        Severity: Major
        Found in diffHistory.js and 2 other locations - About 1 hr to fix
        diffHistory.js on lines 295..302
        diffHistory.js on lines 304..311

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

        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 saveDiffHistory has 37 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        const saveDiffHistory = (queryObject, currentObject, opts) => {
            const queryUpdate = queryObject.getUpdate();
            const schemaOptions = queryObject.model.schema.options || {};
        
            let keysToBeModified = [];
        Severity: Minor
        Found in diffHistory.js - About 1 hr to fix

          Function saveDiffObject has 34 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          function saveDiffObject(currentObject, original, updated, opts, queryObject) {
              const { __user: user, __reason: reason, __session: session } =
                  (queryObject && queryObject.options) || currentObject;
          
              let diff = diffPatcher.diff(
          Severity: Minor
          Found in diffHistory.js - About 1 hr to fix

            Function saveDiffHistory has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
            Open

            const saveDiffHistory = (queryObject, currentObject, opts) => {
                const queryUpdate = queryObject.getUpdate();
                const schemaOptions = queryObject.model.schema.options || {};
            
                let keysToBeModified = [];
            Severity: Minor
            Found in diffHistory.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 getVersion has 31 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

            const getVersion = (model, id, version, queryOpts, cb) => {
                if (typeof queryOpts === 'function') {
                    cb = queryOpts;
                    queryOpts = undefined;
                }
            Severity: Minor
            Found in diffHistory.js - About 1 hr to fix

              Function lastModifiedPlugin has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
              Open

              const plugin = function lastModifiedPlugin(schema, opts = {}) {
                  if (opts.uri) {
                      const mongoVersion = parseInt(mongoose.version);
                      if (mongoVersion < 5) {
                          mongoose.connect(opts.uri, { useMongoClient: true }).catch(e => {
              Severity: Minor
              Found in diffHistory.js - About 55 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

                      } else {
                          mongoose.connect(opts.uri, { useNewUrlParser: true }).catch(e => {
                              console.error('mongoose-diff-history connection error:', e);
                          });
                      }
              Severity: Minor
              Found in diffHistory.js and 1 other location - About 50 mins to fix
              diffHistory.js on lines 247..251

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

              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 (mongoVersion < 5) {
                          mongoose.connect(opts.uri, { useMongoClient: true }).catch(e => {
                              console.error('mongoose-diff-history connection error:', e);
                          });
                      } else {
              Severity: Minor
              Found in diffHistory.js and 1 other location - About 50 mins to fix
              diffHistory.js on lines 251..255

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

              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 saveDiffObject has 5 arguments (exceeds 4 allowed). Consider refactoring.
              Open

              function saveDiffObject(currentObject, original, updated, opts, queryObject) {
              Severity: Minor
              Found in diffHistory.js - About 35 mins to fix

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

                function checkRequired(opts, queryObject, updatedObject) {
                    if (queryObject && !queryObject.options && !updatedObject) {
                        return;
                    }
                    const { __user: user, __reason: reason } =
                Severity: Minor
                Found in diffHistory.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