Feat/merge fixes

.github/workflows/lint.yml

@@ -25,16 +25,12 @@ jobs:
 
       - name: Lint - ruff
         if: always()
-        run: poetry run poe ruff
-
-      - name: Lint - black
-        if: always()
-        run: poetry run poe black --check
+        run: poetry run ruff check ./src ./tests
 
       - name: Lint - mypy
         if: always()
-        run: poetry run poe mypy
+        run: poetry run mypy ./src ./tests
 
       - name: Lint - pyright
         if: always()
-        run: poetry run poe pyright
+        run: poetry run pyright ./src ./tests

Dockerfile

@@ -20,7 +20,7 @@ ADD --link https://unpkg.com/htmx.org@1.9.10/dist/htmx.js \
   https://unpkg.com/htmx.org@1.9.10/dist/htmx.min.js \
   ./src/zulip_write_only_proxy/frontend/static/
 
-FROM python:3.11-alpine AS prod
+FROM python:3.12-alpine AS prod
 
 ENV PYTHONDONTWRITEBYTECODE 1
 ENV PYTHONUNBUFFERED 1
@@ -34,7 +34,7 @@ RUN --mount=type=cache,target=/root/.cache \
   python3 -m pip install --upgrade poetry pip && \
   poetry config virtualenvs.create false --local
 
-COPY ./poetry.lock ./pyproject.toml ./README.md /app
+COPY ./poetry.lock ./pyproject.toml ./README.md /app/
 
 RUN --mount=type=cache,target=/root/.cache \
   poetry install --no-root

pyproject.toml

@@ -16,7 +16,7 @@ uvicorn = "^0.23.1"
 zulip = "^0.8.2"
 python-multipart = "^0.0.6"
 orjson = "^3.9.2"
-pydantic = {extras = ["email"], version = "^2.6.1"}
+pydantic = { extras = ["email"], version = "^2.6.1" }
 pydantic-settings = "^2.4.0"
 authlib = "^1.3.0"
 itsdangerous = "^2.1.2"
@@ -39,15 +39,9 @@ debugpy = "^1.8.1"
 vcrpy = "^6.0.1"
 
 [tool.poetry.group.lint.dependencies]
-ruff = "^0.1.0"
-mypy = "^1.4.1"
-pyright = "^1.1.320"
-black = "^23.7.0"
-
-[tool.black]
-line-length = 88
-target-version = ["py311", "py312"]
-
+ruff = "^0"
+mypy = "^1"
+pyright = "^1"
 
 [tool.poe.tasks]
 up = { shell = "python3 -m zulip_write_only_proxy.main", env = { UVICORN_LOOP = { default = "asyncio" } } }

ruff.toml

@@ -2,6 +2,8 @@ output-format = "grouped"
 
 preview = true
 
+target-version = "py313"
+
 src = ["src", "test"]
 
 [lint]

src/zulip_write_only_proxy/__init__.py

@@ -1,6 +1,6 @@
 try:
     from ._version import __version__, __version_tuple__
-except ImportError:
+except ImportError:  # pragma: no cover
     __version__ = "unknown"
     __version_tuple__ = (0, 0, 0)  # type: ignore[assignment]
 

src/zulip_write_only_proxy/_logging.py

@@ -8,14 +8,14 @@
 from starlette.middleware.base import BaseHTTPMiddleware
 from structlog.stdlib import ProcessorFormatter
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from starlette.requests import Request
     from starlette.responses import Response
 
 
 def logger_name_callsite(logger, method_name, event_dict):
     if not event_dict.get("logger_name"):
-        logger_name = f"{event_dict.pop('module')}.{event_dict.pop('func_name')}"
+        logger_name = f"{event_dict.pop("module")}.{event_dict.pop("func_name")}"
         if not event_dict.pop("disable_name", False):
             event_dict["logger_name"] = logger_name.strip(".")  # pyright: ignore[reportInvalidTypeForm]
 

src/zulip_write_only_proxy/frontend/templates/fragments/create-success.html

@@ -9,13 +9,9 @@ <h2 class="card-title">Bot Created</h2>
       <span>Stream: </span>
       <span class="opacity-60" id="stream_name">{{ client.stream }}</span>
     </div>
-    <div>
-      <span>Bot Name: </span>
-      <span class="opacity-60" id="bot_name">{{ client.bot_name }}</span>
-    </div>
     <div>
       <span>Bot Site: </span>
-      <span class="opacity-60" id="bot_name">{{ bot_site }}</span>
+      <span class="opacity-60" id="bot_site">{{ bot_site }}</span>
     </div>
     <div>
       <span>Key: </span>

src/zulip_write_only_proxy/main.py

@@ -7,8 +7,11 @@ def create_app():
 
     from . import routers, services
     from ._logging import RequestLoggingMiddleware
+    from .settings import configure as configure_settings
     from .settings import settings
 
