@fleetbase/fleetops-engine 0.2.5 → 0.2.7

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

@@ -0,0 +1,137 @@
+<?php
+
+namespace Fleetbase\FleetOps\Console\Commands;
+
+use Fleetbase\FleetOps\Models\Driver;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Support\Utils;
+use Grimzy\LaravelMysqlSpatial\Types\Point;
+use Illuminate\Console\Command;
+use Illuminate\Support\Carbon;
+
+class DispatchAdhocOrders extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'fleetops:dispatch-adhoc {--sandbox} {--testing}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Dispatch & ping adhoc orders where no driver is assigned, only if order isn\'t assigned after 2 minutes';
+
+    /**
+     * Execute the console command.
+     *
+     * This method is responsible for the main logic of the command.
+     * It fetches dispatchable orders, notifies about the current time and number of orders,
+     * and then dispatches each order if there are nearby drivers.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        // Set UTC as default timezone
+        date_default_timezone_set('UTC');
+
+        // Get all dispatchable orders
+        $orders = $this->getDispatchableOrders();
+
+        // Notify Current Time and # of Orders in Alera
+        $this->alert('Found (' . $orders->count() . ') Orders to be Dispatched -- Current Time: ' . Carbon::now()->toDateTimeString());
+
+        // Iterate for each order
+        $orders->each(
+            function ($order) {
+                $pickup   = $order->getPickupLocation();
+                $distance = $order->getAdhocPingDistance();
+
+                if (!Utils::isPoint($pickup)) {
+                    return;
+                }
+
+                // Get nearby drivers for this order
+                $drivers = $this->getNearbyDriversForOrder($order, $pickup, $distance);
+
+                // Inform
+                $this->alert('Found (' . $drivers->count() . ') driver within ' . $distance . ' meters of the pickup location for order ' . $order->public_id);
+
+                // Dispatch if there is nearby drivers
+                if ($drivers->count()) {
+                    $order->dispatch(true);
+                    $this->info('Order ' . $order->public_id . ' dispatched!');
+                }
+            }
+        );
+    }
+
+    /**
+     * Fetches dispatchable orders based on certain criteria.
+     */
+    public function getDispatchableOrders(): \Illuminate\Database\Eloquent\Collection
+    {
+        $sandbox  = Utils::castBoolean($this->option('sandbox'));
+        $interval = 4;
+
+        return Order::on($sandbox ? 'sandbox' : 'mysql')
+            ->withoutGlobalScopes()
+            ->where(['adhoc' => 1, 'dispatched' => 1, 'started' => 0])
+            ->whereDate('dispatched_at', '<=', Carbon::now()->subMinutes($interval)->toDateTimeString())
+            ->whereNull('driver_assigned_uuid')
+            ->whereNull('deleted_at')
+            ->where('status', '!=', 'canceled')
+            ->whereHas('company', function ($q) {
+                $q->whereHas('users', function ($q) {
+                    $q->whereHas('driver', function ($q) {
+                        $q->where(['status' => 'active', 'online' => 1]);
+                        $q->whereNull('deleted_at');
+                    });
+                });
+            })
+            ->whereHas('payload')
+            ->with(['company', 'payload'])
+            ->get();
+    }
+
+    /**
+     * Fetches nearby drivers for a given order based on the pickup location and distance.
+     */
+    public function getNearbyDriversForOrder(Order $order, Point $pickup, int $distance): \Illuminate\Database\Eloquent\Collection
+    {
+        $testing = Utils::castBoolean($this->option('testing'));
+
+        if ($testing) {
+            // one for testing when cannoty be geospatially accurate
+            $drivers = Driver::where(['status' => 'active', 'online' => 1])
+                ->where(function ($q) use ($order) {
+                    $q->where('company_uuid', $order->company_uuid);
+                    $q->orWhereHas('user', function ($q) use ($order) {
+                        $q->where('company_uuid', $order->company_uuid);
+                    });
+                })
+                ->whereNull('deleted_at')
+                ->withoutGlobalScopes()
+                ->get();
+        } else {
+            $drivers = Driver::where(['status' => 'active', 'online' => 1])
+                ->where(function ($q) use ($order) {
+                    $q->where('company_uuid', $order->company_uuid);
+                    $q->orWhereHas('user', function ($q) use ($order) {
+                        $q->where('company_uuid', $order->company_uuid);
+                    });
+                })
+                ->whereNull('deleted_at')
+                ->distanceSphere('location', $pickup, $distance)
+                ->distanceSphereValue('location', $pickup)
+                ->withoutGlobalScopes()
+                ->get();
+        }
+
+        return $drivers;
+    }
+}

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

