-
Notifications
You must be signed in to change notification settings - Fork 132
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 FirstRunAt to StartWorkflowOptions #1360
Add FirstRunAt to StartWorkflowOptions #1360
Conversation
Fix coverage metadata commit info cadence-workflow#1323
…FirstRunAtClientVer
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files
... and 1 file with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
What changed?
Add FirstRunAt in StartWorkflowOptions. Server logic PR: cadence-workflow/cadence#6178
Why?
Add the feature allowing client to specify a exact time for the first run of their workflow.
How did you test it?
Unit tests, also tested in cadence-samples repo as well as dev environment
Potential risks
It should not break anything.
Detailed Description
[In-depth description of the changes made to the interfaces, specifying new fields, removed fields, or modified data structures]
Add a new start workflow option called First_Run_At, which would affect the scheduled time for first run of a workflow.
Impact Analysis
Backward Compatibility: [Analysis of backward compatibility]
It’s an additional optional field so it should be compatible with all clients as the processing happens in the server
In terms of server backward compatibility, old server should be compatible with new requests as the field is added to the end of the request and will be dropped. The logic when this field is ignored will be the same as the older version.
Forward Compatibility: [Analysis of forward compatibility]
It’s forward compatible because new server will treat the value as unset when the old request that's missing that field is received.
Testing Plan
Rollout Plan
Yes, we need to get the server build updated before deploying such change in client.
Yes, rollback server version is safe given that the change is backward compatible.
No