@fleetbase/fleetops-engine 0.6.58 → 0.6.59

package/server/tests/ApiPartControllerContractsTest.php

@@ -0,0 +1,251 @@
+<?php
+
+use Fleetbase\FleetOps\Http\Controllers\Api\v1\PartController;
+use Fleetbase\FleetOps\Http\Requests\CreatePartRequest;
+use Fleetbase\FleetOps\Http\Requests\UpdatePartRequest;
+use Fleetbase\FleetOps\Models\Part;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Http\Request;
+
+class FleetOpsApiPartControllerProbe extends PartController
+{
+    public ?Part $part           = null;
+    public array $createdParts   = [];
+    public array $resolvedUuids  = [];
+    public array $resolvedMorphs = [];
+    public mixed $queryResults   = null;
+    public bool $partNotFound    = false;
+
+    protected function createPart(array $input): Part
+    {
+        $this->createdParts[] = $input;
+
+        $part = new FleetOpsApiPartFake();
+        $part->setRawAttributes(array_merge(['uuid' => 'created-part-uuid'], $input));
+
+        return $part;
+    }
+
+    protected function resolveModel(string $modelClass, string $id): Illuminate\Database\Eloquent\Model
+    {
+        if ($this->partNotFound) {
+            throw new ModelNotFoundException();
+        }
+
+        $this->part?->setAttribute('lookup_id', $id);
+
+        return $this->part;
+    }
+
+    protected function resolveUuid(string $modelClass, ?string $id): ?string
+    {
+        $this->resolvedUuids[] = [$modelClass, $id];
+
+        return $id ? $id . '-uuid' : null;
+    }
+
+    protected function resolveMorph(?string $type, ?string $id): array
+    {
+        $this->resolvedMorphs[] = [$type, $id];
+
+        return [$type ? 'resolved-' . $type : null, $id ? $id . '-uuid' : null];
+    }
+
+    protected function queryParts(Request $request, callable $callback)
+    {
+        $query = new FleetOpsApiPartQueryFake();
+        $callback($query);
+
+        $this->queryResults                = $this->queryResults ?? [['uuid' => 'part-uuid']];
+        $this->queryResults['query_calls'] = $query->calls;
+
+        return $this->queryResults;
+    }
+
+    protected function partResource(Part $part)
+    {
+        return ['resource' => 'part', 'part' => $part];
+    }
+
+    protected function partResourceCollection($results)
+    {
+        return ['collection' => 'part', 'items' => $results];
+    }
+
+    protected function deletedPartResource(Part $part)
+    {
+        return ['resource' => 'deleted-part', 'part' => $part];
+    }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return ['json' => $payload, 'status' => $status];
+    }
+}
+
+class FleetOpsApiPartFake extends Part
+{
+    public array $loads           = [];
+    public array $updates         = [];
+    public bool $refreshedForTest = false;
+    public bool $deletedForTest   = false;
+
+    public function load($relations)
+    {
+        $this->loads[] = $relations;
+
+        return $this;
+    }
+
+    public function update(array $attributes = [], array $options = []): bool
+    {
+        $this->updates[] = $attributes;
+        $this->setRawAttributes(array_merge($this->getAttributes(), $attributes));
+
+        return true;
+    }
+
+    public function refresh()
+    {
+        $this->refreshedForTest = true;
+
+        return $this;
+    }
+
+    public function delete()
+    {
+        $this->deletedForTest = true;
+
+        return true;
+    }
+}
+
+class FleetOpsApiPartQueryFake
+{
+    public array $calls = [];
+
+    public function with(array $relations): void
+    {
+        $this->calls[] = ['with', $relations];
+    }
+}
+
+function fleetopsCreatePartRequest(array $input): CreatePartRequest
+{
+    return CreatePartRequest::create('/api/v1/parts', 'POST', $input);
+}
+
+function fleetopsUpdatePartRequest(array $input): UpdatePartRequest
+{
+    return UpdatePartRequest::create('/api/v1/parts/part-public', 'PUT', $input);
+}
+
+test('api part controller creates parts with public relation and morph resolution', function () {
+    session(['company' => 'company-uuid']);
+
+    $controller = new FleetOpsApiPartControllerProbe();
+
+    $response = $controller->create(fleetopsCreatePartRequest([
+        'sku'              => 'SKU-1',
+        'name'             => 'Brake Pad',
+        'manufacturer'     => 'Acme',
+        'model'            => 'BP-100',
+        'serial_number'    => 'SER-1',
+        'barcode'          => 'BAR-1',
+        'description'      => 'Front brake pad',
+        'quantity_on_hand' => 12,
+        'unit_cost'        => 15.5,
+        'msrp'             => 25,
+        'currency'         => 'USD',
+        'type'             => 'consumable',
+        'status'           => 'active',
+        'specs'            => ['axle' => 'front'],
+        'meta'             => ['source' => 'api'],
+        'vendor'           => 'vendor-public',
+        'warranty'         => 'warranty-public',
+        'photo'            => '',
+        'asset_type'       => 'vehicle',
+        'asset'            => 'vehicle-public',
+        'ignored'          => 'not copied',
+    ]));
+
+    expect($response['resource'])->toBe('part')
+        ->and($controller->createdParts)->toHaveCount(1)
+        ->and($controller->createdParts[0])->toMatchArray([
+            'sku'              => 'SKU-1',
+            'name'             => 'Brake Pad',
+            'manufacturer'     => 'Acme',
+            'model'            => 'BP-100',
+            'serial_number'    => 'SER-1',
+            'barcode'          => 'BAR-1',
+            'description'      => 'Front brake pad',
+            'quantity_on_hand' => 12,
+            'unit_cost'        => 15.5,
+            'msrp'             => 25,
+            'currency'         => 'USD',
+            'type'             => 'consumable',
+            'status'           => 'active',
+            'specs'            => ['axle' => 'front'],
+            'meta'             => ['source' => 'api'],
+            'company_uuid'     => 'company-uuid',
+            'vendor_uuid'      => 'vendor-public-uuid',
+            'warranty_uuid'    => 'warranty-public-uuid',
+            'photo_uuid'       => null,
+            'asset_type'       => 'resolved-vehicle',
+            'asset_uuid'       => 'vehicle-public-uuid',
+        ])
+        ->and($controller->createdParts[0])->not->toHaveKey('ignored')
+        ->and($response['part']->loads)->toBe([['vendor', 'warranty', 'photo', 'asset']]);
+});
+
+test('api part controller updates finds queries and deletes parts', function () {
+    $part = new FleetOpsApiPartFake();
+    $part->setRawAttributes(['uuid' => 'part-uuid', 'name' => 'Old Part']);
+
+    $controller               = new FleetOpsApiPartControllerProbe();
+    $controller->part         = $part;
+    $controller->queryResults = [['uuid' => 'part-a'], ['uuid' => 'part-b']];
+
+    $updated = $controller->update('part-public', fleetopsUpdatePartRequest([
+        'name'       => 'Updated Part',
+        'vendor'     => 'vendor-public',
+        'warranty'   => '',
+        'photo'      => 'photo-public',
+        'asset'      => '',
+        'asset_type' => 'vehicle',
+    ]));
+    $found   = $controller->find('part-public');
+    $query   = $controller->query(new Request(['limit' => 2]));
+    $deleted = $controller->delete('part-public');
+
+    expect($updated['resource'])->toBe('part')
+        ->and($part->updates[0])->toMatchArray([
+            'name'          => 'Updated Part',
+            'vendor_uuid'   => 'vendor-public-uuid',
+            'warranty_uuid' => null,
+            'photo_uuid'    => 'photo-public-uuid',
+            'asset_type'    => null,
+            'asset_uuid'    => null,
+        ])
+        ->and($part->refreshedForTest)->toBeTrue()
+        ->and($part->loads)->toContain(['vendor', 'warranty', 'photo', 'asset'])
+        ->and($found)->toBe(['resource' => 'part', 'part' => $part])
+        ->and($query['collection'])->toBe('part')
+        ->and($query['items']['query_calls'])->toBe([['with', ['vendor', 'warranty', 'photo', 'asset']]])
+        ->and($deleted)->toBe(['resource' => 'deleted-part', 'part' => $part])
+        ->and($part->deletedForTest)->toBeTrue();
+});
+
+test('api part controller returns missing part responses for update find and delete', function () {
+    $controller               = new FleetOpsApiPartControllerProbe();
+    $controller->partNotFound = true;
+
+    $expected = [
+        'json'   => ['error' => 'Part resource not found.'],
+        'status' => 404,
+    ];
+
+    expect($controller->update('missing-part', fleetopsUpdatePartRequest(['name' => 'Missing'])))->toBe($expected)
+        ->and($controller->find('missing-part'))->toBe($expected)
+        ->and($controller->delete('missing-part'))->toBe($expected);
+});

package/server/tests/ApiPayloadControllerContractsTest.php

@@ -0,0 +1,314 @@
+<?php
+
+use Fleetbase\FleetOps\Http\Controllers\Api\v1\PayloadController;
+use Fleetbase\FleetOps\Http\Requests\CreatePayloadRequest;
+use Fleetbase\FleetOps\Http\Requests\UpdatePayloadRequest;
+use Fleetbase\FleetOps\Models\Payload;
+use Fleetbase\FleetOps\Models\Place;
+use Fleetbase\FleetOps\Models\Waypoint;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Http\Request;
+
+class FleetOpsApiPayloadControllerProbe extends PayloadController
+{
+    public ?FleetOpsApiPayloadEndpointFake $payload = null;
+    public array $createdPayloads                   = [];
+    public mixed $queryResults                      = null;
+    public bool $payloadNotFound                    = false;
+
+    protected function newPayload(array $input): Payload
+    {
+        $payload = new FleetOpsApiPayloadEndpointFake();
+        $payload->setRawAttributes($input, true);
+        $payload->firstWaypoint  = fleetopsApiPayloadPlace();
+        $this->createdPayloads[] = $payload;
+
+        return $payload;
+    }
+
+    protected function findPayloadOrFail(string $id, array $with = []): Payload
+    {
+        if ($this->payloadNotFound) {
+            throw new ModelNotFoundException();
+        }
+
+        $this->payload ??= new FleetOpsApiPayloadEndpointFake();
+        $this->payload->lookupId   = $id;
+        $this->payload->lookupWith = $with;
+
+        return $this->payload;
+    }
+
+    protected function queryPayloads(Request $request): mixed
+    {
+        return $this->queryResults ?? [['uuid' => 'payload-1']];
+    }
+
+    protected function payloadResource(Payload $payload): array
+    {
+        return ['resource' => 'payload', 'payload' => $payload];
+    }
+
+    protected function payloadResourceCollection(mixed $results): array
+    {
+        return ['collection' => 'payload', 'items' => $results];
+    }
+
+    protected function deletedPayloadResource(Payload $payload): array
+    {
+        return ['resource' => 'deleted-payload', 'payload' => $payload];
+    }
+
+    protected function jsonResponse(array $payload, int $status): array
+    {
+        return ['json' => $payload, 'status' => $status];
+    }
+}
+
+class FleetOpsApiPayloadEndpointFake extends Payload
+{
+    public array $pickupAssignments          = [];
+    public array $dropoffAssignments         = [];
+    public array $returnAssignments          = [];
+    public array $waypointAssignments        = [];
+    public array $entityAssignments          = [];
+    public array $currentWaypointAssignments = [];
+    public array $loadedRelations            = [];
+    public array $filledPayloads             = [];
+    public bool $removedWaypoints            = false;
+    public bool $savedForTest                = false;
+    public bool $deletedForTest              = false;
+    public ?Place $firstWaypoint             = null;
+    public ?string $lookupId                 = null;
+    public array $lookupWith                 = [];
+
+    public function setPickup($place, array $options = [])
+    {
+        $this->pickupAssignments[] = $place;
+
+        return $this;
+    }
+
+    public function setDropoff($place, array $options = [])
+    {
+        $this->dropoffAssignments[] = $place;
+
+        return $this;
+    }
+
+    public function setReturn($place, array $options = [])
+    {
+        $this->returnAssignments[] = $place;
+
+        return $this;
+    }
+
+    public function setWaypoints($waypoints = [])
+    {
+        $this->waypointAssignments[] = $waypoints;
+
+        return $this;
+    }
+
+    public function removeWaypoints()
+    {
+        $this->removedWaypoints = true;
+
+        return $this;
+    }
+
+    public function setEntities($entities = [])
+    {
+        $this->entityAssignments[] = $entities;
+
+        return $this;
+    }
+
+    public function getPickupOrFirstWaypoint(): ?Place
+    {
+        return $this->firstWaypoint;
+    }
+
+    public function setCurrentWaypoint(Place|Waypoint $destination, bool $save = true): Payload
+    {
+        $this->currentWaypointAssignments[] = $destination->uuid;
+
+        return $this;
+    }
+
+    public function fill(array $attributes)
+    {
+        $this->filledPayloads[] = $attributes;
+
+        return parent::fill($attributes);
+    }
+
+    public function save(array $options = []): bool
+    {
+        $this->savedForTest = true;
+
+        return true;
+    }
+
+    public function load($relations)
+    {
+        $this->loadedRelations[] = $relations;
+
+        return $this;
+    }
+
+    public function delete()
+    {
+        $this->deletedForTest = true;
+
+        return true;
+    }
+}
+
+class FleetOpsApiPayloadEndpointPlaceFake extends Place
+{
+}
+
+function fleetopsCreatePayloadRequest(array $input): CreatePayloadRequest
+{
+    return CreatePayloadRequest::create('/api/v1/payloads', 'POST', $input);
+}
+
+function fleetopsUpdatePayloadRequest(array $input): UpdatePayloadRequest
+{
+    return new FleetOpsUpdatePayloadEndpointRequestFake($input);
+}
+
+class FleetOpsUpdatePayloadEndpointRequestFake extends UpdatePayloadRequest
+{
+    public function __construct(private array $payload)
+    {
+        parent::__construct();
+    }
+
+    public function all($keys = null): array
+    {
+        return $this->payload;
+    }
+}
+
+function fleetopsApiPayloadPlace(): FleetOpsApiPayloadEndpointPlaceFake
+{
+    $place = new FleetOpsApiPayloadEndpointPlaceFake();
+    $place->setRawAttributes(['uuid' => 'place-uuid'], true);
+
+    return $place;
+}
+
+function fleetopsApiPayloadController(): FleetOpsApiPayloadControllerProbe
+{
+    $controller                         = new FleetOpsApiPayloadControllerProbe();
+    $controller->payload                = new FleetOpsApiPayloadEndpointFake();
+    $controller->queryResults           = [['uuid' => 'payload-1'], ['uuid' => 'payload-2']];
+    $controller->payload->firstWaypoint = fleetopsApiPayloadPlace();
+
+    return $controller;
+}
+
+test('api payload controller creates payloads with route shape assignments', function () {
+    session(['company' => 'company-uuid']);
+    $controller = fleetopsApiPayloadController();
+    $request    = fleetopsCreatePayloadRequest([
+        'type'               => 'parcel',
+        'provider'           => 'native',
+        'meta'               => ['source' => 'api'],
+        'cod_amount'         => 120,
+        'cod_currency'       => 'SGD',
+        'cod_payment_method' => 'cash',
+        'pickup'             => ['public_id' => 'pickup-public'],
+        'dropoff'            => ['public_id' => 'dropoff-public'],
+        'return'             => ['public_id' => 'return-public'],
+        'waypoints'          => [['public_id' => 'waypoint-public']],
+        'entities'           => [['name' => 'Box']],
+        'ignored'            => 'nope',
+    ]);
+
+    $response = $controller->create($request);
+    $payload  = $response['payload'];
+
+    expect($response['resource'])->toBe('payload')
+        ->and($payload->getAttributes())->toMatchArray([
+            'type'               => 'parcel',
+            'provider'           => 'native',
+            'meta'               => ['source' => 'api'],
+            'cod_amount'         => 120,
+            'cod_currency'       => 'SGD',
+            'cod_payment_method' => 'cash',
+        ])
+        ->and($payload->pickupAssignments)->toBe([['public_id' => 'pickup-public']])
+        ->and($payload->dropoffAssignments)->toBe([['public_id' => 'dropoff-public']])
+        ->and($payload->returnAssignments)->toBe([['public_id' => 'return-public']])
+        ->and($payload->waypointAssignments)->toBe([[['public_id' => 'waypoint-public']]])
+        ->and($payload->entityAssignments)->toBe([[['name' => 'Box']]])
+        ->and($payload->currentWaypointAssignments)->toBe(['place-uuid'])
+        ->and($payload->savedForTest)->toBeTrue();
+});
+
+test('api payload controller updates route shape and removes waypoints when endpoints are explicit', function () {
+    $controller = fleetopsApiPayloadController();
+    $request    = fleetopsUpdatePayloadRequest([
+        'type'     => 'freight',
+        'provider' => 'native',
+        'pickup'   => ['public_id' => 'pickup-public'],
+        'entities' => [['name' => 'Pallet']],
+    ]);
+
+    $response = $controller->update('payload-public', $request);
+    $payload  = $response['payload'];
+
+    expect($payload->lookupId)->toBe('payload-public')
+        ->and($payload->lookupWith)->toBe(['waypoints'])
+        ->and($payload->pickupAssignments)->toBe([['public_id' => 'pickup-public']])
+        ->and($payload->removedWaypoints)->toBeTrue()
+        ->and($payload->entityAssignments)->toBe([[['name' => 'Pallet']]])
+        ->and($payload->currentWaypointAssignments)->toBe(['place-uuid'])
+        ->and($payload->loadedRelations)->toBe([['entities', 'waypoints', 'pickup', 'dropoff', 'return']]);
+});
+
+test('api payload controller keeps explicit waypoint updates and skips empty entity updates', function () {
+    $controller = fleetopsApiPayloadController();
+    $request    = fleetopsUpdatePayloadRequest([
+        'waypoints' => [['public_id' => 'waypoint-public']],
+        'entities'  => [],
+    ]);
+
+    $response = $controller->update('payload-public', $request);
+    $payload  = $response['payload'];
+
+    expect($payload->waypointAssignments)->toBe([[['public_id' => 'waypoint-public']]])
+        ->and($payload->removedWaypoints)->toBeFalse()
+        ->and($payload->entityAssignments)->toBe([])
+        ->and($payload->savedForTest)->toBeTrue();
+});
+
+test('api payload controller queries finds and deletes payload resources', function () {
+    $controller = fleetopsApiPayloadController();
+
+    $query   = $controller->query(new Request(['limit' => 2]));
+    $found   = $controller->find('payload-public', new Request());
+    $deleted = $controller->delete('payload-public', new Request());
+
+    expect($query)->toBe(['collection' => 'payload', 'items' => [['uuid' => 'payload-1'], ['uuid' => 'payload-2']]])
+        ->and($found)->toBe(['resource' => 'payload', 'payload' => $controller->payload])
+        ->and($deleted)->toBe(['resource' => 'deleted-payload', 'payload' => $controller->payload])
+        ->and($controller->payload->deletedForTest)->toBeTrue();
+});
+
+test('api payload controller returns not found responses for missing payloads', function (string $method) {
+    $controller                  = fleetopsApiPayloadController();
+    $controller->payloadNotFound = true;
+
+    $response = $method === 'update'
+        ? $controller->update('missing-payload', fleetopsUpdatePayloadRequest([]))
+        : $controller->{$method}('missing-payload', new Request());
+
+    expect($response)->toBe([
+        'json'   => ['error' => 'Payload resource not found.'],
+        'status' => 404,
+    ]);
+})->with(['update', 'find', 'delete']);