@@ -0,0 +1,71 @@
+<?php
+
+namespace Fleetbase\FleetOps\Console\Commands;
+
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Support\Utils;
+use Illuminate\Console\Command;
+use Illuminate\Support\Carbon;
+
+class DispatchOrders extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'fleetops:dispatch-orders {--sandbox=false}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Dispatches scheduled orders.';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        // Set UTC as default timezone
+        date_default_timezone_set('UTC');
+
+        // Get all scheduled dispatchable orders
+        $orders = $this->getScheduledOrders();
+
+        // Notify Current Time and # of Orders in Alera
+        $this->alert('Found (' . $orders->count() . ') Orders Scheduled for Dispatched -- Current Time: ' . Carbon::now()->toDateTimeString());
+
+        // Dispatch each order
+        $orders->each(
+            function ($order) {
+                if ($order->shouldDispatch()) {
+                    $order->dispatch();
+
+                    $this->info('Order ' . $order->public_id . ' dispatched! (' . $order->scheduled_at . ')');
+                } else {
+                    $this->warn('Order ' . $order->public_id . ' will be dispatched today today AT ' . $order->scheduled_at);
+                }
+            }
+        );
+    }
+
+    /**
+     * Fetches scheduled dispatchable orders based on certain criteria.
+     */
+    public function getScheduledOrders(): \Illuminate\Database\Eloquent\Collection
+    {
+        $sandbox = Utils::castBoolean($this->option('sandbox'));
+
+        return Order::on($sandbox ? 'sandbox' : 'mysql')
+            ->withoutGlobalScopes()
+            ->where('dispatched', 0)
+            ->whereIn('status', ['pending', 'created'])
+            ->whereDate('scheduled_at', Carbon::today())
+            ->whereNull('deleted_at')
+            ->get();
+    }
+}

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

@@ -0,0 +1,62 @@
+<?php
+
+namespace Fleetbase\FleetOps\Console\Commands;
+
+use Fleetbase\FleetOps\Models\Order;
+use Illuminate\Console\Command;
+use Illuminate\Support\Carbon;
+
+class TrackOrderDistanceAndTime extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'fleetops:update-estimations';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Track and update order distance and time estimations';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        // Set UTC as default timezone
+        date_default_timezone_set('UTC');
+
+        // Get all active/ready order
+        $orders = $this->getActiveOrders();
+
+        // Track updated orders
+        $updated = [];
+
+        // Notify Current Time and # of Orders in Alera
+        $this->alert('Found (' . $orders->count() . ') Orders to update Tracking Estimation -- Current Time: ' . Carbon::now()->toDateTimeString());
+
+        // Update for each order
+        $orders->each(
+            function ($order) use (&$updated) {
+                $updated[] = $order->setDistanceAndTime()->id;
+            }
+        );
+
+        // Update info
+        $this->info('Updated ' . count($updated) . '/' . $orders->count() . ' orders Distance & Time Estimations.');
+    }
+
+    /**
+     * Fetches active orders.
+     */
+    public function getActiveOrders(): \Illuminate\Database\Eloquent\Collection
+    {
+        return Order::whereNotIn('status', ['completed', 'canceled'])->whereNull(['deleted_at'])->whereNotNull('company_uuid')->whereHas('payload')->with(['payload', 'payload.waypoints', 'payload.pickup', 'payload.dropoff'])->withoutGlobalScopes()->get();
+    }
+}

package/server/src/Events/DriverLocationChanged.php

