@fleetbase/fleetops-engine 0.6.58 → 0.6.60

package/server/src/Models/OrderConfig.php

@@ -498,7 +498,7 @@ class OrderConfig extends Model
     /**
      * Get the default order config.
      */
-    public static function default(?Company $company = null): self
+    public static function default(?Company $company = null): ?self
     {
         return static::where(['namespace' => 'system:order-config:transport', 'company_uuid' => $company ? $company->uuid : session('company')])->first();
     }

package/server/src/Models/Payload.php

@@ -911,14 +911,10 @@ class Payload extends Model
         $save     = data_get($options, 'save', false);
         $callback = data_get($options, 'callback', false);
 
-        if ($instance) {
-            if (Str::isUuid($instance)) {
-                $this->setAttribute($attr, $instance);
-            } elseif ($instance instanceof Model) {
-                $this->setAttribute($attr, $instance->uuid);
-            } else {
-                $this->setAttribute($attr, $instance);
-            }
+        // createFromMixed() returns a Place or null, so a resolved instance is
+        // always a model — the uuid-string and passthrough cases cannot occur
+        if ($instance instanceof Model) {
+            $this->setAttribute($attr, $instance->uuid);
         }
 
         // Get the ID property
@@ -1148,19 +1144,16 @@ class Payload extends Model
             }
         }
 
-        // confirm destination_uuid is indeed a place record
-        if (isset($attributes['destination_uuid']) && Place::where('uuid', $attributes['destination_uuid'])->doesntExist()) {
-            // search waypoints for search_uuid if any
-            $destination = Place::where('meta->search_uuid', $attributes['destination_uuid'])->first();
+        // confirm the key is indeed a place record, otherwise fall back to
+        // search-uuid metadata left by console place searches
+        if (Place::where('uuid', $destinationKey)->doesntExist()) {
+            $destination = Place::where('meta->search_uuid', $destinationKey)->first();
 
             if ($destination instanceof Place) {
                 return $destination;
             }
-        }
 
-        // Validate destination actually exists
-        if (isset($attributes['destination_uuid']) && Place::where('uuid', $attributes['destination_uuid'])->doesntExist()) {
-            $destination = $this->_findCorrectDestinationForEntity($attributes);
+            $destination = $this->_findCorrectDestinationForEntity(['destination_uuid' => $destinationKey]);
 
             if ($destination instanceof Place) {
                 return $destination;

package/server/src/Models/Place.php

@@ -394,6 +394,16 @@ class Place extends Model
         return static::getGoogleAddressArray($results->first());
     }
 
+    /**
+     * Inserts a new place into the database from a geocoding lookup on an address.
+     *
+     * @return string|bool the UUID of the newly created place or false if the place was not created
+     */
+    public static function insertFromGeocodingLookup(string $address)
+    {
+        return static::insertGetUuid(static::getValuesFromGeocodingLookup($address));
+    }
+
     /**
      * Compose a fuller geocoding query from structured place attributes.
      */
@@ -644,7 +654,7 @@ class Place extends Model
 
         $results = \Geocoder\Laravel\Facades\Geocoder::reverse($latitude, $longitude)->get();
 
-        if (!$results->count() === 0) {
+        if ($results->count() === 0) {
             return false;
         }
 
@@ -703,11 +713,6 @@ class Place extends Model
         }
         // If $place is an array
         elseif (is_array($place)) {
-            // If $place is an array of coordinates, create a new Place object
-            if (Utils::isCoordinatesStrict($place)) {
-                return static::createFromCoordinates($place, $attributes, $saveInstance);
-            }
-
             // Get uuid if set
             $uuid = data_get($place, 'uuid');
 
@@ -782,12 +787,11 @@ class Place extends Model
                 }
             }
 
-            // handle address if set
-            if (!empty($place['address'])) {
-                return static::insertFromGeocodingLookup($place['address']);
-            }
-
             return static::insertFromGeocodingLookup($place);
+        } elseif ($place instanceof \Geocoder\Provider\GoogleMaps\Model\GoogleAddress) {
+            // Must be tested before the array/object arm below, which would
+            // otherwise swallow it and flatten it to an array
+            return static::insertFromGoogleAddress($place);
         } elseif (is_array($place) || is_object($place)) {
             // if place already exists just return uuid
             if (static::isValidPlaceUuid(data_get($place, 'uuid'))) {
@@ -805,14 +809,17 @@ class Place extends Model
 
             $values = is_array($place) ? $place : (array) $place;
 
+            // handle address if set
+            if (!empty($values['address'])) {
+                return static::insertFromGeocodingLookup($values['address']);
+            }
+
             if ($existingPlace = static::findExistingSharedPlace($values)) {
                 return $existingPlace->uuid;
             }
 
             // create a new place
             return static::insertGetUuid((array) $values);
-        } elseif ($place instanceof \Geocoder\Provider\GoogleMaps\Model\GoogleAddress) {
-            return static::insertFromGoogleAddress($place);
         }
     }
 

