NodeBB/NodeBB

View on GitHub
src/middleware/render.js

Summary

Maintainability
F
4 days
Test Coverage

Function exports has a Cognitive Complexity of 105 (exceeds 10 allowed). Consider refactoring.
Open

module.exports = function (middleware) {
    middleware.processRender = function processRender(req, res, next) {
        // res.render post-processing, modified from here: https://gist.github.com/mrlannigan/5051687
        const { render } = res;

Severity: Minor
Found in src/middleware/render.js - About 2 days 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 418 lines of code (exceeds 75 allowed). Consider refactoring.
Open

module.exports = function (middleware) {
    middleware.processRender = function processRender(req, res, next) {
        // res.render post-processing, modified from here: https://gist.github.com/mrlannigan/5051687
        const { render } = res;

Severity: Major
Found in src/middleware/render.js - About 1 day to fix

    Function loadClientHeaderFooterData has 92 lines of code (exceeds 75 allowed). Consider refactoring.
    Open

        async function loadClientHeaderFooterData(req, res, options) {
            const registrationType = meta.config.registrationType || 'normal';
            res.locals.config = res.locals.config || {};
            const templateValues = {
                title: meta.config.title || '',
    Severity: Major
    Found in src/middleware/render.js - About 1 hr to fix

      Function processRender has 76 lines of code (exceeds 75 allowed). Consider refactoring.
      Open

          middleware.processRender = function processRender(req, res, next) {
              // res.render post-processing, modified from here: https://gist.github.com/mrlannigan/5051687
              const { render } = res;
      
              res.render = async function renderOverride(template, options, fn) {
      Severity: Major
      Found in src/middleware/render.js - About 1 hr to fix

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

            async function renderHeaderFooter(method, req, res, options, headerFooterData) {
        Severity: Minor
        Found in src/middleware/render.js - About 35 mins to fix

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

              function renderContent(render, tpl, req, res, options) {
          Severity: Minor
          Found in src/middleware/render.js - About 35 mins to fix

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

                async function renderAdminFooter(req, res, options, headerFooterData) {
                    const hookReturn = await plugins.hooks.fire('filter:middleware.renderAdminFooter', {
                        req,
                        res,
                        templateValues: headerFooterData, // TODO: deprecate
            Severity: Major
            Found in src/middleware/render.js and 2 other locations - About 1 hr to fix
            src/middleware/render.js on lines 318..328
            src/middleware/render.js on lines 350..360

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

            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

                async function renderHeader(req, res, options, headerFooterData) {
                    const hookReturn = await plugins.hooks.fire('filter:middleware.renderHeader', {
                        req: req,
                        res: res,
                        templateValues: headerFooterData, // TODO: deprecate
            Severity: Major
            Found in src/middleware/render.js and 2 other locations - About 1 hr to fix
            src/middleware/render.js on lines 350..360
            src/middleware/render.js on lines 362..372

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

            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

                async function renderAdminHeader(req, res, options, headerFooterData) {
                    const hookReturn = await plugins.hooks.fire('filter:middleware.renderAdminHeader', {
                        req,
                        res,
                        templateValues: headerFooterData, // TODO: deprecate
            Severity: Major
            Found in src/middleware/render.js and 2 other locations - About 1 hr to fix
            src/middleware/render.js on lines 318..328
            src/middleware/render.js on lines 362..372

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

            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