aurelia/aurelia

View on GitHub
packages/router/src/utilities/runner.ts

Summary

Maintainability
D
2 days
Test Coverage

File runner.ts has 368 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { OpenPromise } from './open-promise';

/**
 * Class for running a sequence of steps with values,
 * functions and promises. Stays sync if possible.
Severity: Minor
Found in packages/router/src/utilities/runner.ts - About 4 hrs to fix

    Function process has a Cognitive Complexity of 28 (exceeds 5 allowed). Consider refactoring.
    Open

      public static process<T = unknown>(step: Step<T> | null): void {
        const root = step!.root;
        while (step !== null && !step.isDoing && !step.isDone) {
          root.current = step;
          if (step.isParallelParent) {
    Severity: Minor
    Found in packages/router/src/utilities/runner.ts - About 4 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 process has 53 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      public static process<T = unknown>(step: Step<T> | null): void {
        const root = step!.root;
        while (step !== null && !step.isDoing && !step.isDone) {
          root.current = step;
          if (step.isParallelParent) {
    Severity: Major
    Found in packages/router/src/utilities/runner.ts - About 2 hrs to fix

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

        public get result(): T | T[] | Promise<T | T[]> | void {
          // TODO: Possibly check done and create a promise if necessary
      
          // If we've got a promise, we're not done so return the promise
          if (this.promise !== null) {
      Severity: Minor
      Found in packages/router/src/utilities/runner.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 run has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

        public static run<T = unknown>(predecessor: Step<T> | null, ...steps: unknown[]): T | Promise<T> | Step<T> {
          if (steps.length === 0) {
            return void 0 as T;
          }
      
      
      Severity: Minor
      Found in packages/router/src/utilities/runner.ts - About 45 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

      Avoid deeply nested control flow statements.
      Open

                  if (!step.isExited) {
                    step = step.nextToDo();
                  } else {
                    step = null;
                  }
      Severity: Major
      Found in packages/router/src/utilities/runner.ts - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                        if (next !== null && !$step.isExited) {
                          Runner.process(next);
                        } else {
                          if ($step.root.doneAll || $step.isExited) {
                            Runner.settlePromise($step.root);
        Severity: Major
        Found in packages/router/src/utilities/runner.ts - About 45 mins to fix

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

            public static runParallel<T = unknown>(parent: Step<T> | null, ...steps: unknown[]): T[] | Promise<T[]> | Step<T> {
              if ((steps?.length ?? 0) === 0) {
                return [];
              }
          
          
          Severity: Minor
          Found in packages/router/src/utilities/runner.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

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

            private static connect<T = unknown>(predecessorOrParent: Step<T>, step: Step<T>, asChild: boolean): Step<T> {
              if (!asChild) {
                // Can have a pre-existing next
                const next = predecessorOrParent.next;
                predecessorOrParent.next = step;
          Severity: Minor
          Found in packages/router/src/utilities/runner.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 name has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

            public get name(): string {
              let name = `${this.id}`;
              if (this.runParallel) {
                name = `:${name}`;
              }
          Severity: Minor
          Found in packages/router/src/utilities/runner.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 nextOrUp has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

            private nextOrUp(): Step<T> | null {
              // Take next if possible
              let next: Step<T> | null = this.next;
              while (next !== null) {
                if (!next.isDoing && !next.isDone) {
          Severity: Minor
          Found in packages/router/src/utilities/runner.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

            public get tail(): Step<T> {
              // eslint-disable-next-line @typescript-eslint/no-this-alias
              let step: Step<T> = this;
              while (step.next !== null) {
                step = step.next;
          Severity: Major
          Found in packages/router/src/utilities/runner.ts and 1 other location - About 1 hr to fix
          packages/router/src/utilities/runner.ts on lines 418..425

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

          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

            public get head(): Step<T> {
              // eslint-disable-next-line @typescript-eslint/no-this-alias
              let step: Step<T> = this;
              while (step.previous !== null) {
                step = step.previous;
          Severity: Major
          Found in packages/router/src/utilities/runner.ts and 1 other location - About 1 hr to fix
          packages/router/src/utilities/runner.ts on lines 426..433

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

          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

                  case 'resolve':
                    step.finally?.resolve(step.result as T | T[] | Promise<T | T[]>);
                    break;
          Severity: Minor
          Found in packages/router/src/utilities/runner.ts and 1 other location - About 55 mins to fix
          packages/router/src/utilities/runner.ts on lines 309..311

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

          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

                  case 'reject':
                    step.finally?.reject(step.result as T | T[] | Promise<T | T[]>);
                    break;
          Severity: Minor
          Found in packages/router/src/utilities/runner.ts and 1 other location - About 55 mins to fix
          packages/router/src/utilities/runner.ts on lines 306..308

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

          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