@fleetbase/fleetops-engine 0.6.57 → 0.6.59

package/server/src/Http/Controllers/Api/v1/ZoneController.php

@@ -24,17 +24,17 @@ class ZoneController extends Controller
     public function create(CreateZoneRequest $request)
     {
         // get request input
-        $input = $request->only(['name', 'border', 'status', 'description', 'color', 'stroke_color', 'trigger_on_entry', 'trigger_on_exit', 'dwell_threshold_minutes', 'speed_limit_kmh']);
+        $input = $this->zoneInputFromRequest($request);
 
         // get radius for creating zone border - default to 500 meters
-        $radius = $request->input('radius', 500);
+        $radius = $this->radiusFromRequest($request);
 
         // make sure company is set
         $input['company_uuid'] = session('company');
 
         // service area assignment
         if ($request->has('service_area')) {
-            $input['service_area_uuid'] = Utils::getUuid('service_areas', [
+            $input['service_area_uuid'] = $this->serviceAreaUuid($request->input('service_area'), [
                 'public_id'    => $request->input('service_area'),
                 'company_uuid' => session('company'),
             ]);
@@ -48,17 +48,17 @@ class ZoneController extends Controller
             $point     = new Point($latitude, $longitude);
 
             if ($point instanceof Point) {
-                $input['border'] = Zone::createPolygonFromPoint($point, $radius);
+                $input['border'] = $this->createBorderFromPoint($point, $radius);
             }
         }
 
         // if a location is provided
         if ($request->has('location')) {
             $location = $request->input('location');
-            $point    = Utils::getPointFromMixed($location);
+            $point    = $this->pointFromLocation($location);
 
             if ($point instanceof Point) {
-                $input['border'] = Zone::createPolygonFromPoint($point, $radius);
+                $input['border'] = $this->createBorderFromPoint($point, $radius);
             }
         }
 
@@ -68,11 +68,11 @@ class ZoneController extends Controller
          */
 
         // create the zone
-        $zone = Zone::create($input);
+        $zone = $this->createZone($input);
         $zone->refresh();
 
         // response the zone resource
-        return new ZoneResource($zone);
+        return $this->zoneResource($zone);
     }
 
     /**
@@ -87,9 +87,9 @@ class ZoneController extends Controller
     {
         // find for the zone
         try {
-            $zone = Zone::findRecordOrFail($id);
+            $zone = $this->findZoneRecord($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Zone resource not found.',
                 ],
@@ -98,14 +98,14 @@ class ZoneController extends Controller
         }
 
         // get request input
-        $input = $request->only(['name', 'border', 'status', 'description', 'color', 'stroke_color', 'trigger_on_entry', 'trigger_on_exit', 'dwell_threshold_minutes', 'speed_limit_kmh']);
+        $input = $this->zoneInputFromRequest($request);
 
         // get radius for creating zone border - default to 500 meters
-        $radius = $request->input('radius', 500);
+        $radius = $this->radiusFromRequest($request);
 
         // service area assignment
         if ($request->has('service_area')) {
-            $input['service_area_uuid'] = Utils::getUuid('service_areas', [
+            $input['service_area_uuid'] = $this->serviceAreaUuid($request->input('service_area'), [
                 'public_id'    => $request->input('service_area'),
                 'company_uuid' => session('company'),
             ]);
@@ -119,17 +119,17 @@ class ZoneController extends Controller
             $point     = new Point($latitude, $longitude);
 
             if ($point instanceof Point) {
-                $input['border'] = Zone::createPolygonFromPoint($point, $radius);
+                $input['border'] = $this->createBorderFromPoint($point, $radius);
             }
         }
 
         // if a location is provided
         if ($request->has('location')) {
             $location = $request->input('location');
-            $point    = Utils::getPointFromMixed($location);
+            $point    = $this->pointFromLocation($location);
 
             if ($point instanceof Point) {
-                $input['border'] = Zone::createPolygonFromPoint($point, $radius);
+                $input['border'] = $this->createBorderFromPoint($point, $radius);
             }
         }
 
@@ -138,7 +138,7 @@ class ZoneController extends Controller
         $zone->refresh();
 
         // response the zone resource
-        return new ZoneResource($zone);
+        return $this->zoneResource($zone);
     }
 
     /**
@@ -148,9 +148,9 @@ class ZoneController extends Controller
      */
     public function query(Request $request)
     {
-        $results = Zone::queryWithRequest($request);
+        $results = $this->queryZones($request);
 
-        return ZoneResource::collection($results);
+        return $this->zoneResourceCollection($results);
     }
 
     /**
@@ -162,9 +162,9 @@ class ZoneController extends Controller
     {
         // find for the zone
         try {
-            $zone = Zone::findRecordOrFail($id);
+            $zone = $this->findZoneRecord($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Zone resource not found.',
                 ],
@@ -173,7 +173,7 @@ class ZoneController extends Controller
         }
 
         // response the zone resource
-        return new ZoneResource($zone);
+        return $this->zoneResource($zone);
     }
 
     /**
@@ -185,9 +185,9 @@ class ZoneController extends Controller
     {
         // find for the driver
         try {
-            $zone = Zone::findRecordOrFail($id);
+            $zone = $this->findZoneRecord($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Zone resource not found.',
                 ],
@@ -199,6 +199,66 @@ class ZoneController extends Controller
         $zone->delete();
 
         // response the zone resource
+        return $this->deletedZoneResource($zone);
+    }
+
+    protected function zoneInputFromRequest(Request $request): array
+    {
+        return $request->only(['name', 'border', 'status', 'description', 'color', 'stroke_color', 'trigger_on_entry', 'trigger_on_exit', 'dwell_threshold_minutes', 'speed_limit_kmh']);
+    }
+
+    protected function radiusFromRequest(Request $request): int
+    {
+        return (int) $request->input('radius', 500);
+    }
+
+    protected function serviceAreaUuid(string $publicId, array $where): ?string
+    {
+        return Utils::getUuid('service_areas', $where);
+    }
+
+    protected function createBorderFromPoint(Point $point, int $radius)
+    {
+        return Zone::createPolygonFromPoint($point, $radius);
+    }
+
+    protected function pointFromLocation(mixed $location)
+    {
+        return Utils::getPointFromMixed($location);
+    }
+
+    protected function createZone(array $input): Zone
+    {
+        return Zone::create($input);
+    }
+
+    protected function findZoneRecord(string $id): Zone
+    {
+        return Zone::findRecordOrFail($id);
+    }
+
+    protected function queryZones(Request $request)
+    {
+        return Zone::queryWithRequest($request);
+    }
+
+    protected function zoneResource(Zone $zone)
+    {
+        return new ZoneResource($zone);
+    }
+
+    protected function zoneResourceCollection($results)
+    {
+        return ZoneResource::collection($results);
+    }
+
+    protected function deletedZoneResource(Zone $zone)
+    {
         return new DeletedResource($zone);
     }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return response()->json($payload, $status);
+    }
 }

package/server/src/Http/Controllers/Internal/v1/AnalyticsController.php

@@ -35,7 +35,7 @@ class AnalyticsController extends Controller
 
     public function revenueTrend(Request $request)
     {
-        return $this->run($request, RevenueTrend::class, function (RevenueTrend $a) use ($request) {
+        return $this->run($request, RevenueTrend::class, function ($a) use ($request) {
             $a->groupBy($request->string('group_by', 'day')->toString());
         });
     }
@@ -47,14 +47,14 @@ class AnalyticsController extends Controller
 
     public function onTimeDelivery(Request $request)
     {
-        return $this->run($request, OnTimeDelivery::class, function (OnTimeDelivery $a) use ($request) {
+        return $this->run($request, OnTimeDelivery::class, function ($a) use ($request) {
             $a->slaMinutes((int) $request->input('sla_minutes', 30));
         });
     }
 
     public function topDrivers(Request $request)
     {
-        return $this->run($request, TopDrivers::class, function (TopDrivers $a) use ($request) {
+        return $this->run($request, TopDrivers::class, function ($a) use ($request) {
             $a->limit((int) $request->input('limit', 10));
             $a->sortBy($request->string('sort_by', 'orders_completed')->toString());
         });
@@ -106,7 +106,7 @@ class AnalyticsController extends Controller
 
         try {
             /** @var AbstractAnalytics $analytics */
-            $analytics = $class::forCompany($request->user()->company)->between($start, $end);
+            $analytics = $this->analyticsForCompany($class, $request->user()->company)->between($start, $end);
 
             if ($configure !== null) {
                 $configure($analytics);
@@ -114,7 +114,9 @@ class AnalyticsController extends Controller
 
             return response()->json($analytics->get());
         } catch (\Throwable $e) {
-            report($e);
+            if (function_exists('report')) {
+                report($e);
+            }
 
             return response()->json([
                 'error'   => $e->getMessage(),
@@ -122,4 +124,12 @@ class AnalyticsController extends Controller
             ], 500);
         }
     }
+
+    /**
+     * @param class-string<AbstractAnalytics> $class
+     */
+    protected function analyticsForCompany(string $class, $company): AbstractAnalytics
+    {
+        return $class::forCompany($company);
+    }
 }

