@fleetbase/fleetops-engine 0.6.48 → 0.6.49

package/server/src/Support/Metrics/Registry.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Fleetbase\FleetOps\Support\Metrics;
+
+/**
+ * Explicit slug → metric-class map. Replaces the legacy
+ * `array_slice(get_class_methods, 9)` reflection which broke whenever a
+ * private helper was added to the wrong position in Metrics.php.
+ */
+class Registry
+{
+    /** @var array<string, class-string<AbstractMetric>> */
+    public const METRICS = [
+        'earnings'                => EarningsMetric::class,
+        'fuel_costs'              => FuelCostsMetric::class,
+        'total_distance_traveled' => TotalDistanceTraveledMetric::class,
+        'total_time_traveled'     => TotalTimeTraveledMetric::class,
+        'orders_completed'        => OrdersCompletedMetric::class,
+        'orders_canceled'         => OrdersCanceledMetric::class,
+        'orders_in_progress'      => OrdersInProgressMetric::class,
+        'orders_scheduled'        => OrdersScheduledMetric::class,
+        'active_live_orders'      => ActiveLiveOrdersMetric::class,
+        'drivers_online'          => DriversOnlineMetric::class,
+        'total_drivers'           => TotalDriversMetric::class,
+        'total_customers'         => TotalCustomersMetric::class,
+        'open_issues'             => OpenIssuesMetric::class,
+        'resolved_issues'         => ResolvedIssuesMetric::class,
+        'avg_order_value'         => AvgOrderValueMetric::class,
+    ];
+
+    public static function resolve(string $slug): ?string
+    {
+        return self::METRICS[$slug] ?? null;
+    }
+
+    /** @return array<string, class-string<AbstractMetric>> */
+    public static function all(): array
+    {
+        return self::METRICS;
+    }
+
+    public static function slugs(): array
+    {
+        return array_keys(self::METRICS);
+    }
+}

package/server/src/Support/Metrics/ResolvedIssuesMetric.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Fleetbase\FleetOps\Support\Metrics;
+
+use Fleetbase\FleetOps\Models\Issue;
+
+class ResolvedIssuesMetric extends AbstractMetric
+{
+    public static function slug(): string
+    {
+        return 'resolved_issues';
+    }
+
+    public function format(): string
+    {
+        return 'count';
+    }
+
+    protected function query(?\DateTimeInterface $start, ?\DateTimeInterface $end)
+    {
+        $query = Issue::where('company_uuid', $this->company->uuid)
+            ->whereNotNull('resolved_at');
+
+        if ($start && $end) {
+            $query->whereBetween('resolved_at', [$start, $end]);
+        }
+
+        return $query;
+    }
+
+    protected function aggregate($query): int
+    {
+        return (int) $query->count();
+    }
+}

package/server/src/Support/Metrics/TotalCustomersMetric.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Fleetbase\FleetOps\Support\Metrics;
+
+use Fleetbase\FleetOps\Models\Contact;
+
+class TotalCustomersMetric extends AbstractMetric
+{
+    public static function slug(): string
+    {
+        return 'total_customers';
+    }
+
+    public function format(): string
+    {
+        return 'count';
+    }
+
+    protected function query(?\DateTimeInterface $start, ?\DateTimeInterface $end)
+    {
+        return Contact::where('company_uuid', $this->company->uuid)
+            ->where('type', 'customer');
+    }
+
+    protected function aggregate($query): int
+    {
+        return (int) $query->count();
+    }
+}

package/server/src/Support/Metrics/TotalDistanceTraveledMetric.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Fleetbase\FleetOps\Support\Metrics;
+
+use Fleetbase\FleetOps\Models\Order;
+
+class TotalDistanceTraveledMetric extends AbstractMetric
+{
+    public static function slug(): string
+    {
+        return 'total_distance_traveled';
+    }
+
+    public function format(): string
+    {
+        return 'meters';
+    }
+
+    protected function query(?\DateTimeInterface $start, ?\DateTimeInterface $end)
+    {
+        $query = Order::where('company_uuid', $this->company->uuid)
+            ->where('status', 'completed');
+
+        if ($start && $end) {
+            $query->whereBetween('created_at', [$start, $end]);
+        }
+
+        return $query;
+    }
+
+    protected function aggregate($query): float
+    {
+        return (float) $query->sum('distance');
+    }
+}

package/server/src/Support/Metrics/TotalDriversMetric.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Fleetbase\FleetOps\Support\Metrics;
+
+use Fleetbase\FleetOps\Models\Driver;
+
+class TotalDriversMetric extends AbstractMetric
+{
+    public static function slug(): string
+    {
+        return 'total_drivers';
+    }
+
+    public function format(): string
+    {
+        return 'count';
+    }
+
+    protected function query(?\DateTimeInterface $start, ?\DateTimeInterface $end)
+    {
+        return Driver::where('company_uuid', $this->company->uuid);
+    }
+
+    protected function aggregate($query): int
+    {
+        return (int) $query->count();
+    }
+}

