Sign upLogin

gfw-api/gfw-subscription-api

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

Summary

Maintainability
D
2 days
Test Coverage
B
80%

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

const Router = require('koa-router');
const UrlService = require('services/urlService');
const logger = require('logger');
const moment = require('moment');
const mongoose = require('mongoose');
Severity: Minor
Found in app/src/routes/api/v1/subscription.router.js - About 5 hrs to fix

    Function findAllSubscriptions has 27 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        static async findAllSubscriptions(ctx) {
        logger.info(`[SubscriptionsRouter] Getting ALL subscriptions`);

        const page = ctx.query.page && ctx.query.page.number ? parseInt(ctx.query.page.number, 10) : 1;
        const limit = ctx.query.page && ctx.query.page.size ? parseInt(ctx.query.page.size, 10) : 10;
    Severity: Minor
    Found in app/src/routes/api/v1/subscription.router.js - About 1 hr to fix

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

      const subscriptionExists = (isForUser) => async (ctx, next) => {
    const { id } = ctx.params;

    if (!mongoose.Types.ObjectId.isValid(id)) {
        ctx.throw(400, 'ID is not valid');
      Severity: Minor
      Found in app/src/routes/api/v1/subscription.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

      Avoid too many return statements within this function.
      Open

              return null;
      Severity: Major
      Found in app/src/routes/api/v1/subscription.router.js - About 30 mins to fix

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

            static validateSubscription(subs) {
        if ((!subs.datasets || subs.datasets.length === 0) && (!subs.datasetsQuery || subs.datasetsQuery.length === 0)) {
            return 'Datasets or datasetsQuery required';
        }
        if (!subs.language) {
        Severity: Minor
        Found in app/src/routes/api/v1/subscription.router.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

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

            static async findAllSubscriptions(ctx) {
        logger.info(`[SubscriptionsRouter] Getting ALL subscriptions`);

        const page = ctx.query.page && ctx.query.page.number ? parseInt(ctx.query.page.number, 10) : 1;
        const limit = ctx.query.page && ctx.query.page.size ? parseInt(ctx.query.page.size, 10) : 10;
        Severity: Minor
        Found in app/src/routes/api/v1/subscription.router.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

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

            static async statisticsGroup(ctx) {
        logger.info('Obtaining statistics group');
        ctx.assert(ctx.query.start, 400, 'Start date required');
        ctx.assert(ctx.query.end, 400, 'End date required');
        ctx.assert(ctx.query.application, 400, 'Application required');
        Severity: Major
        Found in app/src/routes/api/v1/subscription.router.js and 1 other location - About 5 hrs to fix
        app/src/routes/api/v1/subscription.router.js on lines 261..267

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

        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

            static async statisticsByUser(ctx) {
        logger.info('Obtaining statistics by user');
        ctx.assert(ctx.query.start, 400, 'Start date required');
        ctx.assert(ctx.query.end, 400, 'End date required');
        ctx.assert(ctx.query.application, 400, 'Application required');
        Severity: Major
        Found in app/src/routes/api/v1/subscription.router.js and 1 other location - About 5 hrs to fix
        app/src/routes/api/v1/subscription.router.js on lines 231..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 138.

        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 limit = ctx.query.page && ctx.query.page.size ? parseInt(ctx.query.page.size, 10) : 10;
        Severity: Minor
        Found in app/src/routes/api/v1/subscription.router.js and 1 other location - About 55 mins to fix
        app/src/routes/api/v1/subscription.router.js on lines 287..287

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

        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 page = ctx.query.page && ctx.query.page.number ? parseInt(ctx.query.page.number, 10) : 1;
        Severity: Minor
        Found in app/src/routes/api/v1/subscription.router.js and 1 other location - About 55 mins to fix
        app/src/routes/api/v1/subscription.router.js on lines 288..288

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

        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