@fleetbase/fleetops-engine 0.6.8 → 0.6.9

package/addon/components/activity-event-selector.js

@@ -45,6 +45,10 @@ export default class ActivityEventSelectorComponent extends Component {
             name: 'order.canceled',
             description: 'Triggers when an order is canceled by a user, driver, or system process.',
         },
+        'order.completed': {
+            name: 'order.completed',
+            description: 'Triggers when an order is completed by a driver, or system process.',
+        },
     };
 
     /**

package/addon/components/display-place.hbs

@@ -11,9 +11,33 @@
                 </span>
             </div>
         {{else}}
-            {{#if @eta}}
-                <Badge @status="warning" @hideStatusDot={{true}} class="my-1"><span class="font-bold">ETA:</span> {{format-duration @eta}}</Badge>
-            {{/if}}
+            <div class="flex flex-row item-center space-x-2 {{if (or place.status_code @eta) 'mb-2'}}">
+                {{#if place.status_code}}
+                    <Badge @status={{place.status_code}} />
+                {{/if}}
+                {{#if @eta}}
+                    <Badge @status="warning" @hideStatusDot={{true}}><span class="font-bold">ETA:</span> {{format-duration @eta}}</Badge>
+                {{/if}}
+                {{#if @waypointActions}}
+                    <DropdownButton @iconClass="icon-text-height" @size="xs" @buttonClass="fleetops-btn-xxs" @icon="ellipsis-h" @iconPrefix="fas" @contentClass="dropdown-menu" as |dd|>
+                        <div class="next-dd-menu mt-1 mx-0" aria-labelledby="user-menu">
+                            <div class="px-1">
+                                <div class="text-sm flex flex-row items-center px-3 py-1 rounded-md my-1 text-gray-300">
+                                    {{t "fleet-ops.operations.orders.index.view.waypoint-actions"}}
+                                </div>
+                            </div>
+                            <div class="next-dd-menu-seperator"></div>
+                            {{#each-in @waypointActions as |actionId action|}}
+                                <div class="px-1">
+                                    <a href="javascript:;" class="next-dd-item" disabled={{cannot "fleet-ops view order"}} {{on "click" (fn action.fn place dd)}}>
+                                        {{action.label}}
+                                    </a>
+                                </div>
+                            {{/each-in}}
+                        </div>
+                    </DropdownButton>
+                {{/if}}
+            </div>
             <address class={{@addressClass}}>
                 {{#if place.name}}
                     {{place.name}}<br />

package/addon/components/route-list.hbs

@@ -6,7 +6,7 @@
                     <div class="index-count">1</div>
                 </div>
                 <div class="order-route-location {{@routeLocationClass}} dark:text-gray-100">
-                    <DisplayPlace @place={{@order.payload.firstWaypoint}} @eta={{get @eta @order.payload.firstWaypoint.id}} />
+                    <DisplayPlace @place={{@order.payload.firstWaypoint}} @eta={{get @eta @order.payload.firstWaypoint.id}} @waypointActions={{@waypointActions}} />
                 </div>
             </div>
         {{/if}}
@@ -28,7 +28,7 @@
                             <div class="index-count">{{add index 2}}</div>
                         </div>
                         <div class="order-route-location {{@routeLocationClass}} dark:text-gray-100">
-                            <DisplayPlace @place={{waypoint}} @eta={{get @eta waypoint.id}} />
+                            <DisplayPlace @place={{waypoint}} @eta={{get @eta waypoint.id}} @waypointActions={{@waypointActions}} />
                         </div>
                     </div>
                 {{/each}}
@@ -41,7 +41,7 @@
                     <div class="index-count">{{add @order.payload.middleWaypoints.length 2}}</div>
                 </div>
                 <div class="order-route-location {{@routeLocationClass}} dark:text-gray-100">
-                    <DisplayPlace @place={{@order.payload.lastWaypoint}} @eta={{get @eta @order.payload.lastWaypoint.id}} />
+                    <DisplayPlace @place={{@order.payload.lastWaypoint}} @eta={{get @eta @order.payload.lastWaypoint.id}} @waypointActions={{@waypointActions}} />
                 </div>
             </div>
         {{/if}}

package/addon/controllers/operations/orders/index.js

@@ -1047,7 +1047,6 @@ export default class OperationsOrdersIndexController extends BaseController {
         selected = selected.length > 0 ? selected : this.table.selectedRows;
 
         this.crud.bulkDelete(selected, {
-            modelNamePath: `public_id`,
             acceptButtonText: 'Delete Orders',
             resolveModelName: (model) => `${model.get('tracking_number.tracking_number')} - ${model.get('public_id')}`,
             onSuccess: async () => {
@@ -1075,7 +1074,6 @@ export default class OperationsOrdersIndexController extends BaseController {
             acceptButtonText: 'Cancel Orders',
             acceptButtonScheme: 'danger',
             acceptButtonIcon: 'ban',
-            modelNamePath: `public_id`,
             actionPath: `orders/bulk-cancel`,
             actionMethod: `PATCH`,
             resolveModelName: (model) => `${model.get('tracking_number.tracking_number')} - ${model.get('public_id')}`,
@@ -1109,7 +1107,6 @@ export default class OperationsOrdersIndexController extends BaseController {
             acceptButtonText: 'Dispatch Orders',
             acceptButtonScheme: 'magic',
             acceptButtonIcon: 'rocket',
-            modelNamePath: 'public_id',
             actionPath: 'orders/bulk-dispatch',
             actionMethod: 'POST',
             resolveModelName: (model) => `${model.get('tracking_number.tracking_number')} - ${model.get('public_id')}`,
@@ -1152,7 +1149,6 @@ export default class OperationsOrdersIndexController extends BaseController {
             acceptButtonScheme: 'magic',
             acceptButtonIcon: 'user-plus',
             acceptButtonDisabled: true,
-            modelNamePath: 'public_id',
             actionPath: 'orders/bulk-assign-driver',
             actionMethod: 'PATCH',
             driverAssigned: null,

package/addon/routes/operations/orders/index/view.js

@@ -1,6 +1,7 @@
 import Route from '@ember/routing/route';
 import { inject as service } from '@ember/service';
 import { action } from '@ember/object';
+import { debug } from '@ember/debug';
 
 export default class OperationsOrdersIndexViewRoute extends Route {
     @service currentUser;
@@ -66,7 +67,23 @@ export default class OperationsOrdersIndexViewRoute extends Route {
         // Listen for channel subscription
         (async () => {
             for await (let output of channel) {
-                this.refresh();
+                const { event, data } = output;
+
+                // debug output
+                debug(`Socket Event : ${event} : ${JSON.stringify(output)}`);
+
+                // Only reload if the order has a status change stemming from an updated event OR
+                // if a waypoint has been completed which will trigger `order.completed`
+                const statusChanged = event === 'order.updated' && data.status !== model.status;
+                const shouldReload = ['order.completed', 'waypoint.activity', 'order.created'].includes(event);
+                if (statusChanged || shouldReload) {
+                    this.refresh();
+
+                    // reload the controller stuff as well
+                    if (this.controller) {
+                        this.controller.loadOrderRelations.perform(model);
+                    }
+                }
 
                 if (typeof this.onOrderEvent === 'function') {
                     this.onOrderEvent(output);

package/addon/services/movement-tracker.js

@@ -155,7 +155,7 @@ export default class MovementTrackerService extends Service {
 
                 if (event === `${type}.location_changed` || event === `${type}.simulated_location_changed`) {
                     eventBuffer.add(output);
-                    debug(`Incoming socket event added to buffer: ${event}`);
+                    debug(`Socket Event : ${event} : Added to EventBuffer : ${JSON.stringify(output)}`);
                 }
             }
         })();

package/addon/styles/fleetops-engine.css

@@ -1623,3 +1623,10 @@ body[data-theme='dark']
 .justify-end-i {
     justify-content: end !important;
 }
+
+button.fleetops-btn-xxs.btn,
+button.fleetops-btn-xxs,
+.fleetops-btn-xxs {
+    padding-top: 0.2rem !important;
+    padding-bottom: 0.2rem !important;
+}

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

@@ -405,7 +405,7 @@
                                 </div>
                                 <div>
                                     <div class="flex flex-row items-center space-x-4 text-sm mt-2">
-                                        <div class={{if (eq waypoint.type "dropoff") 'is-checked'}}>
+                                        <div class={{if (eq waypoint.type "dropoff") "is-checked"}}>
                                             <div class="flex flex-row items-center">
                                                 <RadioButton
                                                     @radioClass="focus:ring-blue-500 h-4 w-4 text-blue-500"
@@ -418,7 +418,7 @@
                                                 <label for={{concat "waypoint_" index "_dropoff"}} class="ml-2">Dropoff</label>
                                             </div>
                                         </div>
-                                        <div class={{if (eq waypoint.type "pickup") 'is-checked'}}>
+                                        <div class={{if (eq waypoint.type "pickup") "is-checked"}}>
                                             <div class="flex flex-row items-center">
                                                 <RadioButton
                                                     @radioClass="focus:ring-blue-500 h-4 w-4 text-blue-500"

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

@@ -579,7 +579,11 @@
         >
             {{#if @model.payload.isMultiDrop}}
                 <div>
-                    <RouteList @order={{@model}} @eta={{@model.eta}} />
+                    <RouteList
+                        @order={{@model}}
+                        @eta={{@model.eta}}
+                        @waypointActions={{hash viewWaypointLabel=(hash label=(t "fleet-ops.operations.orders.index.view.get-label") fn=this.viewWaypointLabel)}}
+                    />
                 </div>
             {{else}}
                 <div class="grid grid-cols-1 lg:grid-cols-2 gap-4 lg:gap-2">

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

@@ -72,7 +72,12 @@
                     <h4>Bulk Search</h4>
                 </div>
                 <div class="filters-dropdown-body">
-                    <Textarea @value={{this.bulkSearchValue}} class="form-input w-full" rows="8" placeholder="Input comma delimited order ID's or tracking numbers to perform a bulk search" />
+                    <Textarea
+                        @value={{this.bulkSearchValue}}
+                        class="form-input w-full"
+                        rows="8"
+                        placeholder="Input comma delimited order ID's or tracking numbers to perform a bulk search"
+                    />
                 </div>
                 <div class="filters-dropdown-footer space-x-2">
                     <Button @text="Clear" @icon="trash" @size="xs" @onClick={{dropdown-fn dd this.removeBulkQuery}} />

package/addon/templates/settings/notifications.hbs

@@ -1,5 +1,13 @@
 <Layout::Section::Header @title={{t "fleet-ops.settings.notifications.fleet-ops-notification-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}} />
+    <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">

package/composer.json

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

package/extension.json

@@ -1,6 +1,6 @@
 {
     "name": "Fleet-Ops",
-    "version": "0.6.8",
+    "version": "0.6.9",
     "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.8",
+    "version": "0.6.9",
     "description": "Fleet & Transport Management Extension for Fleetbase",
     "fleetbase": {
         "route": "fleet-ops"

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

@@ -69,7 +69,7 @@ class TrackOrderDistanceAndTime extends Command
      * - Not in 'completed' or 'canceled' status.
      * - Not marked as deleted (`deleted_at` is null).
      * - Associated with a company (`company_uuid` is not null).
-     * - The order process has started (`started` is not null).
+     * - The order process has started (`started_at` is not null).
      * - Contains a payload (`payload` relationship exists).
      * - Created within the past month.
      *
@@ -85,7 +85,7 @@ class TrackOrderDistanceAndTime extends Command
         return Order::whereNotIn('status', ['completed', 'canceled'])
                     ->whereNull('deleted_at')
                     ->whereNotNull('company_uuid')
-                    ->whereNotNull('started')
+                    ->whereNotNull('started_at')
                     ->where('created_at', '>=', $oneMonthAgo)
                     ->whereHas('payload')
                     ->with(['payload', 'payload.waypoints', 'payload.pickup', 'payload.dropoff'])

package/server/src/Events/OrderCanceled.php

@@ -4,6 +4,7 @@ namespace Fleetbase\FleetOps\Events;
 
 use Fleetbase\Events\ResourceLifecycleEvent;
 use Fleetbase\FleetOps\Flow\Activity;
+use Fleetbase\FleetOps\Models\Waypoint;
 
 class OrderCanceled extends ResourceLifecycleEvent
 {
@@ -18,4 +19,9 @@ class OrderCanceled extends ResourceLifecycleEvent
      * Assosciated activity which triggered the event.
      */
     public ?Activity $activity;