package/server/src/Support/Metrics/TotalTimeTraveledMetric.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Fleetbase\FleetOps\Support\Metrics;
+
+use Fleetbase\FleetOps\Models\Order;
+
+class TotalTimeTraveledMetric extends AbstractMetric
+{
+    public static function slug(): string
+    {
+        return 'total_time_traveled';
+    }
+
+    public function format(): string
+    {
+        return 'duration';
+    }
+
+    protected function query(?\DateTimeInterface $start, ?\DateTimeInterface $end)
+    {
+        $query = Order::where('company_uuid', $this->company->uuid)
+            ->where('status', 'completed');
+
+        if ($start && $end) {
+            $query->whereBetween('created_at', [$start, $end]);
+        }
+
+        return $query;
+    }
+
+    protected function aggregate($query): int
+    {
+        return (int) $query->sum('time') * 60;
+    }
+}

package/server/src/Support/Metrics.php

@@ -2,21 +2,26 @@
 
 namespace Fleetbase\FleetOps\Support;
 
-use Fleetbase\FleetOps\Models\Contact;
-use Fleetbase\FleetOps\Models\Driver;
-use Fleetbase\FleetOps\Models\FuelReport;
-use Fleetbase\FleetOps\Models\Issue;
-use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Support\Metrics\AbstractMetric;
+use Fleetbase\FleetOps\Support\Metrics\Registry;
 use Fleetbase\Models\Company;
-use Fleetbase\Models\Transaction;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Str;
 
 /**
- * Metrics service to pull analyitcs and metrics from FleetOps.
+ * Thin facade over Support/Metrics/* — preserves the legacy chainable API
+ * (Metrics::new($co)->withEarnings()->withFuelCosts()->get()) for one release
+ * while the new per-slug pattern is preferred:
  *
- * Ex:
- * $metrics = Metrics::new($company)->withEarnings()->withFuelCosts()->get();
+ *     Metrics::forCompany($co)->between($s, $e)->resolve('earnings')->get()
+ *
+ * The 7 documented bugs in the previous monolithic implementation are fixed
+ * by the per-metric classes:
+ *  - totalTimeTraveled now sums `time`, not `distance`
+ *  - openIssues/resolvedIssues use $this->company->uuid (not session)
+ *  - earnings/fuelCosts return float, currency-filtered
+ *  - ordersInProgress uses explicit allowlist
+ *  - metric discovery uses explicit Registry (not array_slice + reflection)
  */
 class Metrics
 {
@@ -57,264 +62,56 @@ class Metrics
         return $this->start($start)->end($end);
     }
 
-    private function setCompany(Company $company): Metrics
+    /**
+     * Resolve a single metric by slug. New preferred entry point.
+     */
+    public function resolve(string $slug): ?AbstractMetric
     {
-        $this->company = $company;
-
-        return $this;
-    }
+        $class = Registry::resolve($slug);
 
