@fleetbase/fleetops-engine 0.6.12 → 0.6.13

package/addon/services/leaflet-router-control.js

@@ -0,0 +1,64 @@
+import Service, { inject as service } from '@ember/service';
+import { tracked } from '@glimmer/tracking';
+import { underscore } from '@ember/string';
+
+export class RouterControlRegistry {
+    @tracked routers = {};
+}
+
+export class RouterControl {
+    @tracked name;
+    @tracked router;
+    @tracked formatter;
+
+    constructor(init) {
+        const { name, router, formatter } = typeof init === 'function' ? init() : init;
+        this.name = name;
+        this.router = router;
+        this.formatter = formatter;
+    }
+}
+
+export default class LeafletRouterControlService extends Service {
+    @service universe;
+    registry = this.#initializeRegistry();
+
+    get availableEngines() {
+        return Object.keys(this.registry.routers).map(underscore);
+    }
+
+    get availableServices() {
+        return Object.entries(this.registry.routers).map(([key, control]) => ({
+            key,
+            name: control.name ?? key,
+        }));
+    }
+
+    register(name, getter) {
+        this.registry.routers = {
+            ...this.registry.routers,
+            [underscore(name)]: getter,
+        };
+    }
+
+    /* eslint-disable no-unused-vars */
+    unregister(name) {
+        let key = underscore(name);
+        let { [key]: _, ...rest } = this.registry.routers;
+        this.registry.routers = rest;
+    }
+
+    get(name) {
+        return this.registry.routers[underscore(name)];
+    }
+
+    #initializeRegistry() {
+        const registry = 'registry:router-controls';
+        const application = this.universe.getApplicationInstance();
+        if (!application.hasRegistration(registry)) {
+            application.register(registry, new RouterControlRegistry(), { instantiate: false });
+        }
+
+        return application.resolveRegistration(registry);
+    }
+}

package/addon/services/osrm.js

@@ -0,0 +1,46 @@
+import RouteOptimizationInterfaceService from './route-optimization-interface';
+import getRoutingHost from '@fleetbase/ember-core/utils/get-routing-host';
+import polyline from '@fleetbase/ember-core/utils/polyline';
+import { debug } from '@ember/debug';
+
+export default class OsrmService extends RouteOptimizationInterfaceService {
+    name = 'OSRM';
+
+    async optimize({ order, payload, waypoints, coordinates: originalCoords }, options = {}) {
+        const driverAssigned = order.driver_assigned;
+        const driverPosition = driverAssigned?.location?.coordinates; // [lon,lat] | undefined
+        const coordinates = driverPosition ? [driverPosition, ...originalCoords] : [...originalCoords];
+        const hasDriverStart = Boolean(driverPosition);
+        const source = 'first';
+        const destination = 'any';
+        const roundtrip = false; // don’t loop back
+        const routingHost = getRoutingHost(payload, waypoints);
+
+        try {
+            const result = await this.fetch.routing(coordinates, { source, destination, roundtrip, annotations: true }, { host: routingHost, ...options });
+
+            // Pair each OSRM waypoint with its Waypoint model
+            const modelsByInputIndex = hasDriverStart ? [null, ...waypoints] : waypoints;
+            const pairs = result.waypoints.map((wp, idx) => ({
+                model: modelsByInputIndex[idx], // Ember model or null (driver)
+                wp,
+            }));
+
+            // Drop the driver start if present
+            const payloadPairs = hasDriverStart ? pairs.slice(1) : pairs;
+
+            // Sort by the optimised order
+            payloadPairs.sort((a, b) => a.wp.waypoint_index - b.wp.waypoint_index);
+
+            // Extract the Ember models (null-safe)
+            const sortedWaypoints = payloadPairs.map((p) => p.model).filter(Boolean);
+            const trip = result.trips?.[0];
+            const route = polyline.decode(trip.geometry);
+
+            return { sortedWaypoints, trip, route, result };
+        } catch (err) {
+            debug(`[OSRM] Error routing trip : ${err.message}`);
+            throw err;
+        }
+    }
+}

package/addon/services/route-optimization-interface.js

@@ -0,0 +1,9 @@
+import Service, { inject as service } from '@ember/service';
+
+export default class RouteOptimizationInterfaceService extends Service {
+    @service fetch;
+
+    optimize() {
+        throw new Error(`${this.constructor.name} must implement optimize(params, options)`);
+    }
+}

package/addon/services/route-optimization.js

