@fleetbase/fleetops-engine 0.6.11 → 0.6.13

package/server/config/api.php

@@ -10,14 +10,15 @@ return [
     'events' => [
         // order events
         'order.created',
+        'order.ready',
         'order.updated',
         'order.deleted',
         'order.dispatched',
         'order.dispatch_failed',
-        'order.completed',
         'order.failed',
         'order.driver_assigned',
         'order.completed',
+        'order.canceled',
 
         // payload events
         'payload.created',
@@ -29,12 +30,19 @@ return [
         'entity.updated',
         'entity.deleted',
         'entity.driver_assigned',
+        'entity.activity',
+        'entity.completed',
+
+        // waypoint events
+        'waypoint.activity',
+        'waypoint.completed',
 
         // driver events
         'driver.created',
         'driver.updated',
         'driver.deleted',
         'driver.assigned',
+        'driver.location_changed',
         // 'driver.entered_zone',
         // 'driver.exited_zone',
 
@@ -87,6 +95,7 @@ return [
         'vehicle.created',
         'vehicle.updated',
         'vehicle.deleted',
+        'vehicle.location_changed',
 
         // vendor events
         'vendor.created',

package/server/src/Auth/Schemas/FleetOps.php

@@ -120,6 +120,11 @@ class FleetOps
             'action'         => [],
             'remove_actions' => ['export', 'create'],
         ],
+        [
+            'name'           => 'routing-settings',
+            'action'         => [],
+            'remove_actions' => ['export', 'create'],
+        ],
     ];
 
     /**

package/server/src/Console/Commands/DebugOrderTracker.php

@@ -29,11 +29,11 @@ class DebugOrderTracker extends Command
      */
     public function handle()
     {
-        $order = Order::where('public_id', 'order_n227274')->first();
-        if ($order) {
-            $tracker = new OrderTracker($order);
-            dd($tracker->getOrderProgressPercentage());
-        }
+        // $order = Order::where('public_id', 'order_n227274')->first();
+        // if ($order) {
+        //     $tracker = new OrderTracker($order);
+        //     dd($tracker->getOrderProgressPercentage());
+        // }
 
         return Command::SUCCESS;
     }

package/server/src/Events/EntityActivityChanged.php

@@ -0,0 +1,118 @@
+<?php
+
+namespace Fleetbase\FleetOps\Events;
+
+use Fleetbase\FleetOps\Flow\Activity;
+use Fleetbase\FleetOps\Models\Entity;
+use Fleetbase\FleetOps\Models\Order;
+use Illuminate\Broadcasting\Channel;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Carbon;
+
+class EntityActivityChanged implements ShouldBroadcast
+{
+    use Dispatchable;
+    use InteractsWithSockets;
+    use SerializesModels;
+
+    /**
+     * The entity which has new activity.
+     */
+    public Entity $entity;
+
+    /**
+     * The activity which triggered the waypoint completed.
+     */
+    public Activity $activity;
+
+    /**
+     * The event id.
+     *
+     * @var string
+     */
+    public $eventId;
+
+    /**
+     * The datetime instance the broadcast ws triggered.
+     *
+     * @var string
+     */
+    public $sentAt;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(Entity $entity, Activity $activity)
+    {
+        $this->entity           = $entity;
+        $this->activity         = $activity;
+        $this->eventId          = uniqid('event_');
+        $this->sentAt           = Carbon::now()->toDateTimeString();
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return Channel|array
+     */
+    public function broadcastOn()
+    {
+        $channels = [
+            new Channel('api.' . session('api_credential')),
+            new Channel('entity.' . $this->entity->public_id),
+            new Channel('entity.' . $this->entity->uuid),
+        ];
+
+        $order = $this->getModelRecord();
+        if ($order) {
+            $channels[] = new Channel('company.' . session('company', data_get($order, 'company.uuid')));
+            $channels[] = new Channel('company.' . data_get($order, 'company.public_id'));
+            $channels[] = new Channel('order.' . $order->uuid);
+            $channels[] = new Channel('order.' . $order->public_id);
+        }
+
+        return $channels;
+    }
+
+    /**
+     * The event's broadcast name.
+     *
+     * @return string
+     */
+    public function broadcastAs()
+    {
+        return 'entity.activity';
+    }
+
+    /**
+     * Get the data to broadcast.
+     *
+     * @return array
+     */
+    public function broadcastWith()
+    {
+        return [
+            'id'          => $this->eventId,
+            'api_version' => config('api.version'),
+            'event'       => $this->broadcastAs(),
+            'created_at'  => $this->sentAt,
+            'data'        => [
+                'entity'   => $this->entity->public_id,
+                'activity' => $this->activity->toArray(),
+            ],
+        ];
+    }
+
+    /**
+     * Get the assosciated order model record for this waypoint.
+     */
+    public function getModelRecord(): ?Order
+    {
+        return Order::where('payload_uuid', $this->entity->payload_uuid)->first();
+    }
+}

package/server/src/Events/EntityCompleted.php

@@ -0,0 +1,118 @@
+<?php
+
+namespace Fleetbase\FleetOps\Events;
+
+use Fleetbase\FleetOps\Flow\Activity;
+use Fleetbase\FleetOps\Models\Entity;
+use Fleetbase\FleetOps\Models\Order;
+use Illuminate\Broadcasting\Channel;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Carbon;
+
+class EntityCompleted implements ShouldBroadcast
+{
+    use Dispatchable;
+    use InteractsWithSockets;
+    use SerializesModels;
+
+    /**
+     * The entity which is completed.
+     */
+    public Entity $entity;
+
+    /**
+     * The activity which triggered the waypoint completed.
+     */
+    public Activity $activity;
+
+    /**
+     * The event id.
+     *
+     * @var string
+     */
+    public $eventId;
+
+    /**
+     * The datetime instance the broadcast ws triggered.
+     *
+     * @var string
+     */
+    public $sentAt;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(Entity $entity, Activity $activity)
+    {
+        $this->entity           = $entity;
+        $this->activity         = $activity;
+        $this->eventId          = uniqid('event_');
+        $this->sentAt           = Carbon::now()->toDateTimeString();
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return Channel|array
+     */
+    public function broadcastOn()
+    {
+        $channels = [
+            new Channel('api.' . session('api_credential')),
+            new Channel('entity.' . $this->entity->public_id),
+            new Channel('entity.' . $this->entity->uuid),
+        ];
+
+        $order = $this->getModelRecord();
+        if ($order) {
+            $channels[] = new Channel('company.' . session('company', data_get($order, 'company.uuid')));
+            $channels[] = new Channel('company.' . data_get($order, 'company.public_id'));
+            $channels[] = new Channel('order.' . $order->uuid);
+            $channels[] = new Channel('order.' . $order->public_id);
+        }
+
+        return $channels;
+    }
+
+    /**
+     * The event's broadcast name.
+     *
+     * @return string
+     */
+    public function broadcastAs()
+    {
+        return 'entity.completed';
+    }
+
+    /**
+     * Get the data to broadcast.
+     *
+     * @return array
+     */
+    public function broadcastWith()
+    {
+        return [
+            'id'          => $this->eventId,
+            'api_version' => config('api.version'),
+            'event'       => $this->broadcastAs(),
+            'created_at'  => $this->sentAt,
+            'data'        => [
+                'entity'   => $this->entity->public_id,
+                'activity' => $this->activity->toArray(),
+            ],
+        ];
+    }
+
+    /**
+     * Get the assosciated order model record for this waypoint.
+     */
+    public function getModelRecord(): ?Order
+    {
+        return Order::where('payload_uuid', $this->entity->payload_uuid)->first();
+    }
+}

package/server/src/Http/Controllers/Api/v1/ServiceAreaController.php

@@ -66,7 +66,9 @@ class ServiceAreaController extends Controller
         try {
             $serviceArea = ServiceArea::create($input);
         } catch (\Throwable $e) {
-            dd($e->getMessage());
+            logger()->error('Unable to create service area.', ['error' => $e->getMessage()]);
+
+            return response()->apiError('Failed to create service area.');
         }
 
         // response the driver resource

package/server/src/Http/Controllers/Internal/v1/OrderController.php

@@ -167,25 +167,28 @@ class OrderController extends FleetOpsController
                         );
                     }
 
-                    // notify driver if assigned
-                    $order->notifyDriverAssigned();
+                    // Run background processes on queue
+                    dispatch(function () use ($order, $serviceQuote): void {
+                        // notify driver if assigned
+                        $order->notifyDriverAssigned();
 
-                    // set driving distance and time
-                    $order->setPreliminaryDistanceAndTime();
+                        // set driving distance and time
+                        $order->setPreliminaryDistanceAndTime();
 
-                    // if service quote attached purchase
-                    $order->purchaseServiceQuote($serviceQuote);
+                        // if service quote attached purchase
+                        $order->purchaseServiceQuote($serviceQuote);
 
-                    // dispatch if flagged true
-                    $order->firstDispatchWithActivity();
+                        // dispatch if flagged true
+                        $order->firstDispatchWithActivity();
 
-                    // load tracking number
-                    $order->load(['trackingNumber']);
+                        // Trigger order created event
+                        event(new OrderReady($order));
+                    })->afterCommit();
                 }
             );
 