+
+    /**
+     * Assosciated order waypoint which event is for.
+     */
+    public ?Waypoint $waypoint;
 }

package/server/src/Events/OrderCompleted.php

@@ -4,6 +4,7 @@ namespace Fleetbase\FleetOps\Events;
 
 use Fleetbase\Events\ResourceLifecycleEvent;
 use Fleetbase\FleetOps\Flow\Activity;
+use Fleetbase\FleetOps\Models\Waypoint;
 
 class OrderCompleted extends ResourceLifecycleEvent
 {
@@ -18,4 +19,9 @@ class OrderCompleted extends ResourceLifecycleEvent
      * Assosciated activity which triggered the event.
      */
     public ?Activity $activity;
+
+    /**
+     * Assosciated order waypoint which event is for.
+     */
+    public ?Waypoint $waypoint;
 }

package/server/src/Events/OrderDispatched.php

@@ -4,6 +4,7 @@ namespace Fleetbase\FleetOps\Events;
 
 use Fleetbase\Events\ResourceLifecycleEvent;
 use Fleetbase\FleetOps\Flow\Activity;
+use Fleetbase\FleetOps\Models\Waypoint;
 
 class OrderDispatched extends ResourceLifecycleEvent
 {
@@ -18,4 +19,9 @@ class OrderDispatched extends ResourceLifecycleEvent
      * Assosciated activity which triggered the event.
      */
     public ?Activity $activity;
+
+    /**
+     * Assosciated order waypoint which event is for.
+     */
+    public ?Waypoint $waypoint;
 }

