Sign upLogin

gfw-api/gfw-viirs-fires-api

View on GitHub
Star
src/services/datasetService.ts

Summary

Maintainability
D
1 day
Test Coverage

Function getViirsAlerts has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
Open

    static async getViirsAlerts(
        apiKey: string,
        alertQuery: string,
        queryParams: Record<string, any>,
        datasetIds: {
Severity: Minor
Found in src/services/datasetService.ts - 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

File datasetService.ts has 253 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import config from 'config';
import logger from 'logger';
import Mustache from 'mustache';
import GeostoreService from 'services/geostoreService';
import { RWAPIMicroservice } from "rw-api-microservice-node";
Severity: Minor
Found in src/services/datasetService.ts - About 2 hrs to fix

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

        static async getViirsAlerts(
        apiKey: string,
        alertQuery: string,
        queryParams: Record<string, any>,
        datasetIds: {
    Severity: Minor
    Found in src/services/datasetService.ts - About 1 hr to fix

      Function getAdm has 38 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          static async getAdm(apiKey: string, iso: string, forSubscription: string, period: string = defaultDate(), group: boolean = false, adm1: string = null, adm2: string = null): Promise<Record<string, any>> {
        logger.debug('Obtaining national of iso %s and period %s', iso, period);
        const periods: string[] = period.split(',');
        const params: {
            iso: string;
      Severity: Minor
      Found in src/services/datasetService.ts - About 1 hr to fix

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

                const datasetIds: {
            all: string;
            summary: string;
            daily: string
        } = {
        Severity: Major
        Found in src/services/datasetService.ts and 1 other location - About 1 hr to fix
        src/services/datasetService.ts on lines 187..191

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

        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 datasetIds: { all: string; summary: string; daily: string } = {
            daily: config.get('datasets.viirs_wdpa_daily_id'),
            all: config.get('datasets.viirs_gadm_all_id'),
            summary: config.get('datasets.wdpa_summary_id')
        };
        Severity: Major
        Found in src/services/datasetService.ts and 1 other location - About 1 hr to fix
        src/services/datasetService.ts on lines 146..154

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

        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 (datasetIds.daily) {
                result = await DatasetService.queryDataset(apiKey, datasetIds.daily, query, queryParams);
            } else {
                result = await DatasetService.queryDataset(apiKey, datasetIds.all, query, queryParams, geostore);
            }
        Severity: Major
        Found in src/services/datasetService.ts and 1 other location - About 1 hr to fix
        src/services/datasetService.ts on lines 257..261

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

        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 (datasetIds.daily) {
            numAlertsResponse = await DatasetService.queryDataset(apiKey, datasetIds.daily, alertQuery, queryParams);
        } else {
            numAlertsResponse = await DatasetService.queryDataset(apiKey, datasetIds.all, alertQuery, queryParams, geostore);
        }
        Severity: Major
        Found in src/services/datasetService.ts and 1 other location - About 1 hr to fix
        src/services/datasetService.ts on lines 248..252

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

        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