Sign upLogin

resource-watch/webshot

View on GitHub
Star
app/src/routes/api/v1/webshot.router.js

Summary

Maintainability
D
1 day
Test Coverage
A
93%

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

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

                        try {
                    logger.debug(`Uploading ${filePath} to S3`);
                    const s3file = await S3Service.uploadFileToS3(filePath, filename);
                    ctx.body = { data: { widgetThumbnail: s3file } };
                } catch (error) {
        Severity: Major
        Found in app/src/routes/api/v1/webshot.router.js and 1 other location - About 3 hrs to fix
        app/src/routes/api/v1/webshot.router.js on lines 213..219

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

        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

                        try {
                    logger.debug(`Uploading ${filePath} to S3`);
                    const s3file = await S3Service.uploadFileToS3(filePath, filename);
                    ctx.body = { data: { layerThumbnail: s3file } };
                } catch (error) {
        Severity: Major
        Found in app/src/routes/api/v1/webshot.router.js and 1 other location - About 3 hrs to fix
        app/src/routes/api/v1/webshot.router.js on lines 161..167

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

        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