-    private function set($key, $value = null): Metrics
-    {
-        if (is_array($key)) {
-            foreach ($key as $k => $v) {
-                $this->set($k, $v);
-            }
-
-            return $this;
+        if ($class === null) {
+            return null;
         }
 
-        $this->metrics = data_set($this->metrics, $key, $value);
-
-        return $this;
-    }
-
-    public function get()
-    {
-        return $this->metrics;
+        return $class::forCompany($this->company)->between($this->start, $this->end);
     }
 
-    public function with(?array $metrics = [])
+    /**
+     * Legacy bulk API: invoke a set of metrics and collect their scalar values
+     * in the same shape the old endpoint returned. Empty $metrics means "all".
+     *
+     * @param array<string> $metrics slugs or camelCase method names accepted for back-compat
+     */
+    public function with(?array $metrics = []): Metrics
     {
         if (empty($metrics)) {
-            $metrics = array_slice(get_class_methods($this), 9);
-        }
-
-        $metrics = array_map(
-            function ($metric) {
-                return Str::camel($metric);
-            },
-            $metrics
-        );
-
-        foreach ($metrics as $metric) {
-            if (method_exists($this, $metric)) {
-                $this->{$metric}();
+            $slugs = Registry::slugs();
+        } else {
+            $slugs = array_map(
+                fn ($m) => Str::snake($m),
+                $metrics
+            );
+        }
+
+        foreach ($slugs as $slug) {
+            $metric = $this->resolve($slug);
+            if ($metric !== null) {
+                $this->metrics[$slug] = $metric->value();
             }
         }
 
         return $this;
     }
 
-    public function earnings(?callable $callback = null): Metrics
-    {
-        $query = Transaction::where('company_uuid', $this->company->uuid)->whereBetween('created_at', [$this->start, $this->end]);
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->sum('amount');
-
-        return $this->set('earnings', (int) $data);
-    }
-
-    public function fuelCosts(?callable $callback = null): Metrics
+    public function get(): array
     {
-        $query = FuelReport::where('company_uuid', $this->company->uuid)->whereBetween('created_at', [$this->start, $this->end]);
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->sum('amount');
-
-        return $this->set('fuel_costs', (int) $data);
-    }
-
-    public function totalDistanceTraveled(?callable $callback = null): Metrics
-    {
-        $query = Order::where(
-            [
-                'company_uuid' => $this->company->uuid,
-                'status'       => 'completed',
-            ]
-        )
-            ->whereBetween('created_at', [$this->start, $this->end]);
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->sum('distance');
-
-        return $this->set('total_distance_traveled', (int) $data);
-    }
-
-    public function totalTimeTraveled(?callable $callback = null): Metrics
-    {
-        $query = Order::where(
-            [
-                'company_uuid' => $this->company->uuid,
-                'status'       => 'completed',
-            ]
-        )
-            ->whereBetween('created_at', [$this->start, $this->end]);
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->sum('distance');
-
-        return $this->set('total_distance_traveled', (int) $data);
-    }
-
-    public function ordersCanceled(?callable $callback = null): Metrics
-    {
-        $query = Order::where('company_uuid', $this->company->uuid)
-            ->whereBetween('created_at', [$this->start, $this->end])
-            ->where('status', 'canceled');
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->count();
-
-        return $this->set('orders_canceled', $data);
-    }
-
-    public function ordersCompleted(?callable $callback = null): Metrics
-    {
-        $query = Order::where('company_uuid', $this->company->uuid)
-            ->whereBetween('created_at', [$this->start, $this->end])
-            ->where('status', 'completed');
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->count();
-
-        return $this->set('orders_completed', $data);
-    }
-
-    public function ordersInProgress(?callable $callback = null): Metrics
-    {
-        $query = Order::where('company_uuid', $this->company->uuid)
-            ->whereBetween('created_at', [$this->start, $this->end])
-            ->whereNotIn('status', ['completed', 'created', 'pending', 'canceled']);
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->count();
-
-        return $this->set('orders_in_progress', $data);
-    }
-
-    public function activeLiveOrders(?callable $callback = null): Metrics
-    {
-        $query = LiveOrderQuery::make($this->company->uuid, [
-            'active' => true,
-        ]);
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->count();
-
-        return $this->set('active_live_orders', $data);
-    }
-
-    public function ordersScheduled(?callable $callback = null): Metrics
-    {
-        $query = Order::where('company_uuid', $this->company->uuid)
-            ->whereBetween('created_at', [$this->start, $this->end])
-            ->where('status', 'created')
-            ->whereDate('scheduled_at', '>', Carbon::now());
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->count();
-
-        return $this->set('orders_scheduled', $data);
-    }
-
-    public function driversOnline(?callable $callback = null): Metrics
-    {
-        $query = Driver::where('company_uuid', $this->company->uuid)
-            ->where('online', true)
-            ->whereNotNull('current_job_uuid');
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->count();
-
-        return $this->set('drivers_online', $data);
-    }
-
-    public function totalDrivers(?callable $callback = null): Metrics
-    {
-        $query = Driver::where('company_uuid', $this->company->uuid);
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->count();
-
-        return $this->set('total_drivers', $data);
-    }
-
-    public function totalCustomers(?callable $callback = null): Metrics
-    {
-        $query = Contact::where('company_uuid', $this->company->uuid)
-            ->where('type', 'customer');
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->count();
-
-        return $this->set('total_customers', $data);
-    }
-
-    public function openIssues(?callable $callback = null): Metrics
-    {
-        $query = Issue::where('company_uuid', session('company'))
-            ->whereBetween('created_at', [$this->start, $this->end])
-            ->where('status', 'pending');
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->count();
-
-        return $this->set('open_issues', $data);
+        return $this->metrics;
     }
 
-    public function resolvedIssues(?callable $callback = null): Metrics
+    private function setCompany(Company $company): Metrics
     {
-        $query = Issue::where('company_uuid', session('company'))
-            ->whereBetween('created_at', [$this->start, $this->end])
-            ->whereNotNull('resolved_at');
-
-        if (is_callable($callback)) {
-            $callback($query);
-        }
-
-        $data = $query->count();
+        $this->company = $company;
 
-        return $this->set('resolved_issues', $data);
+        return $this;
     }
 }