A11yWatch/a11ywatch-core

View on GitHub
src/web/routes/scan.ts

Summary

Maintainability
D
3 days
Test Coverage

Function scanAuthenticated has a Cognitive Complexity of 46 (exceeds 5 allowed). Consider refactoring.
Open

export const scanAuthenticated = async (
  req: FastifyContext["request"],
  res: FastifyContext["reply"]
) => {
  const baseUrl = paramParser(req, "websiteUrl") || paramParser(req, "url");
Severity: Minor
Found in src/web/routes/scan.ts - About 7 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 scanAuthenticated has 84 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export const scanAuthenticated = async (
  req: FastifyContext["request"],
  res: FastifyContext["reply"]
) => {
  const baseUrl = paramParser(req, "websiteUrl") || paramParser(req, "url");
Severity: Major
Found in src/web/routes/scan.ts - About 3 hrs to fix

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

    export const scanSimple = async (
      req: FastifyContext["request"],
      res: FastifyContext["reply"]
    ) => {
      const baseUrl = paramParser(req, "websiteUrl") || paramParser(req, "url");
    Severity: Minor
    Found in src/web/routes/scan.ts - About 1 hr to fix

      Function scanSimple has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

      export const scanSimple = async (
        req: FastifyContext["request"],
        res: FastifyContext["reply"]
      ) => {
        const baseUrl = paramParser(req, "websiteUrl") || paramParser(req, "url");
      Severity: Minor
      Found in src/web/routes/scan.ts - About 35 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 4 locations. Consider refactoring.
      Open

          if (ignore && Array.isArray(ignore)) {
            for (let i = 0; i < ignore.length; i++) {
              const rule = ignore[i];
              // validate rule storing
              if (rule && typeof rule === "string" && rule.length < 200) {
      Severity: Major
      Found in src/web/routes/scan.ts and 3 other locations - About 4 hrs to fix
      src/core/controllers/websites/set/add-website.ts on lines 89..102
      src/core/controllers/websites/set/add-website.ts on lines 107..119
      src/web/routes/scan.ts on lines 116..129

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

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

          if (rules && Array.isArray(rules)) {
            for (let i = 0; i < rules.length; i++) {
              const rule = rules[i];
      
              // validate rule storing
      Severity: Major
      Found in src/web/routes/scan.ts and 3 other locations - About 4 hrs to fix
      src/core/controllers/websites/set/add-website.ts on lines 89..102
      src/core/controllers/websites/set/add-website.ts on lines 107..119
      src/web/routes/scan.ts on lines 134..146

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

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

        if (!url) {
          res.status(400);
          res.send(
            responseModel({
              code: StatusCode.BadRequest,
      Severity: Major
      Found in src/web/routes/scan.ts and 2 other locations - About 50 mins to fix
      src/web/routes/scan.ts on lines 45..55
      src/web/routes/scan.ts on lines 81..91

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

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

        if (!url && !html) {
          res.status(400);
          res.send(
            responseModel({
              code: StatusCode.BadRequest,
      Severity: Major
      Found in src/web/routes/scan.ts and 2 other locations - About 50 mins to fix
      src/web/routes/scan.ts on lines 21..31
      src/web/routes/scan.ts on lines 45..55

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

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

          if (!user) {
            res.status(403);
            res.send(
              responseModel({
                code: StatusCode.Error,
      Severity: Major
      Found in src/web/routes/scan.ts and 2 other locations - About 50 mins to fix
      src/web/routes/scan.ts on lines 21..31
      src/web/routes/scan.ts on lines 81..91

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

      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 isClient =
          frontendClientOrigin(req.headers["origin"]) ||
          frontendClientOrigin(req.headers["host"]) ||
          frontendClientOrigin(req.headers["referer"]);
      Severity: Major
      Found in src/web/routes/scan.ts and 2 other locations - About 45 mins to fix
      src/core/utils/get-user-data.ts on lines 88..91
      src/web/routes_groups/dns-verify.ts on lines 13..16

      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

      There are no issues that match your filters.

      Category
      Status