mirror/Archipelago
1
0
Fork 1
mirror of https://github.com/ArchipelagoMW/Archipelago.git synced 2026-07-27 08:10:45 -07:00
Code Issues Packages Projects Releases Wiki Activity

WebHost: Config option for custom port ranges v2 (#6009)

Browse Source 
* Added ability to define custom port ranges the WebHost will use for game servers, instead of pure random.

* - Added better fallback to default port range when a custom range fails
- Updated config to be clearer

* Added ability to define custom port ranges the WebHost will use for game servers, instead of pure random.

* - Added better fallback to default port range when a custom range fails
- Updated config to be clearer

* Updated soft-fail message

* Removed dead import from customserver.py

* Update requirements.txt

Settings requirements to main core branch

* fix what reviewers said and add some improvements

* remove unused argument

* try fixing test with try

* use yaml lists instead of string for config

* fix value type bug on ephemeral type

* reuse sockets with websockets api instead of opening and closing them

* add used ports cache and filter used ports when looking for ports

* fix port randomizer

* Apply suggestions from code review

Co-authored-by: Duck <31627079+duckboycool@users.noreply.github.com>

* fix some reviews

* use weights for random port and remove more-itertools

* fix net_connections not working on macOS

* rename variables and functions

* lazy init `get_used_ports`

* change `game_ports` to be `tuple`

* fix last_used_ports not being updated locally

* fix random choices and move game_port conversion into tuple

* Apply suggestions from code review

Co-authored-by: Duck <31627079+duckboycool@users.noreply.github.com>

* use a named tuple on parse_game_ports

* only use ranges

* do it the duck way

* this should check all usable ports before failing

* fix while loop

* add return type to weighted random

* Update WebHostLib/customserver.py

Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>

* simplify tuple conversion check

* add tests

* reformat file and change `create_random_port_socket` test

* add more test cases for parse_game_ports

* try to prevent busy-looping on create random port socket when doing test

* simplify parse game port tests to one assertListEqual

* make the range lesser for port test

* reduce range on macOS

* Apply suggestions from code review

Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>

* Update WebHostLib/customserver.py

Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com>

* remove unused import

* Update WebHostLib/customserver.py

Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com>

* use generator expressions

* check for 0-tuple

* use some kind of shuffled queue

* update tests

* refactor new port handling into a class (#1)

* change time to monotonic

* Update docs/webhost configuration sample.yaml

Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>

* add psutil 7.2.2 as requirement

* Update WebHostLib/requirements.txt

Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>

---------

Co-authored-by: Lexipherous <jasonnlelong@gmail.com>
Co-authored-by: Duck <31627079+duckboycool@users.noreply.github.com>
Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>
Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com>
This commit is contained in:
Uriel
2026-06-20 11:36:18 -04:00
committed by GitHub
parent 5ccef9802a
commit e6e0bc3042
6 changed files with 215 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
WebHostLib/customserver.py
+116 -19
View File
@@ -4,6 +4,7 @@ import asyncio
import collections
import datetime
import functools
import itertools
import logging
import multiprocessing
import pickle
@@ -13,7 +14,9 @@ import threading
import time
import typing
import sys
from collections.abc import Iterable
import psutil
import websockets
from pony.orm import commit, db_session, select
@@ -24,6 +27,7 @@ from MultiServer import (
server_per_message_deflate_factory,
)
from Utils import restricted_loads, cache_argsless
from .locker import Locker
from .models import Command, GameDataPackage, Room, db
@@ -76,12 +80,8 @@ class WebHostContext(Context):
self.tags = ["AP", "WebHost"]
def __del__(self):
try:
import psutil
from Utils import format_SI_prefix
self.logger.debug(f"Context destroyed, Mem: {format_SI_prefix(psutil.Process().memory_info().rss, 1024)}iB")
except ImportError:
self.logger.debug("Context destroyed")
from Utils import format_SI_prefix
self.logger.debug(f"Context destroyed, Mem: {format_SI_prefix(psutil.Process().memory_info().rss, 1024)}iB")
def _load_game_data(self):
for key, value in self.static_server_data.items():
@@ -115,7 +115,7 @@ class WebHostContext(Context):
if room.last_port:
self.port = room.last_port
else:
self.port = get_random_port()
self.port = 0
multidata = self.decompress(room.seed.multidata)
game_data_packages = {}
@@ -181,8 +181,97 @@ class WebHostContext(Context):
return d
def get_random_port():
return random.randint(49152, 65535)
class GameRangePorts(typing.NamedTuple):
valid_ports: list[int]
ephemeral_allowed: bool
class RandomPortSocketCreator:
""" Creates server sockets on random available ports from a configured range. """
_next_port_index: int
_used_ports_cache: tuple[frozenset[int], int] | None
_parsed_ports: GameRangePorts
def __init__(self, game_ports: Iterable[str | int]) -> None:
self._next_port_index = 0
self._used_ports_cache = None
self._parsed_ports = self._parse_game_ports(game_ports)
@staticmethod
def _parse_game_ports(game_ports: Iterable[str | int]) -> GameRangePorts:
""" Parse the game ports configuration into a structured format. """
valid_ports: list[int] = []
ephemeral_allowed = False
for item in game_ports:
if isinstance(item, str) and "-" in item:
start, end = map(int, item.split("-"))
x = range(start, end + 1)
valid_ports.extend(x)
elif int(item) == 0:
ephemeral_allowed = True
else:
valid_ports.append(int(item))
random.shuffle(valid_ports)
return GameRangePorts(valid_ports, ephemeral_allowed)
@staticmethod
def _try_conns_per_process(p: psutil.Process) -> Iterable[int]:
""" Get ports from a single process's connections. """
try:
return (c.laddr.port for c in p.net_connections("tcp4") if c.laddr)
except psutil.AccessDenied:
return ()
@staticmethod
def _get_active_net_connections() -> Iterable[int]:
""" Get all active TCP4 connections on the system. """
# Don't even try to check if system using AIX
if psutil.AIX:
return ()
try:
return (c.laddr.port for c in psutil.net_connections("tcp4") if c.laddr)
# raises AccessDenied when done on macOS
except psutil.AccessDenied:
# flatten the list of iterables
return itertools.chain.from_iterable(map(
RandomPortSocketCreator._try_conns_per_process,
psutil.process_iter(["net_connections"])
))
def _get_used_ports(self) -> frozenset[int]:
""" Get currently used ports with 90-second caching. """
t_hash = round(time.monotonic() / 90)
if self._used_ports_cache is None or self._used_ports_cache[1] != t_hash:
self._used_ports_cache = (frozenset(self._get_active_net_connections()), t_hash)
return self._used_ports_cache[0]
def create(self, host: str) -> socket.socket:
""" Create a server socket on an available port. """
valid_ports, ephemeral_allowed = self._parsed_ports
used_ports = self._get_used_ports()
next_index = self._next_port_index
for i, port in enumerate(itertools.chain(valid_ports[next_index:], valid_ports[:next_index])):
if port in used_ports:
continue
try:
res = socket.create_server((host, port))
next_index = (next_index + i + 1) % len(valid_ports)
self._next_port_index = next_index
return res
except OSError:
pass
if ephemeral_allowed:
return socket.create_server((host, 0))
raise OSError(98, "No available ports")
@cache_argsless
@@ -247,7 +336,8 @@ def tear_down_logging(room_id):
def run_server_process(name: str, ponyconfig: dict, static_server_data: dict,
cert_file: typing.Optional[str], cert_key_file: typing.Optional[str],
host: str, rooms_to_run: multiprocessing.Queue, rooms_shutting_down: multiprocessing.Queue):
host: str, game_ports: Iterable[str | int],
rooms_to_run: multiprocessing.Queue, rooms_shutting_down: multiprocessing.Queue):
from setproctitle import setproctitle
setproctitle(name)
@@ -291,6 +381,7 @@ def run_server_process(name: str, ponyconfig: dict, static_server_data: dict,
gc.collect() # free intermediate objects used during setup
loop = asyncio.get_event_loop()
socket_creator = RandomPortSocketCreator(game_ports)
async def start_room(room_id):
with Locker(f"RoomLocker {room_id}"):
@@ -300,20 +391,26 @@ def run_server_process(name: str, ponyconfig: dict, static_server_data: dict,
ctx.load(room_id)
ctx.init_save()
assert ctx.server is None
try:
if ctx.port != 0:
try:
ctx.server = websockets.serve(
functools.partial(server, ctx=ctx),
ctx.host,
ctx.port,
ssl=get_ssl_context(),
extensions=[server_per_message_deflate_factory],
)
await ctx.server
except OSError:
ctx.port = 0
if ctx.port == 0:
ctx.server = websockets.serve(
functools.partial(server, ctx=ctx),
ctx.host,
ctx.port,
sock=socket_creator.create(ctx.host),
ssl=get_ssl_context(),
extensions=[server_per_message_deflate_factory],
)
await ctx.server
except OSError: # likely port in use
ctx.server = websockets.serve(
functools.partial(server, ctx=ctx), ctx.host, 0, ssl=get_ssl_context())
await ctx.server
port = 0
for wssocket in ctx.server.ws_server.sockets:
socketname = wssocket.getsockname()
@@ -388,7 +485,7 @@ def run_server_process(name: str, ponyconfig: dict, static_server_data: dict,
def run(self):
while 1:
next_room = rooms_to_run.get(block=True, timeout=None)
next_room = rooms_to_run.get(block=True, timeout=None)
gc.collect()
task = asyncio.run_coroutine_threadsafe(start_room(next_room), loop)
self._tasks.append(task)