package/server/src/Events/OrderFailed.php

@@ -4,6 +4,7 @@ namespace Fleetbase\FleetOps\Events;
 
 use Fleetbase\Events\ResourceLifecycleEvent;
 use Fleetbase\FleetOps\Flow\Activity;
+use Fleetbase\FleetOps\Models\Waypoint;
 
 class OrderFailed extends ResourceLifecycleEvent
 {
@@ -18,4 +19,9 @@ class OrderFailed extends ResourceLifecycleEvent
      * Assosciated activity which triggered the event.
      */
     public ?Activity $activity;
+
+    /**
+     * Assosciated order waypoint which event is for.
+     */
+    public ?Waypoint $waypoint;
 }

package/server/src/Events/WaypointActivityChanged.php

@@ -0,0 +1,119 @@
+<?php
+
+namespace Fleetbase\FleetOps\Events;
+
+use Fleetbase\FleetOps\Flow\Activity;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Models\Waypoint;
+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 WaypointActivityChanged implements ShouldBroadcast
+{
+    use Dispatchable;
+    use InteractsWithSockets;
+    use SerializesModels;
+
+    /**
+     * The waypoint which is completed.
+     */
+    public Waypoint $waypoint;
+
+    /**
+     * 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(Waypoint $waypoint, Activity $activity)
+    {
+        $this->waypoint         = $waypoint;
+        $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('waypoint.' . $this->waypoint->public_id),
+            new Channel('waypoint.' . $this->waypoint->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 'waypoint.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'        => [
+                'waypoint' => $this->waypoint->public_id,
+                'place'    => data_get($this->waypoint, 'place.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->waypoint->payload_uuid)->first();
+    }
+}

package/server/src/Events/WaypointCompleted.php

@@ -0,0 +1,119 @@
+<?php
+
+namespace Fleetbase\FleetOps\Events;
+
+use Fleetbase\FleetOps\Flow\Activity;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Models\Waypoint;
+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 WaypointCompleted implements ShouldBroadcast
+{
+    use Dispatchable;
+    use InteractsWithSockets;
+    use SerializesModels;
+
+    /**
+     * The waypoint which is completed.
+     */
+    public Waypoint $waypoint;
+
+    /**
+     * 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(Waypoint $waypoint, Activity $activity)
+    {
+        $this->waypoint         = $waypoint;
+        $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('waypoint.' . $this->waypoint->public_id),
+            new Channel('waypoint.' . $this->waypoint->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 'waypoint.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'        => [
+                'waypoint' => $this->waypoint->public_id,
+                'place'    => data_get($this->waypoint, 'place.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->waypoint->payload_uuid)->first();
+    }
+}

package/server/src/Flow/Activity.php

@@ -3,6 +3,7 @@
 namespace Fleetbase\FleetOps\Flow;
 
 use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Models\Waypoint;
 use Fleetbase\FleetOps\Support\Utils;
 
 class Activity extends FlowResource
@@ -100,10 +101,10 @@ class Activity extends FlowResource
      *
      * @param Order $order the order object to be passed to each event
      */
-    public function fireEvents(Order $order)
+    public function fireEvents(Order $order, ?Waypoint $waypoint = null)
     {
         foreach ($this->events as $event) {
-            $event->fire($order, $this);
+            $event->fire($order, $this, $waypoint);
         }
     }
 
@@ -112,12 +113,22 @@ class Activity extends FlowResource
      *
      * @return \Illuminate\Support\Collection a collection of child activities
      */
-    public function getChildActivities()
+    public function getChildActivities(Order|Waypoint|null $context = null)
     {
-        $children = collect();
-        if (is_array($this->activities)) {
-            foreach ($this->activities as $childActivityCode) {
+        $children   = collect();
+        $activities = $this->activities;
+
+        // if waypoint provided
+        $waypointContext = $context instanceof Waypoint;
+
+        if (is_array($activities)) {
+            foreach ($activities as $childActivityCode) {
                 $childActivity = $this->flow->getActivity($childActivityCode);
+                // if waypoint context skip `created` - `started` - `dispatched`
+                if ($waypointContext && in_array($childActivity->code, ['created', 'started', 'dispatched'])) {
+                    return $childActivity->getChildActivities($context);
+                }
+
                 if ($childActivity) {
                     $children->push($childActivity);
                 }
@@ -158,15 +169,19 @@ class Activity extends FlowResource
     /**
      * 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)
+    public function getNext(Order|Waypoint $context)
     {
-        $children       = $this->getChildActivities();
+        $children       = $this->getChildActivities($context);
         $nextActivities = collect();
 
+        // if context is a waypoint get the waypoint order
+        $order = $context;
+        if ($context instanceof Waypoint) {
+            $order = Order::where('payload_uuid', $context->payload_uuid)->first();
+        }
+
         foreach ($children as $childActivity) {
             if ($childActivity->passes($order)) {
                 $nextActivities->push($childActivity);
@@ -237,6 +252,9 @@ class Activity extends FlowResource
         return $this->complete();
     }
 
+    /**
+     *  Checks if this activiy has been completed within the order already.
+     */
     public function isCompleted(Order $order): bool
     {
         return $order->hasCompletedActivity($this);