Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add auto_calculate_deadline attribute to Scheduler #3869

Merged
merged 3 commits into from
Nov 27, 2024

Conversation

jpbruinsslot
Copy link
Contributor

@jpbruinsslot jpbruinsslot commented Nov 20, 2024

Changes

Added attribute auto_calculate_deadline attribute to the Scheduler class, it allows us to specify if a scheduler (boefje, normalizer, report) needs to calculate the deadline automatically (even when a schedule isn't present). For instance we calculate the next deadline of a boefje task based on the grace period and a random jitter. This is something that we don't want for the normalizer, or reporting scheduler.

Currently a report task gets rescheduled when schedule (cron) is specifically set to None. For the report scheduler we want to have tasks only be rescheduled when explicitly a schedule (cron expression) is provided. This is normal behaviour of a BoefjeScheduler, a tasks gets rescheduled daily when it hasn't gotten a schedule from which the ReportScheduler is derived.

Issue link

Closes #3868

QA notes

Best to QA this with the functionality from #3840 where you can scheduler a report with a recurrence of one, and then make sure that the deadline timestamp stays the same when the report has been executed.


Code Checklist

  • All the commits in this PR are properly PGP-signed and verified.
  • This PR only contains functionality relevant to the issue.
  • I have written unit tests for the changes or fixes I made.
  • I have checked the documentation and made changes where necessary.
  • I have performed a self-review of my code and refactored it to the best of my abilities.
  • Tickets have been created for newly discovered issues.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
  • I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.


Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

@jpbruinsslot jpbruinsslot added the mula Issues related to the scheduler label Nov 20, 2024
@jpbruinsslot jpbruinsslot self-assigned this Nov 20, 2024
@jpbruinsslot jpbruinsslot marked this pull request as ready for review November 20, 2024 15:31
@jpbruinsslot jpbruinsslot requested a review from a team as a code owner November 20, 2024 15:31
@stephanie0x00
Copy link
Contributor

Checklist for QA:

  • I have checked out this branch, and successfully ran a fresh make reset.
  • I confirmed that there are no unintended functional regressions in this branch:
    • I have managed to pass the onboarding flow
    • Objects and Findings are created properly
    • Tasks are created and completed properly
  • I confirmed that the PR's advertised feature or hotfix works as intended.
  • I checked the logs for errors and/or warnings and made issues where necessary

What works:

Seems to work, will test better with PR #3840. The onboarding works and a scheduled report runs every minute when the cron is adjusted.

What doesn't work:

n/a

Bug or feature?:

n/a

Copy link

sonarcloud bot commented Nov 27, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

@underdarknl underdarknl merged commit 413ffe5 into main Nov 27, 2024
20 of 22 checks passed
@underdarknl underdarknl deleted the fix/mula/report-rescheduling branch November 27, 2024 10:29
jpbruinsslot added a commit that referenced this pull request Nov 27, 2024
* main:
  Increase max number of PostgreSQL connections (#3889)
  Fix for task id as valid UUID (#3744)
  Add `auto_calculate_deadline` attribute to Scheduler (#3869)
  Ignore specific url parameters when following location headers (#3856)
  Let mailserver inherit l1 (#3704)
  Change plugins enabling in report flow to checkboxes (#3747)
  Fix rocky katalogus tests and delete unused fixtures (#3884)
  Enable/disable scheduled reports (#3871)
jpbruinsslot added a commit that referenced this pull request Nov 27, 2024
* main: (60 commits)
  Increase max number of PostgreSQL connections (#3889)
  Fix for task id as valid UUID (#3744)
  Add `auto_calculate_deadline` attribute to Scheduler (#3869)
  Ignore specific url parameters when following location headers (#3856)
  Let mailserver inherit l1 (#3704)
  Change plugins enabling in report flow to checkboxes (#3747)
  Fix rocky katalogus tests and delete unused fixtures (#3884)
  Enable/disable scheduled reports (#3871)
  optimize locking in katalogus.py, reuse available data (#3752)
  Updates boefje clearances and descriptions (#3863)
  Fixes for empty tables (#3844)
  Fix cron for last day of the month (#3831)
  Sub reports for Aggregate Report (#3852)
  Add start time to scheduled reports (#3809)
  Add configuration setting for number of octopoes workers (#3796)
  Limit requesting prior tasks for ranking in scheduler (#3836)
  Let local plugins (files) take precedence over database entries (#3858)
  Skip empty queues in the Rocky worker (#3860)
  Report types listed in a modal @ report plugins (#3718)
  Support a Schedule without a schedule in scheduler (#3834)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mula Issues related to the scheduler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Report task gets rescheduled when schedule is specifically set to None
5 participants