microfleet/core

View on GitHub

Showing 88 of 88 total issues

File consumer-stream.ts has 379 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { Readable } from 'stream'
import { strict as assert } from 'assert'
import { once } from 'events'
import { uniqWith, isEqual } from 'lodash'
import { promisify, delay } from 'bluebird'
Severity: Minor
Found in packages/plugin-kafka/src/custom/consumer-stream.ts - About 5 hrs to fix

    Function addRoute has a Cognitive Complexity of 28 (exceeds 5 allowed). Consider refactoring.
    Open

      public addRoute(route: string, handler: ServiceAction): void {
        const { routes, config } = this
        let name: string = route
    
        if (config !== undefined) {
    Severity: Minor
    Found in packages/plugin-router/src/router.ts - About 4 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 attachConsulPlugin has 94 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export const attach = async function attachConsulPlugin(
      this: Microfleet,
      opts: Partial<ConsulConfig> = {}
    ): Promise<PluginInterface> {
      assert(this.hasPlugin('logger'), new NotFoundError('log module must be included'))
    Severity: Major
    Found in packages/plugin-consul/src/plugin.ts - About 3 hrs to fix

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

      export default function auditLogFactory(params: AuditLogExtensionParams = {}): LifecycleExtensions {
        const { getErrorLevel } = params
        const disableLogErrorsForNames: string[] = params.disableLogErrorsForNames || []
      
        return [
      Severity: Minor
      Found in packages/plugin-router/src/extensions/audit/log.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 getHapiAdapter has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
      Open

      export default function getHapiAdapter(actionName: string, service: Microfleet): (r: Request) => Promise<any> {
        const { router } = service
        // pre-wrap the function so that we do not need to actually do fromNode(next)
        const reformatError = (error: any) => {
          let statusCode
      Severity: Minor
      Found in packages/plugin-router-hapi/src/adapter.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

      File index.ts has 285 lines of code (exceeds 250 allowed). Consider refactoring.
      Open

      import type * as ns from '@microfleet/core-types'
      import type { PartialDeep } from 'type-fest'
      
      /**
       * Microservice Abstract Class
      Severity: Minor
      Found in packages/core/src/index.ts - About 2 hrs to fix

        Function performMigration has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
        Open

        export async function performMigration(redis: Redis.Redis | Redis.Cluster, service: Microfleet, scripts: unknown): Promise<boolean> {
          let files: Migration[]
          if (typeof scripts === 'string') {
            debug('looking for files in %s', scripts)
            files = await glob('*{.js,/}', { cwd: scripts, withFileTypes: true })
        Severity: Minor
        Found in packages/plugin-redis-core/src/migrate.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 attach has 67 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        export async function attach(
          this: Microfleet,
          options: Partial<HapiPluginConfig> = {}
        ): Promise<PluginInterface> {
          assert(this.hasPlugin('validator'), 'validator plugin must be included')
        Severity: Major
        Found in packages/plugin-hapi/src/plugin.ts - About 2 hrs to fix

          Function attach has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
          Open

          export async function attach(this: Microfleet, opts: Partial<LoggerConfig> = {}): Promise<PluginInterface> {
            const { version, config: { name: applicationName } } = this
          
            assert(this.hasPlugin('validator'), new NotFoundError('validator module must be included'))
            await this.validator.addLocation(resolve(__dirname, '../schemas'))
          Severity: Minor
          Found in packages/plugin-logger/src/logger.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 getHapiAdapter has 64 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          export default function getHapiAdapter(actionName: string, service: Microfleet): (r: Request) => Promise<any> {
            const { router } = service
            // pre-wrap the function so that we do not need to actually do fromNode(next)
            const reformatError = (error: any) => {
              let statusCode
          Severity: Major
          Found in packages/plugin-router-hapi/src/adapter.ts - About 2 hrs to fix

            KafkaConsumerStream has 23 functions (exceeds 20 allowed). Consider refactoring.
            Open

            export class KafkaConsumerStream extends Readable {
              private static trackingKey(topicPart: Assignment): string {
                return `${topicPart.topic}_${topicPart.partition}`
              }
            
            
            Severity: Minor
            Found in packages/plugin-kafka/src/custom/consumer-stream.ts - About 2 hrs to fix

              Function attach has 59 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

              export async function attach(this: Microfleet, opts: Partial<LoggerConfig> = {}): Promise<PluginInterface> {
                const { version, config: { name: applicationName } } = this
              
                assert(this.hasPlugin('validator'), new NotFoundError('validator module must be included'))
                await this.validator.addLocation(resolve(__dirname, '../schemas'))
              Severity: Major
              Found in packages/plugin-logger/src/logger.ts - About 2 hrs to fix

                Function attach has 59 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                export async function attach(
                  this: Microfleet,
                  options: Partial<RouterAMQPPluginConfig> = {}
                ): Promise<PluginInterface> {
                  assert(this.hasPlugin('logger'), new NotFoundError('log module must be included'))
                Severity: Major
                Found in packages/plugin-router-amqp/src/plugin.ts - About 2 hrs to fix

                  Microfleet has 22 functions (exceeds 20 allowed). Consider refactoring.
                  Open

                  export class Microfleet extends EventEmitter {
                    public static readonly version: string = getVersion()
                  
                    public config: ns.CoreOptions
                    public readonly version: string
                  Severity: Minor
                  Found in packages/core/src/index.ts - About 2 hrs to fix

                    Function onCompleteRetry has 58 lines of code (exceeds 25 allowed). Consider refactoring.
                    Open

                      return async function onCompleteRetry(
                        this: Microfleet, err: any, data: any, actionName: string, message: Message
                      ): Promise<any> {
                        const { properties } = message
                        const { headers = Object.create(null) } = properties
                    Severity: Major
                    Found in packages/plugin-router-amqp/src/retry.ts - About 2 hrs to fix

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

                            const reportError = (connectFn: () => Promise<void>) => async () => {
                              try {
                                await connectFn()
                              } catch (e: any) {
                                this.log.warn({ err: e }, 'Failed to connect to aws elastic')
                      Severity: Major
                      Found in packages/plugin-aws-elasticsearch/src/plugin.ts and 1 other location - About 2 hrs to fix
                      packages/plugin-cassandra/src/cassandra.ts on lines 69..76

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

                      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 reportError = (connect: () => Promise<void>) => async () => {
                          try {
                            await connect()
                          } catch (e: any) {
                            this.log.warn({ err: e }, 'Failed to connect to cassandra')
                      Severity: Major
                      Found in packages/plugin-cassandra/src/cassandra.ts and 1 other location - About 2 hrs to fix
                      packages/plugin-aws-elasticsearch/src/plugin.ts on lines 64..71

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

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

                      export async function attach(
                        this: Microfleet,
                        options: Partial<RouterAMQPPluginConfig> = {}
                      ): Promise<PluginInterface> {
                        assert(this.hasPlugin('logger'), new NotFoundError('log module must be included'))
                      Severity: Minor
                      Found in packages/plugin-router-amqp/src/plugin.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 attach has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
                      Open

                      export async function attach(
                        this: Microfleet,
                        opts: ValidatorConfig,
                        parentFile: string
                      ): Promise<void> {
                      Severity: Minor
                      Found in packages/plugin-validator/src/validator.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 attach has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
                      Open

                      export async function attach(
                        this: Microfleet,
                        options: Partial<HapiPluginConfig> = {}
                      ): Promise<PluginInterface> {
                        assert(this.hasPlugin('validator'), 'validator plugin must be included')
                      Severity: Minor
                      Found in packages/plugin-hapi/src/plugin.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

                      Severity
                      Category
                      Status
                      Source
                      Language