feat!: protect against stale queue items #292
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This should allow the worker to invalidate stale queued builds. A stale build is a build that was queued before a Vela upgrade or downgrade if the two Vela versions do not share the same queue ItemVersion.
Make it clear that this is not the Vela version or the pipeline yaml version.
Codecov Report
@@ Coverage Diff @@
## main #292 +/- ##
=======================================
Coverage 97.00% 97.00%
=======================================
Files 59 59
Lines 6545 6546 +1
=======================================
+ Hits 6349 6350 +1
Misses 145 145
Partials 51 51
|
plyr4
approved these changes
May 19, 2023
cognifloyd
changed the title
|
It's difficult to say if it is breaking or not. I added the |
cognifloyd
commented
May 19, 2023
Comment on lines
+24
to
+25
| // The 0-value is the implicit ItemVersion for queued Items that pre-date adding the field. | ||
| ItemVersion uint64 `json:"item_version"` |
There was a problem hiding this comment.
NB: This is downgrade safe because if a json object has an unknown field, it is ignored.
wass3r
approved these changes
May 22, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of go-vela/community#811
Blocks: go-vela/worker#478
This adds an
ItemVersionfield toItemwith anItemVersionconstant that should be bumped whenever we make significant changes toItemor thepipeline.Build. This way, the worker can detect any stale builds that were queued before a Vela server upgrade or downgrade, and fail the build.In the future, we could do something even nicer and ask the server to recompile and requeue the build.