Sign upLogin

integreat-io/integreat-transporter-mongodb

View on GitHub
Star
src/setDocs.ts

Summary

Maintainability
D
2 days
Test Coverage

File setDocs.ts has 371 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/* eslint-disable security/detect-object-injection */
import debug from 'debug'
import prepareFilter from './utils/prepareFilter.js'
import { serializeItem } from './utils/serialize.js'
import { isObject, isObjectWithId, ObjectWithId } from './utils/is.js'
Severity: Minor
Found in src/setDocs.ts - About 4 hrs to fix

    Function updateMany has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
    Open

    async function updateMany(
  operations: Operation[],
  collection: Collection,
  action: Action,
) {
    Severity: Minor
    Found in src/setDocs.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

    Function updateMany has 52 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    async function updateMany(
  operations: Operation[],
  collection: Collection,
  action: Action,
) {
    Severity: Major
    Found in src/setDocs.ts - About 2 hrs to fix

      Function setDocs has 39 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export default async function setDocs(
  action: Action,
  client: MongoClient,
  useIdAsInternalId = false,
): Promise<Response> {
      Severity: Minor
      Found in src/setDocs.ts - About 1 hr to fix

        Function updateOne has 36 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        async function updateOne(
  operation: Operation,
  collection: Collection,
  action: Action,
) {
        Severity: Minor
        Found in src/setDocs.ts - About 1 hr to fix

          Function createOperation has 28 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            function createOperation(item: unknown): Operation | OperationError {
    if (!isObjectWithId(item)) {
      return { error: 'Only object data with an id may be sent to MongoDB' }
    }
          Severity: Minor
          Found in src/setDocs.ts - About 1 hr to fix

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

            async function updateOne(
  operation: Operation,
  collection: Collection,
  action: Action,
) {
            Severity: Minor
            Found in src/setDocs.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 createResponse has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

            const createResponse = (
  oneOrMoreResponses: ItemResponse | ItemResponse[],
  action: Action,
): Response => {
  const responses = ensureArray(oneOrMoreResponses)
            Severity: Minor
            Found in src/setDocs.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

            Avoid too many return statements within this function.
            Open

                return createErrorResponse('error', (error as Error).message, operation.id)
            Severity: Major
            Found in src/setDocs.ts - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                return createResponse(responses, action)
              Severity: Major
              Found in src/setDocs.ts - About 30 mins to fix

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

                const createOperation = (action: Action, useIdAsInternalId: boolean) =>
  function createOperation(item: unknown): Operation | OperationError {
    if (!isObjectWithId(item)) {
      return { error: 'Only object data with an id may be sent to MongoDB' }
    }
                Severity: Minor
                Found in src/setDocs.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 setDocs has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                export default async function setDocs(
  action: Action,
  client: MongoClient,
  useIdAsInternalId = false,
): Promise<Response> {
                Severity: Minor
                Found in src/setDocs.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

                    const {
      payload: { data, ...params },
      meta: {
        options: { keepUndefined = false, appendOnly = false } = {},
      } = {},
                Severity: Major
                Found in src/setDocs.ts and 1 other location - About 1 hr to fix
                src/setDocs.ts on lines 136..139

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

                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

                  const {
    payload: { data, ...params },
    meta: { options: { keepUndefined = false, appendOnly = false } = {} } = {},
  } = action
                Severity: Major
                Found in src/setDocs.ts and 1 other location - About 1 hr to fix
                src/setDocs.ts on lines 165..170

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

                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