Sign upLogin

rschmukler/agenda

View on GitHub
Star

Showing 81 of 81 total issues

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

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

                function getCurrentSectionName() {
  var path = window.location.pathname;
  var pageUrl = path.split('/').pop();

  var sectionName = pageUrl.substring(0, pageUrl.indexOf('.'));
                Severity: Major
                Found in docs/agenda/4.0.1/scripts/pagelocation.js and 5 other locations - About 2 hrs to fix
                docs/agenda/1.0.3/scripts/pagelocation.js on lines 66..76
                docs/agenda/2.0.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/2.2.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/3.1.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/4.2.0/scripts/pagelocation.js on lines 66..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 92.

                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 6 locations. Consider refactoring.
                Open

                function getCurrentSectionName() {
  var path = window.location.pathname;
  var pageUrl = path.split('/').pop();

  var sectionName = pageUrl.substring(0, pageUrl.indexOf('.'));
                Severity: Major
                Found in docs/agenda/1.0.3/scripts/pagelocation.js and 5 other locations - About 2 hrs to fix
                docs/agenda/2.0.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/2.2.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/3.1.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/4.0.1/scripts/pagelocation.js on lines 66..76
                docs/agenda/4.2.0/scripts/pagelocation.js on lines 66..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 92.

                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 6 locations. Consider refactoring.
                Open

                function getCurrentSectionName() {
  var path = window.location.pathname;
  var pageUrl = path.split('/').pop();

  var sectionName = pageUrl.substring(0, pageUrl.indexOf('.'));
                Severity: Major
                Found in docs/agenda/3.1.0/scripts/pagelocation.js and 5 other locations - About 2 hrs to fix
                docs/agenda/1.0.3/scripts/pagelocation.js on lines 66..76
                docs/agenda/2.0.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/2.2.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/4.0.1/scripts/pagelocation.js on lines 66..76
                docs/agenda/4.2.0/scripts/pagelocation.js on lines 66..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 92.

                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 6 locations. Consider refactoring.
                Open

                function getCurrentSectionName() {
  var path = window.location.pathname;
  var pageUrl = path.split('/').pop();

  var sectionName = pageUrl.substring(0, pageUrl.indexOf('.'));
                Severity: Major
                Found in docs/agenda/4.2.0/scripts/pagelocation.js and 5 other locations - About 2 hrs to fix
                docs/agenda/1.0.3/scripts/pagelocation.js on lines 66..76
                docs/agenda/2.0.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/2.2.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/3.1.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/4.0.1/scripts/pagelocation.js on lines 66..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 92.

                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 6 locations. Consider refactoring.
                Open

                function getCurrentSectionName() {
  var path = window.location.pathname;
  var pageUrl = path.split('/').pop();

  var sectionName = pageUrl.substring(0, pageUrl.indexOf('.'));
                Severity: Major
                Found in docs/agenda/2.2.0/scripts/pagelocation.js and 5 other locations - About 2 hrs to fix
                docs/agenda/1.0.3/scripts/pagelocation.js on lines 66..76
                docs/agenda/2.0.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/3.1.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/4.0.1/scripts/pagelocation.js on lines 66..76
                docs/agenda/4.2.0/scripts/pagelocation.js on lines 66..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 92.

                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 6 locations. Consider refactoring.
                Open

                function getCurrentSectionName() {
  var path = window.location.pathname;
  var pageUrl = path.split('/').pop();

  var sectionName = pageUrl.substring(0, pageUrl.indexOf('.'));
                Severity: Major
                Found in docs/agenda/2.0.0/scripts/pagelocation.js and 5 other locations - About 2 hrs to fix
                docs/agenda/1.0.3/scripts/pagelocation.js on lines 66..76
                docs/agenda/2.2.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/3.1.0/scripts/pagelocation.js on lines 66..76
                docs/agenda/4.0.1/scripts/pagelocation.js on lines 66..76
                docs/agenda/4.2.0/scripts/pagelocation.js on lines 66..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 92.

                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

                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

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

                              if (removeJobIndex === -1) {
            // lookup by id
            removeJobIndex = this._queue.findIndex(
                j => j.attrs._id?.toString() === job.attrs._id?.toString()
            );
                      Severity: Major
                      Found in src/JobProcessingQueue.ts and 3 other locations - About 1 hr to fix
                      src/JobProcessor.ts on lines 429..434
                      src/JobProcessor.ts on lines 589..594
                      src/JobProcessor.ts on lines 604..609

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

                      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

                      Severity
                      Category
                      Status
                      Source
                      Language