gfw-api/gfw-imazon-alerts-api

View on GitHub

Showing 69 of 69 total issues

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

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

    Function getAdm0 has 41 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        async getAdm0(iso: string, alertQuery: string, period: string = defaultDate()): Promise<Record<string, any>> {
            logger.debug('Obtaining national of iso %s', iso);
            const gid: Record<string, any> = routeToGid(iso);
            const simplify: number = getSimplify(iso);
            const periods: string[] = period.split(',');
    Severity: Minor
    Found in src/services/cartoDBServiceV2.ts - About 1 hr to fix

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

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

        Function getAdm2 has 41 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            async getAdm2(iso: string, id1: string, id2: string, alertQuery: string, period: string = defaultDate()): Promise<Record<string, any>> {
                logger.debug('Obtaining regional data', iso, id1, id2);
                const gid: Record<string, any> = routeToGid(iso, id1, id2);
                const simplify: number = getSimplify(iso) / 100;
                const periods: string[] = period.split(',');
        Severity: Minor
        Found in src/services/cartoDBServiceV2.ts - About 1 hr to fix

          Function getAdm1 has 40 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              async getAdm1(iso: string, id1: string, alertQuery: string, period: string = defaultDate()): Promise<Record<string, any>> {
                  logger.debug('Obtaining subnational of iso %s and id1', iso, id1);
                  const gid: Record<string, any> = routeToGid(iso, id1);
                  const simplify: number = getSimplify(iso) / 100;
                  const periods: string[] = period.split(',');
          Severity: Minor
          Found in src/services/cartoDBServiceV2.ts - About 1 hr to fix

            Function getAdm0 has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
            Open

                async getAdm0(iso: string, alertQuery: string, period: string = defaultDate()): Promise<Record<string, any>> {
                    logger.debug('Obtaining national of iso %s', iso);
                    const gid: Record<string, any> = routeToGid(iso);
                    const simplify: number = getSimplify(iso);
                    const periods: string[] = period.split(',');
            Severity: Minor
            Found in src/services/cartoDBServiceV2.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 getSubnational has 34 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

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

              Identical blocks of code found in 2 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/imazonAlertsV1.router.ts and 1 other location - About 1 hr to fix
              src/routes/imazonAlertsV2.router.ts on lines 149..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 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 2 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/imazonAlertsV2.router.ts and 1 other location - About 1 hr to fix
              src/routes/imazonAlertsV1.router.ts on lines 163..168

              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 getNational has 32 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

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

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

                    constructor() {
                        this.client = new CartoDB.SQL({
                            user: config.get('cartoDB.user')
                        });
                        this.apiUrl = config.get('cartoDB.apiUrl');
                Severity: Major
                Found in src/services/cartoDBService.ts and 1 other location - About 1 hr to fix
                src/services/cartoDBServiceV2.ts on lines 131..136

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

                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

                    constructor() {
                        this.client = new CartoDB.SQL({
                            user: config.get('cartoDB.user')
                        });
                        this.apiUrl = config.get('cartoDB.apiUrl');
                Severity: Major
                Found in src/services/cartoDBServiceV2.ts and 1 other location - About 1 hr to fix
                src/services/cartoDBService.ts on lines 105..110

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

                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 use has 30 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                    static async use(ctx: Context): Promise<void> {
                        logger.info('Obtaining use data with name %s and id %s', ctx.params.name, ctx.params.id);
                        let useTable: string;
                        switch (ctx.params.name) {
                
                
                Severity: Minor
                Found in src/routes/imazonAlertsV1.router.ts - About 1 hr to fix

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

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

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

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

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

                          async getWdpa(wdpaid: string, alertQuery: string, period: string = defaultDate(), apiKey: string): Promise<Record<string, any>> {
                              logger.debug('Obtaining wpda of id %s', wdpaid);
                              const periods: string[] = period.split(',');
                              const params: Record<string, any> = {
                                  wdpaid,
                      Severity: Minor
                      Found in src/services/cartoDBServiceV2.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 getUse has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
                      Open

                          async getUse(useTable: string, id: string, alertQuery: string, period: string = defaultDate(), apiKey: string): Promise<Record<string, any>> {
                              logger.debug('Obtaining use with id %s', id);
                              const periods: string[] = period.split(',');
                              const params: Record<string, any> = {
                                  useTable,
                      Severity: Minor
                      Found in src/services/cartoDBServiceV2.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 getAdm2 has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                      Open

                          async getAdm2(iso: string, id1: string, id2: string, alertQuery: string, period: string = defaultDate()): Promise<Record<string, any>> {
                              logger.debug('Obtaining regional data', iso, id1, id2);
                              const gid: Record<string, any> = routeToGid(iso, id1, id2);
                              const simplify: number = getSimplify(iso) / 100;
                              const periods: string[] = period.split(',');
                      Severity: Minor
                      Found in src/services/cartoDBServiceV2.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 getAdm1 has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                      Open

                          async getAdm1(iso: string, id1: string, alertQuery: string, period: string = defaultDate()): Promise<Record<string, any>> {
                              logger.debug('Obtaining subnational of iso %s and id1', iso, id1);
                              const gid: Record<string, any> = routeToGid(iso, id1);
                              const simplify: number = getSimplify(iso) / 100;
                              const periods: string[] = period.split(',');
                      Severity: Minor
                      Found in src/services/cartoDBServiceV2.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

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

                              const area: Record<string, any> = await executeThunk(this.client, GIDAREA, {
                                  table: 'gadm36_adm2',
                                  level: '2',
                                  gid: params.id2
                              });
                      Severity: Major
                      Found in src/services/cartoDBServiceV2.ts and 2 other locations - About 45 mins to fix
                      src/services/cartoDBServiceV2.ts on lines 184..188
                      src/services/cartoDBServiceV2.ts on lines 228..232

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

                      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

                      Severity
                      Category
                      Status
                      Source
                      Language