@fleetbase/fleetops-engine 0.6.8 → 0.6.10

package/server/src/Http/Filter/OrderFilter.php

@@ -340,8 +340,8 @@ class OrderFilter extends Filter
     {
         $ids     = Utils::arrayFrom($ids);
         $firstId = Arr::first($ids);
-        $this->builder->where(function ($query) use ($ids, $firstId) {
-            if ($firstId) {
+        if ($firstId) {
+            $this->builder->where(function ($query) use ($ids, $firstId) {
                 if (Utils::isPublicId($firstId)) {
                     return $query->whereIn('public_id', $ids);
                 }
@@ -354,8 +354,8 @@ class OrderFilter extends Filter
                 $query->orWhereHas('trackingNumber', function ($query) use ($ids) {
                     $query->whereIn('tracking_number', $ids);
                 });
-            }
-        });
+            });
+        }
     }
 
     public function createdAt($createdAt)

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

@@ -29,7 +29,7 @@ class Payload extends FleetbaseResource
             'pickup_uuid'           => $this->when(Http::isInternalRequest(), $this->pickup_uuid),
             'dropoff_uuid'          => $this->when(Http::isInternalRequest(), $this->dropoff_uuid),
             'return_uuid'           => $this->when(Http::isInternalRequest(), $this->return_uuid),
-            'current_waypoint'      => $this->when(!Http::isInternalRequest() && $this->currentWaypoint, data_get($this, 'currentWaypoint.public_id')),
+            'current_waypoint'      => $this->when(Http::isPublicRequest() && $this->currentWaypoint, data_get($this, 'currentWaypoint.public_id')),
             'pickup'                => $this->getPlace($this->pickup),
             'dropoff'               => $this->getPlace($this->dropoff),
             'return'                => new Place($this->return),

package/server/src/Listeners/HandleOrderCanceled.php

@@ -3,7 +3,6 @@
 namespace Fleetbase\FleetOps\Listeners;
 
 use Fleetbase\FleetOps\Events\OrderCanceled;
-use Fleetbase\FleetOps\Flow\Activity;
 use Fleetbase\FleetOps\Models\Driver;
 use Fleetbase\FleetOps\Notifications\OrderCanceled as OrderCanceledNotification;
 use Illuminate\Contracts\Queue\ShouldQueue;
