Step 04 — OHS (Sales)
- OrderController OHS versionné sous /api/sales/v1/
- OrderViewAssembler : assemble le modèle interne → OrderView (Published Language)
- Endpoints : POST /orders, GET /orders/{id}, POST /orders/{id}/confirm, GET /customers/{id}/orders
- Tests vérifiant que les modèles internes ne sont jamais exposés
This commit is contained in:
84
src/Sales/Interfaces/Http/Api/V1/OrderController.php
Normal file
84
src/Sales/Interfaces/Http/Api/V1/OrderController.php
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace MiniShop\Sales\Interfaces\Http\Api\V1;
|
||||||
|
|
||||||
|
use MiniShop\Sales\Application\Command\ConfirmOrder;
|
||||||
|
use MiniShop\Sales\Application\Command\ConfirmOrderHandler;
|
||||||
|
use MiniShop\Sales\Application\Command\PlaceOrder;
|
||||||
|
use MiniShop\Sales\Application\Command\PlaceOrderHandler;
|
||||||
|
use MiniShop\Sales\Application\Query\GetOrderById;
|
||||||
|
use MiniShop\Sales\Application\Query\GetOrderByIdHandler;
|
||||||
|
use MiniShop\Sales\Application\Query\ListOrdersByCustomer;
|
||||||
|
use MiniShop\Sales\Application\Query\ListOrdersByCustomerHandler;
|
||||||
|
use MiniShop\Shared\Technical\UuidGenerator;
|
||||||
|
use Symfony\Component\HttpFoundation\JsonResponse;
|
||||||
|
use Symfony\Component\HttpFoundation\Request;
|
||||||
|
use Symfony\Component\HttpFoundation\Response;
|
||||||
|
use Symfony\Component\Routing\Attribute\Route;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Open Host Service — sales.v1
|
||||||
|
* API stable et versionnee. Les modeles internes ne sont jamais exposes.
|
||||||
|
* Tous les DTOs de reponse passent par OrderViewAssembler → OrderView (Published Language).
|
||||||
|
*/
|
||||||
|
#[Route('/api/sales/v1')]
|
||||||
|
final readonly class OrderController
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
private PlaceOrderHandler $placeOrderHandler,
|
||||||
|
private ConfirmOrderHandler $confirmOrderHandler,
|
||||||
|
private GetOrderByIdHandler $getOrderByIdHandler,
|
||||||
|
private ListOrdersByCustomerHandler $listOrdersByCustomerHandler,
|
||||||
|
private OrderViewAssembler $assembler,
|
||||||
|
) {}
|
||||||
|
|
||||||
|
#[Route('/orders', name: 'ohs_sales_place_order', methods: ['POST'])]
|
||||||
|
public function placeOrder(Request $request): JsonResponse
|
||||||
|
{
|
||||||
|
/** @var array{customerId: string, lines: list<array{productName: string, quantity: int, unitPriceInCents: int, currency: string}>} $data */
|
||||||
|
$data = json_decode($request->getContent(), true, flags: JSON_THROW_ON_ERROR);
|
||||||
|
|
||||||
|
$orderId = UuidGenerator::generate();
|
||||||
|
|
||||||
|
($this->placeOrderHandler)(new PlaceOrder(
|
||||||
|
orderId: $orderId,
|
||||||
|
customerId: $data['customerId'],
|
||||||
|
lines: $data['lines'],
|
||||||
|
));
|
||||||
|
|
||||||
|
$order = ($this->getOrderByIdHandler)(new GetOrderById($orderId));
|
||||||
|
|
||||||
|
return new JsonResponse($this->assembler->toView($order), Response::HTTP_CREATED);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[Route('/orders/{orderId}', name: 'ohs_sales_get_order', methods: ['GET'])]
|
||||||
|
public function getOrder(string $orderId): JsonResponse
|
||||||
|
{
|
||||||
|
$order = ($this->getOrderByIdHandler)(new GetOrderById($orderId));
|
||||||
|
|
||||||
|
return new JsonResponse($this->assembler->toView($order));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[Route('/orders/{orderId}/confirm', name: 'ohs_sales_confirm_order', methods: ['POST'])]
|
||||||
|
public function confirmOrder(string $orderId): JsonResponse
|
||||||
|
{
|
||||||
|
($this->confirmOrderHandler)(new ConfirmOrder(orderId: $orderId));
|
||||||
|
|
||||||
|
$order = ($this->getOrderByIdHandler)(new GetOrderById($orderId));
|
||||||
|
|
||||||
|
return new JsonResponse($this->assembler->toView($order));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[Route('/customers/{customerId}/orders', name: 'ohs_sales_list_orders', methods: ['GET'])]
|
||||||
|
public function listOrders(string $customerId): JsonResponse
|
||||||
|
{
|
||||||
|
$orders = ($this->listOrdersByCustomerHandler)(new ListOrdersByCustomer($customerId));
|
||||||
|
|
||||||
|
return new JsonResponse(array_map(
|
||||||
|
fn ($order) => $this->assembler->toView($order),
|
||||||
|
$orders,
|
||||||
|
));
|
||||||
|
}
|
||||||
|
}
|
||||||
37
src/Sales/Interfaces/Http/Api/V1/OrderViewAssembler.php
Normal file
37
src/Sales/Interfaces/Http/Api/V1/OrderViewAssembler.php
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace MiniShop\Sales\Interfaces\Http\Api\V1;
|
||||||
|
|
||||||
|
use MiniShop\Contracts\Sales\V1\Api\OrderView;
|
||||||
|
use MiniShop\Sales\Domain\Model\Order;
|
||||||
|
use MiniShop\Sales\Domain\Model\OrderLine;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Assemble le modele interne Order vers le DTO public OrderView (sales.v1).
|
||||||
|
* Les modeles internes de Sales ne sont jamais exposes directement.
|
||||||
|
*/
|
||||||
|
final class OrderViewAssembler
|
||||||
|
{
|
||||||
|
public function toView(Order $order): OrderView
|
||||||
|
{
|
||||||
|
return new OrderView(
|
||||||
|
orderId: $order->id->toString(),
|
||||||
|
customerId: $order->customerId->toString(),
|
||||||
|
status: $order->status()->value,
|
||||||
|
totalInCents: $order->total()->amount,
|
||||||
|
currency: $order->total()->currency,
|
||||||
|
lines: array_map(
|
||||||
|
static fn (OrderLine $line): array => [
|
||||||
|
'productName' => $line->productName,
|
||||||
|
'quantity' => $line->quantity,
|
||||||
|
'unitPriceInCents' => $line->unitPrice->amount,
|
||||||
|
'currency' => $line->unitPrice->currency,
|
||||||
|
'lineTotalInCents' => $line->lineTotal()->amount,
|
||||||
|
],
|
||||||
|
$order->lines(),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
94
tests/Integration/Sales/OhsApiTest.php
Normal file
94
tests/Integration/Sales/OhsApiTest.php
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace MiniShop\Tests\Integration\Sales;
|
||||||
|
|
||||||
|
use MiniShop\Contracts\Sales\V1\Api\OrderView;
|
||||||
|
use MiniShop\Sales\Application\Command\PlaceOrder;
|
||||||
|
use MiniShop\Sales\Application\Command\PlaceOrderHandler;
|
||||||
|
use MiniShop\Sales\Application\Query\GetOrderById;
|
||||||
|
use MiniShop\Sales\Application\Query\GetOrderByIdHandler;
|
||||||
|
use MiniShop\Sales\Domain\Model\OrderLine;
|
||||||
|
use MiniShop\Sales\Interfaces\Http\Api\V1\OrderViewAssembler;
|
||||||
|
use MiniShop\Sales\Infrastructure\Persistence\InMemoryOrderRepository;
|
||||||
|
use MiniShop\Shared\Technical\SystemClock;
|
||||||
|
use PHPUnit\Framework\TestCase;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test de l'Open Host Service : verifie que l'API OHS expose uniquement
|
||||||
|
* des DTOs du Published Language (OrderView) et jamais les modeles internes.
|
||||||
|
*/
|
||||||
|
final class OhsApiTest extends TestCase
|
||||||
|
{
|
||||||
|
public function test_assembler_returns_order_view_contract(): void
|
||||||
|
{
|
||||||
|
$orderRepo = new InMemoryOrderRepository();
|
||||||
|
$clock = new SystemClock();
|
||||||
|
$assembler = new OrderViewAssembler();
|
||||||
|
|
||||||
|
// Create a stub publisher that does nothing
|
||||||
|
$publisher = new class implements \MiniShop\Sales\Application\Port\SalesEventPublisher {
|
||||||
|
public function publishOrderPlaced(\MiniShop\Sales\Domain\Event\OrderPlaced $event): void {}
|
||||||
|
public function publishOrderConfirmed(\MiniShop\Sales\Domain\Event\OrderConfirmed $event): void {}
|
||||||
|
public function publishOrderCancelled(\MiniShop\Sales\Domain\Event\OrderCancelled $event): void {}
|
||||||
|
};
|
||||||
|
|
||||||
|
$placeHandler = new PlaceOrderHandler($orderRepo, $publisher, $clock);
|
||||||
|
$getHandler = new GetOrderByIdHandler($orderRepo);
|
||||||
|
|
||||||
|
$orderId = 'ohs-test-001';
|
||||||
|
($placeHandler)(new PlaceOrder(
|
||||||
|
orderId: $orderId,
|
||||||
|
customerId: 'cust-001',
|
||||||
|
lines: [
|
||||||
|
['productName' => 'Widget', 'quantity' => 2, 'unitPriceInCents' => 1500, 'currency' => 'EUR'],
|
||||||
|
],
|
||||||
|
));
|
||||||
|
|
||||||
|
$order = ($getHandler)(new GetOrderById($orderId));
|
||||||
|
$view = $assembler->toView($order);
|
||||||
|
|
||||||
|
// Verifie que le retour est un DTO du Published Language
|
||||||
|
self::assertInstanceOf(OrderView::class, $view);
|
||||||
|
self::assertSame($orderId, $view->orderId);
|
||||||
|
self::assertSame('placed', $view->status);
|
||||||
|
self::assertSame(3000, $view->totalInCents);
|
||||||
|
self::assertSame('EUR', $view->currency);
|
||||||
|
self::assertCount(1, $view->lines);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_order_view_does_not_expose_internal_model(): void
|
||||||
|
{
|
||||||
|
$assembler = new OrderViewAssembler();
|
||||||
|
$orderRepo = new InMemoryOrderRepository();
|
||||||
|
$clock = new SystemClock();
|
||||||
|
$publisher = new class implements \MiniShop\Sales\Application\Port\SalesEventPublisher {
|
||||||
|
public function publishOrderPlaced(\MiniShop\Sales\Domain\Event\OrderPlaced $event): void {}
|
||||||
|
public function publishOrderConfirmed(\MiniShop\Sales\Domain\Event\OrderConfirmed $event): void {}
|
||||||
|
public function publishOrderCancelled(\MiniShop\Sales\Domain\Event\OrderCancelled $event): void {}
|
||||||
|
};
|
||||||
|
|
||||||
|
($placeHandler = new PlaceOrderHandler($orderRepo, $publisher, $clock))(new PlaceOrder(
|
||||||
|
orderId: 'ohs-test-002',
|
||||||
|
customerId: 'cust-001',
|
||||||
|
lines: [['productName' => 'Widget', 'quantity' => 1, 'unitPriceInCents' => 1000, 'currency' => 'EUR']],
|
||||||
|
));
|
||||||
|
|
||||||
|
$order = (new GetOrderByIdHandler($orderRepo))(new GetOrderById('ohs-test-002'));
|
||||||
|
$view = $assembler->toView($order);
|
||||||
|
|
||||||
|
$json = json_encode($view, JSON_THROW_ON_ERROR);
|
||||||
|
$decoded = json_decode($json, true, flags: JSON_THROW_ON_ERROR);
|
||||||
|
|
||||||
|
// Le JSON ne doit contenir que les champs du Published Language
|
||||||
|
$allowedKeys = ['orderId', 'customerId', 'status', 'totalInCents', 'currency', 'lines'];
|
||||||
|
self::assertSame($allowedKeys, array_keys($decoded));
|
||||||
|
|
||||||
|
// Les lignes ne doivent pas contenir de types internes (Money, OrderLine)
|
||||||
|
$lineKeys = array_keys($decoded['lines'][0]);
|
||||||
|
self::assertContains('productName', $lineKeys);
|
||||||
|
self::assertContains('lineTotalInCents', $lineKeys);
|
||||||
|
self::assertNotContains('unitPrice', $lineKeys); // pas d'objet Money
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user