fix(sentry_apps): Defer resource change webhooks until transaction commit#108561
Draft
sentry[bot] wants to merge 1 commit intomasterfrom
Draft
fix(sentry_apps): Defer resource change webhooks until transaction commit#108561sentry[bot] wants to merge 1 commit intomasterfrom
sentry[bot] wants to merge 1 commit intomasterfrom
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
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.
This PR addresses the
RetryTaskErroroccurring insentry.sentry_apps.tasks.sentry_apps.process_resource_change_bound.Problem:
The
process_resource_change_boundtask, responsible for sending webhooks on resource changes (like Group creation), was sometimes failing withGroup.DoesNotExist. This happened because the task was enqueued and executed before the database transaction that created theGrouphad fully committed.Root Cause:
A race condition existed where the task worker would pick up and attempt to process the webhook task before the corresponding
Grouprecord was durably written to the database. When the task tried to fetch theGroupusingmodel.objects.get(id=instance_id), it would not find the record, leading to aGroup.DoesNotExistexception and subsequent task retries.Solution:
To resolve this,
django.db.transaction.on_commit()has been introduced. The calls toprocess_resource_change_bound.delay()withinprocess_resource_change_bounds()are now wrapped withtransaction.on_commit(). This ensures that the webhook tasks are only added to the queue after the current database transaction has successfully committed. By guaranteeing theGroupexists in the database before the task is even queued, we eliminate the race condition and prevent theGroup.DoesNotExisterrors.The existing retry mechanism on
process_resource_change_boundremains in place to handle any other legitimate transient failures.Legal Boilerplate
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.