package/server/src/Models/Sensor.php

@@ -147,6 +147,30 @@ class Sensor extends Model
      */
     protected $spatialFields = ['last_position'];
 
+    /**
+     * Bootstrap the model.
+     *
+     * The same migration that made devices.last_position NOT NULL did it to
+     * sensors.last_position too, but only Device got a default. Creating a sensor
+     * without a position therefore failed outright:
+     *
+     *   SQLSTATE[HY000]: General error: 1364 Field 'last_position' doesn't have a
+     *   default value
+     *
+     * Position is not something a caller has when registering a sensor, so default
+     * it to POINT(0,0) on create, exactly as Device does.
+     */
+    protected static function boot()
+    {
+        parent::boot();
+
+        static::creating(function (self $sensor) {
+            if (empty($sensor->last_position)) {
+                $sensor->last_position = new SpatialPoint(0, 0);
+            }
+        });
+    }
+
     /**
      * The attributes that should be cast to native types.
      *

package/server/src/Models/ServiceArea.php

@@ -180,13 +180,10 @@ class ServiceArea extends Model
      */
     public static function createMultiPolygonFromPoint(Point $point, int $meters = 500): MultiPolygon
     {
+        // coordsToCircle() already closes the ring, so first and last are
+        // equivalent on arrival and no re-closing is needed here
         $coordinates = Utils::coordsToCircle($point->getLat(), $point->getLng(), $meters);
 
-        // first and last positions should be equivalent
-        if (Arr::first($coordinates) !== Arr::last($coordinates)) {
-            $coordinates[] = Arr::first($coordinates);
-        }
-
         // conver the coordinate pairs to points
         $coordinates = array_map(
             function ($coord) {
@@ -380,7 +377,7 @@ class ServiceArea extends Model
      */
     public function getCentroid(): \Brick\Geo\Point
     {
-        $geometryEngine       = new \Brick\Geo\Engine\GEOSEngine();
+        $geometryEngine       = Utils::resolveGeometryEngine();
         $borderAsMultiPolygon = $this->toGeosMultiPolygon();
 
         if ($borderAsMultiPolygon instanceof \Brick\Geo\Geometry) {

package/server/src/Models/ServiceQuote.php

@@ -211,7 +211,12 @@ class ServiceQuote extends Model
             return $product;
         }
 
+        // Unreachable: `Payment::getStripeClient()` is `?StripeClient` in its
+        // signature only — it unconditionally returns `new StripeClient([...])`,
+        // so the guard above never falls through.
+        // @codeCoverageIgnoreStart
         return null;
+        // @codeCoverageIgnoreEnd
     }
 
     /**

package/server/src/Models/ServiceRate.php

@@ -856,7 +856,7 @@ class ServiceRate extends Model
 
                 // if no distance fee use the last
                 if ($serviceParcelFee === null) {
-                    $serviceParcelFee = $this->parcelFees->sortByDesc()->first();
+                    $serviceParcelFee = $this->parcelFees->sortByDesc('fee')->first();
                 }
 
                 $subTotal += $serviceParcelFee->fee;
@@ -1050,7 +1050,7 @@ class ServiceRate extends Model
 
                 // if no distance fee use the last
                 if ($serviceParcelFee === null) {
-                    $serviceParcelFee = $this->parcelFees->sortByDesc()->first();
+                    $serviceParcelFee = $this->parcelFees->sortByDesc('fee')->first();
                 }
 
                 $subTotal += $serviceParcelFee->fee;
@@ -1213,10 +1213,15 @@ class ServiceRate extends Model
         $subTotal        = 0;
 
         foreach ($pricedDistances as $entry) {
+            // Unreachable: calculateMultiZoneDistances() only ever emits entries
+            // whose rule is a ServiceRateFee — both its early returns are gated
+            // on a non-null $fallbackRule and its accumulator guards the type.
             $rule = $entry['rule'];
+            // @codeCoverageIgnoreStart
             if (!$rule instanceof ServiceRateFee) {
                 continue;
             }
+            // @codeCoverageIgnoreEnd
 
             $distanceInMeters = (float) ($entry['distance_m'] ?? 0);
             if ($distanceInMeters <= 0) {
@@ -1274,12 +1279,16 @@ class ServiceRate extends Model
         $sampledTotal = 0;
 
         for ($i = 0; $i < $places->count() - 1; $i++) {
+            // Unreachable: $places is filtered to Place instances above, and
+            // getLngLatFromPlace() only returns null for a non-Place.
             $start = $this->getLngLatFromPlace($places[$i]);
             $end   = $this->getLngLatFromPlace($places[$i + 1]);
 
+            // @codeCoverageIgnoreStart
             if (!$start || !$end) {
                 continue;
             }
+            // @codeCoverageIgnoreEnd
 
             $legDistance = $this->haversineDistanceInMeters($start['lat'], $start['lng'], $end['lat'], $end['lng']);
             $steps       = max(1, min(500, (int) ceil($legDistance / 1000)));
@@ -1367,12 +1376,10 @@ class ServiceRate extends Model
             return null;
         }
 
+        // getLocationAsPoint() is typed `: SpatialPoint`, which always exposes
+        // getLat()/getLng(), so no further guarding is possible here
         $point = $place->getLocationAsPoint();
 
-        if (!$point || !method_exists($point, 'getLat') || !method_exists($point, 'getLng')) {
-            return null;
-        }
-
         return ['lat' => (float) $point->getLat(), 'lng' => (float) $point->getLng()];
     }
 

package/server/src/Models/Telematic.php

@@ -385,9 +385,9 @@ class Telematic extends Model
             return 'recently_offline';
         } elseif ($minutesOffline <= 1440) { // 24 hours
             return 'offline';
-        } else {
-            return 'long_offline';
         }
+
+        return 'long_offline';
     }
 
     /**

package/server/src/Models/TrackingNumber.php

@@ -264,10 +264,10 @@ class TrackingNumber extends Model
             }
         }
 
-        $values['uuid']         = $uuid = static::generateUuid();
-        $values['public_id']    = static::generatePublicId('track');
+        $values['uuid']         = $uuid = static::newUuid();
+        $values['public_id']    = static::newPublicId();
         $values['_key']         = session('api_key') ?? 'console';
-        $values['created_at']   = Carbon::now()->toDateTimeString();
+        $values['created_at']   = static::currentTimestamp();
         $values['company_uuid'] = session('company');
 
         if ($owner) {
@@ -275,15 +275,15 @@ class TrackingNumber extends Model
             $values['owner_type'] = Utils::getMutationType($owner);
         }
 
-        $values['tracking_number'] = TrackingNumber::generateNumber($values['region'] ?? 'SG');
-        $values['qr_code']         = DNS2D::getBarcodePNG($values['owner_uuid'], 'QRCODE');
-        $values['barcode']         = DNS2D::getBarcodePNG($values['owner_uuid'], 'PDF417');
+        $values['tracking_number'] = static::newTrackingNumber($values['region'] ?? 'SG');
+        $values['qr_code']         = static::newBarcode((string) ($values['owner_uuid'] ?? ''), 'QRCODE');
+        $values['barcode']         = static::newBarcode((string) ($values['owner_uuid'] ?? ''), 'PDF417');
 
         if (isset($values['meta']) && (is_object($values['meta']) || is_array($values['meta']))) {
             $values['meta'] = json_encode($values['meta']);
         }
 
-        $result = static::insert($values);
+        $result = static::insertTrackingNumber($values);
 
         if (!$result) {
             return false;
@@ -292,7 +292,7 @@ class TrackingNumber extends Model
         $ownerTypeName = class_basename($values['owner_type']);
 
         // create initial status
-        $trackingStatusId = TrackingStatus::insertGetUuid([
+        $trackingStatusId = static::createInitialTrackingStatus([
             'tracking_number_uuid' => $uuid,
             'status'               => Str::title($ownerTypeName . ' created'),
             'details'              => 'New ' . Str::lower($ownerTypeName) . ' created.',
@@ -301,7 +301,7 @@ class TrackingNumber extends Model
         ]);
 
         // update status of tracking number
-        TrackingNumber::where('uuid', $uuid)->update(['status_uuid' => $trackingStatusId]);
+        static::updateTrackingStatusUuid($uuid, $trackingStatusId);
 
         // update owner status
         if ($owner && $owner instanceof Model && static::ownerHasStatusColumn($owner) && $owner->isFillable('status')) {
@@ -309,12 +309,57 @@ class TrackingNumber extends Model
             // $model->update([ 'status' => 'created' ]);
 
             // silent update
-            DB::table($owner->getTable())->where('uuid', $owner->uuid)->update(['status' => 'created']);
+            static::updateOwnerStatusColumn($owner, 'created');
         }
 
         return $uuid;
     }
 
+    protected static function newUuid(): string
+    {
+        return static::generateUuid();
+    }
+
+    protected static function newPublicId(): string
+    {
+        return static::generatePublicId('track');
+    }
+
+    protected static function currentTimestamp(): string
+    {
+        return Carbon::now()->toDateTimeString();
+    }
+
+    protected static function newTrackingNumber(string $region): string
+    {
+        return static::generateNumber($region);
+    }
+
+    protected static function newBarcode(string $value, string $type): string
+    {
+        return DNS2D::getBarcodePNG($value, $type);
+    }
+
+    protected static function insertTrackingNumber(array $values): bool
+    {
+        return static::insert($values);
+    }
+
+    protected static function createInitialTrackingStatus(array $values)
+    {
+        return TrackingStatus::insertGetUuid($values);
+    }
+
+    protected static function updateTrackingStatusUuid(string $uuid, mixed $trackingStatusId): void
+    {
+        TrackingNumber::where('uuid', $uuid)->update(['status_uuid' => $trackingStatusId]);
+    }
+
+    protected static function updateOwnerStatusColumn(Model $owner, string $status): void
+    {
+        DB::table($owner->getTable())->where('uuid', $owner->uuid)->update(['status' => $status]);
+    }
+
     protected static function ownerHasStatusColumn(Model $owner): bool
     {
         return Schema::hasColumn($owner->getTable(), 'status');

package/server/src/Models/TrackingStatus.php

@@ -159,10 +159,10 @@ class TrackingStatus extends Model
             }
         }
 
-        $values['uuid']         = $uuid = (string) Str::uuid();
-        $values['public_id']    = static::generatePublicId('status');
+        $values['uuid']         = $uuid = static::newUuid();
+        $values['public_id']    = static::newPublicId();
         $values['_key']         = session('api_key') ?? 'console';
-        $values['created_at']   = Carbon::now()->toDateTimeString();
+        $values['created_at']   = static::currentTimestamp();
         $values['company_uuid'] = session('company');
 
         if ($trackingNumber) {
@@ -175,11 +175,31 @@ class TrackingStatus extends Model
             $values['meta'] = json_encode($values['meta']);
         }
 
-        $result = static::insert($values);
+        $result = static::insertTrackingStatus($values);
 
         return $result ? $uuid : false;
     }
 
+    protected static function newUuid(): string
+    {
+        return (string) Str::uuid();
+    }
+
+    protected static function newPublicId(): string
+    {
+        return static::generatePublicId('status');
+    }
+
+    protected static function currentTimestamp(): string
+    {
+        return Carbon::now()->toDateTimeString();
+    }
+
+    protected static function insertTrackingStatus(array $values): bool
+    {
+        return static::insert($values);
+    }
+
     public function isComplete(): bool
     {
         return Utils::isTrue($this->complete);

package/server/src/Models/Waypoint.php

@@ -203,10 +203,10 @@ class Waypoint extends Model
             }
         }
 
-        $values['uuid']         = $uuid = static::generateUuid();
-        $values['public_id']    = static::generatePublicId('waypoint');
+        $values['uuid']         = $uuid = static::newUuid();
+        $values['public_id']    = static::newPublicId();
         $values['_key']         = session('api_key') ?? 'console';
-        $values['created_at']   = Carbon::now()->toDateTimeString();
+        $values['created_at']   = static::currentTimestamp();
         $values['company_uuid'] = session('company');
 
         if ($payload) {
@@ -217,23 +217,58 @@ class Waypoint extends Model
             $values['meta'] = json_encode($values['meta']);
         }
 
-        $result = static::insert($values);
+        $result = static::insertWaypoint($values);
         if ($result && $payload) {
             // create tracking number for entity
-            $trackingNumberId = TrackingNumber::insertGetUuid([
+            $trackingNumberId = static::createTrackingNumber([
                 'owner_uuid' => $uuid,
                 'owner_type' => Utils::getModelClassName('waypoint'),
                 'region'     => $payload->getPickupRegion(),
-                'location'   => Utils::parsePointToWkt($payload->getPickupLocation()),
+                'location'   => static::pickupLocationWkt($payload),
             ]);
 
             // set tracking number
-            static::where('uuid', $uuid)->update(['tracking_number_uuid' => $trackingNumberId]);
+            static::updateTrackingNumberUuid($uuid, $trackingNumberId);
         }
 
         return $result ? $uuid : false;
     }
 
+    protected static function newUuid(): string
+    {
+        return static::generateUuid();
+    }
+
+    protected static function newPublicId(): string
+    {
+        return static::generatePublicId('waypoint');
+    }
+
+    protected static function currentTimestamp(): string
+    {
+        return Carbon::now()->toDateTimeString();
+    }
+
+    protected static function insertWaypoint(array $values): bool
+    {
+        return static::insert($values);
+    }
+
+    protected static function createTrackingNumber(array $values)
+    {
+        return TrackingNumber::insertGetUuid($values);
+    }
+
+    protected static function pickupLocationWkt(Payload $payload)
+    {
+        return Utils::parsePointToWkt($payload->getPickupLocation());
+    }
+
+    protected static function updateTrackingNumberUuid(string $uuid, mixed $trackingNumberId): void
+    {
+        static::where('uuid', $uuid)->update(['tracking_number_uuid' => $trackingNumberId]);
+    }
+
     /**
      * Get this waypoint place record.
      */
@@ -269,9 +304,8 @@ class Waypoint extends Model
         array $columns = ['*'],
     ): ?self {
         $payloadId = match (true) {
-            $order instanceof Order   => $order->payload_uuid,
-            $order instanceof Payload => $order->uuid,
-            default                   => null,
+            $order instanceof Order => $order->payload_uuid,
+            default                 => $order->uuid,
         };
 
         if (!$payloadId) {

package/server/src/Models/Zone.php

@@ -170,7 +170,7 @@ class Zone extends Model
      */
     public function getCentroid(): \Brick\Geo\Point
     {
-        $geometryEngine  = new \Brick\Geo\Engine\GEOSEngine();
+        $geometryEngine  = Utils::resolveGeometryEngine();
         $borderAsPolygon = $this->toGeosPolygon();
 
         if ($borderAsPolygon instanceof \Brick\Geo\Geometry) {
@@ -232,13 +232,10 @@ class Zone extends Model
      */
     public static function createPolygonFromPoint(Point $point, int $meters = 500): Polygon
     {
+        // coordsToCircle() already closes the ring, so first and last are
+        // equivalent on arrival and no re-closing is needed here
         $coordinates = Utils::coordsToCircle($point->getLat(), $point->getLng(), $meters);
 
-        // first and last positions should be equivalent
-        if (Arr::first($coordinates) !== Arr::last($coordinates)) {
-            $coordinates[] = Arr::first($coordinates);
-        }
-
         // conver the coordinate pairs to points
         $coordinates = array_map(
             function ($coord) {

package/server/src/Notifications/DriverArrivedAtGeofence.php

@@ -61,7 +61,7 @@ class DriverArrivedAtGeofence extends Notification
             ->greeting('Good news!')
             ->line("Your driver has arrived at {$geofenceName} for order #{$orderId}.")
             ->line('Please be ready to receive your delivery.')
-            ->action('Track Your Order', url("/tracking/{$this->order->tracking_number}"))
+            ->action('Track Your Order', \url("/tracking/{$this->order->tracking_number}"))
             ->line('Thank you for using our service.');
     }
 

package/server/src/Notifications/OrderDispatched.php

@@ -141,17 +141,11 @@ class OrderDispatched extends Notification implements ShouldQueue
      */
     public function toBroadcast($notifiable)
     {
+        // OrderResource declares toWebhookPayload(), so the fallback arms of the
+        // old method_exists() chain were never reachable
         $model        = $this->order;
         $resource     = new OrderResource($model);
-        $resourceData = [];
-
-        if ($resource) {
-            if (method_exists($resource, 'toWebhookPayload')) {
-                $resourceData = $resource->toWebhookPayload();
-            } elseif (method_exists($resource, 'toArray')) {
-                $resourceData = $resource->toArray(request());
-            }
-        }
+        $resourceData = $resource->toWebhookPayload();
 
         $resourceData = ResourceLifecycleEvent::transformResourceChildrenToId($resourceData);
 

package/server/src/Notifications/OrderPing.php

@@ -148,17 +148,11 @@ class OrderPing extends Notification implements ShouldQueue
      */
     public function toBroadcast($notifiable)
     {
+        // OrderResource declares toWebhookPayload(), so the fallback arms of the
+        // old method_exists() chain were never reachable
         $model        = $this->order;
         $resource     = new OrderResource($model);
-        $resourceData = [];
-
-        if ($resource) {
-            if (method_exists($resource, 'toWebhookPayload')) {
-                $resourceData = $resource->toWebhookPayload();
-            } elseif (method_exists($resource, 'toArray')) {
-                $resourceData = $resource->toArray(request());
-            }
-        }
+        $resourceData = $resource->toWebhookPayload();
 
         $resourceData = ResourceLifecycleEvent::transformResourceChildrenToId($resourceData);
 

package/server/src/Observers/CategoryObserver.php

@@ -15,6 +15,11 @@ class CategoryObserver
     public function deleted(Category $category)
     {
         // if the category deleted was for "custom_field_group" - delete the custom fields belonging
-        CustomField::where('category_uuid', $category->uuid)->delete();
+        $this->deleteCustomFields($category->uuid);
+    }
+
+    protected function deleteCustomFields(string $categoryUuid): void
+    {
+        CustomField::where('category_uuid', $categoryUuid)->delete();
     }
 }

package/server/src/Observers/CompanyObserver.php

@@ -15,6 +15,11 @@ class CompanyObserver
     public function created(Company $company)
     {
         // Add the default transport order config
+        $this->createTransportConfig($company);
+    }
+
+    protected function createTransportConfig(Company $company): void
+    {
         FleetOps::createTransportConfig($company);
     }
 }

package/server/src/Observers/CompanyUserObserver.php

@@ -15,7 +15,7 @@ class CompanyUserObserver
     public function deleted(CompanyUser $companyUser)
     {
         // if the company user deleted is a driver, delete their driver record to
-        Driver::where('user_uuid', $companyUser->user_uuid)->delete();
+        $this->deleteDrivers($companyUser->user_uuid);
     }
 
     /**
@@ -26,9 +26,19 @@ class CompanyUserObserver
     public function updated(CompanyUser $companyUser)
     {
         // If the company user has any driver assosciated update status to same as company_users
-        $driver = Driver::where('user_uuid', $companyUser->user_uuid)->first();
+        $driver = $this->findDriver($companyUser->user_uuid);
         if ($driver && $companyUser->wasChanged('status')) {
             $driver->update(['status' => $companyUser->status]);
         }
     }
+
+    protected function deleteDrivers(string $userUuid): void
+    {
+        Driver::where('user_uuid', $userUuid)->delete();
+    }
+
+    protected function findDriver(string $userUuid): ?Driver
+    {
+        return Driver::where('user_uuid', $userUuid)->first();
+    }
 }