Sign upLogin

evrimfeyyaz/covid-19-api

View on GitHub
Star
src/COVID19API.ts

Summary

Maintainability
D
2 days
Test Coverage
A
98%

Function addCalculatedValues has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
Open

  private addCalculatedValues(locationData: InternalLocationData): LocationData {
    const calculatedValues = locationData.values.map((valuesOnDate, index) => {
      let newConfirmed = 0;
      let newRecovered: number | null = null;
      let newDeaths: number | null = null;
Severity: Minor
Found in src/COVID19API.ts - About 3 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

File COVID19API.ts has 298 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { COVID19APIError } from "./COVID19APIError";
import { DataGetter } from "./DataGetter/DataGetter";
import { FileGetter } from "./DataGetter/FileGetter";
import { GitHubGetter } from "./DataGetter/GitHubGetter";
import { DataStore, DataStoreInvalidLocationError } from "./DataStore/DataStore";
Severity: Minor
Found in src/COVID19API.ts - About 3 hrs to fix

    COVID19API has 24 functions (exceeds 20 allowed). Consider refactoring.
    Open

    export class COVID19API {
  private readonly dataValidityInMS: number;
  private readonly lazyLoadUSData: boolean;
  private readonly onLoadingStatusChange:
    | ((isLoading: boolean, loadingMessage?: string) => void)
    Severity: Minor
    Found in src/COVID19API.ts - About 2 hrs to fix

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

        private addCalculatedValues(locationData: InternalLocationData): LocationData {
    const calculatedValues = locationData.values.map((valuesOnDate, index) => {
      let newConfirmed = 0;
      let newRecovered: number | null = null;
      let newDeaths: number | null = null;
      Severity: Minor
      Found in src/COVID19API.ts - About 1 hr to fix

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

            const calculatedValues = locationData.values.map((valuesOnDate, index) => {
      let newConfirmed = 0;
      let newRecovered: number | null = null;
      let newDeaths: number | null = null;
      let recoveryRate: number | null = 0;
        Severity: Minor
        Found in src/COVID19API.ts - About 1 hr to fix

          Function constructor has 34 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            constructor(options: COVID19APIOptions = {}) {
    const { lazyLoadUSData, dataValidityInMS, onLoadingStatusChange, fetch } = options;

    this.lazyLoadUSData = lazyLoadUSData ?? true;
    this.dataValidityInMS = dataValidityInMS ?? 60 * 60 * 1000; // 1 hour
          Severity: Minor
          Found in src/COVID19API.ts - About 1 hr to fix

            Function loadDataIfStoreHasNoFreshData has 30 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

              private async loadDataIfStoreHasNoFreshData(forceLoadUSData = false): Promise<void> {
    const hasFreshData = await this.hasFreshDataInStore();
    const hasUSData = await this.hasUSDataInStore();
    let sourceLastUpdatedAt: Date | undefined;
            Severity: Minor
            Found in src/COVID19API.ts - About 1 hr to fix

              Function loadDataIfStoreHasNoFreshData has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
              Open

                private async loadDataIfStoreHasNoFreshData(forceLoadUSData = false): Promise<void> {
    const hasFreshData = await this.hasFreshDataInStore();
    const hasUSData = await this.hasUSDataInStore();
    let sourceLastUpdatedAt: Date | undefined;
              Severity: Minor
              Found in src/COVID19API.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

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

              export class COVID19APIAlreadyInitializedError extends COVID19APIError {
  constructor() {
    super("The COVID-19 API is already initialized.");
    this.name = "COVID19APIAlreadyInitializedError";
    Object.setPrototypeOf(this, COVID19APIAlreadyInitializedError.prototype);
              Severity: Major
              Found in src/COVID19API.ts and 2 other locations - About 1 hr to fix
              src/COVID19API.ts on lines 83..89
              src/DataStore/DataStore.ts on lines 19..26

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

              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

              export class COVID19APINotInitializedError extends COVID19APIError {
  constructor() {
    super("The COVID-19 API is not initialized. Make sure to first call the `init` method.");
    this.name = "COVID19APINotInitializedError";
    Object.setPrototypeOf(this, COVID19APINotInitializedError.prototype);
              Severity: Major
              Found in src/COVID19API.ts and 2 other locations - About 1 hr to fix
              src/COVID19API.ts on lines 94..100
              src/DataStore/DataStore.ts on lines 19..26

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

              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