144 lines
4.1 KiB
PHP
144 lines
4.1 KiB
PHP
<?php
|
|
|
|
namespace App\Jobs;
|
|
|
|
use App\Models\DhlShipment;
|
|
use App\Services\DhlApiService;
|
|
use Exception;
|
|
use Illuminate\Bus\Queueable as BusQueueable;
|
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
|
use Illuminate\Foundation\Bus\Dispatchable;
|
|
use Illuminate\Queue\InteractsWithQueue;
|
|
use Illuminate\Queue\SerializesModels;
|
|
use Illuminate\Support\Facades\Log;
|
|
|
|
/**
|
|
* Job to cancel DHL shipments asynchronously
|
|
*
|
|
* This job handles the cancellation of DHL shipments in the background,
|
|
* preventing API timeouts and improving user experience.
|
|
*/
|
|
class CancelShipmentJob implements ShouldQueue
|
|
{
|
|
use BusQueueable, Dispatchable, InteractsWithQueue, SerializesModels;
|
|
|
|
/**
|
|
* @var DhlShipment
|
|
*/
|
|
public $dhlShipment;
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
public $options;
|
|
|
|
/**
|
|
* The number of times the job may be attempted.
|
|
*
|
|
* @var int
|
|
*/
|
|
public $tries = 3;
|
|
|
|
/**
|
|
* The maximum number of seconds the job can run before timing out.
|
|
*
|
|
* @var int
|
|
*/
|
|
public $timeout = 60;
|
|
|
|
/**
|
|
* Create a new job instance.
|
|
*
|
|
* @param DhlShipment $dhlShipment
|
|
* @param array $options
|
|
*/
|
|
public function __construct(DhlShipment $dhlShipment, array $options = [])
|
|
{
|
|
$this->dhlShipment = $dhlShipment;
|
|
$this->options = $options;
|
|
|
|
// Set queue name based on priority
|
|
if (isset($options['priority']) && $options['priority'] === 'high') {
|
|
$this->onQueue('high-priority');
|
|
} else {
|
|
$this->onQueue('dhl-cancellations');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Execute the job.
|
|
*/
|
|
public function handle(): void
|
|
{
|
|
try {
|
|
Log::info('[DHL Queue] Starting shipment cancellation job', [
|
|
'shipment_id' => $this->dhlShipment->id,
|
|
'shipment_number' => $this->dhlShipment->shipment_number,
|
|
'attempt' => $this->attempts(),
|
|
]);
|
|
|
|
$dhlService = new DhlApiService();
|
|
|
|
// Cancel the shipment
|
|
$success = $dhlService->cancelShipment($this->dhlShipment);
|
|
|
|
if ($success) {
|
|
Log::info('[DHL Queue] Shipment cancelled successfully', [
|
|
'shipment_id' => $this->dhlShipment->id,
|
|
'shipment_number' => $this->dhlShipment->shipment_number,
|
|
]);
|
|
} else {
|
|
throw new Exception('Cancellation returned false');
|
|
}
|
|
|
|
} catch (Exception $e) {
|
|
Log::error('[DHL Queue] Shipment cancellation failed', [
|
|
'shipment_id' => $this->dhlShipment->id,
|
|
'shipment_number' => $this->dhlShipment->shipment_number,
|
|
'error' => $e->getMessage(),
|
|
'attempt' => $this->attempts(),
|
|
'max_tries' => $this->tries,
|
|
]);
|
|
|
|
// If this is the final attempt, mark as permanently failed
|
|
if ($this->attempts() >= $this->tries) {
|
|
Log::error('[DHL Queue] Shipment cancellation permanently failed', [
|
|
'shipment_id' => $this->dhlShipment->id,
|
|
'error' => $e->getMessage(),
|
|
]);
|
|
}
|
|
|
|
throw $e; // Re-throw to trigger retry mechanism
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handle a job failure.
|
|
*
|
|
* @param Exception $exception
|
|
*/
|
|
public function failed(Exception $exception): void
|
|
{
|
|
Log::error('[DHL Queue] CancelShipmentJob permanently failed', [
|
|
'shipment_id' => $this->dhlShipment->id,
|
|
'shipment_number' => $this->dhlShipment->shipment_number,
|
|
'error' => $exception->getMessage(),
|
|
'trace' => $exception->getTraceAsString(),
|
|
]);
|
|
|
|
// You could implement additional failure handling here:
|
|
// - Send notification to admin
|
|
// - Create manual task for staff to handle cancellation
|
|
// - Update shipment status to indicate cancellation failed
|
|
}
|
|
|
|
/**
|
|
* Determine the time at which the job should timeout.
|
|
*
|
|
* @return \DateTime
|
|
*/
|
|
public function retryUntil()
|
|
{
|
|
return now()->addHour(); // Shorter timeout for cancellations
|
|
}
|
|
}
|