summary refs log tree commit diff
path: root/synapse/util/async.py
diff options
context:
space:
mode:
authorRichard van der Hoff <github@rvanderhoff.org.uk>2017-10-17 13:20:35 +0100
committerGitHub <noreply@github.com>2017-10-17 13:20:35 +0100
commit4cc8bb0767d5c95bc9013b439577ea2e6697496d (patch)
tree64cc01ed7b01ab7fb23175926bbb7127ed97c17f /synapse/util/async.py
parentMerge pull request #2545 from matrix-org/dbkr/auto_join_rooms (diff)
parentFix logcontext handling for persist_events (diff)
downloadsynapse-4cc8bb0767d5c95bc9013b439577ea2e6697496d.tar.xz
Merge pull request #2549 from matrix-org/rav/event_persist_logcontexts
Fix logcontext handling for persist_events
Diffstat (limited to 'synapse/util/async.py')
-rw-r--r--synapse/util/async.py5
1 files changed, 5 insertions, 0 deletions
diff --git a/synapse/util/async.py b/synapse/util/async.py
index 0fd5b42523..a0a9039475 100644
--- a/synapse/util/async.py
+++ b/synapse/util/async.py
@@ -53,6 +53,11 @@ class ObservableDeferred(object):
 
     Cancelling or otherwise resolving an observer will not affect the original
     ObservableDeferred.
+
+    NB that it does not attempt to do anything with logcontexts; in general
+    you should probably make_deferred_yieldable the deferreds
+    returned by `observe`, and ensure that the original deferred runs its
+    callbacks in the sentinel logcontext.
     """
 
     __slots__ = ["_deferred", "_observers", "_result"]