@fleetbase/fleetops-engine 0.6.58 → 0.6.59

package/server/tests/ApiServiceQuoteControllerContractsTest.php

@@ -0,0 +1,322 @@
+<?php
+
+use Fleetbase\FleetOps\Http\Controllers\Api\v1\ServiceQuoteController;
+use Fleetbase\FleetOps\Http\Requests\QueryServiceQuotesRequest;
+use Fleetbase\FleetOps\Models\Place;
+use Fleetbase\FleetOps\Models\ServiceQuote;
+use Fleetbase\FleetOps\Models\ServiceQuoteItem;
+use Fleetbase\FleetOps\Models\ServiceRate;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+
+class FleetOpsApiServiceQuoteQueryRecorder
+{
+    public array $wheres = [];
+
+    public function where($column, $value = null): self
+    {
+        $this->wheres[] = [$column, $value];
+
+        return $this;
+    }
+}
+
+class FleetOpsApiServiceQuoteControllerProbe extends ServiceQuoteController
+{
+    public ?ServiceQuote $serviceQuote                             = null;
+    public ?FleetOpsApiServiceQuoteRateFake $serviceRate           = null;
+    public array $serviceRates                                     = [];
+    public array $createdQuotes                                    = [];
+    public array $createdItems                                     = [];
+    public array $placeLookups                                     = [];
+    public array $distanceMatrixCalls                              = [];
+    public string $requestId                                       = 'request_public';
+    public bool $serviceQuoteNotFound                              = false;
+    public array $findCalls                                        = [];
+    public ?FleetOpsApiServiceQuoteQueryRecorder $serviceRateQuery = null;
+
+    protected function findServiceQuote(string $id): ServiceQuote
+    {
+        $this->findCalls[] = $id;
+
+        if ($this->serviceQuoteNotFound) {
+            throw new ModelNotFoundException();
+        }
+
+        $this->serviceQuote ??= new ServiceQuote();
+        $this->serviceQuote->setRawAttributes([
+            'uuid'      => 'service-quote-uuid',
+            'public_id' => 'service_quote_public',
+            'amount'    => 1200,
+            'currency'  => 'USD',
+        ], true);
+
+        return $this->serviceQuote;
+    }
+
+    protected function serviceQuoteResource(ServiceQuote $serviceQuote)
+    {
+        return ['resource' => 'service-quote', 'serviceQuote' => $serviceQuote];
+    }
+
+    protected function serviceQuoteResourceCollection(iterable $serviceQuotes)
+    {
+        return ['collection' => 'service-quotes', 'items' => collect($serviceQuotes)->values()->all()];
+    }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return ['json' => $payload, 'status' => $status];
+    }
+
+    protected function generateServiceQuoteRequestId(): string
+    {
+        return $this->requestId;
+    }
+
+    protected function findPlaceByPublicId(string $publicId): ?Place
+    {
+        $this->placeLookups[] = $publicId;
+
+        return tap(new Place(), fn (Place $place) => $place->setRawAttributes([
+            'uuid'      => $publicId . '-uuid',
+            'public_id' => $publicId,
+        ], true));
+    }
+
+    protected function distanceMatrix(array $origins, iterable $destinations): mixed
+    {
+        $this->distanceMatrixCalls[] = [$origins, collect($destinations)->values()->all()];
+
+        return (object) ['distance' => 4200, 'time' => 900];
+    }
+
+    protected function findServiceRateByUuid(string $service): ?ServiceRate
+    {
+        return $this->serviceRate;
+    }
+
+    protected function getServicableServiceRates(iterable $waypoints, ?string $serviceType, mixed $currency, callable $callback): iterable
+    {
+        // The real lookup hands the callback a query builder to narrow; running
+        // it against a recorder keeps the scoping the controller applies under
+        // test rather than stubbing it away with the query.
+        $this->serviceRateQuery = new FleetOpsApiServiceQuoteQueryRecorder();
+        $callback($this->serviceRateQuery);
+
+        return $this->serviceRates;
+    }
+
+    protected function createServiceQuote(array $attributes): ServiceQuote
+    {
+        $quote = new FleetOpsApiServiceQuoteFake();
+        $quote->setRawAttributes(array_merge(['uuid' => 'service-quote-' . (count($this->createdQuotes) + 1)], $attributes), true);
+        $this->createdQuotes[] = $attributes;
+
+        return $quote;
+    }
+
+    protected function createServiceQuoteItem(array $attributes): ServiceQuoteItem
+    {
+        $item = new ServiceQuoteItem();
+        $item->setRawAttributes($attributes, true);
+        $this->createdItems[] = $attributes;
+
+        return $item;
+    }
+}
+
+class FleetOpsApiServiceQuoteFake extends ServiceQuote
+{
+    public array $metaUpdates = [];
+
+    public function updateMeta($key, $value = null): bool
+    {
+        $this->metaUpdates[$key] = $value;
+
+        return true;
+    }
+}
+
+class FleetOpsApiServiceQuoteRateFake extends ServiceRate
+{
+    public function __construct(
+        string $uuid = 'service-rate-uuid',
+        public int $amount = 1000,
+        public string $currencyCode = 'USD',
+    ) {
+        parent::__construct();
+
+        $this->setRawAttributes([
+            'uuid'         => $uuid,
+            'public_id'    => $uuid . '_public',
+            'company_uuid' => 'company-uuid',
+            'currency'     => $currencyCode,
+        ], true);
+    }
+
+    public function quoteFromPreliminaryData($entities = [], $waypoints = [], ?int $totalDistance = 0, ?int $totalTime = 0, ?bool $isCashOnDelivery = false, ?int $endpointCount = null)
+    {
+        return [$this->amount, collect([[
+            'amount'   => $this->amount,
+            'currency' => $this->currencyCode,
+            'details'  => [
+                'distance'       => $totalDistance,
+                'time'           => $totalTime,
+                'cod'            => $isCashOnDelivery,
+                'endpoint_count' => $endpointCount,
+            ],
+            'code' => 'base_fee',
+        ]])];
+    }
+}
+
+test('api service quote controller finds service quotes and reports missing resources', function () {
+    $quote = new ServiceQuote();
+    $quote->setRawAttributes([
+        'uuid'      => 'service-quote-uuid',
+        'public_id' => 'service_quote_public',
+        'amount'    => 1200,
+        'currency'  => 'USD',
+    ], true);
+
+    $controller               = new FleetOpsApiServiceQuoteControllerProbe();
+    $controller->serviceQuote = $quote;
+
+    expect($controller->find('service_quote_public'))->toBe([
+        'resource'     => 'service-quote',
+        'serviceQuote' => $quote,
+    ])
+        ->and($controller->findCalls)->toBe(['service_quote_public']);
+
+    $controller                       = new FleetOpsApiServiceQuoteControllerProbe();
+    $controller->serviceQuoteNotFound = true;
+
+    expect($controller->find('missing-service-quote'))->toBe([
+        'json'   => ['error' => 'ServiceQuote resource not found.'],
+        'status' => 404,
+    ]);
+});
+
+test('api service quote controller creates preliminary quotes for a single service', function () {
+    $controller              = new FleetOpsApiServiceQuoteControllerProbe();
+    $controller->serviceRate = new FleetOpsApiServiceQuoteRateFake('service-rate-uuid', 1500, 'USD');
+
+    $response = $controller->queryFromPreliminary(QueryServiceQuotesRequest::create('/fleetops/service-quotes', 'POST', [
+        'pickup'       => 'place_pickup',
+        'dropoff'      => 'place_dropoff',
+        'service'      => 'service-rate-uuid',
+        'distance'     => 1200,
+        'time'         => 300,
+        'single'       => true,
+        'cod'          => true,
+        'currency'     => 'USD',
+        'service_type' => 'delivery',
+    ]));
+
+    $quote = $response['serviceQuote'];
+
+    expect($response)->toMatchArray(['resource' => 'service-quote'])
+        ->and($quote)->toBeInstanceOf(FleetOpsApiServiceQuoteFake::class)
+        ->and($controller->placeLookups)->toBe(['place_dropoff'])
+        ->and($controller->createdQuotes)->toBe([[
+            'request_id'        => 'request_public',
+            'company_uuid'      => 'company-uuid',
+            'service_rate_uuid' => 'service-rate-uuid',
+            'amount'            => 1500,
+            'currency'          => 'USD',
+        ]])
+        ->and($controller->createdItems[0]['details'])->toBe([
+            'distance'       => 1200,
+            'time'           => 300,
+            'cod'            => true,
+            'endpoint_count' => 1,
+        ])
+        ->and($quote->metaUpdates['preliminary_data'])->toMatchArray([
+            'pickup'   => 'place_pickup',
+            'dropoff'  => 'place_dropoff',
+            'cod'      => true,
+            'currency' => true,
+        ]);
+});
+
+test('api service quote controller returns a collection for a single service when not asked for one quote', function () {
+    $controller              = new FleetOpsApiServiceQuoteControllerProbe();
+    $controller->serviceRate = new FleetOpsApiServiceQuoteRateFake('service-rate-uuid', 1500, 'USD');
+
+    // A named service still produces exactly one quote, but without `single`
+    // it comes back wrapped as a collection rather than a bare resource.
+    $response = $controller->queryFromPreliminary(QueryServiceQuotesRequest::create('/fleetops/service-quotes', 'POST', [
+        'pickup'   => 'place_pickup',
+        'dropoff'  => 'place_dropoff',
+        'service'  => 'service-rate-uuid',
+        'distance' => 1200,
+        'time'     => 300,
+        'currency' => 'USD',
+    ]));
+
+    expect($response['collection'])->toBe('service-quotes')
+        ->and($response['items'])->toHaveCount(1)
+        ->and($controller->createdQuotes)->toHaveCount(1)
+        ->and($controller->createdQuotes[0]['amount'])->toBe(1500);
+});
+
+test('api service quote controller picks the cheapest serviceable rate for a single quote', function () {
+    $controller               = new FleetOpsApiServiceQuoteControllerProbe();
+    $controller->serviceRates = [
+        new FleetOpsApiServiceQuoteRateFake('service-rate-a', 2500, 'USD'),
+        new FleetOpsApiServiceQuoteRateFake('service-rate-b', 900, 'USD'),
+        new FleetOpsApiServiceQuoteRateFake('service-rate-c', 1700, 'USD'),
+    ];
+
+    $request = QueryServiceQuotesRequest::create('/fleetops/service-quotes', 'POST', [
+        'pickup'   => 'place_pickup',
+        'dropoff'  => 'place_dropoff',
+        'single'   => true,
+        'currency' => 'USD',
+    ]);
+    $session = app('session.store');
+    $session->put('company', 'company-session-uuid');
+    $request->setLaravelSession($session);
+
+    $response = $controller->queryFromPreliminary($request);
+
+    // Every rate is quoted, and the cheapest is the one handed back
+    expect($controller->createdQuotes)->toHaveCount(3)
+        ->and($response['resource'])->toBe('service-quote')
+        ->and($response['serviceQuote']->amount)->toBe(900)
+        // The rate lookup is scoped to the requesting company
+        ->and($controller->serviceRateQuery->wheres)->toBe([
+            ['company_uuid', 'company-session-uuid'],
+        ]);
+});
+
+test('api service quote controller creates preliminary quote collections from serviceable rates', function () {
+    $controller               = new FleetOpsApiServiceQuoteControllerProbe();
+    $controller->serviceRates = [
+        new FleetOpsApiServiceQuoteRateFake('service-rate-a', 2500, 'USD'),
+        new FleetOpsApiServiceQuoteRateFake('service-rate-b', 900, 'USD'),
+    ];
+
+    $request = QueryServiceQuotesRequest::create('/fleetops/service-quotes', 'POST', [
+        'pickup'    => 'place_pickup',
+        'dropoff'   => 'place_dropoff',
+        'waypoints' => [['public_id' => 'place_middle']],
+        'currency'  => 'USD',
+    ]);
+    $session = app('session.store');
+    $session->put('company', 'company-session-uuid');
+    $request->setLaravelSession($session);
+
+    $response = $controller->queryFromPreliminary($request);
+
+    expect($response['collection'])->toBe('service-quotes')
+        ->and($response['items'])->toHaveCount(2)
+        ->and($controller->distanceMatrixCalls)->toHaveCount(1)
+        ->and($controller->createdQuotes)->toHaveCount(2)
+        ->and($controller->createdQuotes[0]['amount'])->toBe(2500)
+        ->and($controller->createdQuotes[1]['amount'])->toBe(900)
+        ->and($controller->createdItems[0]['details'])->toMatchArray([
+            'distance' => 4200,
+            'time'     => 900,
+        ]);
+});