@@ -0,0 +1,174 @@
+<?php
+
+namespace Fleetbase\FleetOps\Events;
+
+use Fleetbase\FleetOps\Models\Driver;
+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 DriverLocationChanged implements ShouldBroadcast
+{
+    use Dispatchable;
+    use InteractsWithSockets;
+    use SerializesModels;
+
+    /**
+     * The event id.
+     *
+     * @var string
+     */
+    public $eventId;
+
+    /**
+     * The datetime instance the broadcast ws triggered.
+     *
+     * @var string
+     */
+    public $sentAt;
+
+    /**
+     * The uuid of the driver.
+     *
+     * @var string
+     */
+    public $driverUuid;
+
+    /**
+     * The public id of the driver.
+     *
+     * @var string
+     */
+    public $driverId;
+
+    /**
+     * The internal id of the driver.
+     *
+     * @var string
+     */
+    public $driverInternalId;
+
+    /**
+     * The name of the driver.
+     *
+     * @var string
+     */
+    public $driverName;
+
+    /**
+     * The phone of the driver.
+     *
+     * @var string
+     */
+    public $driverPhone;
+
+    /**
+     * The new driver location.
+     *
+     * @var string
+     */
+    public $location;
+
+    /**
+     * The driver altitude.
+     *
+     * @var string
+     */
+    public $altitude;
+
+    /**
+     * The ndriver heading.
+     *
+     * @var string
+     */
+    public $heading;
+
+    /**
+     * The driver speed.
+     *
+     * @var string
+     */
+    public $speed;
+
+    /**
+     * Optional, additional data.
+     *
+     * @var array
+     */
+    public $additionalData = [];
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(Driver $driver, array $additionalData = [])
+    {
+        $this->eventId          = uniqid('event_');
+        $this->sentAt           = Carbon::now()->toDateTimeString();
+        $this->additionalData   = $additionalData;
+        $this->driverUuid       = $driver->uuid;
+        $this->driverId         = $driver->public_id;
+        $this->driverInternalId = $driver->internal_id;
+        $this->driverName       = $driver->name;
+        $this->driverPhone      = $driver->phone;
+        $this->location         = $driver->location;
+        $this->altitude         = $driver->altitude;
+        $this->heading          = $driver->heading;
+        $this->speed            = $driver->speed;
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return \Illuminate\Broadcasting\Channel|array
+     */
+    public function broadcastOn()
+    {
+        return [
+            new Channel('company.' . session('company')),
+            new Channel('api.' . session('api_credential')),
+            new Channel('driver.' . $this->driverId),
+            new Channel('driver.' . $this->driverUuid),
+        ];
+    }
+
+    /**
+     * The event's broadcast name.
+     *
+     * @return string
+     */
+    public function broadcastAs()
+    {
+        return 'driver.location_changed';
+    }
+
+    /**
+     * 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'        => [
+                'id'             => $this->driverId,
+                'internal_id'    => $this->driverInternalId,
+                'name'           => $this->driverName,
+                'phone'          => $this->driverPhone,
+                'location'       => $this->location,
+                'altitude'       => $this->altitude,
+                'heading'        => $this->heading,
+                'speed'          => $this->speed,
+                'additionalData' => $this->additionalData,
+            ],
+        ];
+    }
+}

package/server/src/Events/DriverSimulatedLocationChanged.php

@@ -0,0 +1,183 @@
+<?php
+
+namespace Fleetbase\FleetOps\Events;
+
+use Fleetbase\FleetOps\Models\Driver;
+use Grimzy\LaravelMysqlSpatial\Types\Point;
+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;
+
+/**
+ * Event class for when a driver's simulated location changes.
+ *
+ * This event is broadcasted to multiple channels and includes details
+ * about the driver's location, speed, heading, and other attributes.
+ */
+class DriverSimulatedLocationChanged implements ShouldBroadcast
+{
+    use Dispatchable;
+    use InteractsWithSockets;
+    use SerializesModels;
+
+    /**
+     * The event id.
+     *
+     * @var string
+     */
+    public $eventId;
+
+    /**
+     * The datetime instance the broadcast ws triggered.
+     *
+     * @var string
+     */
+    public $sentAt;
+
+    /**
+     * The uuid of the driver.
+     *
+     * @var string
+     */
+    public $driverUuid;
+
+    /**
+     * The public id of the driver.
+     *
+     * @var string
+     */
+    public $driverId;
+
+    /**
+     * The internal id of the driver.
+     *
+     * @var string
+     */
+    public $driverInternalId;
+
+    /**
+     * The name of the driver.
+     *
+     * @var string
+     */
+    public $driverName;
+
+    /**
+     * The phone of the driver.
+     *
+     * @var string
+     */
+    public $driverPhone;
+
+    /**
+     * The new driver location.
+     *
+     * @var string
+     */
+    public $location;
+
+    /**
+     * The driver altitude.
+     *
+     * @var string
+     */
+    public $altitude;
+
+    /**
+     * The ndriver heading.
+     *
+     * @var string
+     */
+    public $heading;
+
+    /**
+     * The driver speed.
+     *
+     * @var string
+     */
+    public $speed;
+
+    /**
+     * Optional, additional data.
+     *
+     * @var array
+     */
+    public $additionalData = [];
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(Driver $driver, Point $location, array $additionalData = [])
+    {
+        $this->eventId          = uniqid('event_');
+        $this->sentAt           = Carbon::now()->toDateTimeString();
+        $this->driverUuid       = $driver->uuid;
+        $this->driverId         = $driver->public_id;
+        $this->driverInternalId = $driver->internal_id;
+        $this->driverName       = $driver->name;
+        $this->driverPhone      = $driver->phone;
+        $this->altitude         = $driver->altitude;
+
+        // can be set in simulation
+        $this->heading        = data_get($additionalData, 'heading', $driver->heading);
+        $this->speed          = data_get($additionalData, 'speed', $driver->speed);
+        $this->location       = $location;
+        $this->additionalData = $additionalData;
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return \Illuminate\Broadcasting\Channel|array
+     */
+    public function broadcastOn()
+    {
+        return [
+            new Channel('company.' . session('company')),
+            new Channel('api.' . session('api_credential')),
+            new Channel('driver.' . $this->driverId),
+            new Channel('driver.' . $this->driverUuid),
+        ];
+    }
+
+    /**
+     * The event's broadcast name.
+     *
+     * @return string
+     */
+    public function broadcastAs()
+    {
+        return 'driver.simulated_location_changed';
+    }
+
+    /**
+     * 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'        => [
+                'id'             => $this->driverId,
+                'internal_id'    => $this->driverInternalId,
+                'name'           => $this->driverName,
+                'phone'          => $this->driverPhone,
+                'location'       => $this->location,
+                'altitude'       => $this->altitude,
+                'heading'        => $this->heading,
+                'speed'          => $this->speed,
+                'additionalData' => $this->additionalData,
+            ],
+        ];
+    }
+}

package/server/src/Events/EntityDriverAssigned.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Fleetbase\FleetOps\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PrivateChannel;
+use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class EntityDriverAssigned implements ShouldBroadcast
+{
+    use Dispatchable;
+    use InteractsWithSockets;
+    use SerializesModels;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        // @todo
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return \Illuminate\Broadcasting\Channel|array
+     */
+    public function broadcastOn()
+    {
+        return new PrivateChannel('channel-name');
+    }
+}

package/server/src/Events/OrderCanceled.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Fleetbase\FleetOps\Events;
+
+use Fleetbase\Events\ResourceLifecycleEvent;
+
+class OrderCanceled extends ResourceLifecycleEvent
+{
+    /**
+     * The event name.
+     *
+     * @var string
+     */
+    public $eventName = 'canceled';
+}

package/server/src/Events/OrderCompleted.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Fleetbase\FleetOps\Events;
+
+use Fleetbase\Events\ResourceLifecycleEvent;
+
+class OrderCompleted extends ResourceLifecycleEvent
+{
+    /**
+     * The event name.
+     *
+     * @var string
+     */
+    public $eventName = 'completed';
+}