From 5d53cd4a170cd7315b594102f705fcb9e7eec55e Mon Sep 17 00:00:00 2001
From: Itamar Turner-Trauring <itamar@pythonspeed.com>
Date: Mon, 3 Oct 2022 11:16:30 -0400
Subject: [PATCH] Nicer API.

---
 src/allmydata/node.py            |  8 +++++---
 src/allmydata/protocol_switch.py | 20 ++++++++++++--------
 2 files changed, 17 insertions(+), 11 deletions(-)

diff --git a/src/allmydata/node.py b/src/allmydata/node.py
index 597221e9b..d6cbc9e36 100644
--- a/src/allmydata/node.py
+++ b/src/allmydata/node.py
@@ -55,7 +55,7 @@ from allmydata.util.yamlutil import (
 from . import (
     __full_version__,
 )
-from .protocol_switch import support_foolscap_and_https
+from .protocol_switch import create_tub_with_https_support
 
 
 def _common_valid_config():
@@ -708,8 +708,10 @@ def create_tub(tub_options, default_connection_handlers, foolscap_connection_han
     :param dict tub_options: every key-value pair in here will be set in
         the new Tub via `Tub.setOption`
     """
-    tub = Tub(**kwargs)
-    support_foolscap_and_https(tub)
+    # We listen simulataneously for both Foolscap and HTTPS on the same port,
+    # so we have to create a special Foolscap Tub for that to work:
+    tub = create_tub_with_https_support(**kwargs)
+
     for (name, value) in list(tub_options.items()):
         tub.setOption(name, value)
     handlers = default_connection_handlers.copy()
diff --git a/src/allmydata/protocol_switch.py b/src/allmydata/protocol_switch.py
index a17f3055c..2b4ce6da1 100644
--- a/src/allmydata/protocol_switch.py
+++ b/src/allmydata/protocol_switch.py
@@ -6,10 +6,11 @@ simple as possible, with no extra configuration needed.  Listening on the same
 port means a user upgrading Tahoe-LAFS will automatically get HTTPS working
 with no additional changes.
 
-Use ``support_foolscap_and_https()`` to create a new subclass for a ``Tub``
-instance, and then ``add_storage_server()`` on the resulting class to add the
-relevant information for a storage server once it becomes available later in
-the configuration process.
+Use ``create_tub_with_https_support()`` creates a new ``Tub`` that has its
+``negotiationClass`` modified to be a new subclass tied to that specific
+``Tub`` instance.  Calling ``tub.negotiationClass.add_storage_server(...)``
+then adds relevant information for a storage server once it becomes available
+later in the configuration process.
 """
 
 from __future__ import annotations
@@ -193,14 +194,17 @@ class _FoolscapOrHttps(Protocol, metaclass=_PretendToBeNegotiation):
             self.__dict__ = protocol.__dict__
 
 
-def support_foolscap_and_https(tub: Tub):
+def create_tub_with_https_support(**kwargs) -> Tub:
     """
-    Create a new Foolscap-or-HTTPS protocol class for a specific ``Tub``
+    Create a new Tub that also supports HTTPS.
+
+    This involves creating a new protocol switch class for the specific ``Tub``
     instance.
     """
-    the_tub = tub
+    the_tub = Tub(**kwargs)
 
     class FoolscapOrHttpForTub(_FoolscapOrHttps):
         tub = the_tub
 
-    tub.negotiationClass = FoolscapOrHttpForTub  # type: ignore
+    the_tub.negotiationClass = FoolscapOrHttpForTub  # type: ignore
+    return the_tub