+    configure_settings()
+
     @asynccontextmanager
     async def lifespan(app: fastapi.FastAPI):
         from . import _logging, mymdc
@@ -47,7 +50,7 @@ async def lifespan(app: fastapi.FastAPI):
     return app
 
 
-def get_trusted_hosts(logger):
+def get_trusted_hosts(logger):  # pragma: no cover
     import socket
     import struct
     from pathlib import Path
@@ -83,12 +86,15 @@ def get_trusted_hosts(logger):
     return list(trusted)
 
 
-if __name__ == "__main__":
+if __name__ == "__main__":  # pragma: no cover
     import uvicorn
 
     from . import _logging, get_logger
+    from .settings import configure as configure_settings
     from .settings import settings
 
+    configure_settings()
+
     _logging.configure(settings.debug, add_call_site_parameters=False)
 
     logger = get_logger()

src/zulip_write_only_proxy/models/base.py

@@ -8,5 +8,5 @@ class Base(ABC, BaseModel):
     created_at: datetime.datetime
 
     @property
-    def _key(self):
+    def _key(self):  # pragma: no cover
         raise NotImplementedError

src/zulip_write_only_proxy/models/client.py

@@ -1,4 +1,5 @@
 import datetime
+import operator
 import secrets
 from typing import IO, TYPE_CHECKING, Any
 
@@ -16,7 +17,7 @@
 from .base import Base
 from .zulip import PropagateMode
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     import zulip
 
 
@@ -51,7 +52,6 @@ class ScopedClient(Base):
     proposal_no: int
     proposal_id: int
     stream: str | None  # type: ignore [reportIncompatibleVariableOverride]
-    bot_name: str | None
     bot_id: int | None
     bot_site: HttpUrl | None
     token: SecretStr
@@ -137,7 +137,7 @@ def get_messages(self):
         # messages to fetch. TODO: handle multi-page results for more than 100 messages
         messages = self._client.get_messages(request)
         messages["messages"] = sorted(
-            messages["messages"], key=lambda m: m["id"], reverse=True
+            messages["messages"], key=operator.itemgetter("id"), reverse=True
         )
         return messages
 

src/zulip_write_only_proxy/models/zulip.py

@@ -7,7 +7,7 @@
 from .base import Base
 
 
-class PropagateMode(str, enum.Enum):
+class PropagateMode(enum.StrEnum):
     change_one = "change_one"
     change_all = "change_all"
     change_later = "change_later"

src/zulip_write_only_proxy/mymdc.py

@@ -4,15 +4,16 @@
 MyMdC client package is created this can be removed and replaced with calls to that."""
 
 import datetime as dt
-from typing import TYPE_CHECKING, Any, AsyncGenerator
+from collections.abc import AsyncGenerator
+from typing import TYPE_CHECKING, Any
 
 import httpx
 
 from . import logger
 from .exceptions import ZwopException
 from .settings import MyMdCCredentials, Settings
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from fastapi import FastAPI
 
 
@@ -33,7 +34,7 @@ async def acquire_token(self):
 
         Token data stored under `_access_token` and `_expires_at`.
         """
-        expired = self._expires_at <= dt.datetime.now(tz=dt.timezone.utc)
+        expired = self._expires_at <= dt.datetime.now(tz=dt.UTC)
         if self._access_token and not expired:
             logger.debug("Reusing existing MyMdC token", expires_at=self._expires_at)
             return self._access_token
@@ -69,7 +70,7 @@ async def acquire_token(self):
 
         expires_in = dt.timedelta(seconds=data["expires_in"])
         self._access_token = data["access_token"]
-        self._expires_at = dt.datetime.now(tz=dt.timezone.utc) + expires_in
+        self._expires_at = dt.datetime.now(tz=dt.UTC) + expires_in
 
         logger.info("Acquired new MyMdC token", expires_at=self._expires_at)
         return self._access_token

src/zulip_write_only_proxy/repositories.py

@@ -13,6 +13,11 @@
 T = TypeVar("T", bound=Base)
 
 
+class EntryExistsException(exceptions.ZwopException):
+    def __init__(self, key: str):
+        super().__init__(status_code=409, detail=f"Client already exists for {key}")
+
+
 @dataclass
 class BaseRepository(Generic[T]):
     file: Path
@@ -93,10 +98,8 @@ async def delete(self, key: str, by: str | None = None) -> str:
     async def insert(self, item: T):
         if item._key in self.data:
             logger.warning("Client already exists", key=item._key)
-            raise exceptions.ZwopException(
-                status_code=409,
-                detail=f"Client already exists for {item._key}",
-            )
+            raise EntryExistsException(key=item._key)
+
         self._data.append(item)
         self.data[item._key] = self._data[-1]
 

src/zulip_write_only_proxy/routers/api.py

