Sign upLogin

prescottprue/fireadmin

View on GitHub
Star
functions/src/actionRunner/runSteps.ts

Summary

Maintainability
D
1 day
Test Coverage

File runSteps.ts has 302 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import * as functions from 'firebase-functions'
import * as admin from 'firebase-admin'
import { map } from 'lodash'
import {
  copyFromRTDBToFirestore,
Severity: Minor
Found in functions/src/actionRunner/runSteps.ts - About 3 hrs to fix

    Function runStep has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
    Open

    export async function runStep({
  inputs,
  convertedInputValues,
  convertedEnvs,
  step,
    Severity: Minor
    Found in functions/src/actionRunner/runSteps.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

    Function runStepsFromEvent has 51 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export async function runStepsFromEvent(
  snap: admin.database.DataSnapshot,
  context: functions.EventContext
) {
  const eventData = snap.val()
    Severity: Major
    Found in functions/src/actionRunner/runSteps.ts - About 2 hrs to fix

      Function runBackupsFromEvent has 42 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export async function runBackupsFromEvent(snap: admin.database.DataSnapshot, context: functions.EventContext) {
  const eventData = snap.val()
  const {
    inputValues,
    template: { backups, inputs }
      Severity: Minor
      Found in functions/src/actionRunner/runSteps.ts - About 1 hr to fix

        Avoid too many return statements within this function.
        Open

                return batchCopyBetweenRTDBInstances(
          app1,
          app2,
          step,
          convertedInputValues,
        Severity: Major
        Found in functions/src/actionRunner/runSteps.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                  return copyFromRTDBToStorage(app1, app2, step)
          Severity: Major
          Found in functions/src/actionRunner/runSteps.ts - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                    return copyFromStorageToRTDB(app1, app2, step)
            Severity: Major
            Found in functions/src/actionRunner/runSteps.ts - About 30 mins to fix

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

                    if (dest.resource === 'rtdb') {
        return copyFromStorageToRTDB(app1, app2, step)
      } else {
        throw new Error(
          `Invalid dest.resource: ${dest.resource} for step: ${step}`
              Severity: Minor
              Found in functions/src/actionRunner/runSteps.ts and 1 other location - About 50 mins to fix
              functions/src/actionRunner/runSteps.ts on lines 414..420

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

              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

                    } else if (dest.resource === 'storage') {
        return copyFromRTDBToStorage(app1, app2, step)
      } else {
        throw new Error(
          `Invalid dest.resource: ${dest.resource} for step: ${step}`
              Severity: Minor
              Found in functions/src/actionRunner/runSteps.ts and 1 other location - About 50 mins to fix
              functions/src/actionRunner/runSteps.ts on lines 422..428

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

              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