@@ -0,0 +1,67 @@
+import Service, { inject as service } from '@ember/service';
+import { tracked } from '@glimmer/tracking';
+import { underscore } from '@ember/string';
+
+export class RouteOptimizationRegistry {
+    @tracked engines = {};
+}
+
+export default class RouteOptimizationService extends Service {
+    @service universe;
+    registry = this.#initializeRegistry();
+
+    get availableEngines() {
+        return Object.keys(this.registry.engines).map(underscore);
+    }
+
+    get availableServices() {
+        return Object.entries(this.registry.engines).map(([key, engine]) => ({
+            key,
+            name: engine.name ?? key,
+        }));
+    }
+
+    register(name, engine) {
+        if (typeof engine.optimize !== 'function') {
+            throw new Error(`Cannot register "${name}": missing optimize()`);
+        }
+
+        this.registry.engines = {
+            ...this.registry.engines,
+            [underscore(name)]: engine,
+        };
+    }
+
+    /* eslint-disable no-unused-vars */
+    unregister(name) {
+        let key = underscore(name);
+        let { [key]: _, ...rest } = this.registry.engines;
+        this.registry.engines = rest;
+    }
+
+    optimize(name, params = {}, options = {}) {
+        let engine = this.registry.engines[underscore(name)];
+        if (!engine) {
+            return Promise.reject(new Error(`No route optimization engine registered as "${name}"`));
+        }
+        return engine.optimize(params, options);
+    }
+
+    handler(name, context, data) {
+        let engine = this.registry.engines[underscore(name)];
+        if (!engine) {
+            throw new Error(`No route optimization engine registered as "${name}"`);
+        }
+        return engine.handler(context, data);
+    }
+
+    #initializeRegistry() {
+        const registry = 'registry:route-optimization-engines';
+        const application = this.universe.getApplicationInstance();
+        if (!application.hasRegistration(registry)) {
+            application.register(registry, new RouteOptimizationRegistry(), { instantiate: false });
+        }
+
+        return application.resolveRegistration(registry);
+    }
+}

package/addon/templates/operations/orders/index/new.hbs

