@fleetbase/fleetops-engine 0.4.16 → 0.4.17

package/server/migrations/2023_11_09_041807_add_status_column_to_fuel_reports_table.php

@@ -4,8 +4,7 @@ use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_11_15_062814_add_comments_column_and_resolved_at_column_to_vehicle_device_events_table.php

@@ -4,8 +4,7 @@ use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_11_17_053001_add_category_uuid_to_entities_table.php

@@ -4,8 +4,7 @@ use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_11_28_074244_add_supplier_uuid_column_to_entities_table.php

@@ -4,8 +4,7 @@ use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_12_14_100209_add_meta_column_on_driver_table copy.php

@@ -4,8 +4,7 @@ use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2024_02_18_100209_add_avatar_url_columns_table.php

@@ -4,8 +4,7 @@ use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *
@@ -36,8 +35,8 @@ return new class extends Migration
      */
     public function down()
     {
-         // Reverse: Increase size of vehicles avatar url column for signed urls
-         Schema::table('vehicles', function (Blueprint $table) {
+        // Reverse: Increase size of vehicles avatar url column for signed urls
+        Schema::table('vehicles', function (Blueprint $table) {
             $table->string('avatar_url', 300)->change();
         });
 

package/server/migrations/2024_02_27_093648_create_order_configs_table.php

@@ -0,0 +1,43 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class() extends Migration {
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('order_configs', function (Blueprint $table) {
+            $table->increments('id');
+            $table->uuid('uuid')->nullable()->index();
+            $table->foreignUuid('company_uuid')->nullable()->references('uuid')->on('companies')->onUpdate('CASCADE')->onDelete('CASCADE');
+            $table->foreignUuid('author_uuid')->nullable()->references('uuid')->on('users')->onUpdate('CASCADE')->onDelete('CASCADE');
+            $table->foreignUuid('category_uuid')->nullable()->references('uuid')->on('categories')->onUpdate('CASCADE')->onDelete('CASCADE');
+            $table->foreignUuid('icon_uuid')->nullable()->references('uuid')->on('files')->onUpdate('CASCADE')->onDelete('CASCADE');
+            $table->string('name')->nullable();
+            $table->string('namespace')->nullable();
+            $table->mediumText('description')->nullable();
+            $table->string('key')->nullable();
+            $table->string('status')->nullable();
+            $table->string('version')->nullable();
+            $table->boolean('core_service')->default(0);
+            $table->json('flow')->nullable();
+            $table->json('entities')->nullable();
+            $table->json('tags')->nullable();
+            $table->json('meta')->nullable();
+            $table->timestamps();
+            $table->softDeletes();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('order_configs');
+    }
+};

package/server/migrations/2024_03_07_075508_add_order_config_uuid_column_to_orders_table.php

@@ -0,0 +1,28 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class() extends Migration {
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table('orders', function (Blueprint $table) {
+            $table->foreignUuid('order_config_uuid')->nullable()->after('updated_by_uuid')->references('uuid')->on('order_configs')->onUpdate('CASCADE')->onDelete('CASCADE');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table('orders', function (Blueprint $table) {
+            $table->dropForeign(['order_config_uuid']);
+            $table->dropColumn(['order_config_uuid']);
+        });
+    }
+};

package/server/seeders/OrderConfigSeeder.php

@@ -0,0 +1,151 @@
+<?php
+
+namespace Fleetbase\FleetOps\Seeders;
+
+use Fleetbase\FleetOps\Models\OrderConfig;
+use Fleetbase\Models\Company;
+use Illuminate\Database\Seeder;
+use Illuminate\Support\Str;
+
+class OrderConfigSeeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run()
+    {
+        $companies = Company::all();
+        foreach ($companies as $company) {
+            static::createTransportConfig($company);
+        }
+    }
+
+    /**
+     * Creates or retrieves an existing transport configuration for a given company.
+     *
+     * This method attempts to find a transport configuration (`OrderConfig`) for the specified company.
+     * If such a configuration exists, it's returned. Otherwise, a new configuration is created with default values,
+     * such as the company UUID, key, core service flag, status, version, tags, and predefined workflow steps.
+     * These steps include 'created', 'enroute', 'started', 'completed', and 'dispatched', each with specific attributes.
+     *
+     * @param Company $company the company for which the transport configuration is being created or retrieved
+     *
+     * @return OrderConfig the transport configuration associated with the specified company
+     */
+    public static function createTransportConfig(Company $company): OrderConfig
+    {
+        return OrderConfig::firstOrCreate(
+            [
+            'company_uuid' => $company->uuid,
+            'key'          => 'transport',
+            'namespace'    => 'system:order-config:transport',
+        ],
+            [
+            'name'         => 'Transport',
+            'key'          => 'transport',
+            'namespace'    => 'system:order-config:transport',
+            'description'  => 'Default order configuration for transport',
+            'core_service' => 1,
+            'status'       => 'private',
+            'version'      => '0.0.1',
+            'tags'         => ['transport', 'delivery'],
+            'entities'     => [],
+            'meta'         => [],
+            'flow'         => [
+                'created' => [
+                    'key'         => 'created',
+                    'code'        => 'created',
+                    'color'       => '#1f2937',
+                    'logic'       => [],
+                    'events'      => [],
+                    'status'      => 'Order Created',
+                    'actions'     => [],
+                    'details'     => 'New order was created.',
+                    'options'     => [],
+                    'complete'    => false,
+                    'entities'    => [],
+                    'sequence'    => 0,
+                    'activities'  => ['dispatched'],
+                    'internalId'  => Str::uuid(),
+                    'pod_method'  => 'scan',
+                    'require_pod' => false,
+                ],
+                'enroute' => [
+                    'key'         => 'enroute',
+                    'code'        => 'enroute',
+                    'color'       => '#1f2937',
+                    'logic'       => [],
+                    'events'      => [],
+                    'status'      => 'Driver Enroute',
+                    'actions'     => [],
+                    'details'     => 'Driver is en-route.',
+                    'options'     => [],
+                    'complete'    => false,
+                    'entities'    => [],
+                    'sequence'    => 0,
+                    'activities'  => ['completed'],
+                    'internalId'  => Str::uuid(),
+                    'pod_method'  => 'scan',
+                    'require_pod' => false,
+                ],
+                'started' => [
+                    'key'         => 'started',
+                    'code'        => 'started',
+                    'color'       => '#1f2937',
+                    'logic'       => [],
+                    'events'      => [],
+                    'status'      => 'Order Started',
+                    'actions'     => [],
+                    'details'     => 'Order has been started',
+                    'options'     => [],
+                    'complete'    => false,
+                    'entities'    => [],
+                    'sequence'    => 0,
+                    'activities'  => ['enroute'],
+                    'internalId'  => Str::uuid(),
+                    'pod_method'  => 'scan',
+                    'require_pod' => false,
+                ],
+                'completed' => [
+                    'key'         => 'completed',
+                    'code'        => 'completed',
+                    'color'       => '#1f2937',
+                    'logic'       => [],
+                    'events'      => [],
+                    'status'      => 'Order Completed',
+                    'actions'     => [],
+                    'details'     => 'Order has been completed.',
+                    'options'     => [],
+                    'complete'    => true,
+                    'entities'    => [],
+                    'sequence'    => 0,
+                    'activities'  => [],
+                    'internalId'  => Str::uuid(),
+                    'pod_method'  => 'scan',
+                    'require_pod' => false,
+                ],
+                'dispatched' => [
+                    'key'         => 'dispatched',
+                    'code'        => 'dispatched',
+                    'color'       => '#1f2937',
+                    'logic'       => [],
+                    'events'      => [],
+                    'status'      => 'Order Dispatched',
+                    'actions'     => [],
+                    'details'     => 'Order has been dispatched.',
+                    'options'     => [],
+                    'complete'    => false,
+                    'entities'    => [],
+                    'sequence'    => 0,
+                    'activities'  => ['started'],
+                    'internalId'  => Str::uuid(),
+                    'pod_method'  => 'scan',
+                    'require_pod' => false,
+                ],
+            ],
+        ]
+        );
+    }
+}

package/server/src/Casts/OrderConfigEntities.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Fleetbase\FleetOps\Casts;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Models\File;
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+
+class OrderConfigEntities implements CastsAttributes
+{
+    /**
+     * Cast the given value.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @param string                              $key
+     * @param array                               $attributes
+     *
+     * @return array
+     */
+    public function get($model, $key, $value, $attributes)
+    {
+        $entities = Json::decode($value);
+        if (is_array($entities)) {
+            $entities = array_map(function ($entity) {
+                if (isset($entity['photo_uuid'])) {
+                    $file = File::where('uuid', $entity['photo_uuid'])->first();
+                    if ($file) {
+                        $entity['photo_url'] = $file->url;
+                    }
+                }
+
+                return $entity;
+            }, $entities);
+        }
+
+        return $entities;
+    }
+
+    /**
+     * Prepare the given value for storage.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @param string                              $key
+     * @param array                               $value
+     * @param array                               $attributes
+     *
+     * @return string
+     */
+    public function set($model, $key, $value, $attributes)
+    {
+        return json_encode($value);
+    }
+}

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

@@ -0,0 +1,66 @@
+<?php
+
+namespace Fleetbase\FleetOps\Console\Commands;
+
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Models\OrderConfig;
+use Fleetbase\Support\Utils;
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Artisan;
+
+class FixLegacyOrderConfigs extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'fleetops:fix-legacy-order-configs';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'This is a command which migrates legacy orders to the new order config system.';
+
+    /**
+     * 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()
+    {
+        if (Utils::classExists('\\Fleetbase\\FleetOps\\Seeders\\OrderConfigSeeder')) {
+            $this->info('Starting the database seeding...');
+
+            Artisan::call('db:seed', [
+                '--class' => '\\Fleetbase\\FleetOps\\Seeders\\OrderConfigSeeder',
+            ]);
+
+            $this->info('Database seeding completed.');
+        }
+
+        $orders      = Order::whereNull('order_config_uuid')->get();
+        $totalOrders = $orders->count();
+        $this->info($totalOrders . ' orders found for updating.');
+        $progressBar = $this->output->createProgressBar($totalOrders);
+        $progressBar->start();
+        foreach ($orders as $order) {
+            $orderConfig = OrderConfig::where(['company_uuid' => $order->company_uuid, 'namespace' => 'system:order-config:transport'])->first();
+            if ($orderConfig) {
+                $order->update(['order_config_uuid' => $orderConfig->uuid]);
+            }
+            // Advance the progress bar by one step
+            $progressBar->advance();
+        }
+
+        $progressBar->finish();
+        $this->line('');
+        $this->info('All orders have been processed.');
+    }
+}

package/server/src/Events/DriverLocationChanged.php

@@ -124,7 +124,7 @@ class DriverLocationChanged implements ShouldBroadcast
     /**
      * Get the channels the event should broadcast on.
      *
-     * @return \Illuminate\Broadcasting\Channel|array
+     * @return Channel|array
      */
     public function broadcastOn()
     {

package/server/src/Events/DriverSimulatedLocationChanged.php

@@ -133,7 +133,7 @@ class DriverSimulatedLocationChanged implements ShouldBroadcast
     /**
      * Get the channels the event should broadcast on.
      *
-     * @return \Illuminate\Broadcasting\Channel|array
+     * @return Channel|array
      */
     public function broadcastOn()
     {

package/server/src/Flow/Activity.php

@@ -2,12 +2,238 @@
 
 namespace Fleetbase\FleetOps\Flow;
 
-use Fleetbase\Models\Model;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Support\Utils;
 
-class Activity
+class Activity extends FlowResource
 {
-    protected string $status;
-    protected string $code;
-    protected string $details;
-    protected Model $owner;
+    /**
+     * The Flow context for the activity.
+     */
+    public Flow $flow;
+
+    /**
+     * Create a new Activity instance.
+     *
+     * @param array $attributes initial attributes of the activity
+     * @param array $flow       the flow configuration for this activity
+     */
+    public function __construct(array $attributes = [], array $flow = [])
+    {
+        parent::__construct($attributes);
+        $this->flow = new Flow($flow);
+    }
+
+    /**
+     * Retrieves the logic attribute of the Activity.
+     *
+     * @return array an array of Logic instances associated with the Activity
+     */
+    public function getLogicAttribute(): array
+    {
+        return array_map(
+            function ($logic) {
+                return new Logic($logic);
+            },
+            $this->get('logic', [])
+        );
+    }
+
+    /**
+     * Retrieves the events attribute of the Activity.
+     *
+     * @return array an array of Event instances associated with the Activity
+     */
+    public function getEventsAttribute(): array
+    {
+        return array_map(
+            function ($eventName) {
+                return new Event($eventName);
+            },
+            $this->get('events', [])
+        );
+    }
+
+    /**
+     * Determines if the Activity passes based on the provided Order.
+     *
+     * @param Order $order the order to evaluate against the Activity's logic
+     *
+     * @return bool true if all the logic associated with the Activity passes; False otherwise
+     */
+    public function passes(Order $order)
+    {
+        $logicCollection = collect($this->logic);
+
+        return $logicCollection->every(function ($logic) use ($order) {
+            $conditionCollection = collect($logic->conditions);
+
+            switch ($logic->type) {
+                case 'and':
+                    // All conditions must be true
+                    return $conditionCollection->every(fn ($condition) => $condition->eval($order));
+
+                case 'or':
+                    // At least one condition must be true
+                    return $conditionCollection->contains(fn ($condition) => $condition->eval($order));
+
+                case 'not':
+                    // None of the conditions must be true (assuming 'not' can have multiple conditions)
+                    return !$conditionCollection->contains(fn ($condition) => $condition->eval($order));
+
+                case 'if':
+                    // Only one condition in 'if', and it must be true (typically, 'if' has only one condition)
+                    return $conditionCollection->first()->eval($order);
+
+                default:
+                    // Unrecognized logic type
+                    throw new \Exception("Unsupported logic type '{$logic->type}' provided.");
+            }
+        });
+    }
+
+    /**
+     * Fires a series of events associated with an order.
+     *
+     * Iterates over the events array and triggers each event, passing the order as a parameter.
+     * This function is typically used to execute a sequence of events as part of a workflow process.
+     *
+     * @param Order $order the order object to be passed to each event
+     */
+    public function fireEvents(Order $order)
+    {
+        foreach ($this->events as $event) {
+            $event->fire($order);
+        }
+    }
+
+    /**
+     * Retrieves the child activities of this Activity.
+     *
+     * @return \Illuminate\Support\Collection a collection of child activities
+     */
+    public function getChildActivities()
+    {
+        $children = collect();
+        if (is_array($this->activities)) {
+            foreach ($this->activities as $childActivityCode) {
+                $childActivity = $this->flow->getActivity($childActivityCode);
+                if ($childActivity) {
+                    $children->push($childActivity);
+                }
+            }
+        }
+
+        return $children;
+    }
+
+    /**
+     * Retrieves the children activities of this Activity.
+     *
+     * This is a shorthand method for `getChildActivities`.
+     *
+     * @return \Illuminate\Support\Collection the collection of child activities
+     */
+    public function children()
+    {
+        return $this->getChildActivities();
+    }
+
+    /**
+     * Checks whether this Activity has a child activity with a specified code.
+     *
+     * @param string $code the unique code identifier for the child activity
+     *
+     * @return bool true if the child activity is found; otherwise, False
+     */
+    public function hasChildActivity(string $code)
+    {
+        return $this->children()->contains(
+            function ($activity) use ($code) {
+                return $activity->code === $code;
+            }
+        );
+    }
+
+    /**
+     * Determines the next set of activities based on the provided Order.
+     *
+     * @param Order $order the order to determine the next activities for
+     *
+     * @return \Illuminate\Support\Collection a collection of the next activities
+     */
+    public function getNext(Order $order)
+    {
+        $children       = $this->getChildActivities();
+        $nextActivities = collect();
+
+        foreach ($children as $childActivity) {
+            if ($childActivity->passes($order)) {
+                $nextActivities->push($childActivity);
+            }
+        }
+
+        return $nextActivities;
+    }
+
+    /**
+     * Retrieves the previous activities of this Activity in the Flow.
+     *
+     * This method iterates over the flow to find activities that list this Activity as a child.
+     *
+     * @return \Illuminate\Support\Collection a collection of previous activities
+     */
+    public function getPrevious()
+    {
+        $previous = collect();
+        foreach ($this->flow as $activity) {
+            if ($activity->hasChildActivity($this->code)) {
+                $previous->push($activity);
+            }
+        }
+
+        return $previous;
+    }
+
+    /**
+     * Checks if the activity's code matches a specified code.
+     *
+     * This method is used to determine if the current activity instance
+     * has a specific code, which is useful for identifying the activity.
+     *
+     * @param string $code the code to compare against the activity's code
+     *
+     * @return bool returns true if the activity's code matches the specified code, false otherwise
+     */
+    public function is(string $code)
+    {
+        return $this->code === $code;
+    }
+
+    /**
+     * Determines if the activity is marked as complete.
+     *
+     * This method checks the 'complete' property of the activity. It's typically used
+     * to verify if the activity has been completed as part of the workflow process.
+     *
+     * @return bool returns true if the activity is marked as complete, false otherwise
+     */
+    public function complete(): bool
+    {
+        return Utils::isTrue($this->complete);
+    }
+
+    /**
+     * Checks if completing this activity leads to the completion of the order.
+     *
+     * This method uses the `complete` method to determine if the completion of
+     * this activity signifies the completion of the associated order. It is useful
+     * for workflows where the finalization of an activity concludes the entire order process.
+     *
+     * @return bool returns true if completing this activity completes the order, false otherwise
+     */
+    public function completesOrder(): bool
+    {
+        return $this->complete();
+    }
 }