@@ -24,15 +23,6 @@ class HandleOrderCanceled implements ShouldQueue
     {
         /** @var \Fleetbase\FleetOps\Models\Order $order */
         $order    = $event->getModelRecord();
-        $location = $order->getLastLocation();
-
-        // Create order cancel activity
-        $activity = $order->config()->getCanceledActivity();
-
-        // Update order activity
-        $order->setStatus($activity->status);
-        $order->createActivity($activity, $location);
-
         if ($order->isIntegratedVendorOrder()) {
             $order->facilitator->provider()->callback('onCanceled', $order);
         }

package/server/src/Listeners/NotifyOrderEvent.php

@@ -32,15 +32,15 @@ class NotifyOrderEvent implements ShouldQueue
             // Send a notification for order events
             if ($event instanceof \Fleetbase\FleetOps\Events\OrderCanceled) {
                 $reason = $event->activity ? $event->activity->get('details') : '';
-                NotificationRegistry::notify(OrderCanceled::class, $order);
+                NotificationRegistry::notify(OrderCanceled::class, $order, $reason, $event->waypoint);
             }
             if ($event instanceof \Fleetbase\FleetOps\Events\OrderCompleted) {
-                NotificationRegistry::notify(OrderCompleted::class, $order);
+                NotificationRegistry::notify(OrderCompleted::class, $order, $event->waypoint);
             }
 
             if ($event instanceof \Fleetbase\FleetOps\Events\OrderFailed) {
                 $reason = $event->activity ? $event->activity->get('details') : '';
-                NotificationRegistry::notify(OrderFailed::class, $order, $reason);
+                NotificationRegistry::notify(OrderFailed::class, $order, $reason, $event->waypoint);
             }
 
             if ($event instanceof \Fleetbase\FleetOps\Events\OrderDispatchFailed) {
@@ -48,7 +48,7 @@ class NotifyOrderEvent implements ShouldQueue
             }
 
             if ($event instanceof \Fleetbase\FleetOps\Events\OrderDispatched) {
-                NotificationRegistry::notify(OrderDispatched::class, $order);
+                NotificationRegistry::notify(OrderDispatched::class, $order, $event->waypoint);
             }
 
             if ($event instanceof \Fleetbase\FleetOps\Events\OrderDriverAssigned) {

package/server/src/Models/OrderConfig.php

@@ -209,18 +209,25 @@ class OrderConfig extends Model
     /**
      * Retrieves the current order context, setting it if not already set.
      *
-     * @param Order|null $order the order to use as context if no current context is set
-     *
      * @return Order|null the current order context
      *
      * @throws \Exception if no order context is found and none is provided
      */
-    public function getOrderContext(?Order $order = null): ?Order
+    public function getOrderContext(Order|Waypoint|null $context = null): ?Order
     {
-        if (!$this->orderContext && $order instanceof Order) {
-            $this->setOrderContext($order);
+        if (!$this->orderContext && $context instanceof Order) {
+            $this->setOrderContext($context);
+
+            return $context;
+        }
 
-            return $order;
+        if (!$this->orderContext && $context instanceof Waypoint) {
+            $order = Order::where('payload_uuid', $context->payload_uuid)->first();
+            if ($order) {
+                $this->setOrderContext($order);
+
+                return $order;
+            }
         }
 
         if (!$this->orderContext) {
@@ -268,30 +275,35 @@ class OrderConfig extends Model
     /**
      * Determines the current activity based on the order's status.
      *
-     * @param Order|null $order the order to evaluate
-     *
      * @return Activity|null the current Activity object or null if not found
      */
-    public function currentActivity(?Order $order = null): ?Activity
+    public function currentActivity(Order|Waypoint|null $context = null): ?Activity
     {
-        $order = $this->getOrderContext($order);
+        if ($context === null) {
+            $context = $this->getOrderContext($context);
+        }
+
+        if ($context instanceof Waypoint) {
+            return $this->activities()->firstWhere('code', strtolower($context->status_code));
+        }
 
-        return $this->activities()->firstWhere('code', $order->status);
+        return $this->activities()->firstWhere('code', $context->status);
     }
 
     /**
      * Determines the next set of activities based on the current activity.
      *
-     * @param Order|null $order the order to evaluate
-     *
      * @return Collection a collection of the next activities
      */
-    public function nextActivity(?Order $order = null): Collection
+    public function nextActivity(Order|Waypoint|null $context = null): Collection
     {
-        $order           = $this->getOrderContext($order);
-        $currentActivity = $this->currentActivity($order);
+        if ($context === null) {
+            $context = $this->getOrderContext($context);
+        }
+
+        $currentActivity = $this->currentActivity($context);
         if ($currentActivity) {
-            return $currentActivity->getNext($order);
+            return $currentActivity->getNext($context);
         }
 
         return collect();
@@ -300,17 +312,18 @@ class OrderConfig extends Model
     /**
      * Retrieves the first activity in the next set of activities.
      *
-     * @param Order|null $order the order to evaluate
-     *
      * @return Activity|null the first Activity object in the next set or null if not found
      */
-    public function nextFirstActivity(?Order $order = null): ?Activity
+    public function nextFirstActivity(Order|Waypoint|null $context = null): ?Activity
     {
+        if ($context === null) {
+            $context = $this->getOrderContext($context);
+        }
+
         $next            = collect();
-        $order           = $this->getOrderContext($order);
-        $currentActivity = $this->currentActivity($order);
+        $currentActivity = $this->currentActivity($context);
         if ($currentActivity) {
-            $next = $currentActivity->getNext($order);
+            $next = $currentActivity->getNext($context);
         }
 
         return $next->first();
@@ -319,17 +332,18 @@ class OrderConfig extends Model
     /**
      * Retrieves the activity that follows after the next activity.
      *
-     * @param Order|null $order the order to evaluate
-     *
      * @return Activity|null the Activity object that follows after the next or null if not found
      */
-    public function afterNextActivity(?Order $order = null): ?Activity
+    public function afterNextActivity(Order|Waypoint|null $context = null): ?Activity
     {
+        if ($context === null) {
+            $context = $this->getOrderContext($context);
+        }
+
         $afterNext       = collect();
-        $order           = $this->getOrderContext($order);
-        $nextActivity    = $this->nextFirstActivity($order);
+        $nextActivity    = $this->nextFirstActivity($context);
         if ($nextActivity) {
-            $afterNext = $nextActivity->getNext($order);
+            $afterNext = $nextActivity->getNext($context);
         }
 
         return $afterNext->first();
@@ -338,16 +352,17 @@ class OrderConfig extends Model
     /**
      * Retrieves the previous activities based on the current activity.
      *
-     * @param Order|null $order the order to evaluate
-     *
      * @return Collection a collection of previous activities
      */
-    public function previousActivity(?Order $order = null): Collection
+    public function previousActivity(Order|Waypoint|null $context = null): Collection
     {
-        $order           = $this->getOrderContext($order);
-        $currentActivity = $this->currentActivity($order);
+        if ($context === null) {
+            $context = $this->getOrderContext($context);
+        }
+
+        $currentActivity = $this->currentActivity($context);
         if ($currentActivity) {
-            return $currentActivity->getPrevious($order);
+            return $currentActivity->getPrevious($context);
         }
 
         return collect();

package/server/src/Models/Payload.php

@@ -3,6 +3,8 @@
 namespace Fleetbase\FleetOps\Models;
 
 use Fleetbase\Casts\Json;
+use Fleetbase\FleetOps\Events\WaypointActivityChanged;
+use Fleetbase\FleetOps\Events\WaypointCompleted;
 use Fleetbase\FleetOps\Flow\Activity;
 use Fleetbase\FleetOps\Http\Resources\v1\Payload as PayloadResource;
 use Fleetbase\FleetOps\Support\Utils;
@@ -282,10 +284,13 @@ class Payload extends Model
         return $this;
     }
 
-    public function setCurrentWaypoint(Place $destination, bool $save = true): Payload
+    public function setCurrentWaypoint(Place|Waypoint $destination, bool $save = true): Payload
     {
-        $this->current_waypoint_uuid = $destination->uuid;
+        if ($destination instanceof Waypoint) {
+            $destination = $destination->getPlace();
+        }
 
+        $this->current_waypoint_uuid = $destination->uuid;
         if ($save) {
             DB::table($this->getTable())->where('uuid', $this->uuid)->update(['current_waypoint_uuid' => $destination->uuid]);
         }
@@ -772,7 +777,7 @@ class Payload extends Model
             $currentWaypoint = $this->waypointMarkers->firstWhere('place_uuid', $this->current_waypoint_uuid);
             if ($currentWaypoint) {
                 $currentWaypoint->insertActivity($activity, $location, $proof);
-                $activity->fireEvents($this->order);
+                $activity->fireEvents($this->order, $currentWaypoint);
             }
 
             // update activity for all entities for this destination/waypoint
@@ -780,6 +785,13 @@ class Payload extends Model
             foreach ($entities as $entity) {
                 $entity->insertActivity($activity, $location, $proof);
             }
+
+            // if this activity completes the waypoint notify waypoint customer
+            if ($activity && $activity->complete()) {
+                event(new WaypointCompleted($currentWaypoint, $activity));
+            } else {
+                event(new WaypointActivityChanged($currentWaypoint, $activity));
+            }
         }
 
         return $this;
@@ -792,16 +804,23 @@ class Payload extends Model
      */
     public function setNextWaypointDestination()
     {
-        $nextWaypoint = $this->waypointMarkers->filter(function ($waypoint) {
+        $nextWaypoint = $this->waypointMarkers->first(function ($waypoint) {
             return !$waypoint->complete && $waypoint->place_uuid !== $this->current_waypoint_uuid;
-        })->first();
+        });
 
         if (!$nextWaypoint || $this->current_waypoint_uuid === $nextWaypoint->place_uuid) {
             return $this;
         }
 
-        $this->setRelation('currentWaypoint', $nextWaypoint);
-        $this->update(['current_waypoint_uuid' => $nextWaypoint->place_uuid]);
+        // if next waypoint is waypoint get the place record
+        $destination = $nextWaypoint;
+        if ($nextWaypoint instanceof Waypoint) {
+            $destination = $nextWaypoint->getPlace();
+        }
+
+        // Always set the destination using a place model
+        $this->setCurrentWaypoint($destination);
+        $this->setRelation('currentWaypoint', $destination);
 
         return $this;
     }

package/server/src/Models/Waypoint.php

@@ -224,4 +224,14 @@ class Waypoint extends Model
 
         return $result ? $uuid : false;
     }
+
+    /**
+     * Get this waypoint place record.
+     */
+    public function getPlace(): ?Place
+    {
+        $this->loadMissing('place');
+
+        return $this->place ?? Place::where('uuid', $this->place_uuid)->first();
+    }
 }

package/server/src/Notifications/OrderAssigned.php

@@ -21,7 +21,7 @@ class OrderAssigned extends Notification implements ShouldQueue
     /**
      * The order instance this notification is for.
      *
-     * @var \Fleetbase\Models\Order
+     * @var Order
      */
     public $order;
 
@@ -106,12 +106,10 @@ class OrderAssigned extends Notification implements ShouldQueue
         $order = new OrderResource($this->order);
 
         return [
+            'event' => 'order.assigned_notification',
             'title' => $this->title,
             'body'  => $this->message,
-            'data'  => [
-                ...$this->data,
-                'order' => $order->toWebhookPayload(),
-            ],
+            'data'  => $this->data,
         ];
     }
 

package/server/src/Notifications/OrderCanceled.php

@@ -4,6 +4,7 @@ namespace Fleetbase\FleetOps\Notifications;
 
 use Fleetbase\FleetOps\Http\Resources\v1\Order as OrderResource;
 use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Models\Waypoint;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Support\PushNotification;
 use Illuminate\Broadcasting\Channel;
@@ -21,10 +22,17 @@ class OrderCanceled extends Notification implements ShouldQueue
     /**
      * The order instance this notification is for.
      *
-     * @var \Fleetbase\Models\Order
+     * @var Order
      */
     public $order;
 
+    /**
+     * The waypoint instance this notification is for.
+     *
+     * @var Waypoint
+     */
+    public $waypoint;
+
     /**
      * Notification name.
      */
@@ -65,13 +73,14 @@ class OrderCanceled extends Notification implements ShouldQueue
      *
      * @return void
      */
-    public function __construct(Order $order, string $reason = '')
+    public function __construct(Order $order, string $reason = '', ?Waypoint $waypoint = null)
     {
-        $this->order    = $order;
-        $this->reason   = $reason;
-        $this->title    = 'Order ' . $this->order->trackingNumber->tracking_number . ' was canceled';
-        $this->message  = 'Order ' . $this->order->trackingNumber->tracking_number . ' has been canceled.';
-        $this->data     = ['id' => $this->order->public_id, 'type' => 'order_canceled'];
+        $this->order       = $order;
+        $this->waypoint    = $waypoint;
+        $this->reason      = $reason;
+        $this->title       = 'Order ' . $this->getTrackingNumber() . ' was canceled';
+        $this->message     = 'Order ' . $this->getTrackingNumber() . ' has been canceled.';
+        $this->data        = ['id' => $this->order->public_id, 'type' => 'order_canceled'];
     }
 
     /**
@@ -110,12 +119,10 @@ class OrderCanceled extends Notification implements ShouldQueue
         $order = new OrderResource($this->order);
 
         return [
+            'event' => 'order.canceled_notification',
             'title' => $this->title,
             'body'  => $this->message . ' ' . $this->reason,
-            'data'  => [
-                ...$this->data,
-                'order' => $order->toWebhookPayload(),
-            ],
+            'data'  => $this->data,
         ];
     }
 
@@ -131,7 +138,7 @@ class OrderCanceled extends Notification implements ShouldQueue
             ->line($this->message)
             ->line($this->reason)
             ->line('No further action is necessary.')
-            ->action('Track Order', Utils::consoleUrl('track-order', ['order' => $this->order->trackingNumber->tracking_number]));
+            ->action('Track Order', Utils::consoleUrl('track-order', ['order' => $this->getTrackingNumber()]));
     }
 
     /**
@@ -153,4 +160,17 @@ class OrderCanceled extends Notification implements ShouldQueue
     {
         return PushNotification::createApnMessage($this->title, $this->message, $this->data, 'view_order');
     }
+
+    /**
+     * Get the tracking number which should be used for this event.
+     * In the case that the order has a currentWaypoint attached use its tracking number otherwise use the orders.
+     */
+    private function getTrackingNumber(): ?string
+    {
+        if ($this->waypoint instanceof Waypoint) {
+            return $this->waypoint->tracking;
+        }
+
+        return $this->order->tracking;
+    }
 }

package/server/src/Notifications/OrderCompleted.php

@@ -4,6 +4,7 @@ namespace Fleetbase\FleetOps\Notifications;
 
 use Fleetbase\FleetOps\Http\Resources\v1\Order as OrderResource;
 use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Models\Waypoint;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Support\PushNotification;
 use Illuminate\Broadcasting\Channel;
@@ -21,10 +22,17 @@ class OrderCompleted extends Notification implements ShouldQueue
     /**
      * The order instance this notification is for.
      *
-     * @var \Fleetbase\Models\Order
+     * @var Order
      */
     public $order;
 
+    /**
+     * The waypoint instance this notification is for.
+     *
+     * @var Waypoint
+     */
+    public $waypoint;
+
     /**
      * Notification name.
      */
@@ -60,12 +68,13 @@ class OrderCompleted extends Notification implements ShouldQueue
      *
      * @return void
      */
-    public function __construct(Order $order)
+    public function __construct(Order $order, ?Waypoint $waypoint = null)
     {
-        $this->order   = $order;
-        $this->title   = 'Order ' . $this->order->trackingNumber->tracking_number . ' has been completed.';
-        $this->message = 'Order ' . $this->order->trackingNumber->tracking_number . ' has been completed by agent.';
-        $this->data    = ['id' => $this->order->public_id, 'type' => 'order_completed'];
+        $this->order      = $order;
+        $this->waypoint   = $waypoint;
+        $this->title      = 'Order ' . $this->getTrackingNumber() . ' has been completed.';
+        $this->message    = 'Order ' . $this->getTrackingNumber() . ' has been completed by agent.';
+        $this->data       = ['id' => $this->order->public_id, 'type' => 'order_completed'];
     }
 
     /**
@@ -104,12 +113,10 @@ class OrderCompleted extends Notification implements ShouldQueue
         $order = new OrderResource($this->order);
 
         return [
+            'event' => 'order.completed_notification',
             'title' => $this->title,
             'body'  => $this->message,
-            'data'  => [
-                ...$this->data,
-                'order' => $order->toWebhookPayload(),
-            ],
+            'data'  => $this->data,
         ];
     }
 
@@ -124,7 +131,7 @@ class OrderCompleted extends Notification implements ShouldQueue
             ->subject($this->title)
             ->line($this->message)
             ->line('No further action is necessary.')
-            ->action('Track Order', Utils::consoleUrl('track-order', ['order' => $this->order->trackingNumber->tracking_number]));
+            ->action('Track Order', Utils::consoleUrl('track-order', ['order' => $this->getTrackingNumber()]));
     }
 
     /**
@@ -146,4 +153,17 @@ class OrderCompleted extends Notification implements ShouldQueue
     {
         return PushNotification::createApnMessage($this->title, $this->message, $this->data, 'view_order');
     }
+
+    /**
+     * Get the tracking number which should be used for this event.
+     * In the case that the order has a currentWaypoint attached use its tracking number otherwise use the orders.
+     */
+    private function getTrackingNumber(): ?string
+    {
+        if ($this->waypoint instanceof Waypoint) {
+            return $this->waypoint->tracking;
+        }
+
+        return $this->order->tracking;
+    }
 }

package/server/src/Notifications/OrderDispatchFailed.php

@@ -19,7 +19,7 @@ class OrderDispatchFailed extends Notification implements ShouldQueue
     /**
      * The order instance this notification is for.
      *
-     * @var \Fleetbase\Models\Order
+     * @var Order
      */
     public $order;
 
@@ -110,12 +110,10 @@ class OrderDispatchFailed extends Notification implements ShouldQueue
         $order = new OrderResource($this->order);
 
         return [
+            'event' => 'order.assigned_failed_notification',
             'title' => $this->title,
             'body'  => $this->message,
-            'data'  => [
-                ...$this->data,
-                'order' => $order->toWebhookPayload(),
-            ],
+            'data'  => $this->data,
         ];
     }
 

package/server/src/Notifications/OrderDispatched.php

@@ -5,6 +5,7 @@ namespace Fleetbase\FleetOps\Notifications;
 use Fleetbase\Events\ResourceLifecycleEvent;
 use Fleetbase\FleetOps\Http\Resources\v1\Order as OrderResource;
 use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Models\Waypoint;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Support\PushNotification;
 use Illuminate\Broadcasting\Channel;
@@ -23,10 +24,17 @@ class OrderDispatched extends Notification implements ShouldQueue
     /**
      * The order instance this notification is for.
      *
-     * @var \Fleetbase\Models\Order
+     * @var Order
      */
     public $order;
 
+    /**
+     * The waypoint instance this notification is for.
+     *
+     * @var Waypoint
+     */
+    public $waypoint;
+
     /**
      * Notification name.
      */
@@ -62,12 +70,13 @@ class OrderDispatched extends Notification implements ShouldQueue
      *
      * @return void
      */
-    public function __construct(Order $order)
+    public function __construct(Order $order, ?Waypoint $waypoint = null)
     {
-        $this->order   = $order;
-        $this->title   = 'Order ' . $this->order->trackingNumber->tracking_number . ' has been dispatched!';
-        $this->message = 'An order has just been dispatched to you and is ready to be started.';
-        $this->data    = ['id' => $this->order->public_id, 'type' => 'order_dispatched'];
+        $this->order       = $order;
+        $this->waypoint    = $waypoint;
+        $this->title       = 'Order ' . $this->getTrackingNumber() . ' has been dispatched!';
+        $this->message     = 'An order has just been dispatched to you and is ready to be started.';
+        $this->data        = ['id' => $this->order->public_id, 'type' => 'order_dispatched'];
     }
 
     /**
@@ -118,12 +127,10 @@ class OrderDispatched extends Notification implements ShouldQueue
         $order = new OrderResource($this->order);
 
         return [
+            'event' => 'order.dispatched_notification',
             'title' => $this->title,
             'body'  => $this->message,
-            'data'  => [
-                ...$this->data,
-                'order' => $order->toWebhookPayload(),
-            ],
+            'data'  => $this->data,
         ];
     }
 
@@ -169,7 +176,7 @@ class OrderDispatched extends Notification implements ShouldQueue
         return (new MailMessage())
             ->subject($this->title)
             ->line($this->message)
-            ->action('Track Order', Utils::consoleUrl('track-order', ['order' => $this->order->trackingNumber->tracking_number]));
+            ->action('Track Order', Utils::consoleUrl('track-order', ['order' => $this->getTrackingNumber()]));
     }
 
     /**
@@ -191,4 +198,17 @@ class OrderDispatched extends Notification implements ShouldQueue
     {
         return PushNotification::createApnMessage($this->title, $this->message, $this->data, 'view_order');
     }
+
+    /**
+     * Get the tracking number which should be used for this event.
+     * In the case that the order has a currentWaypoint attached use its tracking number otherwise use the orders.
+     */
+    private function getTrackingNumber(): ?string
+    {
+        if ($this->waypoint instanceof Waypoint) {
+            return $this->waypoint->tracking;
+        }
+
+        return $this->order->tracking;
+    }
 }