Sign upLogin

zenflow/composite-service

View on GitHub
Star

Showing 8 of 8 total issues

Function validateDependencyTree has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

function validateDependencyTree(services: { [id: string]: NormalizedServiceConfig }): void {
  const serviceIds = Object.keys(services);
  for (const [serviceId, { dependencies }] of Object.entries(services)) {
    for (const dependency of dependencies) {
      if (!serviceIds.includes(dependency)) {
Severity: Minor
Found in src/validateAndNormalizeConfig.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 validateDependencyTree has 33 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function validateDependencyTree(services: { [id: string]: NormalizedServiceConfig }): void {
  const serviceIds = Object.keys(services);
  for (const [serviceId, { dependencies }] of Object.entries(services)) {
    for (const dependency of dependencies) {
      if (!serviceIds.includes(dependency)) {
Severity: Minor
Found in src/validateAndNormalizeConfig.ts - About 1 hr to fix

    Function constructor has 32 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      constructor(config: NormalizedCompositeServiceConfig) {
    this.config = config;

    if (this.config.windowsCtrlCShutdown) {
      require("generate-ctrl-c-event"); // make sure this module loads before we even start
    Severity: Minor
    Found in src/CompositeService.ts - About 1 hr to fix

      Function handleCrash has 30 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        private async handleCrash(proc: ServiceProcess) {
    this.logger.log("info", `Service '${this.id}' crashed`);
    const delayPromise = delay(this.config.minimumRestartDelay);
    const crash: ServiceCrash = {
      date: new Date(),
      Severity: Minor
      Found in src/Service.ts - About 1 hr to fix

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

                tapStreamLines((line) => {
          this.logTail.push(line);
          if (this.logTail.length > this.serviceConfig.logTailLength) {
            this.logTail.shift();
          }
        Severity: Major
        Found in src/ServiceProcess.ts and 1 other location - About 1 hr to fix
        src/Service.ts on lines 91..96

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

        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

            if (this.config.crashesLength > 0) {
      this.crashes.push(crash);
      if (this.crashes.length > this.config.crashesLength) {
        this.crashes.shift();
      }
        Severity: Major
        Found in src/Service.ts and 1 other location - About 1 hr to fix
        src/ServiceProcess.ts on lines 41..46

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

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

          constructor(
    serviceId: string,
    serviceConfig: NormalizedServiceConfig,
    logger: Logger,
    onCrash: () => void
        Severity: Minor
        Found in src/ServiceProcess.ts - About 1 hr to fix

          Function end has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

            public end(windowsCtrlCShutdown: boolean) {
    if (!this.wasEndCalled) {
      this.wasEndCalled = true;
      if (this.isRunning()) {
        if (windowsCtrlCShutdown) {
          Severity: Minor
          Found in src/ServiceProcess.ts - About 45 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