Be careful with logcontext in DeferredEvent#19142
Closed
MadLittleMods wants to merge 2 commits intodevelopfrom
Closed
Be careful with logcontext in DeferredEvent#19142MadLittleMods wants to merge 2 commits intodevelopfrom
DeferredEvent#19142MadLittleMods wants to merge 2 commits intodevelopfrom
Conversation
MadLittleMods
commented
Nov 4, 2025
Comment on lines
+1032
to
+1033
| with PreserveLoggingContext(): | ||
| self._deferred.callback(None) |
Contributor
Author
There was a problem hiding this comment.
This is the main fix!
See the Deferred callbacks section of our logcontext docs for more info (specifically using solution 2).
Heads-up, I wrote the docs too so it's my assumptions/understanding all the way down. Apply your own scrutiny.
MadLittleMods
commented
Nov 4, 2025
| if not self._deferred.called: | ||
| self._deferred.callback(None) | ||
| with PreserveLoggingContext(): | ||
| self._deferred.callback(None) |
Contributor
Author
There was a problem hiding this comment.
This usage is actually probably fine given you can't get a handle to the raw deferred and add some callbacks to the chain that could cause the logcontext to change.
Contributor
Author
There was a problem hiding this comment.
This was actually a problem, see #19146 (comment) for an explanation
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.
Be careful with logcontext in
DeferredEventSee
docs/log_contexts.md#deferred-callbackssynapse/docs/log_contexts.md
Lines 205 to 212 in 2fd8d88
Spawning from seeing the
DeferredEventusage in #19138Pull Request Checklist
EventStoretoEventWorkerStore.".code blocks.