@fleetbase/fleetops-engine 0.6.17 → 0.6.19

package/server/src/Models/Order.php

@@ -14,11 +14,10 @@ use Fleetbase\FleetOps\Support\OrderTracker;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\FleetOps\Traits\HasTrackingNumber;
 use Fleetbase\LaravelMysqlSpatial\Types\Point;
-use Fleetbase\Models\CustomField;
-use Fleetbase\Models\CustomFieldValue;
 use Fleetbase\Models\Model;
 use Fleetbase\Models\Transaction;
 use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasCustomFields;
 use Fleetbase\Traits\HasInternalId;
 use Fleetbase\Traits\HasMetaAttributes;
 use Fleetbase\Traits\HasOptionsAttributes;
@@ -34,6 +33,7 @@ use Illuminate\Database\Eloquent\Relations\HasManyThrough;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Support\Carbon;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use Spatie\Activitylog\LogOptions;
 use Spatie\Activitylog\Traits\LogsActivity;
@@ -51,6 +51,7 @@ class Order extends Model
     use Searchable;
     use LogsActivity;
     use HasTrackingNumber;
+    use HasCustomFields;
 
     /**
      * The database table used by the model.
@@ -348,16 +349,6 @@ class Order extends Model
         return $this->hasMany(\Fleetbase\Models\File::class, 'subject_uuid')->latest();
     }
 
-    public function customFields(): HasMany
-    {
-        return $this->hasMany(CustomField::class, 'subject_uuid')->orderBy('order');
-    }
-
-    public function customFieldValues(): HasMany
-    {
-        return $this->hasMany(CustomFieldValue::class, 'subject_uuid');
-    }
-
     public function drivers(): HasManyThrough
     {
         return $this->hasManyThrough(Driver::class, Entity::class, 'tracking_number_uuid', 'tracking_number_uuid');
@@ -720,7 +711,6 @@ class Order extends Model
      */
     public function createPayload(?array $attributes = [], bool $setPayload = true): Payload
     {
-        // set payload type if not set
         if (!isset($attributes['type'])) {
             $attributes['type'] = $this->type;
         }
@@ -769,7 +759,6 @@ class Order extends Model
      */
     public function insertPayload(?array $attributes = [], bool $setPayload = true): Payload
     {
-        // set payload type if not set
         if (!isset($attributes['type'])) {
             $attributes['type'] = $this->type;
         }
@@ -794,7 +783,7 @@ class Order extends Model
 
         $fillable   = $this->getFillable();
         $insertKeys = array_keys($attributes);
-        // clean insert data
+
         foreach ($insertKeys as $key) {
             if (!in_array($key, $fillable)) {
                 unset($attributes[$key]);
@@ -813,10 +802,8 @@ class Order extends Model
             return $this->createPayload($attributes);
         }
 
-        // get newly inserted payload
         $payload = Payload::find($uuid);
 
-        // manyally trigger payload created event
         $payload->fireModelEvent('created', false);
 
         if ($setPayload) {
@@ -960,8 +947,6 @@ class Order extends Model
      */
     public function purchaseQuote(string $serviceQuoteId, $meta = [])
     {
-        // $serviceQuote = ServiceQuote::where('uuid', $serviceQuoteId)->first();
-        // create purchase rate for order
         $purchasedRate = PurchaseRate::create([
             'customer_uuid'      => $this->customer_uuid,
             'customer_type'      => $this->customer_type,
@@ -989,7 +974,6 @@ class Order extends Model
     public function purchaseServiceQuote($serviceQuote, $meta = [])
     {
         if (!$serviceQuote) {
-            // create transaction for order
             $this->createOrderTransactionWithoutServiceQuote();
 
             return $this;
@@ -1033,7 +1017,6 @@ class Order extends Model
         $transaction = null;
 
         try {
-            // create transaction and transaction items
             $transaction = Transaction::create([
                 'company_uuid'           => session('company', $this->company_uuid),
                 'customer_uuid'          => $this->customer_uuid,
@@ -1047,10 +1030,8 @@ class Order extends Model
                 'status'                 => 'success',
             ]);
 
-            // set transaction to order
             $this->update(['transaction_uuid' => $transaction->uuid]);
         } catch (\Throwable $e) {
-            // log error unable to create order transaction
         }
 
         return $transaction;
@@ -1081,21 +1062,16 @@ class Order extends Model
      *
      * @throws \LogicException if the order is already dispatched
      */
-    public function dispatch(bool $save = true): static
+    public function dispatch(bool $save = true): self
     {
         $this->dispatched    = true;
         $this->dispatched_at = now();
 
         if ($save) {
-            // Save quietly to avoid duplicate model events;
-            // wrap in a transaction if your code is not already in one.
             $this->saveQuietly();
-
-            // Flush any attribute cache that depends on persisted state
             $this->flushAttributesCache();
         }
 
-        // Queue the OrderDispatched event to run after the DB commit succeeds
         dispatch(fn () => event(new OrderDispatched($this)))->afterCommit();
 
         return $this;
@@ -1109,7 +1085,6 @@ class Order extends Model
      */
     public function insertDispatchActivity(): Order
     {
-        // get dispatch activity if any and apply to order
         $dispatchActivity = $this->config()->getDispatchActivity();
 
         if ($dispatchActivity) {
@@ -1141,7 +1116,7 @@ class Order extends Model
      */
     public function firstDispatch(): Order
     {
-        if ($this->dispatched) {
+        if (!$this->dispatched) {
             $this->dispatch();
         }
 
@@ -1156,7 +1131,7 @@ class Order extends Model
      */
     public function firstDispatchWithActivity(): Order
     {
-        if ($this->dispatched) {
+        if (!$this->hasDispatchedStatus()) {
             $this->dispatchWithActivity();
         }
 
@@ -1173,12 +1148,10 @@ class Order extends Model
     {
         $this->status = 'canceled';
 
-        // if saving update the status and add the cancel activity
         $this->loadMissing('orderConfig');
         $canceledActivity = $this->orderConfig->getCanceledActivity();
         $this->updateActivity($canceledActivity);
 
-        // trigger integrated vendor cancelation
         if ($this->isIntegratedVendorOrder()) {
             $api = $this->facilitator->api();
 
@@ -1218,16 +1191,12 @@ class Order extends Model
             return $this;
         }
 
-        // Get location
         $location = $this->getLastLocation();
 
-        // Insert dispatch activity
         $this->insertActivity($activity, $location, $proof);
 
-        // Update status using code
         $this->setStatus($activity->get('code'), true);
 
-        // Fire activity events
         $activity->fireEvents($this);
 
         return $this;
@@ -1301,8 +1270,6 @@ class Order extends Model
             $doesNotStartWithFleetOps = !Str::startsWith($type, 'fleet-ops');
             $isValidType              = $type === 'contact' || $type === 'vendor';
 
-            // preprend fleet-ops IF not a namespace and does not start with fleet-ops
-            // this is for handling ember style registry spacing
             if ($isNotNamespace && $doesNotStartWithFleetOps && $isValidType) {
                 $type = 'fleet-ops:' . $type;
             }
@@ -1324,8 +1291,6 @@ class Order extends Model
             $doesNotStartWithFleetOps = !Str::startsWith($type, 'fleet-ops');
             $isValidType              = $type === 'contact' || $type === 'vendor';
 
-            // preprend fleet-ops IF not a namespace and does not start with fleet-ops
-            // this is for handling ember style registry spacing
             if ($isNotNamespace && $doesNotStartWithFleetOps && $isValidType) {
                 $type = 'fleet-ops:' . $type;
             }
@@ -1350,8 +1315,6 @@ class Order extends Model
             }
         }
 
-        // if payload is using a special key `pickup_is_driver_location`
-        // and driver is assigned set the pickup point as the drivers current location
         if ($this->isDirty('driver_assigned_uuid') && !empty($this->driver_assigned_uuid) && $this->payload && $this->payload->hasMeta('pickup_is_driver_location')) {
             $this->load('driverAssigned');
 
@@ -1381,7 +1344,6 @@ class Order extends Model
      */
     public function updateStatus($code = null)
     {
-        // update multiple status codes
         if (is_array($code)) {
             return collect($code)->every(function ($activityCode) {
                 return $this->updateStatus($activityCode);
@@ -1389,7 +1351,7 @@ class Order extends Model
         }
 
         $orderConfig = $this->config();
-        // @todo if no order config set the order config based on order type
+
         $flow         = $orderConfig->activities();
         $activity     = $orderConfig->nextActivity();
 
@@ -1417,7 +1379,6 @@ class Order extends Model
         $this->setStatus($activity->code);
         $this->insertActivity($activity, $location);
 
-        // fire events if any
         $activity->fireEvents($this);
 
         return true;
@@ -1603,104 +1564,6 @@ class Order extends Model
         return (int) Utils::get($this, 'adhoc_distance', Utils::get($this, 'company.options.fleetops.adhoc_distance', 6000));
     }
 
-    /**
-     * Retrieves a custom field by its key.
-     *
-     * This method searches for a custom field where the name or label matches the given key.
-     *
-     * @param string $key the key used to search for the custom field
-     *
-     * @return CustomField|null the found CustomField object or null if not found
-     */
-    public function getCustomField(string $key): ?CustomField
-    {
-        $name         = Str::slug($key);
-        $label        = Str::title($key);
-
-        return $this->customFields()->where('name', $name)->orWhere('label', $label)->first();
-    }
-
-    /**
-     * Retrieves the custom field value for the specified custom field.
-     *
-     * @param CustomField $customField the custom field to retrieve the value for
-     *
-     * @return CustomFieldValue|null the custom field value, or null if not found
-     */
-    public function getCustomFieldValue(CustomField $customField): ?CustomFieldValue
-    {
-        $customFieldValue = $this->customFieldValues()->where('custom_field_uuid', $customField->uuid)->first();
-        if ($customFieldValue) {
-            return $customFieldValue;
-        }
-
-        return null;
-    }
-
-    /**
-     * Retrieves the value of a custom field by its key.
-     *
-     * @param string $key the key of the custom field
-     *
-     * @return mixed|null the value of the custom field, or null if not found
-     */
-    public function getCustomFieldValueByKey(string $key)
-    {
-        $customField = $this->getCustomField($key);
-        if ($customField) {
-            $customFieldValue = $this->getCustomFieldValue($customField);
-            if ($customFieldValue) {
-                return $customFieldValue->value;
-            }
-        }
-
-        return null;
-    }
-
-    /**
-     * Checks if a custom field exists.
-     *
-     * @param string $key the key of the custom field
-     */
-    public function isCustomField(string $key): bool
-    {
-        $name         = Str::slug($key);
-        $label        = Str::title($key);
-
-        return $this->customFields()->where('name', $name)->orWhere('label', $label)->exists();
-    }
-
-    /**
-     * Retrieves all custom field values associated with the order.
-     *
-     * @return array an array of custom field values
-     */
-    public function getCustomFieldValues(): array
-    {
-        $customFields = [];
-        foreach ($this->customFieldValues as $customFieldValue) {
-            $key = Str::snake(strtolower($customFieldValue->custom_field_label));
-            if ($key) {
-                $customFields[$key] = $customFieldValue->value;
-            }
-        }
-
-        return $customFields;
-    }
-
-    public function getCustomFieldKeys(): array
-    {
-        $keys = [];
-        foreach ($this->customFieldValues as $customFieldValue) {
-            $key = Str::snake(strtolower($customFieldValue->custom_field_label));
-            if ($key) {
-                $keys[] = $key;
-            }
-        }
-
-        return $keys;
-    }
-
     /**
      * Retrieves the OrderConfig associated with this order.
      *
@@ -1764,8 +1627,7 @@ class Order extends Model
      */
     public function resolveDynamicProperty(string $property)
     {
-        // Special payload shortcuts
-        $root       = Str::before($property, '.');   // e.g. "pickup" in "pickup.address"
+        $root       = Str::before($property, '.');
         $payloadMap = [
             'pickup'                => 'payload.pickup',
             'dropoff'               => 'payload.dropoff',
@@ -1778,15 +1640,12 @@ class Order extends Model
             $this->loadMissing($payloadMap[$root]);
             $target = data_get($this, $payloadMap[$root]);
 
-            // “pickup”, “dropoff”, or “currentWaypoint” on their own
             if ($property === $root) {
                 return $target;
             }
 
-            // e.g. "address.city" part of "pickup.address.city"
             $subKey = Str::after($property, $root . '.');
 
-            // if waypoint we can do "waypoint.place.address" or "waypoint.address" for resolution
             $isWaypointMarker = Str::startsWith($root, 'currentWaypoint') || $root === 'waypoint';
             if ($isWaypointMarker && $target instanceof Waypoint) {
                 $target->loadMissing('place');
@@ -1797,13 +1656,11 @@ class Order extends Model
             return data_get($target, $subKey);
         }
 
-        // Direct attribute on the model
         $snake = Str::snake($property);
         if (array_key_exists($snake, $this->getAttributes())) {
             return $this->getAttribute($snake);
         }
 
-        // Custom-field / meta look-ups
         if ($this->isCustomField($property)) {
             return $this->getCustomFieldValueByKey($property);
         }
@@ -1812,7 +1669,6 @@ class Order extends Model
             return $this->getMeta($property);
         }
 
-        // Fallback deep-path access
         return data_get($this, $property);
     }
 
@@ -1895,12 +1751,10 @@ class Order extends Model
     public function resolveDynamicNotifiable(string $property)
     {
         if ($property === 'customer') {
-            // Load payload and waypoint markers if not already loaded
             $this->loadMissing(['payload', 'payload.waypointMarkers']);
 
             $payload = $this->payload;
 
-            // Attempt to resolve customer from the current waypoint
             if ($payload && $payload->current_waypoint_uuid) {
                 $currentWaypoint = $payload->waypointMarkers
                     ?->firstWhere('place_uuid', $payload->current_waypoint_uuid);
@@ -1914,15 +1768,61 @@ class Order extends Model
                 }
             }
 
-            // Fallback to the order's customer
             return $this->customer;
         }
 
-        // For other relationships, load dynamically
         if (!$this->relationLoaded($property)) {
             $this->load($property);
         }
 
         return $this->{$property};
     }
+
+    /**
+     * Determine whether this order already has a "dispatched" tracking status.
+     *
+     * Uses the in-memory relationship when available to avoid extra queries.
+     * Falls back to a lightweight EXISTS query when the relationship isn't loaded.
+     *
+     * @return bool true if a tracking status with code "dispatched" exists; otherwise false
+     */
+    public function hasDispatchedStatus(): bool
+    {
+        if ($this->relationLoaded('trackingStatuses')) {
+            return $this->trackingStatuses->contains(
+                fn ($ts) => strcasecmp((string) $ts->code, 'dispatched') === 0
+            );
+        }
+
+        return TrackingStatus::where('tracking_number_uuid', $this->tracking_number_uuid)
+            ->whereRaw('LOWER(code) = ?', ['dispatched'])
+            ->exists();
+    }
+
+    public function findClosestDrivers(int $distance = 6000): Collection
+    {
+        $pickup   = $this->getPickupLocation();
+        $distance = $distance;
+
+        if (!Utils::isPoint($pickup)) {
+            return collect();
+        }
+
+        $drivers = Driver::where(['status' => 'active', 'online' => 1])
+            ->whereHas('company', function ($q) {
+                $q->whereHas('users', function ($q) {
+                    $q->whereHas('driver', function ($q) {
+                        $q->where(['status' => 'active', 'online' => 1]);
+                        $q->whereNull('deleted_at');
+                    });
+                });
+            })
+            ->whereNull('deleted_at')
+            ->distanceSphere('location', $pickup, $distance)
+            ->distanceSphereValue('location', $pickup)
+            ->withoutGlobalScopes()
+            ->get();
+
+        return $drivers;
+    }
 }

package/server/src/Models/OrderConfig.php

@@ -368,6 +368,14 @@ class OrderConfig extends Model
         return collect();
     }
 
+    /**
+     * Gets an activity from the order config by it's code.
+     */
+    public function getActivityByCode(string $code): ?Activity
+    {
+        return $this->activities()->firstWhere('code', $code);
+    }
+
     /**
      * Creates an Activity instance representing a canceled order.
      *