refactor: Move shipment creation logic to CourierService for DRY principle

- Move all validation (packing, payment, status, duplicates) to CourierService::createShipmentForOrder()
- Move database updates to service layer
- Move document fetching to service layer
- Simplify ShippingController to just handle HTTP concerns (request/response)
- Simplify CreateShipmentOnReadyToShip listener to just dispatch events
- Single source of truth for business logic in CourierService
- Eliminates duplicate validation between controller and listener
This commit is contained in:
twotalesanimation
2026-01-02 18:13:16 +02:00
parent 2ddb3dc19f
commit db0454d102
3 changed files with 145 additions and 191 deletions
+12 -128
View File
@@ -23,120 +23,30 @@ class ShippingController extends Controller
*/
public function createShipment(Request $request, Order $order)
{
Log::info('Initiating shipment creation', ['order_uuid' => $order->uuid]);
// Guard 1: Verify packing completed with valid dimensions
if (! $this->validatePackingGate($order)) {
Log::warning('Packing gate validation failed', [
'order_uuid' => $order->uuid,
'packing_completed_at' => $order->packing_completed_at,
'width' => $order->packing_width,
'length' => $order->packing_length,
'weight' => $order->packing_weight,
]);
return response()->json([
'error' => 'Order not yet packed with valid dimensions',
'details' => [
'packing_completed_at' => $order->packing_completed_at,
'dimensions' => [
'width' => $order->packing_width,
'length' => $order->packing_length,
'weight' => $order->packing_weight,
],
],
], 400);
}
// Guard 2: Verify payment and approval rules
if (! $this->validatePaymentAndApprovalGate($order)) {
$message = $order->is_custom_order ?
'Custom order requires proof approved and balance paid' :
'Standard order must be fully paid';
Log::warning('Payment/approval gate validation failed', [
'order_uuid' => $order->uuid,
'is_custom_order' => $order->is_custom_order,
'payment_status' => $order->payment_status,
]);
return response()->json([
'error' => $message,
'payment_status' => $order->payment_status,
], 403);
}Log::warning('Order status gate validation failed', [
'order_uuid' => $order->uuid,
'expected_status' => 'ready_to_ship',
'current_status' => $order->status,
]);
// Guard 3: Check order status is Ready to Ship
if ($order->status !== 'ready_to_ship') {
return response()->json([
'error' => 'Order must be in Ready to Ship state',
'current_status' => $order->status,
], 409);
}
// Guard 4: Idempotency - if already shipped, return existing shipment
if ($order->courier_waybill_id) {
Log::info('Shipment already exists, returning existing', ['order_uuid' => $order->uuid]);
return response()->json([
'success' => true,
'message' => 'Shipment already created',
'shipment' => [
'waybill_id' => $order->courier_waybill_id,
'tracking_number' => $order->courier_tracking_number,
],
]);
}
try {
// Call courier API
$shipmentData = $this->courierService->createShipment(
$order->id,
$order->packing_width,
$order->packing_length,
$order->packing_weight,
);
$result = $this->courierService->createShipmentForOrder($order);
// Save shipment details
$order->update([
'courier_waybill_id' => $shipmentData['waybill_id'],
'courier_tracking_number' => $shipmentData['tracking_number'],
'courier_status' => 'awaiting_collection',
'status' => 'awaiting_collection',
]);
Log::info('Shipment created with courier', [
'order_uuid' => $order->uuid,
'waybill_id' => $shipmentData['waybill_id'],
'tracking_number' => $shipmentData['tracking_number'],
]);
// Fetch and store shipping documents
$stickerPath = $this->courierService->fetchSticker($shipmentData['shipment_id'], $order->id);
$waybillPath = $this->courierService->fetchWaybill($shipmentData['shipment_id'], $order->id);
// Emit event to trigger Trello update, Slack notification, document attachment
// Emit event to trigger Slack notification and Trello updates
ShipmentCreated::dispatch(
$order,
$shipmentData['waybill_id'],
$shipmentData['tracking_number'],
$stickerPath,
$waybillPath,
$result['waybill_id'],
$result['tracking_number'],
$result['sticker_path'],
$result['waybill_path'],
);
return response()->json([
'success' => true,
'message' => 'Shipment created successfully',
'shipment' => [
'waybill_id' => $shipmentData['waybill_id'],
'tracking_number' => $shipmentData['tracking_number'],
'sticker' => $stickerPath ? route('storage.file', $stickerPath) : null,
'waybill' => $waybillPath ? route('storage.file', $waybillPath) : null,
'waybill_id' => $result['waybill_id'],
'tracking_number' => $result['tracking_number'],
'sticker' => $result['sticker_path'] ? route('storage.file', $result['sticker_path']) : null,
'waybill' => $result['waybill_path'] ? route('storage.file', $result['waybill_path']) : null,
],
]);
} catch (\Exception $e) {
Log::error('Failed to create shipment', [
Log::error('Shipment creation failed', [
'order_uuid' => $order->uuid,
'error' => $e->getMessage(),
]);
@@ -147,7 +57,7 @@ class ShippingController extends Controller
return response()->json([
'error' => 'Failed to create shipment',
'message' => $e->getMessage(),
], 500);
], 400);
}
}
@@ -169,30 +79,4 @@ class ShippingController extends Controller
// Re-run the shipment creation
return $this->createShipment($request, $order);
}
/**
* Validate packing gate: order must be packed with dimensions
*/
private function validatePackingGate(Order $order): bool
{
return $order->packing_completed_at !== null &&
$order->packing_width > 0 &&
$order->packing_length > 0 &&
$order->packing_weight > 0;
}
/**
* Validate payment and approval gate
*/
private function validatePaymentAndApprovalGate(Order $order): bool
{
// Standard orders: must be fully paid
if ($order->is_custom_order === false) {
return $order->payment_status === 'paid';
}
// Custom orders: proof must be approved and balance must be paid
// TODO: Add proof_approved and balance_status fields to CustomOrder model
return true; // Placeholder - update when custom order model is ready
}
}