@@ -315,17 +315,21 @@
                 </div>
                 <div class="flex flex-1 justify-end space-x-2">
                     {{#if this.isMultipleDropoffOrder}}
-                        <Button
-                            @type="magic"
-                            @icon="magic"
-                            @text={{t "fleet-ops.operations.orders.index.new.optimize-route"}}
-                            @size="sm"
-                            @onClick={{perform this.optimizeRoute}}
-                            @permission="fleet-ops optimize order"
-                            @helpText={{t "fleet-ops.operations.orders.index.new.optimize-route-help-text"}}
-                            @disabled={{lt this.waypoints.length 3}}
-                            @isLoading={{this.isOptimizingRoute}}
-                        />
+                        {{#if this.hasRouteOptimizationEngines}}
+                            <RouteOptimizationEngineSelectButton @onClick={{perform this.optimizeRouteWithService}} @isLoading={{this.optimizeRouteWithService.isRunning}} />
+                        {{else}}
+                            <Button
+                                @type="magic"
+                                @icon="magic"
+                                @text={{t "fleet-ops.operations.orders.index.new.optimize-route"}}
+                                @size="sm"
+                                @onClick={{perform this.optimizeRoute}}
+                                @permission="fleet-ops optimize order"
+                                @helpText={{t "fleet-ops.operations.orders.index.new.optimize-route-help-text"}}
+                                @disabled={{lt this.waypoints.length 3}}
+                                @isLoading={{this.optimizeRoute.isRunning}}
+                            />
+                        {{/if}}
                         <Button
                             @icon="map-marked-alt"
                             @text={{t "fleet-ops.operations.orders.index.new.add-waypoint"}}
@@ -630,11 +634,9 @@
                             </div>
                         </DropdownButton>
                     {{/if}}
-                    {{#if this.renderableEntityInputComponents}}
-                        {{#each this.renderableEntityInputComponents as |renderableEntityInputComponent|}}
-                            {{component renderableEntityInputComponent order=this.order controller=this}}
-                        {{/each}}
-                    {{/if}}
+                    <RegistryYield @registry="fleet-ops:template:operations:orders:new:entities-input" as |RegistryComponent|>
+                        <RegistryComponent @order={{this.order}} @controller={{this}} />
+                    </RegistryYield>
                 </div>
             {{/if}}
             {{#if this.isCsvImportedOrder}}
@@ -709,6 +711,9 @@
                                     <div>
                                         <Input @value={{entity.sku}} @type="text" class="w-full form-input form-input-sm" placeholder={{t "fleet-ops.operations.orders.index.new.sku"}} />
                                     </div>
+                                    <RegistryYield @registry="fleet-ops:template:operations:orders:new:entities-input:entity" as |RegistryComponent|>
+                                        <RegistryComponent @entity={{entity}} @order={{this.order}} @controller={{this}} />
+                                    </RegistryYield>
                                     {{#if this.waypoints.length}}
                                         <Select
                                             @value={{entity.destination_uuid}}

package/addon/templates/settings/routing.hbs

@@ -0,0 +1,32 @@
+<Layout::Section::Header @title={{t "fleet-ops.settings.routing.fleet-ops-routing-settings"}}>
+    <Button
+        @type="primary"
+        @size="sm"
+        @icon="save"
+        @text={{t "common.save-button-text"}}
+        @onClick={{perform this.saveSettings}}
+        @disabled={{this.saveSettings.isRunning}}
+        @isLoading={{or this.saveSettings.isRunning this.getSettings.isRunning}}
+    />
+</Layout::Section::Header>
+
+<Layout::Section::Body class="overflow-y-scroll h-full">
+    <div class="container mx-auto h-screen">
+        <div class="max-w-3xl my-10 mx-auto space-y-6">
+            <ContentPanel @title={{t "fleet-ops.settings.routing.configure-routing"}} @open={{true}} @pad={{true}} @panelBodyClass="bg-white dark:bg-gray-800">
+                <InputGroup @name="Routing Service" @helpText="Select the service which is responsible for calculating and plotting routes on the map.">
+                    <Select
+                        @value={{this.routerService}}
+                        @options={{this.leafletRouterControl.availableServices}}
+                        @optionLabel="name"
+                        @optionValue="key"
+                        @onSelect={{fn (mut this.routerService)}}
+                        @placeholder="Select routing service..."
+                        class="w-full"
+                    />
+                </InputGroup>
+            </ContentPanel>
+        </div>
+    </div>
+    <Spacer @height="600px" />
+</Layout::Section::Body>

package/app/components/route-optimization-engine-select-button.js

@@ -0,0 +1 @@
+export { default } from '@fleetbase/fleetops-engine/components/route-optimization-engine-select-button';

package/app/controllers/settings/routing.js

@@ -0,0 +1 @@
+export { default } from '@fleetbase/fleetops-engine/controllers/settings/routing';

package/app/routes/settings/routing.js

@@ -0,0 +1 @@
+export { default } from '@fleetbase/fleetops-engine/routes/settings/routing';

package/app/services/leaflet-router-control.js

@@ -0,0 +1 @@
+export { default } from '@fleetbase/fleetops-engine/services/leaflet-router-control';

package/app/services/osrm.js

@@ -0,0 +1 @@
+export { default } from '@fleetbase/fleetops-engine/services/osrm';

package/app/services/route-optimization-interface.js

@@ -0,0 +1 @@
+export { default } from '@fleetbase/fleetops-engine/services/route-optimization-interface';

package/app/services/route-optimization.js

@@ -0,0 +1 @@
+export { default } from '@fleetbase/fleetops-engine/services/route-optimization';

package/app/templates/settings/routing.js

@@ -0,0 +1 @@
+export { default } from '@fleetbase/fleetops-engine/templates/settings/routing';

package/composer.json

@@ -1,6 +1,6 @@
 {
     "name": "fleetbase/fleetops-api",
-    "version": "0.6.12",
+    "version": "0.6.13",
     "description": "Fleet & Transport Management Extension for Fleetbase",
     "keywords": [
         "fleetbase-extension",

package/extension.json

@@ -1,6 +1,6 @@
 {
     "name": "Fleet-Ops",
-    "version": "0.6.12",
+    "version": "0.6.13",
     "description": "Fleet & Transport Management Extension for Fleetbase",
     "repository": "https://github.com/fleetbase/fleetops",
     "license": "AGPL-3.0-or-later",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fleetbase/fleetops-engine",
-    "version": "0.6.12",
+    "version": "0.6.13",
     "description": "Fleet & Transport Management Extension for Fleetbase",
     "fleetbase": {
         "route": "fleet-ops"
@@ -45,7 +45,7 @@
         "@fleetbase/ember-core": "latest",
         "@fleetbase/ember-ui": "latest",
         "@fleetbase/fleetops-data": "latest",
-        "@fleetbase/leaflet-routing-machine": "^3.2.16",
+        "@fleetbase/leaflet-routing-machine": "^3.2.17",
         "@fortawesome/ember-fontawesome": "^2.0.0",
         "@fortawesome/fontawesome-svg-core": "6.4.0",
         "@fortawesome/free-brands-svg-icons": "6.4.0",

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/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/Internal/v1/OrderController.php

@@ -354,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();