rschmukler/agenda

View on GitHub

Showing 35 of 81 total issues

File JobProcessor.ts has 463 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import * as debug from 'debug';
import type { IAgendaJobStatus, IAgendaStatus } from './types/AgendaStatus';
import type { IJobDefinition } from './types/JobDefinition';
import type { Agenda, JobWithId } from './index';
import type { IJobParameters } from './types/JobParameters';
Severity: Minor
Found in src/JobProcessor.ts - About 7 hrs to fix

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

    import { EventEmitter } from 'events';
    import * as debug from 'debug';
    
    import type { Db, Filter, MongoClientOptions, Sort } from 'mongodb';
    import { SortDirection } from 'mongodb';
    Severity: Minor
    Found in src/index.ts - About 5 hrs to fix

      Function runOrRetry has 118 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private async runOrRetry(job: JobWithId): Promise<void> {
              if (!this.isRunning) {
                  // const a = new Error();
                  // console.log('STACK', a.stack);
                  log.extend('runOrRetry')(
      Severity: Major
      Found in src/JobProcessor.ts - About 4 hrs to fix

        Function runOrRetry has a Cognitive Complexity of 31 (exceeds 5 allowed). Consider refactoring.
        Open

            private async runOrRetry(job: JobWithId): Promise<void> {
                if (!this.isRunning) {
                    // const a = new Error();
                    // console.log('STACK', a.stack);
                    log.extend('runOrRetry')(
        Severity: Minor
        Found in src/JobProcessor.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 jobProcessing has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring.
        Open

            private async jobProcessing(handledJobs: IJobParameters['_id'][] = []) {
                // Ensure we have jobs
                if (this.jobQueue.length === 0) {
                    return;
                }
        Severity: Minor
        Found in src/JobProcessor.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

        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

            Function saveJob has 84 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                async saveJob<DATA = unknown | void>(job: Job<DATA>): Promise<Job<DATA>> {
                    try {
                        log('attempting to save a job');
            
                        // Grab information needed to save job but that we don't want to persist in MongoDB
            Severity: Major
            Found in src/JobDbRepository.ts - About 3 hrs to fix

              Agenda has 27 functions (exceeds 20 allowed). Consider refactoring.
              Open

              export class Agenda extends EventEmitter {
                  readonly attrs: IAgendaConfig & IDbConfig;
              
                  public readonly forkedWorker?: boolean;
              
              
              Severity: Minor
              Found in src/index.ts - About 3 hrs to fix

                File JobDbRepository.ts has 297 lines of code (exceeds 250 allowed). Consider refactoring.
                Open

                import * as debug from 'debug';
                import {
                    Collection,
                    Db,
                    Filter,
                Severity: Minor
                Found in src/JobDbRepository.ts - About 3 hrs to fix

                  Function jobProcessing has 73 lines of code (exceeds 25 allowed). Consider refactoring.
                  Open

                      private async jobProcessing(handledJobs: IJobParameters['_id'][] = []) {
                          // Ensure we have jobs
                          if (this.jobQueue.length === 0) {
                              return;
                          }
                  Severity: Major
                  Found in src/JobProcessor.ts - About 2 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 lockOnTheFly has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
                      Open

                          async lockOnTheFly(): Promise<void> {
                              // Already running this? Return
                              if (this.isLockingOnTheFly) {
                                  log.extend('lockOnTheFly')('already running, returning');
                                  return;
                      Severity: Minor
                      Found in src/JobProcessor.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 lockOnTheFly has 55 lines of code (exceeds 25 allowed). Consider refactoring.
                      Open

                          async lockOnTheFly(): Promise<void> {
                              // Already running this? Return
                              if (this.isLockingOnTheFly) {
                                  log.extend('lockOnTheFly')('already running, returning');
                                  return;
                      Severity: Major
                      Found in src/JobProcessor.ts - About 2 hrs to fix

                        Function computeFromInterval has 47 lines of code (exceeds 25 allowed). Consider refactoring.
                        Open

                        export const computeFromInterval = (attrs: IJobParameters<any>): Date => {
                            const previousNextRunAt = attrs.nextRunAt || new Date();
                            log('[%s:%s] computing next run via interval [%s]', attrs.name, attrs._id, attrs.repeatInterval);
                        
                            const lastRun = dateForTimezone(attrs.lastRunAt || new Date(), attrs.repeatTimezone);
                        Severity: Minor
                        Found in src/utils/nextRunAt.ts - About 1 hr to fix

                          Function getStatus has 46 lines of code (exceeds 25 allowed). Consider refactoring.
                          Open

                              async getStatus(fullDetails = false): Promise<IAgendaStatus> {
                                  const jobStatus = Object.keys(this.jobStatus).reduce((obj, key) => {
                                      // eslint-disable-next-line no-param-reassign
                                      obj[key] = {
                                          ...this.jobStatus[key],
                          Severity: Minor
                          Found in src/JobProcessor.ts - About 1 hr to fix

                            Function jobQueueFilling has 41 lines of code (exceeds 25 allowed). Consider refactoring.
                            Open

                                private async jobQueueFilling(name: string): Promise<void> {
                                    this.isJobQueueFilling.set(name, true);
                            
                                    try {
                                        // Don't lock because of a limit we have set (lockLimit, etc)
                            Severity: Minor
                            Found in src/JobProcessor.ts - About 1 hr to fix

                              Function checkIfJobIsStillAlive has 40 lines of code (exceeds 25 allowed). Consider refactoring.
                              Open

                                                  new Promise<void>((resolve, reject) => {
                                                      setTimeout(async () => {
                                                          // when job is not running anymore, just finish
                                                          if (!jobIsRunning) {
                                                              log.extend('runOrRetry')(
                              Severity: Minor
                              Found in src/JobProcessor.ts - About 1 hr to fix

                                Function insert has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
                                Open

                                    insert(job: Job): void {
                                        const matchIndex = this._queue.findIndex(element => {
                                            if (
                                                element.attrs.nextRunAt &&
                                                job.attrs.nextRunAt &&
                                Severity: Minor
                                Found in src/JobProcessingQueue.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 saveJob has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
                                Open

                                    async saveJob<DATA = unknown | void>(job: Job<DATA>): Promise<Job<DATA>> {
                                        try {
                                            log('attempting to save a job');
                                
                                            // Grab information needed to save job but that we don't want to persist in MongoDB
                                Severity: Minor
                                Found in src/JobDbRepository.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

                                Severity
                                Category
                                Status
                                Source
                                Language