From 1ee268d33d3e4eb40270eb169ca5266843481b41 Mon Sep 17 00:00:00 2001
From: Amber Brown <hawkowl@atleastfornow.net>
Date: Fri, 5 Jul 2019 02:32:02 +1000
Subject: [PATCH] Improve the backwards compatibility re-exports of
 synapse.logging.context (#5617)

* Improve the backwards compatibility re-exports of synapse.logging.context.

* reexport logformatter too
---
 changelog.d/5617.misc        |  1 +
 synapse/util/__init__.py     |  6 +-----
 synapse/util/logcontext.py   | 39 ++++++++++++++++++++++++++++++++++++
 synapse/util/logformatter.py | 21 +++++++++++++++++++
 4 files changed, 62 insertions(+), 5 deletions(-)
 create mode 100644 changelog.d/5617.misc
 create mode 100644 synapse/util/logcontext.py
 create mode 100644 synapse/util/logformatter.py

diff --git a/changelog.d/5617.misc b/changelog.d/5617.misc
new file mode 100644
index 000000000..bb3c02816
--- /dev/null
+++ b/changelog.d/5617.misc
@@ -0,0 +1 @@
+Move logging code out of `synapse.util` and into `synapse.logging`.
diff --git a/synapse/util/__init__.py b/synapse/util/__init__.py
index c6d2ce440..f506b2a69 100644
--- a/synapse/util/__init__.py
+++ b/synapse/util/__init__.py
@@ -21,14 +21,10 @@ import attr
 
 from twisted.internet import defer, task
 
-from synapse.logging import context, formatter
+from synapse.logging import context
 
 logger = logging.getLogger(__name__)
 
-# Compatibility alias, for existing logconfigs.
-logcontext = context
-logformatter = formatter
-
 
 def unwrapFirstError(failure):
     # defer.gatherResults and DeferredLists wrap failures.
diff --git a/synapse/util/logcontext.py b/synapse/util/logcontext.py
new file mode 100644
index 000000000..40e5c10a4
--- /dev/null
+++ b/synapse/util/logcontext.py
@@ -0,0 +1,39 @@
+# Copyright 2019 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Backwards compatibility re-exports of ``synapse.logging.context`` functionality.
+"""
+
+from synapse.logging.context import (
+    LoggingContext,
+    LoggingContextFilter,
+    PreserveLoggingContext,
+    defer_to_thread,
+    make_deferred_yieldable,
+    nested_logging_context,
+    preserve_fn,
+    run_in_background,
+)
+
+__all__ = [
+    "defer_to_thread",
+    "LoggingContext",
+    "LoggingContextFilter",
+    "make_deferred_yieldable",
+    "nested_logging_context",
+    "preserve_fn",
+    "PreserveLoggingContext",
+    "run_in_background",
+]
diff --git a/synapse/util/logformatter.py b/synapse/util/logformatter.py
new file mode 100644
index 000000000..320e8f817
--- /dev/null
+++ b/synapse/util/logformatter.py
@@ -0,0 +1,21 @@
+# Copyright 2019 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Backwards compatibility re-exports of ``synapse.logging.formatter`` functionality.
+"""
+
+from synapse.logging.formatter import LogFormatter
+
+__all__ = ["LogFormatter"]