resource-watch/webshot

View on GitHub

Showing 10 of 18 total issues

Function exports has 63 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 screenshot has 55 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        static async screenshot(ctx) {
            ctx.assert(ctx.query.url, 400, 'url param is required');
            ctx.assert(ctx.query.filename, 400, 'filename param is required');
            if (ctx.query.format && !VALID_FORMATS.includes(ctx.query.format)) {
                ctx.assert(ctx.query.query, 400, 'format param is invalid');
    Severity: Major
    Found in app/src/routes/api/v1/webshot.router.js - About 2 hrs to fix

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

          static async screenshot(ctx) {
              ctx.assert(ctx.query.url, 400, 'url param is required');
              ctx.assert(ctx.query.filename, 400, 'filename param is required');
              if (ctx.query.format && !VALID_FORMATS.includes(ctx.query.format)) {
                  ctx.assert(ctx.query.query, 400, 'format param is invalid');
      Severity: Minor
      Found in app/src/routes/api/v1/webshot.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 init has 52 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      async function init() {
          return new Promise((resolve) => {
              const app = new Koa();
      
              const koaBody = require('koa-body')({
      Severity: Major
      Found in app/src/app.js - About 2 hrs to fix

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

              static async widgetThumbnail(ctx) {
                  const { widget } = ctx.params;
                  const queryParamsClone = { ...ctx.query };
                  delete queryParamsClone.width;
                  delete queryParamsClone.height;
          Severity: Minor
          Found in app/src/routes/api/v1/webshot.router.js - About 1 hr to fix

            Function uploadFileToS3 has 39 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                static async uploadFileToS3(filePath, fileName) {
                    if (!S3_ACCESS_KEY_ID || !S3_SECRET_ACCESS_KEY) {
                        logger.error('[SERVICE] S3 access credentials missing');
                        throw new MissingS3Credentials();
                    }
            Severity: Minor
            Found in app/src/services/s3.service.js - About 1 hr to fix

              Function layerThumbnail has 35 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  static async layerThumbnail(ctx) {
                      const { layer } = ctx.params;
              
                      logger.info(`Generating thumbnail for layer ${layer}`);
              
              
              Severity: Minor
              Found in app/src/routes/api/v1/webshot.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

                  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