Remove unnecessary features to decrease maintenance/complexity overhead. + Cleanup & more repo usage. (osuAkatsuki#612)

* Start to remove unnecessary complex code & unnecessary features

* remove usage of `__all__`, use players repo in players obj, general cleanups

* remove more unnecessary code

* app host/port required -- remove deprecated vals

* unused import

* remove deprecated env vars from docker compoes files

* re-add warn on lack of internet connectivity

* use better word

* move internet check into startup dialog

Author: cmyui

app/api/domains/osu.py

@@ -1593,9 +1593,16 @@ async def get_screenshot(
             status_code=status.HTTP_404_NOT_FOUND,
         )
 
+    if extension in ("jpg", "jpeg"):
+        media_type = "image/jpeg"
+    elif extension == "png":
+        media_type = "image/png"
+    else:
+        media_type = None
+
     return FileResponse(
         path=screenshot_path,
-        media_type=app.utils.get_media_type(extension),
+        media_type=media_type,
     )
 
 

app/api/init_api.py

@@ -2,8 +2,10 @@
 from __future__ import annotations
 
 import asyncio
+import io
 import os
 import pprint
+import sys
 from collections.abc import AsyncIterator
 from contextlib import asynccontextmanager
 from typing import Any
@@ -69,11 +71,13 @@ def openapi(self) -> dict[str, Any]:
 
 @asynccontextmanager
 async def lifespan(asgi_app: BanchoAPI) -> AsyncIterator[Never]:
-    app.utils.setup_runtime_environment()
-    app.utils.ensure_supported_platform()
-    app.utils.ensure_directory_structure()
+    if isinstance(sys.stdout, io.TextIOWrapper):
+        sys.stdout.reconfigure(encoding="utf-8")
+
+    app.utils.ensure_persistent_volumes_are_available()
 
     app.state.loop = asyncio.get_running_loop()
+
     if app.utils.is_running_as_admin():
         log(
             "Running the server with root privileges is not recommended.",

app/bg_loops.py

@@ -10,8 +10,6 @@
 from app.logging import Ansi
 from app.logging import log
 
-__all__ = ("initialize_housekeeping_tasks",)
-
 OSU_CLIENT_MIN_PING_INTERVAL = 300000 // 1000  # defined by osu!
 
 

app/commands.py

@@ -15,6 +15,7 @@
 from collections.abc import Sequence
 from dataclasses import dataclass
 from datetime import datetime
+from datetime import timedelta
 from functools import wraps
 from pathlib import Path
 from time import perf_counter_ns as clock_ns
@@ -64,7 +65,6 @@
 from app.repositories import tourney_pool_maps as tourney_pool_maps_repo
 from app.repositories import tourney_pools as tourney_pools_repo
 from app.usecases.performance import ScoreParams
-from app.utils import seconds_readable
 
 if TYPE_CHECKING:
     from app.objects.channel import Channel
@@ -1258,7 +1258,7 @@ async def server(ctx: Context) -> str | None:
 
     return "\n".join(
         (
-            f"{build_str} | uptime: {seconds_readable(uptime)}",
+            f"{build_str} | uptime: {timedelta(seconds=uptime)}",
             f"cpu: {cpu_info_str}",
             f"ram: {ram_info}",
             f"search mirror: {mirror_search_url} | download mirror: {mirror_download_url}",

app/constants/clientflags.py

@@ -6,8 +6,6 @@
 from app.utils import escape_enum
 from app.utils import pymysql_encode
 
-__all__ = ("ClientFlags",)
-
 
 @unique
 @pymysql_encode(escape_enum)

app/constants/gamemodes.py

@@ -8,8 +8,6 @@
 from app.utils import escape_enum
 from app.utils import pymysql_encode
 
-__all__ = ("GAMEMODE_REPR_LIST", "GameMode")
-
 GAMEMODE_REPR_LIST = (
     "vn!std",
     "vn!taiko",

app/constants/mods.py

@@ -7,10 +7,6 @@
 from app.utils import escape_enum
 from app.utils import pymysql_encode
 
-__all__ = ("Mods",)
-
-# NOTE: the order of some of these = stupid
-
 
 @unique
 @pymysql_encode(escape_enum)

app/constants/privileges.py

@@ -7,8 +7,6 @@
 from app.utils import escape_enum
 from app.utils import pymysql_encode
 
-__all__ = ("Privileges", "ClientPrivileges", "ClanPrivileges")
-
 
 @unique
 @pymysql_encode(escape_enum)

app/constants/regexes.py

@@ -2,9 +2,6 @@
 
 import re
 
-__all__ = ("OSU_VERSION", "USERNAME", "EMAIL", "BEST_OF")
-
-
 OSU_VERSION = re.compile(
     r"^b(?P<date>\d{8})(?:\.(?P<revision>\d))?"
     r"(?P<stream>beta|cuttingedge|dev|tourney)?$",

app/discord.py

@@ -10,20 +10,6 @@
 
 from app.state import services
 
-# NOTE: this module currently only implements discord webhooks
-
-__all__ = (
-    "Footer",
-    "Image",
-    "Thumbnail",
-    "Video",
-    "Provider",
-    "Author",
-    "Field",
-    "Embed",
-    "Webhook",
-)
-
 
 class Footer:
     def __init__(self, text: str, **kwargs: Any) -> None:

app/objects/achievement.py

@@ -6,8 +6,6 @@
 if TYPE_CHECKING:
     from app.objects.score import Score
 
-__all__ = ("Achievement",)
-
 
 class Achievement:
     """A class to represent a single osu! achievement."""

app/objects/channel.py

@@ -10,8 +10,6 @@
 if TYPE_CHECKING:
     from app.objects.player import Player
 
-__all__ = ("Channel",)
-
 
 class Channel:
     """An osu! chat channel.

app/objects/clan.py

@@ -11,8 +11,6 @@
 if TYPE_CHECKING:
     from app.objects.player import Player
 
-__all__ = ("Clan",)
-
 
 class Clan:
     """A class to represent a single bancho.py clan."""

app/objects/player.py

@@ -10,7 +10,6 @@
 from enum import unique
 from functools import cached_property
 from typing import TYPE_CHECKING
-from typing import Any
 from typing import TypedDict
 from typing import cast
 
@@ -36,6 +35,7 @@
 from app.objects.score import Grade
 from app.objects.score import Score
 from app.repositories import logs as logs_repo
+from app.repositories import players as players_repo
 from app.repositories import stats as stats_repo
 from app.state.services import Geolocation
 from app.utils import escape_enum
@@ -238,7 +238,6 @@ def __init__(
 
         self.id = id
         self.name = name
-        self.safe_name = self.make_safe(self.name)
         self.priv = priv
         self.pw_bcrypt = pw_bcrypt
         self.token = token
@@ -282,8 +281,6 @@ def _noop_enqueue(data: bytes) -> None:
 
         self.pres_filter = PresenceFilter.Nil
 
-        # XXX: below is mostly implementation-specific & internal stuff
-
         # store most recent score for each gamemode.
         self.recent_scores: dict[GameMode, Score | None] = {
             mode: None for mode in GameMode
@@ -297,6 +294,10 @@ def _noop_enqueue(data: bytes) -> None:
     def __repr__(self) -> str:
         return f"<{self.name} ({self.id})>"
 
+    @property
+    def safe_name(self) -> str:
+        return make_safe_name(self.name)
+
     @property
     def is_online(self) -> bool:
         return bool(self.token != "")
@@ -384,11 +385,6 @@ def generate_token() -> str:
         """Generate a random uuid as a token."""
         return str(uuid.uuid4())
 
-    @staticmethod
-    def make_safe(name: str) -> str:
-        """Return a name safe for usage in sql."""
-        return make_safe_name(name)
-
     def logout(self) -> None:
         """Log `self` out of the server."""
         # invalidate the user's token.
@@ -421,45 +417,45 @@ def logout(self) -> None:
 
     async def update_privs(self, new: Privileges) -> None:
         """Update `self`'s privileges to `new`."""
+
         self.priv = new
+        if "bancho_priv" in vars(self):
+            del self.bancho_priv  # wipe cached_property
 
-        await app.state.services.database.execute(
-            "UPDATE users SET priv = :priv WHERE id = :user_id",
-            {"priv": self.priv, "user_id": self.id},
+        await players_repo.update(
+            id=self.id,
+            priv=self.priv,
         )
 
-        if "bancho_priv" in self.__dict__:
-            del self.bancho_priv  # wipe cached_property
-
     async def add_privs(self, bits: Privileges) -> None:
         """Update `self`'s privileges, adding `bits`."""
+
         self.priv |= bits
+        if "bancho_priv" in vars(self):
+            del self.bancho_priv  # wipe cached_property
 
-        await app.state.services.database.execute(
-            "UPDATE users SET priv = :priv WHERE id = :user_id",
-            {"priv": self.priv, "user_id": self.id},
+        await players_repo.update(
+            id=self.id,
+            priv=self.priv,
         )
 
-        if "bancho_priv" in self.__dict__:
-            del self.bancho_priv  # wipe cached_property
-
         if self.is_online:
             # if they're online, send a packet
             # to update their client-side privileges
             self.enqueue(app.packets.bancho_privileges(self.bancho_priv))
 
     async def remove_privs(self, bits: Privileges) -> None:
         """Update `self`'s privileges, removing `bits`."""
+
         self.priv &= ~bits
+        if "bancho_priv" in vars(self):
+            del self.bancho_priv  # wipe cached_property
 
-        await app.state.services.database.execute(
-            "UPDATE users SET priv = :priv WHERE id = :user_id",
-            {"priv": self.priv, "user_id": self.id},
+        await players_repo.update(
+            id=self.id,
+            priv=self.priv,
         )
 
-        if "bancho_priv" in self.__dict__:
-            del self.bancho_priv  # wipe cached_property
-
         if self.is_online:
             # if they're online, send a packet
             # to update their client-side privileges
@@ -542,9 +538,9 @@ async def silence(self, admin: Player, duration: float, reason: str) -> None:
         """Silence `self` for `duration` seconds, and log to sql."""
         self.silence_end = int(time.time() + duration)
 
-        await app.state.services.database.execute(
-            "UPDATE users SET silence_end = :silence_end WHERE id = :user_id",
-            {"silence_end": self.silence_end, "user_id": self.id},
+        await players_repo.update(
+            id=self.id,
+            silence_end=self.silence_end,
         )
 
         await logs_repo.create(
@@ -570,9 +566,9 @@ async def unsilence(self, admin: Player, reason: str) -> None:
         """Unsilence `self`, and log to sql."""
         self.silence_end = int(time.time())
 
-        await app.state.services.database.execute(
-            "UPDATE users SET silence_end = :silence_end WHERE id = :user_id",
-            {"silence_end": self.silence_end, "user_id": self.id},
+        await players_repo.update(
+            id=self.id,
+            silence_end=self.silence_end,
         )
 
         await logs_repo.create(
@@ -1006,9 +1002,9 @@ async def stats_from_sql_full(self, db_conn: databases.core.Connection) -> None:
 
     def update_latest_activity_soon(self) -> None:
         """Update the player's latest activity in the database."""
-        task = app.state.services.database.execute(
-            "UPDATE users SET latest_activity = UNIX_TIMESTAMP() WHERE id = :user_id",
-            {"user_id": self.id},
+        task = players_repo.update(
+            id=self.id,
+            latest_activity=int(time.time()),
         )
         app.state.loop.create_task(task)
 

app/settings.py

@@ -2,30 +2,16 @@
 
 import os
 import tomllib
-from datetime import date
 
 from dotenv import load_dotenv
 
 from app.settings_utils import read_bool
 from app.settings_utils import read_list
-from app.settings_utils import support_deprecated_vars
 
 load_dotenv()
 
-APP_HOST = support_deprecated_vars(
-    new_name="APP_HOST",
-    deprecated_name="SERVER_ADDR",
-    until=date(2024, 1, 1),
-)
-APP_PORT = None
-_app_port = support_deprecated_vars(
-    new_name="APP_PORT",
-    deprecated_name="SERVER_PORT",
-    until=date(2024, 1, 1),
-    allow_empty_string=True,
-)
-if _app_port:
-    APP_PORT = int(_app_port)
+APP_HOST = os.environ["APP_HOST"]
+APP_PORT = int(os.environ["APP_PORT"])
 
 DB_HOST = os.environ["DB_HOST"]
 DB_PORT = int(os.environ["DB_PORT"])