-            // Trigger order created event
-            event(new OrderReady($record));
+            // Reload payload and tracking number
+            $record->load(['payload', 'trackingNumber']);
 
             return ['order' => new $this->resource($record)];
         } catch (\Exception $e) {
@@ -351,7 +354,7 @@ class OrderController extends FleetOpsController
      */
     public function bulkCancel(BulkActionRequest $request)
     {
-        /** @var Order */
+        /** @var \Illuminate\Database\Eloquent\Collection $orders */
         $orders = Order::whereIn('uuid', $request->input('ids'))->get();
 
         $count      = $orders->count();

package/server/src/Http/Controllers/Internal/v1/SettingController.php

@@ -150,7 +150,7 @@ class SettingController extends Controller
         if (!is_array($notificationSettings)) {
             throw new \Exception('Invalid notification settings data.');
         }
-        $currentNotificationSettings = Setting::lookupCompany('notification_settings');
+        $currentNotificationSettings = Setting::lookupCompany('notification_settings', []);
         Setting::configureCompany('notification_settings', array_merge($currentNotificationSettings, $notificationSettings));
 
         return response()->json([
@@ -174,4 +174,34 @@ class SettingController extends Controller
             'notificationSettings' => $notificationSettings,
         ]);
     }
+
+    /**
+     * Save routing settings.
+     *
+     * @param Request $request the HTTP request object containing the routing settings data
+     *
+     * @return \Illuminate\Http\JsonResponse a JSON response
+     */
+    public function saveRoutingSettings(Request $request)
+    {
+        $router = $request->input('router');
+        Setting::configureCompany('routing', ['router' => $router]);
+
+        return response()->json([
+            'status'  => 'ok',
+            'message' => 'Routing settings succesfully saved.',
+        ]);
+    }
+
+    /**
+     * Retrieve and return the routing settings.
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function getRoutingSettings()
+    {
+        $routingSettings = Setting::lookupCompany('routing', ['router' => 'osrm']);
+
+        return response()->json($routingSettings);
+    }
 }

package/server/src/Http/Resources/v1/Waypoint.php

@@ -58,7 +58,7 @@ class Waypoint extends FleetbaseResource
             'owner'                  => $this->when(!Http::isInternalRequest(), Resolve::resourceForMorph($this->owner_type, $this->owner_uuid)),
             'tracking_number'        => $this->whenLoaded('trackingNumber', $waypoint->trackingNumber),
             'customer'               => $this->setCustomerType(Resolve::resourceForMorph($waypoint->customer_type, $waypoint->customer_uuid)),
-            'type'                   => $this->type,
+            'type'                   => $waypoint->type ?? $this->type,
             'meta'                   => data_get($this, 'meta', Utils::createObject()),
             'eta'                    => $this->eta,
             'updated_at'             => $this->updated_at,

package/server/src/Models/Order.php

@@ -1173,6 +1173,12 @@ 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();
 
@@ -1395,8 +1401,6 @@ class Order extends Model
             $activity = $flow->firstWhere('code', $code);
         }
 
-        // dd($activity);
-
         if (!Utils::isActivity($activity)) {
             return false;
         }
@@ -1760,23 +1764,55 @@ class Order extends Model
      */
     public function resolveDynamicProperty(string $property)
     {
-        $snakedProperty = Str::snake($property);
+        // Special payload shortcuts
+        $root       = Str::before($property, '.');   // e.g. "pickup" in "pickup.address"
+        $payloadMap = [
+            'pickup'                => 'payload.pickup',
+            'dropoff'               => 'payload.dropoff',
+            'waypoint'              => 'payload.currentWaypointMarker',
+            'currentWaypoint'       => 'payload.currentWaypointMarker',
+            'currentWaypointMarker' => 'payload.currentWaypointMarker',
+        ];
+
+        if (isset($payloadMap[$root])) {
+            $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');
+
+                return data_get($target, $subKey) ?? data_get($target->place, $subKey);
+            }
+
+            return data_get($target, $subKey);
+        }
 
-        // check if existing property
-        if ($this->{$snakedProperty}) {
-            return $this->{$snakedProperty};
+        // Direct attribute on the model
+        $snake = Str::snake($property);
+        if (array_key_exists($snake, $this->getAttributes())) {
+            return $this->getAttribute($snake);
         }
 
-        // Check if custom field property
+        // Custom-field / meta look-ups
         if ($this->isCustomField($property)) {
             return $this->getCustomFieldValueByKey($property);
         }
 
-        // Check if meta attribute
         if ($this->hasMeta($property)) {
             return $this->getMeta($property);
         }
 
+        // Fallback deep-path access
         return data_get($this, $property);
     }
 

package/server/src/Models/Payload.php

@@ -3,6 +3,8 @@
 namespace Fleetbase\FleetOps\Models;
 
 use Fleetbase\Casts\Json;
+use Fleetbase\FleetOps\Events\EntityActivityChanged;
+use Fleetbase\FleetOps\Events\EntityCompleted;
 use Fleetbase\FleetOps\Events\WaypointActivityChanged;
 use Fleetbase\FleetOps\Events\WaypointCompleted;
 use Fleetbase\FleetOps\Flow\Activity;
@@ -185,6 +187,14 @@ class Payload extends Model
         return $this->belongsTo(Place::class, 'current_waypoint_uuid')->withoutGlobalScopes();
     }
 
