XYOracleNetwork/sdk-xyo-client-js

View on GitHub
packages/modules/packages/module/packages/resolver/src/CompositeModuleResolver.ts

Summary

Maintainability
D
3 days
Test Coverage

Function resolveHandler has a Cognitive Complexity of 62 (exceeds 5 allowed). Consider refactoring.
Open

  async resolveHandler<T extends ModuleInstance = ModuleInstance>(
    idOrFilter: ModuleFilter<T> | ModuleIdentifier = '*',
    options: ModuleFilterOptions<T> = {},
  ): Promise<T[]> {
    const mutatedOptions = { ...options, maxDepth: options?.maxDepth ?? CompositeModuleResolver.defaultMaxDepth }

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

  async resolveHandler<T extends ModuleInstance = ModuleInstance>(
    idOrFilter: ModuleFilter<T> | ModuleIdentifier = '*',
    options: ModuleFilterOptions<T> = {},
  ): Promise<T[]> {
    const mutatedOptions = { ...options, maxDepth: options?.maxDepth ?? CompositeModuleResolver.defaultMaxDepth }

    Avoid too many return statements within this function.
    Open

            return (
              mod ?
                Array.isArray(mod) ?
                  mod
                : [mod]

      Avoid too many return statements within this function.
      Open

            return flatResult.filter(duplicateModules)

        Avoid too many return statements within this function.
        Open

                return (
                  mod ?
                    Array.isArray(mod) ?
                      mod
                    : [mod]

          Avoid too many return statements within this function.
          Open

                    return (
                      mod ?
                        Array.isArray(mod) ?
                          mod
                        : [mod]

            Avoid too many return statements within this function.
            Open

                    return await this._localResolver.resolve(filter, mutatedOptions)

              Avoid too many return statements within this function.
              Open

                  return []

                Avoid too many return statements within this function.
                Open

                          return []

                  Avoid too many return statements within this function.
                  Open

                              return [cachedResult] as T[]

                    Avoid too many return statements within this function.
                    Open

                            return []

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

                        add(module: ModuleInstance | ModuleInstance[]): this {
                          if (Array.isArray(module)) {
                            for (const mod of module) this.addSingleModule(mod)
                          } else {
                            this.addSingleModule(module)
                      packages/modules/packages/module/packages/resolver/src/SimpleModuleResolver.ts on lines 40..47
                      packages/modules/packages/module/packages/resolver/src/SimpleModuleResolver.ts on lines 53..60

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

                      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 result = await Promise.all(
                              this.resolvers.map(async (resolver) => {
                                const result: T[] = await resolver.resolve<T>(filter, childOptions)
                                return result
                              }),
                      packages/modules/packages/module/packages/resolver/src/CompositeModuleResolver.ts on lines 128..133

                      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

                            const result = await Promise.all(
                              this.resolvers.map(async (resolver) => {
                                const result: T[] = await resolver.resolve<T>(all, childOptions)
                                return result
                              }),
                      packages/modules/packages/module/packages/resolver/src/CompositeModuleResolver.ts on lines 225..230

                      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

                      There are no issues that match your filters.

                      Category
                      Status