feat!: Add an 'operation' argument to the job bundle export callback. #92
Conversation
rmv
force-pushed
the
rmvh/add_callback_reason
branch
from
9b993a1
to
9a059d4
Compare
| # ---- Types to export | ||
|
|
||
|
|
||
| class CallbackOperation(str, Enum): |
There was a problem hiding this comment.
"Callback" doesn't feel like the right adjective here. Yes, it's used in a callback, but "export" and "submission" aren't about the general idea of callbacks, they're about creating a job bundle.
Maybe JobBundlePurpose or JobBundleReason better characterizes this?
| @@ -322,6 +323,54 @@ def on_settings_button_clicked(self): | |||
| if DeadlineConfigDialog.configure_settings(parent=self): | |||
| self.refresh_deadline_settings() | |||
|
|
|||
| def _on_create_job_bundle_callback( | |||
There was a problem hiding this comment.
What's the plan to remove this? I worry a bit that code like this would just keep getting added, instead of being tidied up when things are switched to the new option.
What if we first modified the downstream consumers to accept the operation (or maybe purpose or reason to match the enum name). The changes there require a lot less code to be backwards compatible. Once they're all released, then update the code here by directly modifying the call instead of adding this shim.
|
Split the type definition part into #94 |
Signed-off-by: Ramon Montoya Vozmediano <1171039+rmv@users.noreply.github.com>
rmv
force-pushed
the
rmvh/add_callback_reason
branch
from
9a059d4
to
54f7228
Compare
rmv
changed the title
What was the problem/requirement? (What/Why)
When submitting a job to Deadline Cloud, it should be possible to run on the DCC certain sanity checks that are not required when exporting a bundle. For instance, when submitting, it makes sense to check if the scene file has become stale, and alert the user that the file should be saved. But when exporting a bundle that check makes no sense.
Currently there's no way for the DCC submitter to determine if the
create_job_bundle_callbackis called because of an export or a submission.What was the solution? (How)
This patch adds a new argument to the callback with an operation enum so that client code can determine if we are exporting or submitting. It also refactors the callback calls to avoid repeating the code related to backwards compatibility.
What is the impact of this change?
This is backwards compatible with submitters that don't expect that argument. It should make it possible for submitters to cancel a submission early given DCC specific tests while leaving export functionality intact.
How was this change tested?
With the Maya submitter, using a callback signature with and without the new argument.
Was this change documented?
No.
Is this a breaking change?
No.