From f40da7dc27d089e3bdfdca48e51aec25aea282c0 Mon Sep 17 00:00:00 2001
From: Jean-Paul Calderone <exarkun@twistedmatrix.com>
Date: Mon, 29 Nov 2021 13:23:59 -0500
Subject: [PATCH] Put the choice of JSON encoder for Eliot into its own module

and use it in a few places
---
 src/allmydata/test/__init__.py       |  4 ++--
 src/allmydata/test/test_eliotutil.py |  4 ++--
 src/allmydata/util/_eliot_updates.py | 28 ++++++++++++++++++++++++++++
 src/allmydata/util/eliotutil.py      |  7 ++++---
 4 files changed, 36 insertions(+), 7 deletions(-)
 create mode 100644 src/allmydata/util/_eliot_updates.py

diff --git a/src/allmydata/test/__init__.py b/src/allmydata/test/__init__.py
index 893aa15ce..ad245ca77 100644
--- a/src/allmydata/test/__init__.py
+++ b/src/allmydata/test/__init__.py
@@ -125,5 +125,5 @@ if sys.platform == "win32":
     initialize()
 
 from eliot import to_file
-from allmydata.util.jsonbytes import AnyBytesJSONEncoder
-to_file(open("eliot.log", "wb"), encoder=AnyBytesJSONEncoder)
+from allmydata.util.eliotutil import eliot_json_encoder
+to_file(open("eliot.log", "wb"), encoder=eliot_json_encoder)
diff --git a/src/allmydata/test/test_eliotutil.py b/src/allmydata/test/test_eliotutil.py
index 00110530c..0be02b277 100644
--- a/src/allmydata/test/test_eliotutil.py
+++ b/src/allmydata/test/test_eliotutil.py
@@ -65,11 +65,11 @@ from twisted.internet.task import deferLater
 from twisted.internet import reactor
 
 from ..util.eliotutil import (
+    eliot_json_encoder,
     log_call_deferred,
     _parse_destination_description,
     _EliotLogging,
 )
-from ..util.jsonbytes import AnyBytesJSONEncoder
 
 from .common import (
     SyncTestCase,
@@ -118,7 +118,7 @@ class ParseDestinationDescriptionTests(SyncTestCase):
         reactor = object()
         self.assertThat(
             _parse_destination_description("file:-")(reactor),
-            Equals(FileDestination(stdout, encoder=AnyBytesJSONEncoder)),
+            Equals(FileDestination(stdout, encoder=eliot_json_encoder)),
         )
 
 
diff --git a/src/allmydata/util/_eliot_updates.py b/src/allmydata/util/_eliot_updates.py
new file mode 100644
index 000000000..4300f2be8
--- /dev/null
+++ b/src/allmydata/util/_eliot_updates.py
@@ -0,0 +1,28 @@
+"""
+Bring in some Eliot updates from newer versions of Eliot than we can
+depend on in Python 2.
+
+Every API in this module (except ``eliot_json_encoder``) should be obsolete as
+soon as we depend on Eliot 1.14 or newer.
+
+Ported to Python 3.
+"""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+from future.utils import PY2
+if PY2:
+    from builtins import filter, map, zip, ascii, chr, hex, input, next, oct, open, pow, round, super, bytes, dict, list, object, range, str, max, min  # noqa: F401
+
+from .jsonbytes import AnyBytesJSONEncoder
+
+# There are currently a number of log messages that include non-UTF-8 bytes.
+# Allow these, at least for now.  Later when the whole test suite has been
+# converted to our SyncTestCase or AsyncTestCase it will be easier to turn
+# this off and then attribute log failures to specific codepaths so they can
+# be fixed (and then not regressed later) because those instances will result
+# in test failures instead of only garbage being written to the eliot log.
+eliot_json_encoder = AnyBytesJSONEncoder
diff --git a/src/allmydata/util/eliotutil.py b/src/allmydata/util/eliotutil.py
index 4e48fbb9f..ff858531d 100644
--- a/src/allmydata/util/eliotutil.py
+++ b/src/allmydata/util/eliotutil.py
@@ -87,8 +87,9 @@ from twisted.internet.defer import (
 )
 from twisted.application.service import Service
 
-from .jsonbytes import AnyBytesJSONEncoder
-
+from ._eliot_updates import (
+    eliot_json_encoder,
+)
 
 def validateInstanceOf(t):
     """
@@ -306,7 +307,7 @@ class _DestinationParser(object):
                     rotateLength=rotate_length,
                     maxRotatedFiles=max_rotated_files,
                 )
-        return lambda reactor: FileDestination(get_file(), AnyBytesJSONEncoder)
+        return lambda reactor: FileDestination(get_file(), eliot_json_encoder)
 
 
 _parse_destination_description = _DestinationParser().parse