package/server/src/Http/Controllers/Internal/v1/ContactController.php

@@ -79,7 +79,7 @@ class ContactController extends FleetOpsController
      */
     public function getAsFacilitator($id)
     {
-        $contact = Contact::where('uuid', $id)->withTrashes()->first();
+        $contact = $this->contactByUuidWithTrashed($id);
 
         if (!$contact) {
             return response()->error('Facilitator not found.');
@@ -97,7 +97,7 @@ class ContactController extends FleetOpsController
      */
     public function getAsCustomer($id)
     {
-        $contact = Contact::where('uuid', $id)->first();
+        $contact = $this->contactByUuid($id);
 
         if (!$contact) {
             return response()->error('Customer not found.');
@@ -110,15 +110,11 @@ class ContactController extends FleetOpsController
 
     public function convertToVendor(Request $request, string $id)
     {
-        $contact = Contact::where('company_uuid', session('company'))
-            ->where(function ($query) use ($id) {
-                $query->where('uuid', $id)->orWhere('public_id', $id)->orWhere('id', $id);
-            })
-            ->firstOrFail();
+        $contact = $this->contactForVendorConversion($id);
 
-        $vendor = DB::transaction(function () use ($contact, $request) {
+        $vendor = $this->runContactConversionTransaction(function () use ($contact, $request) {
             $originalType = $contact->type;
-            $vendor       = Vendor::create([
+            $vendor       = $this->createVendorFromContact([
                 'company_uuid' => $contact->company_uuid,
                 'place_uuid'   => $contact->place_uuid,
                 'name'         => $request->input('name', $contact->name),
@@ -134,7 +130,7 @@ class ContactController extends FleetOpsController
                 ],
             ]);
 
-            VendorPersonnel::updateOrCreate(
+            $this->updateOrCreateVendorPersonnel(
                 ['vendor_uuid' => $vendor->uuid, 'contact_uuid' => $contact->uuid],
                 ['role' => 'admin', 'status' => 'active', 'invited_by_uuid' => session('user')]
             );
@@ -155,7 +151,7 @@ class ContactController extends FleetOpsController
         });
 
         return response()->json([
-            'vendor' => (new VendorResource($vendor->load('personnels')))->resolve(),
+            'vendor' => $this->vendorResourcePayload($vendor),
         ]);
     }
 
@@ -197,21 +193,57 @@ class ContactController extends FleetOpsController
         return response()->json(['status' => 'ok', 'message' => 'Import completed', 'imported' => $importedCount]);
     }
 
-    private function migrateContactCustomerContextToVendor(Contact $contact, Vendor $vendor): void
+    protected function contactByUuidWithTrashed(string $id): ?Contact
+    {
+        return Contact::where('uuid', $id)->withTrashed()->first();
+    }
+
+    protected function contactByUuid(string $id): ?Contact
+    {
+        return Contact::where('uuid', $id)->first();
+    }
+
+    protected function contactForVendorConversion(string $id): Contact
+    {
+        return Contact::where('company_uuid', session('company'))
+            ->where(function ($query) use ($id) {
+                $query->where('uuid', $id)->orWhere('public_id', $id)->orWhere('id', $id);
+            })
+            ->firstOrFail();
+    }
+
+    protected function runContactConversionTransaction(callable $callback): mixed
+    {
+        return DB::transaction($callback);
+    }
+
+    protected function createVendorFromContact(array $attributes): Vendor
+    {
+        return Vendor::create($attributes);
+    }
+
+    protected function updateOrCreateVendorPersonnel(array $where, array $attributes): VendorPersonnel
+    {
+        return VendorPersonnel::updateOrCreate($where, $attributes);
+    }
+
+    protected function vendorResourcePayload(Vendor $vendor): array
+    {
+        return (new VendorResource($vendor->load('personnels')))->resolve();
+    }
+
+    protected function migrateContactCustomerContextToVendor(Contact $contact, Vendor $vendor): void
     {
         $contactType = Utils::getMutationType($contact);
         $vendorType  = Utils::getMutationType($vendor);
         $filter      = ['customer_uuid' => $contact->uuid, 'customer_type' => $contactType];
         $replacement = ['customer_uuid' => $vendor->uuid, 'customer_type' => $vendorType];
 
-        Order::where($filter)->update($replacement);
-        PurchaseRate::where($filter)->update($replacement);
-        Entity::where($filter)->update($replacement);
+        $this->bulkUpdateCustomerContext(Order::class, $filter, $replacement);
+        $this->bulkUpdateCustomerContext(PurchaseRate::class, $filter, $replacement);
+        $this->bulkUpdateCustomerContext(Entity::class, $filter, $replacement);
 
-        Issue::where('company_uuid', $contact->company_uuid)
-            ->where('meta->customer_portal->customer_uuid', $contact->uuid)
-            ->where('meta->customer_portal->customer_type', 'contact')
-            ->get()
+        $this->customerPortalIssuesForContact($contact)
             ->each(function (Issue $issue) use ($vendor) {
                 $meta = (array) $issue->meta;
                 data_set($meta, 'customer_portal.customer_uuid', $vendor->uuid);
@@ -220,6 +252,19 @@ class ContactController extends FleetOpsController
             });
     }
 
+    protected function bulkUpdateCustomerContext(string $modelClass, array $filter, array $replacement): void
+    {
+        $modelClass::where($filter)->update($replacement);
+    }
+
+    protected function customerPortalIssuesForContact(Contact $contact)
+    {
+        return Issue::where('company_uuid', $contact->company_uuid)
+            ->where('meta->customer_portal->customer_uuid', $contact->uuid)
+            ->where('meta->customer_portal->customer_type', 'contact')
+            ->get();
+    }
+
     private function resolveUserInput(Request $request, array &$input): void
     {
         $user = data_get($input, 'user_uuid') ?? data_get($input, 'user') ?? $request->input('contact.user_uuid') ?? $request->input('contact.user');
@@ -232,11 +277,16 @@ class ContactController extends FleetOpsController
             return;
         }
 
-        $input['user_uuid'] = User::where('uuid', $user)->orWhere('public_id', $user)->value('uuid') ?? $user;
+        $input['user_uuid'] = $this->resolveUserUuid($user);
         unset($input['user']);
     }
 
-    private function assertCustomerPortalCanSendWelcomeEmail(array $input): void
+    protected function resolveUserUuid(string $user): string
+    {
+        return User::where('uuid', $user)->orWhere('public_id', $user)->value('uuid') ?? $user;
+    }
+
+    protected function assertCustomerPortalCanSendWelcomeEmail(array $input): void
     {
         $type = data_get($input, 'type', 'contact');
         if ($type !== 'customer' || !data_get($input, 'meta.customer_portal.send_welcome_email')) {
@@ -248,7 +298,7 @@ class ContactController extends FleetOpsController
         }
     }
 
-    private function sendCustomerPortalWelcomeEmail(Contact $contact): void
+    protected function sendCustomerPortalWelcomeEmail(Contact $contact): void
     {
         if (!data_get($contact->meta, 'customer_portal.send_welcome_email')) {
             return;
@@ -258,29 +308,64 @@ class ContactController extends FleetOpsController
             throw new \Exception('Customer portal must be installed before sending a customer welcome email.');
         }
 
-        $user = $contact->getUser() ?? Contact::createUserFromContact($contact, false, true);
+        $user = $this->contactUser($contact) ?? $this->createCustomerUserFromContact($contact);
         if (!$user) {
             throw new \Exception('Unable to create customer portal login.');
         }
 
-        $password = Str::random(16);
+        $password = $this->customerPortalPassword();
         $user->changePassword($password);
 
         if ($user->status !== 'active') {
             $user->activate();
         }
 
-        Mail::to($user)->send(new CustomerCredentialsMail($password, $contact));
+        $this->sendCustomerCredentialsMail($user, $password, $contact);
 
         $meta = (array) $contact->meta;
         data_forget($meta, 'customer_portal.send_welcome_email');
-        $contact->forceFill(['meta' => $meta])->saveQuietly();
+        $this->saveContactMetaQuietly($contact, $meta);
         $contact->setAttribute('meta', $meta);
     }
 
-    private function isCustomerPortalInstalled(): bool
+    protected function contactUser(Contact $contact): ?User
+    {
+        return $contact->getUser();
+    }
+
+    protected function createCustomerUserFromContact(Contact $contact): ?User
+    {
+        return Contact::createUserFromContact($contact, false, true);
+    }
+
+    protected function customerPortalPassword(): string
+    {
+        return Str::random(16);
+    }
+
+    protected function sendCustomerCredentialsMail(User $user, string $password, Contact $contact): void
+    {
+        Mail::to($user)->send(new CustomerCredentialsMail($password, $contact));
+    }
+
+    protected function saveContactMetaQuietly(Contact $contact, array $meta): void
+    {
+        $contact->forceFill(['meta' => $meta])->saveQuietly();
+    }
+
+    protected function isCustomerPortalInstalled(): bool
+    {
+        return $this->containsCustomerPortalExtension($this->installedFleetbaseExtensions());
+    }
+
+    protected function installedFleetbaseExtensions(): array
+    {
+        return Utils::getInstalledFleetbaseExtensions();
+    }
+
+    protected function containsCustomerPortalExtension(array $packages): bool
     {
-        return collect(Utils::getInstalledFleetbaseExtensions())
+        return collect($packages)
             ->contains(fn ($package) => data_get($package, 'name') === 'fleetbase/customer-portal-api');
     }
 

package/server/src/Http/Controllers/Internal/v1/CustomerController.php

@@ -26,7 +26,7 @@ class CustomerController extends Controller
         }
 
         return response()->json([
-            'customer' => $this->customerPayload($customer->fresh()),
+            'customer' => $this->customerPayload($this->freshCustomer($customer)),
         ]);
     }
 
@@ -39,19 +39,19 @@ class CustomerController extends Controller
             return response()->error('Unable to send customer portal credentials.');
         }
 
-        $password = Str::random(16);
+        $password = $this->randomPassword();
         $user->changePassword($password);
-        Mail::to($user)->send(new CustomerCredentialsMail($password, $customer));
+        $this->sendCustomerCredentials($user, $password, $customer);
 
         return response()->json([
-            'customer' => $this->customerPayload($customer->fresh()),
+            'customer' => $this->customerPayload($this->freshCustomer($customer)),
         ]);
     }
 
     public function deactivatePortalLogin(Request $request)
     {
         $customer = $this->resolveCustomer($request);
-        $user     = $customer->user_uuid ? User::where('uuid', $customer->user_uuid)->first() : null;
+        $user     = $customer->user_uuid ? $this->findUser($customer->user_uuid) : null;
 
         if (!$user) {
             return response()->error('Customer portal login not found.');
@@ -60,14 +60,14 @@ class CustomerController extends Controller
         $user->deactivate();
 
         return response()->json([
-            'customer' => $this->customerPayload($customer->fresh()),
+            'customer' => $this->customerPayload($this->freshCustomer($customer)),
         ]);
     }
 
     public function reactivatePortalLogin(Request $request)
     {
         $customer = $this->resolveCustomer($request);
-        $user     = $customer->user_uuid ? User::where('uuid', $customer->user_uuid)->first() : null;
+        $user     = $customer->user_uuid ? $this->findUser($customer->user_uuid) : null;
 
         if (!$user) {
             return response()->error('Customer portal login not found.');
@@ -76,7 +76,7 @@ class CustomerController extends Controller
         $user->activate();
 
         return response()->json([
-            'customer' => $this->customerPayload($customer->fresh()),
+            'customer' => $this->customerPayload($this->freshCustomer($customer)),
         ]);
     }
 
@@ -154,12 +154,12 @@ class CustomerController extends Controller
 
         // Send credentials to customer if opted
         if ($sendCredentials) {
-            Mail::to($user)->send(new CustomerCredentialsMail($password, $customer));
+            $this->sendCustomerCredentials($user, $password, $customer);
         }
 
         return response()->json([
             'status'   => 'ok',
-            'customer' => $this->customerPayload($customer->fresh()),
+            'customer' => $this->customerPayload($this->freshCustomer($customer)),
         ]);
     }
 
@@ -180,7 +180,32 @@ class CustomerController extends Controller
 
     protected function resolveCustomerUser(Contact $customer): ?User
     {
-        return $customer->user_uuid ? User::where('uuid', $customer->user_uuid)->first() : Contact::createUserFromContact($customer, false, true);
+        return $customer->user_uuid ? $this->findUser($customer->user_uuid) : $this->createUserFromCustomer($customer);
+    }
+
+    protected function findUser(string $uuid): ?User
+    {
+        return User::where('uuid', $uuid)->first();
+    }
+
+    protected function createUserFromCustomer(Contact $customer): ?User
+    {
+        return Contact::createUserFromContact($customer, false, true);
+    }
+
+    protected function randomPassword(): string
+    {
+        return Str::random(16);
+    }
+
+    protected function sendCustomerCredentials(User $user, string $password, Contact $customer): void
+    {
+        Mail::to($user)->send(new CustomerCredentialsMail($password, $customer));
+    }
+
+    protected function freshCustomer(Contact $customer): Contact
+    {
+        return $customer->fresh();
     }
 
     protected function customerPayload(Contact $customer): array

package/server/src/Http/Controllers/Internal/v1/DeviceController.php

@@ -211,13 +211,18 @@ class DeviceController extends FleetOpsController
     {
         $query->where(function ($vehicleQuery) use ($vehicle) {
             $vehicleQuery->where('attachable_uuid', $vehicle)
-                ->orWhereIn('attachable_uuid', Vehicle::query()
-                    ->where('company_uuid', session('company'))
-                    ->where('public_id', $vehicle)
-                    ->pluck('uuid'));
+                ->orWhereIn('attachable_uuid', static::vehicleUuidsForPublicId($vehicle));
         });
     }
 
+    protected static function vehicleUuidsForPublicId(string $vehicle)
+    {
+        return Vehicle::query()
+            ->where('company_uuid', session('company'))
+            ->where('public_id', $vehicle)
+            ->pluck('uuid');
+    }
+
     protected function logDeviceAttachmentLookupFailure(string $action, string $missingResource, string $deviceId, ?string $vehicleId): void
     {
         Log::warning('Device attachment lookup failed', [