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

ScheduledJob - Clean up form code & improve validation #26879

Merged
merged 1 commit into from
Aug 24, 2023

Conversation

colemanw
Copy link
Member

@colemanw colemanw commented Jul 19, 2023

Overview

Updates some old form code with better validation of job params.

Before

Api entity only validated against APIv3.
No validation of the api params input, even though it's easy to make mistakes since it's nothing but a textarea!

After

Api params are validated (at least to ensure the input is parseable)
Api entity is validated against whatever version is given in the params

Technical Details

There was no function to parse these params (because, of course there wasn't) so I extracted one from the scheduled job runner for re-use on the form.
While poking around in that CRM_Core_ScheduledJob I noticed that it relies heavily on setting undeclared class properties (watch out PHP8!) so added a few and left a TODO comment about the rest.
Removed a very large outdated comment block about APIv2.

@civibot
Copy link

civibot bot commented Jul 19, 2023

Thank you for contributing to CiviCRM! ❤️ We will need to test and review the PR. 👷

Introduction for new contributors
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
Quick links for reviewers

@civibot civibot bot added the master label Jul 19, 2023
@seamuslee001
Copy link
Contributor

Jenkins re test this please

@seamuslee001
Copy link
Contributor

I tested this and confirmed it works for me

@colemanw colemanw merged commit b90dfe6 into civicrm:master Aug 24, 2023
@colemanw colemanw deleted the scheduledJobForm branch August 24, 2023 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants