Merge branch 'main' into feat/tr/pagination

Author: theodorehreuter

CHANGELOG.md

@@ -6,14 +6,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
-## [unreleased]
+## [v0.5.0] - 2025-01-08
 
 ### Added
 
 - Endpoint `/orders/{order_id}/statuses` supporting `GET` for retrieving statuses. The entity returned by this conforms
   to the change proposed in [stapi-spec#239](https://github.com/stapi-spec/stapi-spec/pull/239).
-- Endpoint `/orders/{order_id}/statuses` supporting `POST` for updating current status
-- RootBackend has new methods `get_order_statuses` and `set_order_status`
+- RootBackend has new method `get_order_statuses`
+- `*args`/`**kwargs` support in RootRouter's `add_product` allows to configure underlyinging ProductRouter
 
 ### Changed
 
@@ -25,17 +25,19 @@ none
 
 ### Removed
 
-none
+- Endpoint `/orders/{order_id}/statuses` supporting `POST` for updating current status was added and then
+  removed prior to release
+- RootBackend method `set_order_status` was added and then removed
 
 ### Fixed
 
-none
+- Exception logging
 
 ### Security
 
 none
 
-## [0.4.0] - 2024-12-11
+## [v0.4.0] - 2024-12-11
 
 ### Added
 
@@ -63,7 +65,7 @@ none
 none
 
 
-## [0.3.0] - 2024-12-6
+## [v0.3.0] - 2024-12-6
 
 ### Added
 
@@ -137,7 +139,8 @@ Initial release
 - Add links `opportunities` and `create-order` to Product
 - Add link `create-order` to OpportunityCollection
 
-[unreleased]: https://github.com/stapi-spec/stapi-fastapi/compare/v0.4.0...main
+[unreleased]: https://github.com/stapi-spec/stapi-fastapi/compare/v0.5.0...main
+[v0.4.0]: https://github.com/stapi-spec/stapi-fastapi/tree/v0.5.0
 [v0.4.0]: https://github.com/stapi-spec/stapi-fastapi/tree/v0.4.0
 [v0.3.0]: https://github.com/stapi-spec/stapi-fastapi/tree/v0.3.0
 [v0.2.0]: https://github.com/stapi-spec/stapi-fastapi/tree/v0.2.0

src/stapi_fastapi/backends/root_backend.py

@@ -8,7 +8,6 @@
     Order,
     OrderCollection,
     OrderStatus,
-    OrderStatusPayload,
 )
 
 
@@ -37,7 +36,7 @@ async def get_order(self, order_id: str, request: Request) -> ResultE[Maybe[Orde
 
     async def get_order_statuses(
         self, order_id: str, request: Request
-    ) -> ResultE[list[U]]:
+    ) -> ResultE[list[T]]:
         """
         Get statuses for order with `order_id`.
 
@@ -49,17 +48,3 @@ async def get_order_statuses(
         A Failure[Exception] will result in a 500.
         """
         ...
-
-    async def set_order_status(
-        self, order_id: str, payload: T, request: Request
-    ) -> ResultE[U]:
-        """
-        Set statuses for order with `order_id`.
-
-        Should return returns.results.Success[OrderStatus] if successful.
-
-        Should return returns.results.Failure[Exception] if the status was not able to be set.
-
-        A Failure[Exception] will result in a 500.
-        """
-        ...

src/stapi_fastapi/models/order.py

@@ -122,12 +122,3 @@ class OrderPayload(BaseModel, Generic[ORP]):
     order_parameters: ORP
 
     model_config = ConfigDict(strict=True)
-
-
-class OrderStatusPayload(BaseModel):
-    status_code: OrderStatusCode | None = None
-    reason_code: str | None = None
-    reason_text: str | None = None
-
-    # todo: rework generic types to allow subclasses to be used correctly, and remove extra=allow
-    model_config = ConfigDict(strict=True, extra="allow")

src/stapi_fastapi/routers/product_router.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import logging
+import traceback
 from typing import TYPE_CHECKING, Self
 
 from fastapi import APIRouter, HTTPException, Request, Response, status
@@ -22,6 +23,8 @@
 if TYPE_CHECKING:
     from stapi_fastapi.routers import RootRouter
 
+logger = logging.getLogger(__name__)
+
 
 class ProductRouter(APIRouter):
     def __init__(
@@ -182,7 +185,10 @@ async def search_opportunities(
             case Failure(e) if isinstance(e, ConstraintsException):
                 raise e
             case Failure(e):
-                logging.exception("An error occurred while searching opportunities", e)
+                logger.error(
+                    "An error occurred while searching opportunities: %s",
+                    traceback.format_exception(e),
+                )
                 raise HTTPException(
                     status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
                     detail="Error searching opportunities",
@@ -221,7 +227,10 @@ async def create_order(
             case Failure(e) if isinstance(e, ConstraintsException):
                 raise e
             case Failure(e):
-                logging.exception("An error occurred while creating order", e)
+                logger.error(
+                    "An error occurred while creating order: %s",
+                    traceback.format_exception(e),
+                )
                 raise HTTPException(
                     status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
                     detail="Error creating order",

src/stapi_fastapi/routers/root_router.py

@@ -1,9 +1,9 @@
 import logging
+import traceback
 from typing import Self
 
 from fastapi import APIRouter, HTTPException, Request, status
 from fastapi.datastructures import URL
-from fastapi.responses import Response
 from returns.maybe import Maybe, Some
 from returns.result import Failure, Success
 
@@ -15,14 +15,15 @@
     Order,
     OrderCollection,
     OrderStatuses,
-    OrderStatusPayload,
 )
 from stapi_fastapi.models.product import Product, ProductsCollection
 from stapi_fastapi.models.root import RootResponse
 from stapi_fastapi.models.shared import Link
 from stapi_fastapi.responses import GeoJSONResponse
 from stapi_fastapi.routers.product_router import ProductRouter
 
+logger = logging.getLogger(__name__)
+
 
 class RootRouter(APIRouter):
     def __init__(
@@ -98,14 +99,6 @@ def __init__(
             tags=["Orders"],
         )
 
-        self.add_api_route(
-            "/orders/{order_id}/statuses",
-            self.set_order_status,
-            methods=["POST"],
-            name=f"{self.name}:set-order-status",
-            tags=["Orders"],
-        )
-
     def get_root(self, request: Request) -> RootResponse:
         return RootResponse(
             id="STAPI API",
@@ -205,8 +198,10 @@ async def get_order(self: Self, order_id: str, request: Request) -> Order:
             case Success(Maybe.empty):
                 raise NotFoundException("Order not found")
             case Failure(e):
-                logging.exception(
-                    f"An error occurred while retrieving order '{order_id}'", e
+                logger.error(
+                    "An error occurred while retrieving order '%s': %s",
+                    order_id,
+                    traceback.format_exception(e),
                 )
                 raise HTTPException(
                     status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
@@ -236,8 +231,9 @@ async def get_order_statuses(
                     ],
                 )
             case Failure(e):
-                logging.exception(
-                    "An error occurred while retrieving order statuses", e
+                logger.error(
+                    "An error occurred while retrieving order statuses: %s",
+                    traceback.format_exception(e),
                 )
                 raise HTTPException(
                     status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
@@ -246,24 +242,9 @@ async def get_order_statuses(
             case _:
                 raise AssertionError("Expected code to be unreachable")
 
-    async def set_order_status(
-        self, order_id: str, payload: OrderStatusPayload, request: Request
-    ) -> Response:
-        match await self.backend.set_order_status(order_id, payload, request):
-            case Success(_):
-                return Response(status_code=status.HTTP_202_ACCEPTED)
-            case Failure(e):
-                logging.exception("An error occurred while setting order status", e)
-                raise HTTPException(
-                    status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
-                    detail="Error setting Order Status",
-                )
-            case x:
-                raise AssertionError(f"Expected code to be unreachable {x}")
-
-    def add_product(self: Self, product: Product) -> None:
+    def add_product(self: Self, product: Product, *args, **kwargs) -> None:
         # Give the include a prefix from the product router
-        product_router = ProductRouter(product, self)
+        product_router = ProductRouter(product, self, *args, **kwargs)
         self.include_router(product_router, prefix=f"/products/{product.id}")
         self.product_routers[product.id] = product_router
 

tests/application.py

@@ -1,5 +1,5 @@
 from collections import defaultdict
-from datetime import UTC, datetime, timezone
+from datetime import datetime, timezone
 from typing import Literal, Self
 from uuid import uuid4
 
@@ -23,7 +23,6 @@
     OrderPayload,
     OrderStatus,
     OrderStatusCode,
-    OrderStatusPayload,
 )
 from stapi_fastapi.models.product import (
     Product,
@@ -84,16 +83,6 @@ async def get_order_statuses(
     ) -> ResultE[list[OrderStatus]]:
         return Success(self._orders_db._statuses[order_id])
 
-    async def set_order_status(
-        self, order_id: str, payload: OrderStatusPayload, request: Request
-    ) -> ResultE[OrderStatus]:
-        input = payload.model_dump()
-        input["timestamp"] = datetime.now(UTC)
-        order_status = OrderStatus.model_validate(input)
-        self._orders_db._orders[order_id].properties.status = order_status
-        self._orders_db._statuses[order_id].insert(0, order_status)
-        return Success(order_status)
-
 
 class MockProductBackend(ProductBackend):
     def __init__(self, orders: InMemoryOrderDB) -> None:

tests/test_order.py

@@ -247,3 +247,4 @@ def test_token_not_found(stapi_client: TestClient):
     res = stapi_client.get("/orders", params={"next": "a_token"})
     # should return 404 as a result of bad token
     assert res.status_code == status.HTTP_404_NOT_FOUND
+