Sign upLogin

evrimfeyyaz/covid-19-api

View on GitHub
Star

Showing 20 of 26 total issues

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 putLocationData has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
      Open

        async putLocationData(data: InternalLocationData[]): Promise<void> {
    if (this.data == null || this.counties == null || this.states == null) {
      throw new DataStoreNotInitializedError();
    }
      Severity: Minor
      Found in src/DataStore/MemoryStore.ts - 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

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

        async getSourceLastUpdatedAt(): Promise<Date | undefined> {
    if (this.data == null) {
      throw new DataStoreNotInitializedError();
    }
      Severity: Major
      Found in src/DataStore/MemoryStore.ts and 1 other location - About 1 hr to fix
      src/DataStore/MemoryStore.ts on lines 116..122

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

      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

        async getSavedAt(): Promise<Date | undefined> {
    if (this.data == null) {
      throw new DataStoreNotInitializedError();
    }
      Severity: Major
      Found in src/DataStore/MemoryStore.ts and 1 other location - About 1 hr to fix
      src/DataStore/MemoryStore.ts on lines 134..140

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

      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

      function getChinaTotalData(chinaProvinceData: InternalLocationData[]): InternalLocationData {
  const chinaTotalValues = sumMultipleLocationValues(chinaProvinceData);

  // Latitude and longitude are from https://www.latlong.net/.
  return {
      Severity: Major
      Found in src/format.ts and 1 other location - About 1 hr to fix
      src/format.ts on lines 56..67

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

      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

      function getAustraliaTotalData(australiaStateData: InternalLocationData[]): InternalLocationData {
  const australiaTotalValues = sumMultipleLocationValues(australiaStateData);

  // Latitude and longitude are from https://www.latlong.net/.
  return {
      Severity: Major
      Found in src/format.ts and 1 other location - About 1 hr to fix
      src/format.ts on lines 117..128

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

      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

      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 formatParsedData has 35 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          function formatParsedData(
  parsedConfirmedData: ParsedCSV,
  parsedDeathsData: ParsedCSV,
  parsedRecoveredData?: ParsedCSV
): InternalLocationData[] {
          Severity: Minor
          Found in src/format.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

                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

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

                export class DataStoreNotInitializedError extends DataStoreError {
  constructor() {
    super("The data store is not initialized. Make sure to first call the `init` method.");
    this.name = "DataStoreNotInitializedError";
                Severity: Major
                Found in src/DataStore/DataStore.ts and 2 other locations - About 1 hr to fix
                src/COVID19API.ts on lines 83..89
                src/COVID19API.ts on lines 94..100

                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

                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

                Function sumMultipleLocationValues has 27 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                function sumMultipleLocationValues(data: InternalLocationData[]): InternalLocationDataValues {
  let sum: InternalLocationDataValues = [];

  data.forEach(({ values }, index) => {
    if (index === 0) {
                Severity: Minor
                Found in src/format.ts - About 1 hr to fix

                  Function formatGlobalParsedData has 27 lines of code (exceeds 25 allowed). Consider refactoring.
                  Open

                  export function formatGlobalParsedData(
  parsedGlobalConfirmedData: ParsedCSV,
  parsedGlobalDeathsData: ParsedCSV,
  parsedGlobalRecoveredData: ParsedCSV
): InternalLocationData[] {
                  Severity: Minor
                  Found in src/format.ts - About 1 hr to fix

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

                    function formatParsedData(
  parsedConfirmedData: ParsedCSV,
  parsedDeathsData: ParsedCSV,
  parsedRecoveredData?: ParsedCSV
): InternalLocationData[] {
                    Severity: Minor
                    Found in src/format.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

                    Severity
                    Category
                    Status
                    Source
                    Language