Retry GithubSyncJob if new commit sha is missing in Github response on push from target branch #1417
Conversation
This file contains hidden or 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
…n push from target branch
hubb
approved these changes
Sep 17, 2025
yao0204
reviewed
Sep 17, 2025
| MAX_RETRY_ATTEMPTS = 5 | ||
| RETRY_DELAY = 5.seconds | ||
| queue_as :default | ||
| on_duplicate :drop |
There was a problem hiding this comment.
How does the on_duplicate :drop work? Will we be able to enqueue the job before the current job is succeeded?
There was a problem hiding this comment.
It looks like it applies to perform:
Contributor
Author
There was a problem hiding this comment.
Yes, it should be alright since we enqueue the job with a delay and the lock operates on the perform, we don't expect 2 jobs to run at once in this situation.
jacobrydh
approved these changes
Sep 17, 2025
tjwp
approved these changes
Sep 17, 2025
tjwp
left a comment
tjwp
left a comment
There was a problem hiding this comment.
The backoff is not exponential, but I think the retries up to a total of 75 seconds after the initial attempt is a reasonable approach.
| MAX_RETRY_ATTEMPTS = 5 | ||
| RETRY_DELAY = 5.seconds | ||
| queue_as :default | ||
| on_duplicate :drop |
There was a problem hiding this comment.
It looks like it applies to perform:
yao0204
approved these changes
Sep 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
What you trying to accomplish?
Part of https://github.com/Shopify/deploys/issues/2000
In this PR, we address a critical race condition where commits ready to deploy are missing from the list. This occurrs when GitHub sends push webhooks to Shipit, but GithubSyncJob queries the GitHub API which hasn't yet updated with the new commits. The job will find 0 new commits and complete successfully, leaving deployable commits missing from the system.
We solve this by passing the expected HEAD SHA from the webhook payload through to the sync job, allowing it to detect when the API hasn't caught up yet and retry with exponential backoff.
This ensures that commits are properly synchronized even when GitHub's API experiences eventual consistency delays.