gfw-api/gfw-umd-forest-api

View on GitHub

Showing 31 of 31 total issues

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

        if (data.rows && data.rows.length > 0) {
            const periods: string[] = period ? period.split(',') : [String(data.rows[0].min_year), String(data.rows[0].max_year)];

            const initYear: number = new Date(periods[0]).getFullYear();
            const lastYear: number = new Date(periods[1]).getFullYear();
Severity: Major
Found in src/services/cartoDBService.ts and 1 other location - About 2 days to fix
src/services/cartoDBService.ts on lines 82..113

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

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

        if (data.rows && data.rows.length > 0) {
            const periods: string[] = period ? period.split(',') : [String(data.rows[0].min_year), String(data.rows[0].max_year)];

            const initYear: number = new Date(periods[0]).getFullYear();
            const lastYear: number = new Date(periods[1]).getFullYear();
Severity: Major
Found in src/services/cartoDBService.ts and 1 other location - About 2 days to fix
src/services/cartoDBService.ts on lines 124..155

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

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

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

    async getNational(iso: string, thresh: string, period: string): Promise<Record<string, any>> {
        const data: Record<string, any> = await executeThunk(this.client, ISO, {
            iso,
            thresh
        });
Severity: Minor
Found in src/services/cartoDBService.ts - About 3 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 getSubnational has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Open

    async getSubnational(iso: string, id1: string, thresh: string, period: string): Promise<Record<string, any>> {
        const data: Record<string, any> = await executeThunk(this.client, ID1, {
            iso,
            id1,
            thresh
Severity: Minor
Found in src/services/cartoDBService.ts - About 3 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 init has 61 lines of code (exceeds 25 allowed). Consider refactoring.
Open

const init: () => Promise<IInit> = async (): Promise<IInit> => {
    return new Promise((resolve: (value: IInit | PromiseLike<IInit>) => void
    ) => {

        const app: Koa = new Koa();
Severity: Major
Found in src/app.ts - About 2 hrs to fix

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

            const filtered: Array<Record<string, any>> = periods ? data.filter((year: Record<string, any>) => year.year >= periods[0] && year.year <= periods[1]) : data;
    Severity: Major
    Found in src/services/elasticService.ts and 1 other location - About 2 hrs to fix
    src/services/elasticService.ts on lines 73..73

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

    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 filtered: Array<Record<string, any>> = periods ? yearArray.filter((year: Record<string, any>) => year.year >= periods[0] && year.year <= periods[1]) : yearArray;
    Severity: Major
    Found in src/services/elasticService.ts and 1 other location - About 2 hrs to fix
    src/services/elasticService.ts on lines 57..57

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

    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 getGeostoreByUse(useTable: string, id: string, apiKey: string): Promise<Record<string, any>> {
            logger.debug('Getting geostore by use');
            return await GeostoreService.getGeostore(`use/${useTable}/${id}`, apiKey);
        }
    Severity: Major
    Found in src/services/geostoreService.ts and 1 other location - About 2 hrs to fix
    src/services/geostoreService.ts on lines 37..40

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

    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 getGeostoreByIsoAndId(iso: string, id1: string, apiKey: string): Promise<Record<string, any>> {
            logger.debug('Getting geostore by iso and region');
            return await GeostoreService.getGeostore(`admin/${iso}/${id1}`, apiKey);
        }
    Severity: Major
    Found in src/services/geostoreService.ts and 1 other location - About 2 hrs to fix
    src/services/geostoreService.ts on lines 42..45

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

    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

    Function fetchData has 46 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        static async fetchData(ctx: Context): Promise<void> {
            logger.info('Obtaining data for', ctx.params);
            const thresh: string = (ctx.query.thresh as string) || '30';
            const period: string[] = ctx.query.period ? (ctx.query.period as string).split(',').map((el: string) => el.trim()) : [];
            const iso: string = (ctx.params.iso as string) || null;
    Severity: Minor
    Found in src/routes/umdLossGainV3.router.ts - About 1 hr to fix

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

          static async getGeostoreByWdpa(wdpaid: string, apiKey: string): Promise<Record<string, any>> {
              logger.debug('Getting geostore by use');
              return await GeostoreService.getGeostore(`wdpa/${wdpaid}`, apiKey);
          }
      Severity: Major
      Found in src/services/geostoreService.ts and 1 other location - About 1 hr to fix
      src/services/geostoreService.ts on lines 32..35

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

      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 getGeostoreByIso(iso: string, apiKey: string): Promise<Record<string, any>> {
              logger.debug('Getting geostore by iso');
              return await GeostoreService.getGeostore(`admin/${iso}`, apiKey);
          }
      Severity: Major
      Found in src/services/geostoreService.ts and 1 other location - About 1 hr to fix
      src/services/geostoreService.ts on lines 47..50

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

      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

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

          async getSubnational(iso: string, id1: string, thresh: string, period: string): Promise<Record<string, any>> {
              const data: Record<string, any> = await executeThunk(this.client, ID1, {
                  iso,
                  id1,
                  thresh
      Severity: Minor
      Found in src/services/cartoDBService.ts - About 1 hr to fix

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

            async getNational(iso: string, thresh: string, period: string): Promise<Record<string, any>> {
                const data: Record<string, any> = await executeThunk(this.client, ISO, {
                    iso,
                    thresh
                });
        Severity: Minor
        Found in src/services/cartoDBService.ts - About 1 hr to fix

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

          const isCached = async (ctx: Context, next: Next): Promise<void> => {
              if (await ctx.cashed()) {
                  return;
              }
              await next();
          Severity: Major
          Found in src/routes/umdLossGainV1.router.ts and 2 other locations - About 1 hr to fix
          src/routes/umdLossGainV2.router.ts on lines 16..21
          src/routes/umdLossGainV3.router.ts on lines 72..77

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

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

          const isCached = async (ctx: Context, next: Next): Promise<void> => {
              if (await ctx.cashed()) {
                  return;
              }
              await next();
          Severity: Major
          Found in src/routes/umdLossGainV3.router.ts and 2 other locations - About 1 hr to fix
          src/routes/umdLossGainV1.router.ts on lines 64..69
          src/routes/umdLossGainV2.router.ts on lines 16..21

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

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

          const isCached = async (ctx: Context, next: Next): Promise<void> => {
              if (await ctx.cashed()) {
                  return;
              }
              await next();
          Severity: Major
          Found in src/routes/umdLossGainV2.router.ts and 2 other locations - About 1 hr to fix
          src/routes/umdLossGainV1.router.ts on lines 64..69
          src/routes/umdLossGainV3.router.ts on lines 72..77

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

          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

          Function fetchData has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
          Open

              static async fetchData(ctx: Context): Promise<void> {
                  logger.info('Obtaining data for', ctx.params);
                  const thresh: string = (ctx.query.thresh as string) || '30';
                  const period: string[] = ctx.query.period ? (ctx.query.period as string).split(',').map((el: string) => el.trim()) : [];
                  const iso: string = (ctx.params.iso as string) || null;
          Severity: Minor
          Found in src/routes/umdLossGainV3.router.ts - 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 fetchData has 31 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              async fetchData(params: Record<string, any>, apiKey: string): Promise<Record<string, any> | Array<void>> {
                  let baseData: Record<string, any> = await ElasticService.getData(BASE_QUERY, params, apiKey);
                  if (!baseData || !baseData.data || baseData.data.length === 0) {
                      logger.error('No base data found.');
                      baseData = [];
          Severity: Minor
          Found in src/services/elasticService.ts - About 1 hr to fix

            Function getData has 26 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                static async getData(sqlTemplate: string, params: Record<string, any>, apiKey: string): Promise<Record<string, any>> {
                    const { adm1, adm2 } = params;
                    const sql: string = sqlTemplate.replace('{location}', getLocationString(params))
                        .replace('{vars}', getLocationVars(params))
                        .replace('{threshold}', params.thresh);
            Severity: Minor
            Found in src/services/elasticService.ts - About 1 hr to fix
              Severity
              Category
              Status
              Source
              Language