Skip to content

Commit 7b88313

Browse files
No need to have version_string as an argument since it's always the same (#19012)
Assuming, we're happy with #19011, this PR makes sense.
1 parent fb12d51 commit 7b88313

File tree

11 files changed

+23
-23
lines changed

11 files changed

+23
-23
lines changed

changelog.d/19012.misc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Remove `version_string` argument from `HomeServer` since it's always the same.

synapse/_scripts/synapse_port_db.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,6 @@
9898
from synapse.storage.engines import create_engine
9999
from synapse.storage.prepare_database import prepare_database
100100
from synapse.types import ISynapseReactor
101-
from synapse.util import SYNAPSE_VERSION
102101

103102
# Cast safety: Twisted does some naughty magic which replaces the
104103
# twisted.internet.reactor module with a Reactor instance at runtime.
@@ -325,7 +324,6 @@ def __init__(self, config: HomeServerConfig):
325324
hostname=config.server.server_name,
326325
config=config,
327326
reactor=reactor,
328-
version_string=f"Synapse/{SYNAPSE_VERSION}",
329327
)
330328

331329

synapse/_scripts/update_synapse_database.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@
3131
from synapse.server import HomeServer
3232
from synapse.storage import DataStore
3333
from synapse.types import ISynapseReactor
34-
from synapse.util import SYNAPSE_VERSION
3534

3635
# Cast safety: Twisted does some naughty magic which replaces the
3736
# twisted.internet.reactor module with a Reactor instance at runtime.
@@ -47,7 +46,6 @@ def __init__(self, config: HomeServerConfig):
4746
hostname=config.server.server_name,
4847
config=config,
4948
reactor=reactor,
50-
version_string=f"Synapse/{SYNAPSE_VERSION}",
5149
)
5250

5351

synapse/app/_base.py

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -421,17 +421,26 @@ def listen_http(
421421
context_factory: Optional[IOpenSSLContextFactory],
422422
reactor: ISynapseReactor = reactor,
423423
) -> List[Port]:
424+
"""
425+
Args:
426+
listener_config: TODO
427+
root_resource: TODO
428+
version_string: A string to present for the Server header
429+
max_request_body_size: TODO
430+
context_factory: TODO
431+
reactor: TODO
432+
"""
424433
assert listener_config.http_options is not None
425434

426435
site_tag = listener_config.get_site_tag()
427436

428437
site = SynapseSite(
429-
"synapse.access.%s.%s"
438+
logger_name="synapse.access.%s.%s"
430439
% ("https" if listener_config.is_tls() else "http", site_tag),
431-
site_tag,
432-
listener_config,
433-
root_resource,
434-
version_string,
440+
site_tag=site_tag,
441+
config=listener_config,
442+
resource=root_resource,
443+
server_version_string=version_string,
435444
max_request_body_size=max_request_body_size,
436445
reactor=reactor,
437446
hs=hs,

synapse/app/admin_cmd.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@
6565
from synapse.storage.databases.main.tags import TagsWorkerStore
6666
from synapse.storage.databases.main.user_erasure_store import UserErasureWorkerStore
6767
from synapse.types import JsonMapping, StateMap
68-
from synapse.util import SYNAPSE_VERSION
6968
from synapse.util.logcontext import LoggingContext
7069

7170
logger = logging.getLogger("synapse.app.admin_cmd")
@@ -316,7 +315,6 @@ def start(config: HomeServerConfig, args: argparse.Namespace) -> None:
316315
ss = AdminCmdServer(
317316
config.server.server_name,
318317
config=config,
319-
version_string=f"Synapse/{SYNAPSE_VERSION}",
320318
)
321319

322320
setup_logging(ss, config, use_worker_options=True)

synapse/app/generic_worker.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,6 @@
112112
from synapse.storage.databases.main.ui_auth import UIAuthWorkerStore
113113
from synapse.storage.databases.main.user_directory import UserDirectoryStore
114114
from synapse.storage.databases.main.user_erasure_store import UserErasureWorkerStore
115-
from synapse.util import SYNAPSE_VERSION
116115
from synapse.util.httpresourcetree import create_resource_tree
117116

118117
logger = logging.getLogger("synapse.app.generic_worker")
@@ -359,7 +358,6 @@ def start(config: HomeServerConfig) -> None:
359358
hs = GenericWorkerServer(
360359
config.server.server_name,
361360
config=config,
362-
version_string=f"Synapse/{SYNAPSE_VERSION}",
363361
)
364362

365363
setup_logging(hs, config, use_worker_options=True)

synapse/app/homeserver.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@
7171
from synapse.server import HomeServer
7272
from synapse.storage import DataStore
7373
from synapse.types import ISynapseReactor
74-
from synapse.util import SYNAPSE_VERSION
7574
from synapse.util.check_dependencies import check_requirements
7675
from synapse.util.httpresourcetree import create_resource_tree
7776
from synapse.util.module_loader import load_module
@@ -400,7 +399,6 @@ def setup(
400399
hs = SynapseHomeServer(
401400
config.server.server_name,
402401
config=config,
403-
version_string=f"Synapse/{SYNAPSE_VERSION}",
404402
reactor=reactor,
405403
)
406404

synapse/http/site.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -741,6 +741,7 @@ class SynapseSite(ProxySite):
741741

742742
def __init__(
743743
self,
744+
*,
744745
logger_name: str,
745746
site_tag: str,
746747
config: ListenerConfig,

synapse/server.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@
175175
from synapse.streams.events import EventSources
176176
from synapse.synapse_rust.rendezvous import RendezvousHandler
177177
from synapse.types import DomainSpecificString, ISynapseReactor
178+
from synapse.util import SYNAPSE_VERSION
178179
from synapse.util.caches import CACHE_METRIC_REGISTRY
179180
from synapse.util.clock import Clock
180181
from synapse.util.distributor import Distributor
@@ -322,7 +323,6 @@ def __init__(
322323
hostname: str,
323324
config: HomeServerConfig,
324325
reactor: Optional[ISynapseReactor] = None,
325-
version_string: str = "Synapse",
326326
):
327327
"""
328328
Args:
@@ -347,7 +347,7 @@ def __init__(
347347
self._instance_id = random_string(5)
348348
self._instance_name = config.worker.instance_name
349349

350-
self.version_string = version_string
350+
self.version_string = f"Synapse/{SYNAPSE_VERSION}"
351351

352352
self.datastores: Optional[Databases] = None
353353

tests/server.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1198,7 +1198,6 @@ def setup_test_homeserver(
11981198
hs = homeserver_to_use(
11991199
server_name,
12001200
config=config,
1201-
version_string="Synapse/tests",
12021201
reactor=reactor,
12031202
)
12041203

0 commit comments

Comments
 (0)