From a0f99f81b35b0e2ff600d7c72a0d71f15bf94f4c Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Date: Fri, 22 May 2020 10:17:36 +0100
Subject: [PATCH] Fix stacktrace mangling in `patch_inline_callbacks` (#7554)

`Failure()` is more cunning than `Failure(e)`.
---
 changelog.d/7554.misc                  | 1 +
 synapse/util/patch_inline_callbacks.py | 9 +++++++--
 2 files changed, 8 insertions(+), 2 deletions(-)
 create mode 100644 changelog.d/7554.misc

diff --git a/changelog.d/7554.misc b/changelog.d/7554.misc
new file mode 100644
index 000000000..7c35c46aa
--- /dev/null
+++ b/changelog.d/7554.misc
@@ -0,0 +1 @@
+Fix some test code to not mangle stacktraces, to make it easier to debug errors.
diff --git a/synapse/util/patch_inline_callbacks.py b/synapse/util/patch_inline_callbacks.py
index fdff19577..2605f3c65 100644
--- a/synapse/util/patch_inline_callbacks.py
+++ b/synapse/util/patch_inline_callbacks.py
@@ -186,10 +186,15 @@ def _check_yield_points(f: Callable, changes: List[str]):
                     )
                     raise Exception(err)
 
+            # the wrapped function yielded a Deferred: yield it back up to the parent
+            # inlineCallbacks().
             try:
                 result = yield d
-            except Exception as e:
-                result = Failure(e)
+            except Exception:
+                # this will fish an earlier Failure out of the stack where possible, and
+                # thus is preferable to passing in an exeception to the Failure
+                # constructor, since it results in less stack-mangling.
+                result = Failure()
 
             if current_context() != expected_context: