@fleetbase/fleetops-engine 0.6.58 → 0.6.59

package/server/src/Models/TrackingNumber.php

@@ -264,10 +264,10 @@ class TrackingNumber extends Model
             }
         }
 
-        $values['uuid']         = $uuid = static::generateUuid();
-        $values['public_id']    = static::generatePublicId('track');
+        $values['uuid']         = $uuid = static::newUuid();
+        $values['public_id']    = static::newPublicId();
         $values['_key']         = session('api_key') ?? 'console';
-        $values['created_at']   = Carbon::now()->toDateTimeString();
+        $values['created_at']   = static::currentTimestamp();
         $values['company_uuid'] = session('company');
 
         if ($owner) {
@@ -275,15 +275,15 @@ class TrackingNumber extends Model
             $values['owner_type'] = Utils::getMutationType($owner);
         }
 
-        $values['tracking_number'] = TrackingNumber::generateNumber($values['region'] ?? 'SG');
-        $values['qr_code']         = DNS2D::getBarcodePNG($values['owner_uuid'], 'QRCODE');
-        $values['barcode']         = DNS2D::getBarcodePNG($values['owner_uuid'], 'PDF417');
+        $values['tracking_number'] = static::newTrackingNumber($values['region'] ?? 'SG');
+        $values['qr_code']         = static::newBarcode((string) ($values['owner_uuid'] ?? ''), 'QRCODE');
+        $values['barcode']         = static::newBarcode((string) ($values['owner_uuid'] ?? ''), 'PDF417');
 
         if (isset($values['meta']) && (is_object($values['meta']) || is_array($values['meta']))) {
             $values['meta'] = json_encode($values['meta']);
         }
 
-        $result = static::insert($values);
+        $result = static::insertTrackingNumber($values);
 
         if (!$result) {
             return false;
@@ -292,7 +292,7 @@ class TrackingNumber extends Model
         $ownerTypeName = class_basename($values['owner_type']);
 
         // create initial status
-        $trackingStatusId = TrackingStatus::insertGetUuid([
+        $trackingStatusId = static::createInitialTrackingStatus([
             'tracking_number_uuid' => $uuid,
             'status'               => Str::title($ownerTypeName . ' created'),
             'details'              => 'New ' . Str::lower($ownerTypeName) . ' created.',
@@ -301,7 +301,7 @@ class TrackingNumber extends Model
         ]);
 
         // update status of tracking number
-        TrackingNumber::where('uuid', $uuid)->update(['status_uuid' => $trackingStatusId]);
+        static::updateTrackingStatusUuid($uuid, $trackingStatusId);
 
         // update owner status
         if ($owner && $owner instanceof Model && static::ownerHasStatusColumn($owner) && $owner->isFillable('status')) {
@@ -309,12 +309,57 @@ class TrackingNumber extends Model
             // $model->update([ 'status' => 'created' ]);
 
             // silent update
-            DB::table($owner->getTable())->where('uuid', $owner->uuid)->update(['status' => 'created']);
+            static::updateOwnerStatusColumn($owner, 'created');
         }
 
         return $uuid;
     }
 
+    protected static function newUuid(): string
+    {
+        return static::generateUuid();
+    }
+
+    protected static function newPublicId(): string
+    {
+        return static::generatePublicId('track');
+    }
+
+    protected static function currentTimestamp(): string
+    {
+        return Carbon::now()->toDateTimeString();
+    }
+
+    protected static function newTrackingNumber(string $region): string
+    {
+        return static::generateNumber($region);
+    }
+
+    protected static function newBarcode(string $value, string $type): string
+    {
+        return DNS2D::getBarcodePNG($value, $type);
+    }
+
+    protected static function insertTrackingNumber(array $values): bool
+    {
+        return static::insert($values);
+    }
+
+    protected static function createInitialTrackingStatus(array $values)
+    {
+        return TrackingStatus::insertGetUuid($values);
+    }
+
+    protected static function updateTrackingStatusUuid(string $uuid, mixed $trackingStatusId): void
+    {
+        TrackingNumber::where('uuid', $uuid)->update(['status_uuid' => $trackingStatusId]);
+    }
+
+    protected static function updateOwnerStatusColumn(Model $owner, string $status): void
+    {
+        DB::table($owner->getTable())->where('uuid', $owner->uuid)->update(['status' => $status]);
+    }
+
     protected static function ownerHasStatusColumn(Model $owner): bool
     {
         return Schema::hasColumn($owner->getTable(), 'status');

package/server/src/Models/TrackingStatus.php

@@ -159,10 +159,10 @@ class TrackingStatus extends Model
             }
         }
 
-        $values['uuid']         = $uuid = (string) Str::uuid();
-        $values['public_id']    = static::generatePublicId('status');
+        $values['uuid']         = $uuid = static::newUuid();
+        $values['public_id']    = static::newPublicId();
         $values['_key']         = session('api_key') ?? 'console';
-        $values['created_at']   = Carbon::now()->toDateTimeString();
+        $values['created_at']   = static::currentTimestamp();
         $values['company_uuid'] = session('company');
 
         if ($trackingNumber) {
@@ -175,11 +175,31 @@ class TrackingStatus extends Model
             $values['meta'] = json_encode($values['meta']);
         }
 
-        $result = static::insert($values);
+        $result = static::insertTrackingStatus($values);
 
         return $result ? $uuid : false;
     }
 
+    protected static function newUuid(): string
+    {
+        return (string) Str::uuid();
+    }
+
+    protected static function newPublicId(): string
+    {
+        return static::generatePublicId('status');
+    }
+
+    protected static function currentTimestamp(): string
+    {
+        return Carbon::now()->toDateTimeString();
+    }
+
+    protected static function insertTrackingStatus(array $values): bool
+    {
+        return static::insert($values);
+    }
+
     public function isComplete(): bool
     {
         return Utils::isTrue($this->complete);

package/server/src/Models/Waypoint.php

@@ -203,10 +203,10 @@ class Waypoint extends Model
             }
         }
 
-        $values['uuid']         = $uuid = static::generateUuid();
-        $values['public_id']    = static::generatePublicId('waypoint');
+        $values['uuid']         = $uuid = static::newUuid();
+        $values['public_id']    = static::newPublicId();
         $values['_key']         = session('api_key') ?? 'console';
-        $values['created_at']   = Carbon::now()->toDateTimeString();
+        $values['created_at']   = static::currentTimestamp();
         $values['company_uuid'] = session('company');
 
         if ($payload) {
@@ -217,23 +217,58 @@ class Waypoint extends Model
             $values['meta'] = json_encode($values['meta']);
         }
 
-        $result = static::insert($values);
+        $result = static::insertWaypoint($values);
         if ($result && $payload) {
             // create tracking number for entity
-            $trackingNumberId = TrackingNumber::insertGetUuid([
+            $trackingNumberId = static::createTrackingNumber([
                 'owner_uuid' => $uuid,
                 'owner_type' => Utils::getModelClassName('waypoint'),
                 'region'     => $payload->getPickupRegion(),
-                'location'   => Utils::parsePointToWkt($payload->getPickupLocation()),
+                'location'   => static::pickupLocationWkt($payload),
             ]);
 
             // set tracking number
-            static::where('uuid', $uuid)->update(['tracking_number_uuid' => $trackingNumberId]);
+            static::updateTrackingNumberUuid($uuid, $trackingNumberId);
         }
 
         return $result ? $uuid : false;
     }
 
+    protected static function newUuid(): string
+    {
+        return static::generateUuid();
+    }
+
+    protected static function newPublicId(): string
+    {
+        return static::generatePublicId('waypoint');
+    }
+
+    protected static function currentTimestamp(): string
+    {
+        return Carbon::now()->toDateTimeString();
+    }
+
+    protected static function insertWaypoint(array $values): bool
+    {
+        return static::insert($values);
+    }
+
+    protected static function createTrackingNumber(array $values)
+    {
+        return TrackingNumber::insertGetUuid($values);
+    }
+
+    protected static function pickupLocationWkt(Payload $payload)
+    {
+        return Utils::parsePointToWkt($payload->getPickupLocation());
+    }
+
+    protected static function updateTrackingNumberUuid(string $uuid, mixed $trackingNumberId): void
+    {
+        static::where('uuid', $uuid)->update(['tracking_number_uuid' => $trackingNumberId]);
+    }
+
     /**
      * Get this waypoint place record.
      */
@@ -269,9 +304,8 @@ class Waypoint extends Model
         array $columns = ['*'],
     ): ?self {
         $payloadId = match (true) {
-            $order instanceof Order   => $order->payload_uuid,
-            $order instanceof Payload => $order->uuid,
-            default                   => null,
+            $order instanceof Order => $order->payload_uuid,
+            default                 => $order->uuid,
         };
 
         if (!$payloadId) {

package/server/src/Models/Zone.php

@@ -170,7 +170,7 @@ class Zone extends Model
      */
     public function getCentroid(): \Brick\Geo\Point
     {
-        $geometryEngine  = new \Brick\Geo\Engine\GEOSEngine();
+        $geometryEngine  = Utils::resolveGeometryEngine();
         $borderAsPolygon = $this->toGeosPolygon();
 
         if ($borderAsPolygon instanceof \Brick\Geo\Geometry) {
@@ -232,13 +232,10 @@ class Zone extends Model
      */
     public static function createPolygonFromPoint(Point $point, int $meters = 500): Polygon
     {
+        // coordsToCircle() already closes the ring, so first and last are
+        // equivalent on arrival and no re-closing is needed here
         $coordinates = Utils::coordsToCircle($point->getLat(), $point->getLng(), $meters);
 
-        // first and last positions should be equivalent
-        if (Arr::first($coordinates) !== Arr::last($coordinates)) {
-            $coordinates[] = Arr::first($coordinates);
-        }
-
         // conver the coordinate pairs to points
         $coordinates = array_map(
             function ($coord) {

package/server/src/Notifications/DriverArrivedAtGeofence.php

@@ -61,7 +61,7 @@ class DriverArrivedAtGeofence extends Notification
             ->greeting('Good news!')
             ->line("Your driver has arrived at {$geofenceName} for order #{$orderId}.")
             ->line('Please be ready to receive your delivery.')
-            ->action('Track Your Order', url("/tracking/{$this->order->tracking_number}"))
+            ->action('Track Your Order', \url("/tracking/{$this->order->tracking_number}"))
             ->line('Thank you for using our service.');
     }
 

package/server/src/Notifications/OrderDispatched.php

@@ -141,17 +141,11 @@ class OrderDispatched extends Notification implements ShouldQueue
      */
     public function toBroadcast($notifiable)
     {
+        // OrderResource declares toWebhookPayload(), so the fallback arms of the
+        // old method_exists() chain were never reachable
         $model        = $this->order;
         $resource     = new OrderResource($model);
-        $resourceData = [];
-
-        if ($resource) {
-            if (method_exists($resource, 'toWebhookPayload')) {
-                $resourceData = $resource->toWebhookPayload();
-            } elseif (method_exists($resource, 'toArray')) {
-                $resourceData = $resource->toArray(request());
-            }
-        }
+        $resourceData = $resource->toWebhookPayload();
 
         $resourceData = ResourceLifecycleEvent::transformResourceChildrenToId($resourceData);
 

package/server/src/Notifications/OrderPing.php

@@ -148,17 +148,11 @@ class OrderPing extends Notification implements ShouldQueue
      */
     public function toBroadcast($notifiable)
     {
+        // OrderResource declares toWebhookPayload(), so the fallback arms of the
+        // old method_exists() chain were never reachable
         $model        = $this->order;
         $resource     = new OrderResource($model);
-        $resourceData = [];
-
-        if ($resource) {
-            if (method_exists($resource, 'toWebhookPayload')) {
-                $resourceData = $resource->toWebhookPayload();
-            } elseif (method_exists($resource, 'toArray')) {
-                $resourceData = $resource->toArray(request());
-            }
-        }
+        $resourceData = $resource->toWebhookPayload();
 
         $resourceData = ResourceLifecycleEvent::transformResourceChildrenToId($resourceData);
 

package/server/src/Observers/CategoryObserver.php

@@ -15,6 +15,11 @@ class CategoryObserver
     public function deleted(Category $category)
     {
         // if the category deleted was for "custom_field_group" - delete the custom fields belonging
-        CustomField::where('category_uuid', $category->uuid)->delete();
+        $this->deleteCustomFields($category->uuid);
+    }
+
+    protected function deleteCustomFields(string $categoryUuid): void
+    {
+        CustomField::where('category_uuid', $categoryUuid)->delete();
     }
 }

package/server/src/Observers/CompanyObserver.php

@@ -15,6 +15,11 @@ class CompanyObserver
     public function created(Company $company)
     {
         // Add the default transport order config
+        $this->createTransportConfig($company);
+    }
+
+    protected function createTransportConfig(Company $company): void
+    {
         FleetOps::createTransportConfig($company);
     }
 }

package/server/src/Observers/CompanyUserObserver.php

@@ -15,7 +15,7 @@ class CompanyUserObserver
     public function deleted(CompanyUser $companyUser)
     {
         // if the company user deleted is a driver, delete their driver record to
-        Driver::where('user_uuid', $companyUser->user_uuid)->delete();
+        $this->deleteDrivers($companyUser->user_uuid);
     }
 
     /**
@@ -26,9 +26,19 @@ class CompanyUserObserver
     public function updated(CompanyUser $companyUser)
     {
         // If the company user has any driver assosciated update status to same as company_users
-        $driver = Driver::where('user_uuid', $companyUser->user_uuid)->first();
+        $driver = $this->findDriver($companyUser->user_uuid);
         if ($driver && $companyUser->wasChanged('status')) {
             $driver->update(['status' => $companyUser->status]);
         }
     }
+
+    protected function deleteDrivers(string $userUuid): void
+    {
+        Driver::where('user_uuid', $userUuid)->delete();
+    }
+
+    protected function findDriver(string $userUuid): ?Driver
+    {
+        return Driver::where('user_uuid', $userUuid)->first();
+    }
 }

package/server/src/Observers/DriverObserver.php

@@ -30,7 +30,7 @@ class DriverObserver
      */
     public function created(Driver $driver)
     {
-        LiveCacheService::invalidateMultiple(['drivers', 'operations-monitor']);
+        $this->invalidateLiveCache();
     }
 
     /**
@@ -40,7 +40,7 @@ class DriverObserver
      */
     public function updated(Driver $driver)
     {
-        LiveCacheService::invalidateMultiple(['drivers', 'operations-monitor']);
+        $this->invalidateLiveCache();
     }
 
     /**
@@ -62,14 +62,29 @@ class DriverObserver
     public function deleted(Driver $driver)
     {
         // Unassign them from any order they are assigned to
-        Order::where(['driver_assigned_uuid' => $driver->uuid])->update(['driver_assigned_uuid' => null]);
+        $this->unassignOrders($driver);
 
         // If the driver had a user account with the role driver and type user delete it
-        $user = User::where(['uuid' => $driver->user_uuid, 'type' => 'user'])->first();
+        $user = $this->findDriverUser($driver);
         if ($user && $user->hasRole('Driver')) {
             $user->delete();
         }
 
+        $this->invalidateLiveCache();
+    }
+
+    protected function invalidateLiveCache(): void
+    {
         LiveCacheService::invalidateMultiple(['drivers', 'operations-monitor']);
     }
+
+    protected function unassignOrders(Driver $driver): int
+    {
+        return Order::where(['driver_assigned_uuid' => $driver->uuid])->update(['driver_assigned_uuid' => null]);
+    }
+
+    protected function findDriverUser(Driver $driver): ?User
+    {
+        return User::where(['uuid' => $driver->user_uuid, 'type' => 'user'])->first();
+    }
 }

package/server/src/Observers/FleetObserver.php

@@ -35,8 +35,13 @@ class FleetObserver
     public function deleted(Fleet $fleet)
     {
         // If the fleet being deleted is set as parent fleet, remove it as the parent fleet
-        $subFleets = Fleet::where(['parent_fleet_uuid' => $fleet->uuid])->update(['parent_fleet_uuid' => null]);
+        $this->clearParentFleet($fleet->uuid);
 
         LiveCacheService::invalidate('operations-monitor');
     }
+
+    protected function clearParentFleet(string $fleetUuid): void
+    {
+        Fleet::where(['parent_fleet_uuid' => $fleetUuid])->update(['parent_fleet_uuid' => null]);
+    }
 }

package/server/src/Observers/PurchaseRateObserver.php

@@ -20,21 +20,21 @@ class PurchaseRateObserver
     public function creating(PurchaseRate $purchaseRate)
     {
         if (!$purchaseRate->uuid) {
-            $purchaseRate->uuid = PurchaseRate::generateUuid();
+            $purchaseRate->uuid = $this->generateUuid();
         }
 
-        $purchaseRate->load(['serviceQuote.items', 'serviceQuote.serviceRate']);
+        $this->loadRelations($purchaseRate);
         $order = $this->resolveOrder($purchaseRate);
 
         // get company
-        $company = Company::where('uuid', session('company', $purchaseRate->company_uuid))->first();
+        $company = $this->findCompany(session('company', $purchaseRate->company_uuid));
 
         // get currency to use
-        $currency = data_get($purchaseRate, 'serviceQuote.currency')
-            ?: Utils::getCompanyTransactionCurrency($company ?? $purchaseRate->company_uuid);
+        $currency = $this->getServiceQuoteCurrency($purchaseRate)
+            ?: $this->getCompanyTransactionCurrency($company ?? $purchaseRate->company_uuid);
 
         // create transaction and transaction items
-        $transaction = Transaction::create([
+        $transaction = $this->createTransaction([
             'company_uuid'           => session('company', $purchaseRate->company_uuid),
             'customer_uuid'          => $purchaseRate->customer_uuid,
             'customer_type'          => $purchaseRate->customer_type,
@@ -42,9 +42,9 @@ class PurchaseRateObserver
             'subject_type'           => $order ? Order::class : null,
             'context_uuid'           => $purchaseRate->uuid,
             'context_type'           => PurchaseRate::class,
-            'gateway_transaction_id' => $purchaseRate->getMeta('transaction_id', Transaction::generateNumber()),
+            'gateway_transaction_id' => $this->getTransactionId($purchaseRate),
             'gateway'                => 'internal',
-            'amount'                 => data_get($purchaseRate, 'serviceQuote.amount', 0),
+            'amount'                 => $this->getServiceQuoteAmount($purchaseRate),
             'currency'               => $currency,
             'description'            => 'Dispatch order',
             'type'                   => 'dispatch',
@@ -53,9 +53,9 @@ class PurchaseRateObserver
             'settlement_status'      => Transaction::SETTLEMENT_STATUS_UNPAID,
         ]);
 
-        if (isset($purchaseRate->serviceQuote)) {
-            $purchaseRate->serviceQuote->items->each(function ($serviceQuoteItem) use ($transaction, $currency) {
-                TransactionItem::create([
+        if ($this->hasServiceQuote($purchaseRate)) {
+            $this->getServiceQuoteItems($purchaseRate)->each(function ($serviceQuoteItem) use ($transaction, $currency) {
+                $this->createTransactionItem([
                     'transaction_uuid' => $transaction->uuid,
                     'amount'           => $serviceQuoteItem->amount ?? 0,
                     'currency'         => $currency,
@@ -69,6 +69,61 @@ class PurchaseRateObserver
         $purchaseRate->status           = $purchaseRate->status ?: Transaction::STATUS_SUCCESS;
     }
 
+    protected function generateUuid(): string
+    {
+        return PurchaseRate::generateUuid();
+    }
+
+    protected function loadRelations(PurchaseRate $purchaseRate): void
+    {
+        $purchaseRate->load(['serviceQuote.items', 'serviceQuote.serviceRate']);
+    }
+
+    protected function findCompany(?string $uuid): ?Company
+    {
+        return Company::where('uuid', $uuid)->first();
+    }
+
+    protected function getCompanyTransactionCurrency(mixed $company): string
+    {
+        return Utils::getCompanyTransactionCurrency($company);
+    }
+
+    protected function getServiceQuoteCurrency(PurchaseRate $purchaseRate): ?string
+    {
+        return data_get($purchaseRate, 'serviceQuote.currency');
+    }
+
+    protected function getServiceQuoteAmount(PurchaseRate $purchaseRate): int|float
+    {
+        return data_get($purchaseRate, 'serviceQuote.amount', 0);
+    }
+
+    protected function getTransactionId(PurchaseRate $purchaseRate): string
+    {
+        return $purchaseRate->getMeta('transaction_id', Transaction::generateNumber());
+    }
+
+    protected function hasServiceQuote(PurchaseRate $purchaseRate): bool
+    {
+        return isset($purchaseRate->serviceQuote);
+    }
+
+    protected function getServiceQuoteItems(PurchaseRate $purchaseRate): \Illuminate\Support\Collection
+    {
+        return $purchaseRate->serviceQuote->items;
+    }
+
+    protected function createTransaction(array $attributes): Transaction
+    {
+        return Transaction::create($attributes);
+    }
+
+    protected function createTransactionItem(array $attributes): TransactionItem
+    {
+        return TransactionItem::create($attributes);
+    }
+
     protected function resolveOrder(PurchaseRate $purchaseRate): ?Order
     {
         if (!$purchaseRate->payload_uuid) {

package/server/src/Observers/ServiceAreaObserver.php

@@ -17,7 +17,7 @@ class ServiceAreaObserver
     {
         // if no border is set but country is, create the border from the country
         if (empty($serviceArea->border) && isset($serviceArea->country)) {
-            $serviceArea->border = FleetOpsUtils::createPolygonFromCountry($serviceArea->country);
+            $serviceArea->border = $this->createPolygonFromCountry($serviceArea->country);
         }
     }
 
@@ -30,6 +30,16 @@ class ServiceAreaObserver
     {
         $serviceArea->load(['zones']);
 
-        Utils::deleteModels($serviceArea->zones);
+        $this->deleteModels($serviceArea->zones);
+    }
+
+    protected function createPolygonFromCountry(string $country): mixed
+    {
+        return FleetOpsUtils::createPolygonFromCountry($country);
+    }
+
+    protected function deleteModels(mixed $models): void
+    {
+        Utils::deleteModels($models);
     }
 }

package/server/src/Observers/ServiceRateObserver.php

@@ -14,8 +14,8 @@ class ServiceRateObserver
      */
     public function created(ServiceRate $serviceRate)
     {
-        $serviceRateFees       = request()->input('serviceRate.rate_fees', request()->input('service_rate.rate_fees'));
-        $serviceRateParcelFees = request()->input('serviceRate.parcel_fees', request()->input('service_rate.parcel_fees'));
+        $serviceRateFees       = $this->rateFeesInput();
+        $serviceRateParcelFees = $this->parcelFeesInput();
 
         if ($serviceRate->isFixedMeter() || $serviceRate->isPerDrop() || $serviceRate->isMultiZoneDistance()) {
             $serviceRate->setServiceRateFees($serviceRateFees);
@@ -33,8 +33,8 @@ class ServiceRateObserver
      */
     public function updated(ServiceRate $serviceRate)
     {
-        $serviceRateFees       = request()->input('serviceRate.rate_fees', request()->input('service_rate.rate_fees'));
-        $serviceRateParcelFees = request()->input('serviceRate.parcel_fees', request()->input('service_rate.parcel_fees'));
+        $serviceRateFees       = $this->rateFeesInput();
+        $serviceRateParcelFees = $this->parcelFeesInput();
 
         if ($serviceRate->isFixedMeter() || $serviceRate->isPerDrop() || $serviceRate->isMultiZoneDistance()) {
             $serviceRate->setServiceRateFees($serviceRateFees);
@@ -54,7 +54,22 @@ class ServiceRateObserver
     {
         $serviceRate->load(['parcelFees', 'rateFees']);
 
-        Utils::deleteModels($serviceRate->parcelFees);
-        Utils::deleteModels($serviceRate->rateFees);
+        $this->deleteModels($serviceRate->parcelFees);
+        $this->deleteModels($serviceRate->rateFees);
+    }
+
+    protected function rateFeesInput(): mixed
+    {
+        return request()->input('serviceRate.rate_fees', request()->input('service_rate.rate_fees'));
+    }
+
+    protected function parcelFeesInput(): mixed
+    {
+        return request()->input('serviceRate.parcel_fees', request()->input('service_rate.parcel_fees'));
+    }
+
+    protected function deleteModels(mixed $models): void
+    {
+        Utils::deleteModels($models);
     }
 }