@fleetbase/fleetops-engine 0.6.71 → 0.6.72

package/server/src/Listeners/HandleGeofenceEntered.php

@@ -6,7 +6,10 @@ use Fleetbase\FleetOps\Events\GeofenceEntered;
 use Fleetbase\FleetOps\Flow\Activity;
 use Fleetbase\FleetOps\Models\GeofenceEventLog;
 use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Models\Payload;
+use Fleetbase\FleetOps\Models\Place;
 use Fleetbase\FleetOps\Notifications\DriverArrivedAtGeofence;
+use Fleetbase\FleetOps\Support\ResolvesOrderServiceStops;
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Support\Facades\Log;
@@ -24,6 +27,7 @@ use Illuminate\Support\Str;
 class HandleGeofenceEntered implements ShouldQueue
 {
     use InteractsWithQueue;
+    use ResolvesOrderServiceStops;
 
     /**
      * The number of times the job may be attempted.
@@ -89,10 +93,11 @@ class HandleGeofenceEntered implements ShouldQueue
             return;
         }
 
-        // Get the current destination waypoint
-        $destination = null;
+        // Resolve the stop the driver is currently heading to: the pickup
+        // until it is completed, then the next waypoint or the dropoff.
+        $place = null;
         try {
-            $destination = $order->payload?->getPickupOrCurrentWaypoint();
+            $place = $this->currentDestination($order);
         } catch (\Throwable $e) {
             Log::warning('GeofenceEntered: Could not resolve order destination', [
                 'order_uuid'  => $order->uuid,
@@ -103,18 +108,6 @@ class HandleGeofenceEntered implements ShouldQueue
             return;
         }
 
-        if (!$destination) {
-            return;
-        }
-
-        // Resolve the destination place
-        $place = null;
-        try {
-            $place = $destination->place ?? $destination->getPlace();
-        } catch (\Throwable $e) {
-            return;
-        }
-
         if (!$place || !$place->location) {
             return;
         }
@@ -171,6 +164,29 @@ class HandleGeofenceEntered implements ShouldQueue
         }
     }
 
+    /**
+     * Resolve the place of the order's current destination stop.
+     *
+     * Uses the payload's current service stop (pickup, waypoints, dropoff in
+     * sequence, tracked by `current_waypoint_uuid`). When that stop has
+     * already been completed but the pointer was not advanced, the next
+     * incomplete stop is the destination instead.
+     */
+    protected function currentDestination(Order $order): ?Place
+    {
+        $payload = $order->payload;
+        if (!$payload instanceof Payload) {
+            return null;
+        }
+
+        $stop = $this->payloadCurrentServiceStop($payload);
+        if ($stop && $this->serviceStopIsComplete($order, $payload, $stop)) {
+            $stop = $this->nextIncompleteServiceStop($order, $payload);
+        }
+
+        return $stop['place'] ?? null;
+    }
+
     /**
      * Calculate the haversine distance in metres between two lat/lng points.
      *

package/server/src/Listeners/HandleOrderCanceled.php

@@ -12,6 +12,11 @@ class HandleOrderCanceled implements ShouldQueue
 {
     use InteractsWithQueue;
 
+    /**
+     * The reason the order being handled was canceled.
+     */
+    protected string $reason = '';
+
     /**
      * Handle the event.
      *
@@ -21,6 +26,9 @@ class HandleOrderCanceled implements ShouldQueue
      */
     public function handle(OrderCanceled $event)
     {
+        // the cancellation reason travels as the canceled activity's details
+        $this->reason = (string) ($event->activity ? $event->activity->get('details', '') : '');
+
         /** @var \Fleetbase\FleetOps\Models\Order $order */
         $order    = $event->getModelRecord();
         if ($order->isIntegratedVendorOrder()) {
@@ -50,6 +58,6 @@ class HandleOrderCanceled implements ShouldQueue
 
     protected function notifyAssignedDriver(Driver $driver, $order): void
     {
-        $driver->notify(new OrderCanceledNotification($order));
+        $driver->notify(new OrderCanceledNotification($order, $this->reason));
     }
 }

package/server/src/Listeners/HandleUserRemovedFromCompany.php

@@ -26,7 +26,8 @@ class HandleUserRemovedFromCompany implements ShouldQueue
 
     protected function deleteDriversForCompanyUser(string $companyUuid, string $userUuid): void
     {
-        $this->driverQueryForCompanyUser($companyUuid, $userUuid)->delete();
+        // Delete each driver through the model so DriverObserver cleans up after it
+        $this->driverQueryForCompanyUser($companyUuid, $userUuid)->get()->each->delete();
     }
 
     protected function driverQueryForCompanyUser(string $companyUuid, string $userUuid): mixed

package/server/src/Listeners/PublishTrackingUpdates.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Fleetbase\FleetOps\Listeners;
+
+use Fleetbase\FleetOps\Support\TrackingPublisher;
+
+/**
+ * Queues public tracking updates when a waypoint's or an entity's activity changes.
+ *
+ * Runs synchronously but only looks up the order and queues a job, and does nothing at all
+ * while socket authentication is off.
+ */
+class PublishTrackingUpdates
+{
+    public function __construct(protected ?TrackingPublisher $publisher = null)
+    {
+        $this->publisher ??= app(TrackingPublisher::class);
+    }
+
+    /**
+     * @param \Fleetbase\FleetOps\Events\WaypointActivityChanged|\Fleetbase\FleetOps\Events\WaypointCompleted|\Fleetbase\FleetOps\Events\EntityActivityChanged|\Fleetbase\FleetOps\Events\EntityCompleted $event
+     */
+    public function handle(object $event): bool
+    {
+        return $this->publisher->stopChanged($event->waypoint ?? $event->entity ?? null);
+    }
+}

package/server/src/Mail/CustomerCredentialsMail.php

@@ -73,8 +73,10 @@ class CustomerCredentialsMail extends Mailable
     private function getCustomerPortalAccessUrl(): string
     {
         $customerPortalConfig = Setting::lookupForCompany($this->customer->company_uuid, 'customer-portal-config');
-        $accessUrlSlug        = data_get($customerPortalConfig, 'accessUrlSlug', 'customer-portal');
+        $accessUrlSlug        = data_get($customerPortalConfig, 'accessUrlSlug');
 
-        return Utils::consoleUrl($accessUrlSlug ?: 'customer-portal');
+        // The portal resolves a company's access slug under /customer-access/{slug};
+        // without one, send the customer to the portal's own sign-in route.
+        return Utils::consoleUrl($accessUrlSlug ? 'customer-access/' . $accessUrlSlug : 'customer-portal');
     }
 }

package/server/src/Models/AssetConnection.php

@@ -5,6 +5,7 @@ namespace Fleetbase\FleetOps\Models;
 use Fleetbase\Casts\Json;
 use Fleetbase\Casts\PolymorphicType;
 use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasApiModelCache;
 use Fleetbase\Traits\HasPublicId;
 use Fleetbase\Traits\HasUuid;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
@@ -14,6 +15,8 @@ use Illuminate\Database\Eloquent\SoftDeletes;
 class AssetConnection extends Model
 {
     use HasUuid;
+    // Writes bump the asset_connections API cache version, which cached vehicle lists filter on.
+    use HasApiModelCache;
     use HasPublicId;
     use SoftDeletes;
 

package/server/src/Models/Contact.php

@@ -417,6 +417,7 @@ class Contact extends Model
                 ]);
                 $user->forceFill(['type' => 'customer'])->saveQuietly();
                 $this->forceFill(['user_uuid' => $user->uuid])->saveQuietly();
+                $this->invalidateApiCache();
             } else {
                 $user = $this->createUser();
             }
@@ -645,6 +646,8 @@ class Contact extends Model
             return null;
         }
 
+        ProfileAccountManager::copyAccountToSandbox($user, $contact->company->uuid);
+
         $role        = $contact->isCustomer() ? 'Fleet-Ops Customer' : 'Fleet-Ops Contact';
         $companyUser = $contact->company->addUser($user, $role);
 

package/server/src/Models/Device.php

@@ -56,6 +56,18 @@ class Device extends Model
      */
     protected $table = 'devices';
 
+    /**
+     * Relation paths and tables the cached device lists embed (fleetbase/core-api#301).
+     *
+     * Lists load telematic, warranty and attachable and count sensors.
+     * attachable is a morphTo to a vehicle or trailer, so its tables are named.
+     * photo (public list) is left out: files is written by every upload, and a
+     * new photo is set by writing the device's own photo_uuid.
+     *
+     * @var string[]
+     */
+    protected $apiCacheDependencies = ['telematic', 'warranty', 'sensors', 'vehicles', 'assets'];
+
     /**
      * The type of public Id to generate.
      *
@@ -453,6 +465,10 @@ class Device extends Model
         });
 
         if ($updated) {
+            // Cached vehicle and trailer lists filter on attached devices without depending on
+            // the device table, which telemetry writes on every ping
+            static::invalidateAttachableApiCache($attachable, $this->company_uuid);
+
             activity('device_attached')
                 ->performedOn($this)
                 ->withProperties([
@@ -466,6 +482,14 @@ class Device extends Model
         return $updated;
     }
 
+    /**
+     * Invalidate the cached lists of the attached model's table (vehicles or trailers).
+     */
+    protected static function invalidateAttachableApiCache(\Illuminate\Database\Eloquent\Model $attachable, ?string $companyUuid): void
+    {
+        \Fleetbase\Support\ApiModelCache::invalidateModelCache($attachable, $companyUuid);
+    }
+
     /**
      * Detach the device from its current attachment.
      */
@@ -483,6 +507,10 @@ class Device extends Model
             return $this->update(['attachable_type' => null, 'attachable_uuid' => null]);
         });
 
+        if ($updated && $oldAttachableType && is_a($oldAttachableType, \Illuminate\Database\Eloquent\Model::class, true)) {
+            static::invalidateAttachableApiCache(new $oldAttachableType(), $this->company_uuid);
+        }
+
         if ($updated) {
             activity('device_detached')
                 ->performedOn($this)

package/server/src/Models/DeviceEvent.php

@@ -46,6 +46,13 @@ class DeviceEvent extends Model
      */
     protected $table = 'device_events';
 
+    /**
+     * Relation paths the cached device event lists embed (fleetbase/core-api#301).
+     *
+     * @var string[]
+     */
+    protected $apiCacheDependencies = ['device', 'device.telematic'];
+
     /**
      * The type of public Id to generate.
      *

package/server/src/Models/Driver.php

@@ -171,6 +171,17 @@ class Driver extends Model
      */
     protected $with = [];
 
+    /**
+     * Relation paths the cached driver lists depend on (fleetbase/core-api#301).
+     *
+     * Lists eager load nothing, but which drivers they hold depends on the
+     * user (existence, name, email and phone search), the vehicle (vehicle
+     * search) and the fleets (fleet filter, through fleet_drivers).
+     *
+     * @var string[]
+     */
+    protected $apiCacheDependencies = ['user', 'vehicle', 'fleets'];
+
     /**
      * Dynamic attributes that are appended to object.
      *
@@ -272,10 +283,7 @@ class Driver extends Model
         return $this->belongsTo(\Fleetbase\Models\Company::class);
     }
 
-    /**
-     * @return BelongsTo
-     */
-    public function vehicle()
+    public function vehicle(): BelongsTo
     {
         return $this->belongsTo(Vehicle::class)->select([
             'uuid',
@@ -431,7 +439,8 @@ class Driver extends Model
             return static::getAvatar($value);
         }
 
-        return $value;
+        // legacy rows hold an absolute URL; re-sign it if it points into the private media bucket
+        return Utils::signStoredFileUrl($value);
     }
 
     /**
@@ -669,8 +678,12 @@ class Driver extends Model
      */
     public function assignVehicle(Vehicle $vehicle): self
     {
-        // Unassign vehicle from other drivers
-        static::where('vehicle_uuid', $vehicle->uuid)->update(['vehicle_uuid' => null]);
+        // Unassign vehicle from other drivers. This driver is skipped: when it already holds the
+        // vehicle the save below isn't dirty, so it would not write the vehicle back
+        static::where('vehicle_uuid', $vehicle->uuid)
+            ->when($this->uuid, fn ($query) => $query->where('uuid', '!=', $this->uuid))
+            ->update(['vehicle_uuid' => null]);
+        static::invalidateApiCacheManually($vehicle->company_uuid ?? $this->company_uuid);
 
         // Set this vehicle to the driver instance
         $this->setVehicle($vehicle);

package/server/src/Models/Entity.php

@@ -9,6 +9,7 @@ use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\FleetOps\Traits\HasTrackingNumber;
 use Fleetbase\FleetOps\Traits\PayloadAccessors;
 use Fleetbase\Models\Model;
+use Fleetbase\Support\ApiModelCache;
 use Fleetbase\Traits\HasApiModelBehavior;
 use Fleetbase\Traits\HasCustomFields;
 use Fleetbase\Traits\HasInternalId;
@@ -437,6 +438,7 @@ class Entity extends Model
             Entity::where('uuid', $values['uuid'])->update([
                 'payload_uuid' => $payload->uuid,
             ]);
+            ApiModelCache::invalidateModelCache(new static(), $payload->company_uuid ?? session('company'));
 
             return $values['uuid'];
         }
@@ -471,16 +473,22 @@ class Entity extends Model
         if ($result && $payload) {
             // create tracking number for entity
             $trackingNumberId = TrackingNumber::insertGetUuid([
-                'owner_uuid' => $uuid,
-                'owner_type' => Utils::getModelClassName('entity'),
-                'region'     => $payload->getPickupRegion(),
-                'location'   => Utils::parsePointToWkt($payload->getPickupLocation()),
+                'owner_uuid'      => $uuid,
+                'owner_type'      => Utils::getModelClassName('entity'),
+                'owner_public_id' => $values['public_id'],
+                'region'          => $payload->getPickupRegion(),
+                'location'        => Utils::parsePointToWkt($payload->getPickupLocation()),
             ]);
 
             // set tracking number
             static::where('uuid', $uuid)->update(['tracking_number_uuid' => $trackingNumberId]);
         }
 
+        // Inserted and updated without model events
+        if ($result) {
+            ApiModelCache::invalidateModelCache($instance, $values['company_uuid']);
+        }
+
         return $result ? $uuid : false;
     }
 

package/server/src/Models/Fleet.php

@@ -11,6 +11,9 @@ use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\Searchable;
 use Fleetbase\Traits\SendsWebhooks;
 use Fleetbase\Traits\TracksApiCredential;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasManyThrough;
 use Illuminate\Notifications\Notifiable;
 use Spatie\Activitylog\LogOptions;
 use Spatie\Activitylog\Traits\LogsActivity;
@@ -105,66 +108,42 @@ class Fleet extends Model
      */
     protected $hidden = [];
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function photo()
+    public function photo(): BelongsTo
     {
         return $this->belongsTo(\Fleetbase\Models\File::class, 'image_uuid', 'uuid');
     }
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function serviceArea()
+    public function serviceArea(): BelongsTo
     {
         return $this->belongsTo(ServiceArea::class)->select(['uuid', 'public_id', 'name', 'type', 'border']);
     }
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function zone()
+    public function zone(): BelongsTo
     {
         return $this->belongsTo(Zone::class)->select(['uuid', 'public_id', 'name', 'border']);
     }
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function vendor()
+    public function vendor(): BelongsTo
     {
         return $this->belongsTo(Vendor::class)->select(['uuid', 'public_id', 'name']);
     }
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function parentFleet()
+    public function parentFleet(): BelongsTo
     {
         return $this->belongsTo(Fleet::class)->without(['subFleets']);
     }
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\HasMany
-     */
-    public function subFleets()
+    public function subFleets(): HasMany
     {
         return $this->hasMany(Fleet::class, 'parent_fleet_uuid', 'uuid')->without(['parentFleet']);
     }
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\HasManyThrough
-     */
-    public function drivers()
+    public function drivers(): HasManyThrough
     {
         return $this->hasManyThrough(Driver::class, FleetDriver::class, 'fleet_uuid', 'uuid', 'uuid', 'driver_uuid');
     }
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\HasManyThrough
-     */
-    public function vehicles()
+    public function vehicles(): HasManyThrough
     {
         return $this->hasManyThrough(Vehicle::class, FleetVehicle::class, 'fleet_uuid', 'uuid', 'uuid', 'vehicle_uuid');
     }

package/server/src/Models/FleetDriver.php

@@ -3,12 +3,15 @@
 namespace Fleetbase\FleetOps\Models;
 
 use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasApiModelCache;
 use Fleetbase\Traits\HasUuid;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 class FleetDriver extends Model
 {
     use HasUuid;
+    // Writes bump the fleet_drivers API cache version, which cached driver lists filter on.
+    use HasApiModelCache;
 
     /**
      * The database table used by the model.

package/server/src/Models/FleetVehicle.php

@@ -3,12 +3,15 @@
 namespace Fleetbase\FleetOps\Models;
 
 use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasApiModelCache;
 use Fleetbase\Traits\HasUuid;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 class FleetVehicle extends Model
 {
     use HasUuid;
+    // Writes bump the fleet_vehicles API cache version, which cached vehicle lists filter on.
+    use HasApiModelCache;
 
     /**
      * The database table used by the model.

package/server/src/Models/FuelReport.php

@@ -16,6 +16,7 @@ use Fleetbase\Traits\HasPublicId;
 use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\Searchable;
 use Fleetbase\Traits\TracksApiCredential;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 class FuelReport extends Model
 {
@@ -118,34 +119,25 @@ class FuelReport extends Model
         $this->attributes['amount'] = Utils::numbersOnly($value);
     }
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function driver()
+    public function driver(): BelongsTo
     {
         return $this->belongsTo(Driver::class)->without(['vehicle']);
     }
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function vehicle()
+    public function vehicle(): BelongsTo
     {
         return $this->belongsTo(Vehicle::class)->without(['driver']);
     }
 
     /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     * @return BelongsTo
      */
     public function reportedBy()
     {
         return $this->belongsTo(User::class);
     }
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function reporter()
+    public function reporter(): BelongsTo
     {
         return $this->belongsTo(User::class, 'reported_by_uuid');
     }

package/server/src/Models/Issue.php

@@ -152,10 +152,7 @@ class Issue extends Model
         return $this->belongsTo(User::class);
     }
 
-    /**
-     * @return BelongsTo
-     */
-    public function reporter()
+    public function reporter(): BelongsTo
     {
         return $this->belongsTo(User::class, 'reported_by_uuid');
     }
@@ -168,26 +165,17 @@ class Issue extends Model
         return $this->belongsTo(User::class);
     }
 
-    /**
-     * @return BelongsTo
-     */
-    public function assignee()
+    public function assignee(): BelongsTo
     {
         return $this->belongsTo(User::class, 'assigned_to_uuid');
     }
 
-    /**
-     * @return BelongsTo
-     */
-    public function vehicle()
+    public function vehicle(): BelongsTo
     {
         return $this->belongsTo(Vehicle::class);
     }
 
-    /**
-     * @return BelongsTo
-     */
-    public function driver()
+    public function driver(): BelongsTo
     {
         return $this->belongsTo(Driver::class);
     }