Sign upLogin

gfw-api/gfw-forms-api

View on GitHub
Star
app/src/routes/api/v1/reports.router.js

Summary

Maintainability
F
4 days
Test Coverage
F
27%

File reports.router.js has 374 lines of code (exceeds 250 allowed). Consider refactoring.
Open

const Router = require('koa-router');
const logger = require('logger');
const ReportsSerializer = require('serializers/reportsSerializer');
const ReportsModel = require('models/reportsModel');
const ReportsValidator = require('validators/reportsValidator');
Severity: Minor
Found in app/src/routes/api/v1/reports.router.js - About 5 hrs to fix

    Function downloadAnswers has 82 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        static* downloadAnswers() {
        logger.info(`Downloading answers for report ${this.params.id}`);
        this.set('Content-disposition', `attachment; filename=${this.params.id}.csv`);
        this.set('Content-type', 'text/csv');
        this.body = passThrough();
    Severity: Major
    Found in app/src/routes/api/v1/reports.router.js - About 3 hrs to fix

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

          static* patch() {
        logger.info(`Updating template with id ${this.params.id}...`);

        const reportFilter = {
            $and: [
      Severity: Major
      Found in app/src/routes/api/v1/reports.router.js - About 2 hrs to fix

        Function patch has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
        Open

            static* patch() {
        logger.info(`Updating template with id ${this.params.id}...`);

        const reportFilter = {
            $and: [
        Severity: Minor
        Found in app/src/routes/api/v1/reports.router.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 delete has 50 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            static* delete() {
        const { role } = this.state.loggedUser;
        const aoi = this.state.query && this.state.query.aoi !== null ? this.state.query.aoi.split(',') : null;
        logger.info(`Checking report for answers...`);
        const answers = yield AnswersModel.count({ report: new ObjectId(this.params.id) });
        Severity: Minor
        Found in app/src/routes/api/v1/reports.router.js - About 2 hrs to fix

          Function save has 36 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              static* save() {
        logger.info('Saving reports', this.request.body);
        const request = this.request.body;

        if (request.public && this.state.loggedUser.role !== 'ADMIN') {
          Severity: Minor
          Found in app/src/routes/api/v1/reports.router.js - About 1 hr to fix

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

                static* downloadAnswers() {
        logger.info(`Downloading answers for report ${this.params.id}`);
        this.set('Content-disposition', `attachment; filename=${this.params.id}.csv`);
        this.set('Content-type', 'text/csv');
        this.body = passThrough();
            Severity: Minor
            Found in app/src/routes/api/v1/reports.router.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 delete has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
            Open

                static* delete() {
        const { role } = this.state.loggedUser;
        const aoi = this.state.query && this.state.query.aoi !== null ? this.state.query.aoi.split(',') : null;
        logger.info(`Checking report for answers...`);
        const answers = yield AnswersModel.count({ report: new ObjectId(this.params.id) });
            Severity: Minor
            Found in app/src/routes/api/v1/reports.router.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 getAll has 34 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                static* getAll() {
        logger.info('Obtaining all reports');
        const filter = {
            $and: [
                {
            Severity: Minor
            Found in app/src/routes/api/v1/reports.router.js - About 1 hr to fix

              Function data has 31 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                          .map((answer) => {
                const responses = {
                    userId: answer.user || null,
                    reportName: answer.reportName,
                    areaOfInterest: answer.areaOfInterest || null,
              Severity: Minor
              Found in app/src/routes/api/v1/reports.router.js - About 1 hr to fix

                Function getAll has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                    static* getAll() {
        logger.info('Obtaining all reports');
        const filter = {
            $and: [
                {
                Severity: Minor
                Found in app/src/routes/api/v1/reports.router.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

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

                function* loggedUserToState(next) {
    if (this.query && this.query.loggedUser) {
        this.state.loggedUser = JSON.parse(this.query.loggedUser);
        delete this.query.loggedUser;
    } else if (this.request.body && this.request.body.loggedUser) {
                Severity: Major
                Found in app/src/routes/api/v1/reports.router.js and 1 other location - About 6 hrs to fix
                app/src/routes/api/v1/questionnaire.router.js on lines 103..115

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

                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

                function* mapTemplateParamToId(next) {
    if (this.params.id === config.get('legacyTemplateId') || this.params.id === 'default') {
        this.params.id = config.get('defaultTemplateId');
    }
    yield next;
                Severity: Major
                Found in app/src/routes/api/v1/reports.router.js and 1 other location - About 2 hrs to fix
                app/src/routes/api/v1/answers.router.js on lines 232..237

                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

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

                function* queryToState(next) {
    if (this.request.query && Object.keys(this.request.query).length > 0) {
        this.state.query = this.request.query;
    }
    yield next;
                Severity: Major
                Found in app/src/routes/api/v1/reports.router.js and 1 other location - About 2 hrs to fix
                app/src/routes/api/v1/answers.router.js on lines 195..200

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

                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

                                    yield RWAPIMicroservice.requestToMicroservice({
                        uri: `/area/${request.oldAreaOfInterest}`,
                        method: 'PATCH',
                        json: true,
                        body: {
                Severity: Major
                Found in app/src/routes/api/v1/reports.router.js and 1 other location - About 1 hr to fix
                app/src/routes/api/v1/reports.router.js on lines 266..274

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

                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

                                    yield RWAPIMicroservice.requestToMicroservice({
                        uri: `/area/${aoi[i]}`,
                        method: 'PATCH',
                        json: true,
                        body: {
                Severity: Major
                Found in app/src/routes/api/v1/reports.router.js and 1 other location - About 1 hr to fix
                app/src/routes/api/v1/reports.router.js on lines 205..213

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

                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

                        let report = yield ReportsModel.findOne({
            $and: [
                { _id: new ObjectId(this.params.id) },
                { $or: [{ public: true }, { user: new ObjectId(this.state.loggedUser.id) }] }
            ]
                Severity: Major
                Found in app/src/routes/api/v1/reports.router.js and 1 other location - About 1 hr to fix
                app/src/routes/api/v1/answers.router.js on lines 215..220

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

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

                        if (!result || !result.result || result.result.ok === 0) {
            this.throw(404, 'Report not found with these permissions. You must be the owner to remove.');
            return;
        }
                Severity: Major
                Found in app/src/routes/api/v1/reports.router.js and 3 other locations - About 40 mins to fix
                app/src/routes/api/v1/answers.router.js on lines 166..169
                app/src/routes/api/v1/questionnaire.router.js on lines 45..48
                app/src/routes/api/v1/questionnaireAnswer.router.js on lines 100..103

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

                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