Sign upLogin

rschmukler/agenda

View on GitHub
Star
src/Job.ts

Summary

Maintainability
D
1 day
Test Coverage

File Job.ts has 350 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import * as date from 'date.js';
import * as debug from 'debug';
import { ObjectId } from 'mongodb';
import { ChildProcess, fork } from 'child_process';
import type { Agenda } from './index';
Severity: Minor
Found in src/Job.ts - About 4 hrs to fix

    Function run has 88 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        async run(): Promise<void> {
        this.attrs.lastRunAt = new Date();
        log(
            '[%s:%s] setting lastRunAt to: %s',
            this.attrs.name,
    Severity: Major
    Found in src/Job.ts - About 3 hrs to fix

      Job has 24 functions (exceeds 20 allowed). Consider refactoring.
      Open

      export class Job<DATA = unknown | void> {
    readonly attrs: IJobParameters<DATA>;

    /** this flag is set to true, if a job got canceled (e.g. due to a timeout or other exception),
     * you can use it for long running tasks to periodically check if canceled is true,
      Severity: Minor
      Found in src/Job.ts - About 2 hrs to fix

        Function runJob has 27 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            async runJob() {
        const definition = this.agenda.definitions[this.attrs.name];

        if (!definition) {
            log('[%s:%s] has no definition, can not run', this.attrs.name, this.attrs._id);
        Severity: Minor
        Found in src/Job.ts - About 1 hr to fix

          Function toJson has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

              toJson(): IJobParameters {
        const result = {} as IJobParameters;

        for (const key of Object.keys(this.attrs)) {
            if (Object.hasOwnProperty.call(this.attrs, key)) {
          Severity: Minor
          Found in src/Job.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

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

              async run(): Promise<void> {
        this.attrs.lastRunAt = new Date();
        log(
            '[%s:%s] setting lastRunAt to: %s',
            this.attrs.name,
          Severity: Minor
          Found in src/Job.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

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

                  args: Partial<IJobParameters<DATA>> & {
            name: string;
            type: 'normal' | 'single';
            data: DATA;
        },
          Severity: Minor
          Found in src/Job.ts and 1 other location - About 55 mins to fix
          src/Job.ts on lines 65..69

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

          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

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

                  args: Partial<IJobParameters<DATA>> & {
            name: string;
            type: 'normal' | 'single';
            data: DATA;
        },
          Severity: Minor
          Found in src/Job.ts and 1 other location - About 55 mins to fix
          src/Job.ts on lines 74..78

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

          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