Skip to content

A free open source IT asset/license management system

Added the checkout request listener so all checkout paths are covered

snipec6c7e9129dd0
diff --git a/app/Listeners/FulfillCheckoutRequestListener.php b/app/Listeners/FulfillCheckoutRequestListener.php
new file mode 100644
index 0000000000..60c57e6ea9
--- /dev/null
+++ b/app/Listeners/FulfillCheckoutRequestListener.php
@@ -0,0 +1,108 @@
+<?php
+
+namespace App\Listeners;
+
+use App\Actions\CheckoutRequests\FulfillCheckoutRequestAction;
+use App\Enums\ActionType;
+use App\Enums\CheckoutRequestState;
+use App\Events\CheckoutableCheckedOut;
+use App\Models\Actionlog;
+use App\Models\CheckoutRequest;
+use App\Models\License;
+use App\Models\LicenseSeat;
+use App\Models\User;
+use Illuminate\Support\Facades\Log;
+
+/**
+ * Close the fulfillment loop when a checkout happens. Runs off the
+ * CheckoutableCheckedOut event, so every checkout path (web
+ * controllers, API, imports, tinker) closes matching requests
+ * automatically instead of each controller wiring the hook itself.
+ *
+ * Registered AFTER LogListener in EventServiceProvider so by the
+ * time this fires, the checkout Actionlog row exists and can be
+ * linked from the CheckoutRequest via checkout_actionlog_id.
+ *
+ * Only fires for user-target checkouts. Location and child-asset
+ * targets don't correspond to a requester (requests are user-
+ * owned), so those checkouts have no matching request to close.
+ *
+ * LicenseSeat checkouts map to License for the request lookup:
+ * requesters ask for a License (not a specific seat), and
+ * Loggable::determineLogItemType stores License::class in the
+ * checkout actionlog for the same reason.
+ */
+class FulfillCheckoutRequestListener
+{
+ public function subscribe($events): void
+ {
+ $events->listen(
+ CheckoutableCheckedOut::class,
+ self::class.'@onCheckedOut',
+ );
+ }
+
+ public function onCheckedOut(CheckoutableCheckedOut $event): void
+ {
+ if (! $event->checkedOutTo instanceof User) {
+ return;
+ }
+
+ // Map LicenseSeat -> License so the request lookup matches
+ // the requestable_type the requester actually filed against.
+ $checkoutable = $event->checkoutable;
+ $requestableType = $checkoutable instanceof LicenseSeat
+ ? License::class
+ : $checkoutable::class;
+ $requestableId = $checkoutable instanceof LicenseSeat
+ ? $checkoutable->license_id
+ : $checkoutable->id;
+
+ $openRequests = CheckoutRequest::where('requestable_type', $requestableType)
+ ->where('requestable_id', $requestableId)
+ ->where('user_id', $event->checkedOutTo->id)
+ ->where('state', CheckoutRequestState::Pending->value)
+ ->get();
+
+ if ($openRequests->isEmpty()) {
+ return;
+ }
+
+ // Find the checkout Actionlog LogListener just wrote (it
+ // subscribes to the same event and runs first per the order
+ // in EventServiceProvider). Match on all four polymorphic
+ // slots plus action_type. Grab the most recent id in case
+ // this user has multiple checkout rows for the same item
+ // over its lifetime.
+ $actionlog = Actionlog::where('item_type', $requestableType)
+ ->where('item_id', $requestableId)
+ ->where('target_type', User::class)
+ ->where('target_id', $event->checkedOutTo->id)
+ ->where('action_type', ActionType::Checkout->value)
+ ->latest('id')
+ ->first();
+
+ // Pass the event's quantity through so partial-fulfillment
+ // tracking works. A request for 5 pens that gets a checkout
+ // of 3 should advance fulfilled_quantity by 3 (not by the
+ // full remainder). null qty on the event (older single-
+ // target flows without a qty concept) falls back to the
+ // "consume the whole remainder" default in the action.
+ $eventQty = property_exists($event, 'quantity') ? (int) $event->quantity : null;
+ if ($eventQty !== null && $eventQty < 1) {
+ $eventQty = null;
+ }
+
+ foreach ($openRequests as $request) {
+ try {
+ FulfillCheckoutRequestAction::run($request, $actionlog, $eventQty);
+ } catch (\Throwable $e) {
+ // Never let a fulfillment failure roll back the
+ // checkout that already succeeded. Log and continue -
+ // the row will surface on the admin queue for manual
+ // cleanup rather than silently corrupting state.
+ Log::warning('Failed to auto-fulfill CheckoutRequest #'.$request->id.': '.$e->getMessage());
+ }
+ }
+ }
+}