feat: email actions improvements #2281
Conversation
Also some test cleanup: - Rename testing job template to make it obviously test-only - Remove some optional fields with default values from mock datasets and jobs
Fixes: - improve error message in the switch regex case - flatten Job objects in update notifications Changes: - Add an example job config for sending emails only for finished jobs Features: - Add 'matches' and 'default' handlebars helpers
sbliven
changed the title
| auth: "#jobOwnerUser" | ||
| actions: [] | ||
| actions: | ||
| - # Only send emails for updates to status 'finished*' |
There was a problem hiding this comment.
Should this be added to jobConfig.recommended.yaml as well, since sending email is such a common task?
| jobParams: true, | ||
| contactEmail: true, | ||
| }, | ||
| allowProtoPropertiesByDefault: false, // limit accessible fields for security |
There was a problem hiding this comment.
There were two possible solutions to the problem of template variable coming from mongo (JobClass, DatasetClass, etc). The previous solution was whitelisting properties which we wanted to support. This wasn't maintained (now they are nested under job) so this broke. Instead we call toObject on mongo classes before adding them to the template context.
Another solution would have been to just allow all ProtoProperties here, and then we wouldn't need the overhead of toObject (at least for handlebars). I didn't feel confident about the security ramifications of that, and we might still need toObject for JSONPath calls (which also fail on ProtoProperties).
|
This is ready to review. I am still working on a new job-template.html file, but it will come in a fresh PR. |
1 participant
Description
Following #2271, this adds a
ignoreErrorsconfiguration option to the email action for cases where you don't want an error sending the email to block the job POST or PATCH request.It also makes other small improvements and bug fixes regarding emails.
Motivation
Generating the email can cause errors, either from templating or from sending the URL itself. This allows jobs to continue despite the error. Errors are logged in all cases.
Fixes
Changes:
Tests included
Documentation
official documentation info