@@ -7,7 +7,7 @@
 
 from .. import __version__, __version_tuple__, logger, models, services
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from tempfile import SpooledTemporaryFile
 
 _docs_url = "https://zulip.com/api/send-message#response"
@@ -70,12 +70,12 @@ def send_message(
     if image:
         # Some screwing around to get the spooled tmp file to act more like a real file
         # since Zulip needs it to have a filename
-        f: "SpooledTemporaryFile" = image.file  # type: ignore[assignment]
+        f: SpooledTemporaryFile = image.file  # type: ignore[assignment]
         f._file.name = image.filename  # type: ignore[misc, assignment]
 
         result = client.upload_file(f)
 
-        content += f"\n[]({result['uri']})"
+        content += f"\n\n[]({result["uri"]})"
 
     return client.send_message(topic, content)
 
@@ -118,7 +118,7 @@ def upload_file(
     client: Annotated[models.ScopedClient, fastapi.Depends(get_client_zulip)],
     file: Annotated[fastapi.UploadFile, fastapi.File(...)],
 ):
-    f: "SpooledTemporaryFile" = file.file  # type: ignore[assignment]
+    f: SpooledTemporaryFile = file.file  # type: ignore[assignment]
     f._file.name = file.filename  # type: ignore[misc, assignment]
 
     return client.upload_file(f)

src/zulip_write_only_proxy/routers/auth.py

@@ -12,7 +12,7 @@
 from .. import logger
 from .frontend import AuthException
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from fastapi import FastAPI
 
     from ..settings import Settings

src/zulip_write_only_proxy/routers/frontend.py

@@ -9,7 +9,7 @@
 
 from .. import exceptions, logger, models, services
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no-cover
     from ..settings import Settings
 
 TEMPLATES: Jinja2Templates = None  # type: ignore[assignment]
@@ -43,7 +43,7 @@ class AuthException(exceptions.ZwopException):
     pass
 
 
-async def check_auth(request: Request):
+async def check_auth(request: Request):  # noqa: RUF029
     user = request.session.get("user")
     if not user:
         raise AuthException(
@@ -58,13 +58,13 @@ async def check_auth(request: Request):
     if "da" not in user.get("groups", []):
         raise AuthException(
             status_code=403,
-            detail=f"Forbidden - `{user.get('preferred_username')}` not allowed access",
+            detail=f"Forbidden - `{user.get("preferred_username")}` not allowed access",
         )
 
     logger.debug("Authenticated", user=user)
 
 
-async def auth_redirect(request: Request, exc: AuthException):
+async def auth_redirect(request: Request, exc: AuthException):  # noqa: RUF029
     logger.info("Redirecting to login", status_code=exc.status_code, detail=exc.detail)
     return TEMPLATES.TemplateResponse(
         "login.html",

src/zulip_write_only_proxy/routers/mymdc.py

@@ -1,12 +1,12 @@
-from typing import Annotated, TypeAlias
+from typing import Annotated
 
 import orjson
 from fastapi import APIRouter, Depends, HTTPException, Request, Response
 
 from .. import logger, models, mymdc
 from .api import get_client
 
-ScopedClient: TypeAlias = Annotated[models.ScopedClient, Depends(get_client)]
+type ScopedClient = Annotated[models.ScopedClient, Depends(get_client)]
 
 
 async def proxy_request(mymdc_path: str, params) -> Response:

src/zulip_write_only_proxy/services.py

@@ -1,4 +1,5 @@
 import asyncio
+import contextlib
 import datetime
 import hashlib
 from pathlib import Path
@@ -14,7 +15,7 @@
 from .models.client import NoBotForClientError
 from .settings import Settings, settings
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no-cover
     from os import PathLike
 
 CLIENT_REPO: repositories.BaseRepository[models.ScopedClient] = None  # type: ignore[assignment,type-var]
@@ -90,11 +91,12 @@ async def get_or_create_bot(
         key=SecretStr(bot_key),
         email=bot_email,
         site=Url(bot_site),
-        created_at=created_at or datetime.datetime.now(tz=datetime.timezone.utc),
+        created_at=created_at or datetime.datetime.now(tz=datetime.UTC),
         proposal_no=proposal_no,
     )
 
-    await ZULIPRC_REPO.insert(bot)
+    with contextlib.suppress(repositories.EntryExistsException):
+        await ZULIPRC_REPO.insert(bot)
 
     return bot
 
@@ -179,8 +181,8 @@ async def get_client(key: str | None) -> models.ScopedClient:
     return client
 
 
-async def get_bot(bot_name: str) -> models.BotConfig | None:
-    return await ZULIPRC_REPO.get(bot_name)
+async def get_bot(bot_key: str) -> models.BotConfig | None:
+    return await ZULIPRC_REPO.get(bot_key)
 
 
 async def list_clients() -> list[models.ScopedClient]: