snowplow/snowplow-javascript-tracker

View on GitHub
libraries/browser-tracker-core/src/helpers/index.ts

Summary

Maintainability
C
7 hrs
Test Coverage

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

export function cookie(
  name: string,
  value?: string,
  ttl?: number,
  path?: string,
Severity: Minor
Found in libraries/browser-tracker-core/src/helpers/index.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 decorateQuerystring has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

export function decorateQuerystring(url: string, name: string, value: string) {
  var initialQsParams = name + '=' + value;
  var hashSplit = url.split('#');
  var qsSplit = hashSplit[0].split('?');
  var beforeQuerystring = qsSplit.shift();
Severity: Minor
Found in libraries/browser-tracker-core/src/helpers/index.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 cookie has 7 arguments (exceeds 4 allowed). Consider refactoring.
Open

  name: string,
  value?: string,
  ttl?: number,
  path?: string,
  domain?: string,
Severity: Major
Found in libraries/browser-tracker-core/src/helpers/index.ts - About 50 mins to fix

    Avoid too many return statements within this function.
    Open

      return document.referrer;
    Severity: Major
    Found in libraries/browser-tracker-core/src/helpers/index.ts - About 30 mins to fix

      Function findRootDomain has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

      export function findRootDomain(sameSite: string, secure: boolean) {
        const windowLocationHostnameAlias = window.location.hostname,
          cookiePrefix = '_sp_root_domain_test_',
          cookieName = cookiePrefix + new Date().getTime(),
          cookieValue = '_test_value_' + new Date().getTime();
      Severity: Minor
      Found in libraries/browser-tracker-core/src/helpers/index.ts - About 25 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 getSpecifiedClassesSet has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

      function getSpecifiedClassesSet<T>(criterion: FilterCriterion<T>) {
        // Convert the array of classes to an object of the form {class1: true, class2: true, ...}
        var specifiedClassesSet: Record<string, boolean> = {};
        var specifiedClasses = criterion.allowlist || criterion.denylist;
      
      
      Severity: Minor
      Found in libraries/browser-tracker-core/src/helpers/index.ts - About 25 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 getReferrer has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

      export function getReferrer(oldLocation?: string) {
        let windowAlias = window,
          fromQs =
            fromQuerystring('referrer', windowAlias.location.href) || fromQuerystring('referer', windowAlias.location.href);
      
      
      Severity: Minor
      Found in libraries/browser-tracker-core/src/helpers/index.ts - About 25 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 2 locations. Consider refactoring.
      Open

      export function parseAndValidateInt(obj: unknown) {
        var result = parseInt(obj as string);
        return isNaN(result) ? undefined : result;
      }
      Severity: Minor
      Found in libraries/browser-tracker-core/src/helpers/index.ts and 1 other location - About 40 mins to fix
      libraries/browser-tracker-core/src/helpers/index.ts on lines 358..361

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

      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

      export function parseAndValidateFloat(obj: unknown) {
        var result = parseFloat(obj as string);
        return isNaN(result) ? undefined : result;
      }
      Severity: Minor
      Found in libraries/browser-tracker-core/src/helpers/index.ts and 1 other location - About 40 mins to fix
      libraries/browser-tracker-core/src/helpers/index.ts on lines 346..349

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

      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 (criterion == null || typeof criterion !== 'object' || Array.isArray(criterion)) {
          return function () {
            return true;
          };
        }
      Severity: Minor
      Found in libraries/browser-tracker-core/src/helpers/index.ts and 1 other location - About 35 mins to fix
      libraries/browser-tracker-core/src/helpers/index.ts on lines 397..401

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

      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 (criterion == null || typeof criterion !== 'object' || Array.isArray(criterion)) {
          return function () {
            return true;
          };
        }
      Severity: Minor
      Found in libraries/browser-tracker-core/src/helpers/index.ts and 1 other location - About 35 mins to fix
      libraries/browser-tracker-core/src/helpers/index.ts on lines 374..378

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

      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