+    /**
+     * The current waypoint of the payload in progress.
+     */
+    public function currentWaypointMarker()
+    {
+        return $this->belongsTo(Waypoint::class, 'current_waypoint_uuid', 'place_uuid')->withoutGlobalScopes();
+    }
+
     /**
      * Waypoints between start and end.
      *
@@ -305,7 +315,7 @@ class Payload extends Model
         }
 
         foreach ($waypoints as $index => $attributes) {
-            $waypoint = ['payload_uuid' => $this->payload_uuid];
+            $waypoint = ['payload_uuid' => $this->payload_uuid, 'type' => data_get($attributes, 'type', 'dropoff')];
 
             if (Utils::isset($attributes, 'place') && is_array(Utils::get($attributes, 'place'))) {
                 $attributes = Utils::get($attributes, 'place');
@@ -329,11 +339,13 @@ class Payload extends Model
             }
 
             // Handle customer assosciation for waypoint
-            if (is_array($attributes) && Utils::notEmpty($attributes['customer_uuid']) && Utils::notEmpty($attributes['customer_type'])) {
-                $customerTypeNamespace = Utils::getMutationType($attributes['customer_type']);
-                $customerExists        = app($customerTypeNamespace)->where('uuid', $attributes['customer_uuid'])->exists();
+            $customerId   = data_get($attributes, 'customer_uuid');
+            $customerType = data_get($attributes, 'customer_type', 'fleetops:contact');
+            if ($customerId && $customerType) {
+                $customerTypeNamespace = Utils::getMutationType($customerType);
+                $customerExists        = app($customerTypeNamespace)->where('uuid', $customerId)->exists();
                 if ($customerExists) {
-                    $waypoint['customer_uuid'] = $attributes['customer_uuid'];
+                    $waypoint['customer_uuid'] = $customerId;
                     $waypoint['customer_type'] = $customerTypeNamespace;
                 }
             }
@@ -355,7 +367,7 @@ class Payload extends Model
         }
 
         foreach ($waypoints as $index => $attributes) {
-            $waypoint = ['payload_uuid' => $this->uuid, 'order' => $index];
+            $waypoint = ['payload_uuid' => $this->uuid, 'order' => $index, 'type' => data_get($attributes, 'type', 'dropoff')];
 
             if (Utils::isset($attributes, 'place') && is_array(Utils::get($attributes, 'place'))) {
                 $placeAttributes = Utils::get($attributes, 'place');
@@ -384,11 +396,13 @@ class Payload extends Model
             }
 
             // Handle customer assosciation for waypoint
-            if (is_array($attributes) && Utils::notEmpty($attributes['customer_uuid']) && Utils::notEmpty($attributes['customer_type'])) {
-                $customerTypeNamespace = Utils::getMutationType($attributes['customer_type']);
-                $customerExists        = app($customerTypeNamespace)->where('uuid', $attributes['customer_uuid'])->exists();
+            $customerId   = data_get($attributes, 'customer_uuid');
+            $customerType = data_get($attributes, 'customer_type', 'fleetops:contact');
+            if ($customerId && $customerType) {
+                $customerTypeNamespace = Utils::getMutationType($customerType);
+                $customerExists        = app($customerTypeNamespace)->where('uuid', $customerId)->exists();
                 if ($customerExists) {
-                    $waypoint['customer_uuid'] = $attributes['customer_uuid'];
+                    $waypoint['customer_uuid'] = $customerId;
                     $waypoint['customer_type'] = $customerTypeNamespace;
                 }
             }
@@ -784,6 +798,11 @@ class Payload extends Model
             $entities = $this->entities->where('destination_uuid', $this->current_waypoint_uuid);
             foreach ($entities as $entity) {
                 $entity->insertActivity($activity, $location, $proof);
+                if ($activity && $activity->complete()) {
+                    event(new EntityCompleted($entity, $activity));
+                } else {
+                    event(new EntityActivityChanged($entity, $activity));
+                }
             }
 
             // if this activity completes the waypoint notify waypoint customer