package/server/tests/ApiTrackingNumberControllerContractsTest.php

@@ -0,0 +1,225 @@
+<?php
+
+use Fleetbase\FleetOps\Http\Controllers\Api\v1\TrackingNumberController;
+use Fleetbase\FleetOps\Http\Requests\CreateTrackingNumberRequest;
+use Fleetbase\FleetOps\Http\Requests\DecodeTrackingNumberQR;
+use Fleetbase\FleetOps\Models\TrackingNumber;
+use Fleetbase\FleetOps\Support\Utils;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Http\Request;
+
+class FleetOpsApiTrackingNumberControllerProbe extends TrackingNumberController
+{
+    public ?TrackingNumber $trackingNumber = null;
+    public ?Model $qrModel                 = null;
+    public array $createdTrackingNumbers   = [];
+    public array $ownerLookups             = [];
+    public array $qrLookups                = [];
+    public mixed $ownerResult              = null;
+    public mixed $queryResults             = null;
+    public bool $trackingNumberNotFound    = false;
+
+    protected function getOwnerUuid(array $tables, array $where, array $options)
+    {
+        $this->ownerLookups[] = [$tables, $where, $options];
+
+        return $this->ownerResult;
+    }
+
+    protected function createTrackingNumber(array $input): TrackingNumber
+    {
+        $this->createdTrackingNumbers[] = $input;
+
+        $trackingNumber = new FleetOpsApiTrackingNumberFake();
+        $trackingNumber->setRawAttributes(array_merge(['uuid' => 'created-tracking-number-uuid'], $input));
+
+        return $trackingNumber;
+    }
+
+    protected function queryTrackingNumbers(Request $request)
+    {
+        return $this->queryResults ?? [['uuid' => 'tracking-number-uuid']];
+    }
+
+    protected function findTrackingNumber(string $id): TrackingNumber
+    {
+        if ($this->trackingNumberNotFound) {
+            throw new ModelNotFoundException();
+        }
+
+        $this->trackingNumber?->setAttribute('lookup_id', $id);
+
+        return $this->trackingNumber;
+    }
+
+    protected function trackingNumberResource(TrackingNumber $trackingNumber)
+    {
+        return ['resource' => 'tracking-number', 'trackingNumber' => $trackingNumber];
+    }
+
+    protected function trackingNumberResourceCollection($results)
+    {
+        return ['collection' => 'tracking-number', 'items' => $results];
+    }
+
+    protected function deletedTrackingNumberResource(TrackingNumber $trackingNumber)
+    {
+        return ['resource' => 'deleted-tracking-number', 'trackingNumber' => $trackingNumber];
+    }
+
+    protected function findQrModel(array $tables, array $where)
+    {
+        $this->qrLookups[] = [$tables, $where];
+
+        return $this->qrModel;
+    }
+
+    protected function qrModelResource($model)
+    {
+        return ['resource' => 'qr-model', 'model' => $model];
+    }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return ['json' => $payload, 'status' => $status];
+    }
+}
+
+class FleetOpsApiTrackingNumberFake extends TrackingNumber
+{
+    public bool $deletedForTest = false;
+
+    public function delete()
+    {
+        $this->deletedForTest = true;
+
+        return true;
+    }
+}
+
+function fleetopsCreateTrackingNumberRequest(array $input): CreateTrackingNumberRequest
+{
+    return CreateTrackingNumberRequest::create('/api/v1/tracking-numbers', 'POST', $input);
+}
+
+function fleetopsDecodeTrackingNumberQrRequest(array $input): DecodeTrackingNumberQR
+{
+    return DecodeTrackingNumberQR::create('/api/v1/tracking-numbers/from-qr', 'POST', $input);
+}
+
+test('api tracking number controller creates tracking numbers with owner assignment', function () {
+    session(['company' => 'company-uuid']);
+
+    $controller              = new FleetOpsApiTrackingNumberControllerProbe();
+    $controller->ownerResult = ['uuid' => 'owner-uuid', 'table' => 'orders'];
+
+    $response = $controller->create(fleetopsCreateTrackingNumberRequest([
+        'region'  => 'SG',
+        'type'    => 'country',
+        'status'  => 'active',
+        'owner'   => 'order-public',
+        'ignored' => 'not copied',
+    ]));
+
+    expect($response['resource'])->toBe('tracking-number')
+        ->and($controller->ownerLookups)->toBe([
+            [
+                ['orders', 'entities'],
+                [
+                    'public_id'    => 'order-public',
+                    'company_uuid' => 'company-uuid',
+                ],
+                ['with_table' => true],
+            ],
+        ])
+        ->and($controller->createdTrackingNumbers[0])->toMatchArray([
+            'region'       => 'SG',
+            'type'         => 'country',
+            'company_uuid' => 'company-uuid',
+            'owner_uuid'   => 'owner-uuid',
+            'owner_type'   => Utils::getModelClassName('orders'),
+        ])
+        ->and($controller->createdTrackingNumbers[0])->not->toHaveKey('status')
+        ->and($controller->createdTrackingNumbers[0])->not->toHaveKey('ignored');
+});
+
+test('api tracking number controller skips owner assignment when lookup is not resolved', function () {
+    session(['company' => 'company-uuid']);
+
+    $controller              = new FleetOpsApiTrackingNumberControllerProbe();
+    $controller->ownerResult = null;
+
+    $response = $controller->create(fleetopsCreateTrackingNumberRequest([
+        'region' => 'MN',
+        'owner'  => 'missing-owner',
+    ]));
+
+    expect($response['resource'])->toBe('tracking-number')
+        ->and($controller->createdTrackingNumbers[0])->toMatchArray([
+            'region'       => 'MN',
+            'company_uuid' => 'company-uuid',
+        ])
+        ->and($controller->createdTrackingNumbers[0])->not->toHaveKey('owner_uuid')
+        ->and($controller->createdTrackingNumbers[0])->not->toHaveKey('owner_type');
+});
+
+test('api tracking number controller queries finds deletes and handles missing resources', function () {
+    $trackingNumber = new FleetOpsApiTrackingNumberFake();
+    $trackingNumber->setRawAttributes(['uuid' => 'tracking-number-uuid']);
+
+    $controller                 = new FleetOpsApiTrackingNumberControllerProbe();
+    $controller->trackingNumber = $trackingNumber;
+    $controller->queryResults   = [['uuid' => 'tracking-a'], ['uuid' => 'tracking-b']];
+
+    $query   = $controller->query(new Request(['limit' => 2]));
+    $found   = $controller->find('tracking-public');
+    $deleted = $controller->delete('tracking-public', new Request());
+
+    expect($query)->toBe([
+        'collection' => 'tracking-number',
+        'items'      => [['uuid' => 'tracking-a'], ['uuid' => 'tracking-b']],
+    ])
+        ->and($found)->toBe(['resource' => 'tracking-number', 'trackingNumber' => $trackingNumber])
+        ->and($deleted)->toBe(['resource' => 'deleted-tracking-number', 'trackingNumber' => $trackingNumber])
+        ->and($trackingNumber->lookup_id)->toBe('tracking-public')
+        ->and($trackingNumber->deletedForTest)->toBeTrue();
+
+    $controller                         = new FleetOpsApiTrackingNumberControllerProbe();
+    $controller->trackingNumberNotFound = true;
+
+    $expected = [
+        'json'   => ['error' => 'TrackingNumber resource not found.'],
+        'status' => 404,
+    ];
+
+    expect($controller->find('missing-tracking-number'))->toBe($expected)
+        ->and($controller->delete('missing-tracking-number', new Request()))->toBe($expected);
+});
+
+test('api tracking number controller decodes qr models and reports missing values', function () {
+    $model = new class extends Model {
+        protected $table = 'orders';
+    };
+    $model->setRawAttributes(['uuid' => 'order-uuid']);
+
+    $controller          = new FleetOpsApiTrackingNumberControllerProbe();
+    $controller->qrModel = $model;
+
+    $response = $controller->fromQR(fleetopsDecodeTrackingNumberQrRequest(['code' => 'order-uuid']));
+
+    expect($response)->toBe(['resource' => 'qr-model', 'model' => $model])
+        ->and($controller->qrLookups)->toBe([
+            [
+                ['entities', 'orders'],
+                ['uuid' => 'order-uuid'],
+            ],
+        ]);
+
+    $controller = new FleetOpsApiTrackingNumberControllerProbe();
+
+    expect($controller->fromQR(fleetopsDecodeTrackingNumberQrRequest(['code' => 'missing-uuid'])))->toBe([
+        'json'   => ['error' => 'Unable to find QR code value'],
+        'status' => 400,
+    ]);
+});