gfw-api/gfw-forma-alerts-api

View on GitHub
src/services/cartoDBService.ts

Summary

Maintainability
F
4 days
Test Coverage

File cartoDBService.ts has 262 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import config from 'config';
import logger from 'logger';
import Mustache from 'mustache';
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
Severity: Minor
Found in src/services/cartoDBService.ts - About 2 hrs to fix

    Function getSubnational has 29 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        async getSubnational(iso: string, id1: string, forSubscription: string, period: string = defaultDate(), apiKey: string): Promise<Record<string, any> | void> {
            logger.debug('Obtaining subnational of iso %s and id1', iso, id1);
            const periods: string[] = period.split(',');
            const params: { iso: any; id1: any; end: string; begin: string } = {
                iso,
    Severity: Minor
    Found in src/services/cartoDBService.ts - About 1 hr to fix

      Function getUse has 29 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          async getUse(useName: string, useTable: string, id: string, forSubscription: string, period: string = defaultDate(), apiKey: string): Promise<Record<string, any> | void> {
              logger.debug('Obtaining use with id %s', id);
              const periods: string[] = period.split(',');
              const params: { pid: any; end: string; useTable: any; begin: string } = {
                  useTable,
      Severity: Minor
      Found in src/services/cartoDBService.ts - About 1 hr to fix

        Function getNational has 28 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            async getNational(iso: string, forSubscription: string, period: string = defaultDate(), apiKey: string): Promise<Record<string, any> | void> {
                logger.debug('Obtaining national of iso %s', iso);
                const periods: string[] = period.split(',');
                const params: { iso: string; end: string; begin: string } = {
                    iso,
        Severity: Minor
        Found in src/services/cartoDBService.ts - About 1 hr to fix

          Function getWdpa has 28 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              async getWdpa(wdpaid: string, forSubscription: string, period: string = defaultDate(), apiKey: string): Promise<Record<string, any> | void> {
                  logger.debug('Obtaining wpda of id %s', wdpaid);
                  const periods: string[] = period.split(',');
                  const params: { end: string; begin: string; wdpaid: any } = {
                      wdpaid,
          Severity: Minor
          Found in src/services/cartoDBService.ts - About 1 hr to fix

            Function getWorldWithGeojson has 28 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                async getWorldWithGeojson(geojson: Record<string, any>, forSubscription: string, period: string = defaultDate(), areaHa: string = null): Promise<Record<string, any> | void> {
                    logger.debug('Executing query in cartodb with geojson', geojson);
                    const periods: string[] = period.split(',');
                    const params: { geojson: string; end: string; begin: string } = {
                        geojson: JSON.stringify(geojson.features[0].geometry),
            Severity: Minor
            Found in src/services/cartoDBService.ts - About 1 hr to fix

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

                  async getWorldWithGeojson(geojson: Record<string, any>, forSubscription: string, period: string = defaultDate(), areaHa: string = null): Promise<Record<string, any> | void> {
                      logger.debug('Executing query in cartodb with geojson', geojson);
                      const periods: string[] = period.split(',');
                      const params: { geojson: string; end: string; begin: string } = {
                          geojson: JSON.stringify(geojson.features[0].geometry),
              Severity: Minor
              Found in src/services/cartoDBService.ts - 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

              Function getNational has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
              Open

                  async getNational(iso: string, forSubscription: string, period: string = defaultDate(), apiKey: string): Promise<Record<string, any> | void> {
                      logger.debug('Obtaining national of iso %s', iso);
                      const periods: string[] = period.split(',');
                      const params: { iso: string; end: string; begin: string } = {
                          iso,
              Severity: Minor
              Found in src/services/cartoDBService.ts - About 45 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 getSubnational has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
              Open

                  async getSubnational(iso: string, id1: string, forSubscription: string, period: string = defaultDate(), apiKey: string): Promise<Record<string, any> | void> {
                      logger.debug('Obtaining subnational of iso %s and id1', iso, id1);
                      const periods: string[] = period.split(',');
                      const params: { iso: any; id1: any; end: string; begin: string } = {
                          iso,
              Severity: Minor
              Found in src/services/cartoDBService.ts - 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 getUse has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
              Open

                  async getUse(useName: string, useTable: string, id: string, forSubscription: string, period: string = defaultDate(), apiKey: string): Promise<Record<string, any> | void> {
                      logger.debug('Obtaining use with id %s', id);
                      const periods: string[] = period.split(',');
                      const params: { pid: any; end: string; useTable: any; begin: string } = {
                          useTable,
              Severity: Minor
              Found in src/services/cartoDBService.ts - 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 getWdpa has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
              Open

                  async getWdpa(wdpaid: string, forSubscription: string, period: string = defaultDate(), apiKey: string): Promise<Record<string, any> | void> {
                      logger.debug('Obtaining wpda of id %s', wdpaid);
                      const periods: string[] = period.split(',');
                      const params: { end: string; begin: string; wdpaid: any } = {
                          wdpaid,
              Severity: Minor
              Found in src/services/cartoDBService.ts - 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 4 locations. Consider refactoring.
              Open

                      if (geostore) {
                          if (forSubscription && data.rows) {
                              return data.rows;
                          }
                          if (data.rows && data.rows.length > 0) {
              Severity: Major
              Found in src/services/cartoDBService.ts and 3 other locations - About 4 hrs to fix
              src/services/cartoDBService.ts on lines 137..151
              src/services/cartoDBService.ts on lines 170..184
              src/services/cartoDBService.ts on lines 235..249

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

              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 (geostore) {
                          if (forSubscription && data.rows) {
                              return data.rows;
                          }
                          if (data.rows && data.rows.length > 0) {
              Severity: Major
              Found in src/services/cartoDBService.ts and 3 other locations - About 4 hrs to fix
              src/services/cartoDBService.ts on lines 137..151
              src/services/cartoDBService.ts on lines 203..217
              src/services/cartoDBService.ts on lines 235..249

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

              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 (geostore) {
                          if (forSubscription && data.rows) {
                              return data.rows;
                          }
                          if (data.rows && data.rows.length > 0) {
              Severity: Major
              Found in src/services/cartoDBService.ts and 3 other locations - About 4 hrs to fix
              src/services/cartoDBService.ts on lines 170..184
              src/services/cartoDBService.ts on lines 203..217
              src/services/cartoDBService.ts on lines 235..249

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

              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 (geostore) {
                          if (forSubscription && data.rows) {
                              return data.rows;
                          }
                          if (data.rows && data.rows.length > 0) {
              Severity: Major
              Found in src/services/cartoDBService.ts and 3 other locations - About 4 hrs to fix
              src/services/cartoDBService.ts on lines 137..151
              src/services/cartoDBService.ts on lines 170..184
              src/services/cartoDBService.ts on lines 203..217

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

              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

                  return `${today.getFullYear().toString()}-${(today.getMonth() + 1).toString()}-${today.getDate().toString()}`;
              Severity: Major
              Found in src/services/cartoDBService.ts and 1 other location - About 1 hr to fix
              src/services/cartoDBService.ts on lines 75..75

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

                  return `${yesterday.getFullYear().toString()}-${(yesterday.getMonth() + 1).toString()}-${yesterday.getDate().toString()}`;
              Severity: Major
              Found in src/services/cartoDBService.ts and 1 other location - About 1 hr to fix
              src/services/cartoDBService.ts on lines 70..70

              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

              There are no issues that match your filters.

              Category
              Status