Fix get_one_or_create IntegrityError handler (PP-1838) #2134
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
jonathangreen
commented
Oct 23, 2024
| @@ -913,7 +913,7 @@ def get_patron_credential( | |||
| :param is_fulfillment: Boolean indicating whether we need a fulfillment credential. | |||
| """ | |||
|
|
|||
| def refresh(credential): | |||
| def refresh(credential: Credential) -> Credential: | |||
There was a problem hiding this comment.
Unrelated type hint changes.
| allow_persistent_token: bool = False, | ||
| allow_empty_token: bool = False, | ||
| collection: Collection | None = None, | ||
| force_refresh: bool = False, |
There was a problem hiding this comment.
Unrelated type hint changes.
| if key in kwargs: | ||
| del kwargs[key] | ||
| obj = create(db, model, create_method, create_method_kwargs, **kwargs) | ||
| return obj |
There was a problem hiding this comment.
this is the actual fix
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2134 +/- ##
=======================================
Coverage 90.82% 90.83%
=======================================
Files 352 352
Lines 40854 40854
Branches 8852 8853 +1
=======================================
+ Hits 37104 37108 +4
+ Misses 2442 2438 -4
Partials 1308 1308 ☔ View full report in Codecov by Sentry. |
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.
Description
Fix an issue with the Exception handler for an
IntegrityErrorin theget_one_or_createfunction.If one of the parameters for this function is a sqlalchemy class, then the logging function can cause a
PendingRollbackError, since the rollback is happening after the log message.Update the function to use db.begin_nested() as a context manager, and write a test for this case.
I added type hints to a couple related functions while I was debugging this before i narrowed in on exactly the cause. These hints are included in this PR. They aren't really related to this fix, but they seem harmless to come in with this one. I can break them out to separate PR if desired.
Motivation and Context
We are seeing a number of
PendingRollbackErrorhappening via thepatron_activity.sync_patron_activitycelery task. 282 in the last week. Trying to clean up these errors that are causing tasks to fail, so we can add alerts for failed celery tasks.How Has This Been Tested?
Checklist