gfw-api/fw-alerts

View on GitHub

Showing 9 of 9 total issues

Function exports has 64 lines of code (exceeds 25 allowed). Consider refactoring.
Open

module.exports = (grunt) => {

    grunt.file.setBase('..');
    // eslint-disable-next-line import/no-extraneous-dependencies
    require('load-grunt-tasks')(grunt);
Severity: Major
Found in app/Gruntfile.js - About 2 hrs to fix

    Function getAlertsByGeostore has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
    Open

        static async getAlertsByGeostore(ctx) {
            logger.debug('Getting alerts by geostore');
            const { dataset } = ctx.params;
            const { range } = ctx.query;
            const { geostore } = ctx.params;
    Severity: Minor
    Found in app/src/routes/api/v1/alerts.router.js - 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

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

    module.exports = (() => {
    
        const loadAPI = (app, path, pathApi) => {
            const routesFiles = fs.readdirSync(path);
            let existIndexRouter = false;
    Severity: Minor
    Found in app/src/loader.js - About 1 hr to fix

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

          static async getAlertsByGeostore(ctx) {
              logger.debug('Getting alerts by geostore');
              const { dataset } = ctx.params;
              const { range } = ctx.query;
              const { geostore } = ctx.params;
      Severity: Minor
      Found in app/src/routes/api/v1/alerts.router.js - About 1 hr to fix

        Function loadAPI has 32 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            const loadAPI = (app, path, pathApi) => {
                const routesFiles = fs.readdirSync(path);
                let existIndexRouter = false;
                routesFiles.forEach((file) => {
                    const newPath = path ? (`${path}/${file}`) : file;
        Severity: Minor
        Found in app/src/loader.js - About 1 hr to fix

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

                      if (pathApi) {
                          app.use(mount(pathApi, require(newPath).middleware()));
                      } else {
                          app.use(require(newPath).middleware());
                      }
          Severity: Major
          Found in app/src/loader.js and 1 other location - About 1 hr to fix
          app/src/loader.js on lines 25..29

          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

                                  if (pathApi) {
                                      app.use(mount(pathApi, require(newPath).middleware()));
                                  } else {
                                      app.use(require(newPath).middleware());
                                  }
          Severity: Major
          Found in app/src/loader.js and 1 other location - About 1 hr to fix
          app/src/loader.js on lines 42..46

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

              static async queryDataset(dataset, query, geostoreId = null, datasetVersion = 'latest') {
                  const axiosRequestConfig = {
                      baseURL: config.get('gfwDataApi.url'),
                      method: 'GET',
                      params: {
          Severity: Minor
          Found in app/src/services/gfw-data-api.service.js - About 1 hr to fix

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

            module.exports = (() => {
            
                const loadAPI = (app, path, pathApi) => {
                    const routesFiles = fs.readdirSync(path);
                    let existIndexRouter = false;
            Severity: Minor
            Found in app/src/loader.js - 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

            Severity
            Category
            Status
            Source
            Language