refactor: use the exit statement in webhook events only when it is pr…

…ocessed
impress-org · Oct 27, 2023 · bc50c34 · bc50c34
1 parent 8fd8f4c
commit bc50c34
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 37 deletions.
diff --git a/...ateways/Gateways/Stripe/StripePaymentElementGateway/Webhooks/Listeners/ChargeRefunded.php b/...ateways/Gateways/Stripe/StripePaymentElementGateway/Webhooks/Listeners/ChargeRefunded.php
@@ -22,6 +22,7 @@ class ChargeRefunded
      *
      * @see https://stripe.com/docs/api/events/types#event_types-charge.refunded
      *
+     * @unreleased Add exit statement only when the event is successfully processed.
      * @since 3.0.0
      *
      * @return void
@@ -30,28 +31,29 @@ class ChargeRefunded
     public function __invoke(Event $event)
     {
         try {
-            $this->processEvent($event);
+            if ($this->processEvent($event)) {
+                exit;
+            }
         } catch (Exception $exception) {
             $this->logWebhookError($event, $exception);
         }
-
-        exit;
     }
 
     /**
+     * @unreleased Return a bool value.
      * @since 3.0.0
      *
      * @throws Exception
      */
-    public function processEvent(Event $event)
+    public function processEvent(Event $event): bool
     {
         /* @var Charge $stripeCharge */
         $stripeCharge = $event->data->object;
 
         $donation = give()->donations->getByGatewayTransactionId($stripeCharge->payment_intent);
 
         if (!$donation || !$this->shouldProcessDonation($donation)) {
-            return;
+            return false;
         }
 
         if ($stripeCharge->refunded && !$donation->status->isRefunded()) {
@@ -63,5 +65,7 @@ public function processEvent(Event $event)
                 'content' => __('Payment refunded in Stripe.', 'give'),
             ]);
         }
+
+        return true;
     }
 }
diff --git a/...ays/Stripe/StripePaymentElementGateway/Webhooks/Listeners/CustomerSubscriptionCreated.php b/...ays/Stripe/StripePaymentElementGateway/Webhooks/Listeners/CustomerSubscriptionCreated.php
@@ -20,6 +20,7 @@ class CustomerSubscriptionCreated
      *
      * @see https://stripe.com/docs/api/events/types#event_types-customer.subscription.created
      *
+     * @unreleased Add exit statement only when the event is successfully processed.
      * @since 3.0.0
      *
      * @return void
@@ -28,18 +29,19 @@ class CustomerSubscriptionCreated
     public function __invoke(Event $event)
     {
         try {
-            $this->processEvent($event);
+            if ($this->processEvent($event)) {
+                exit;
+            }
         } catch (Exception $exception) {
             $this->logWebhookError($event, $exception);
         }
-
-        exit;
     }
 
     /**
+     * @unreleased Return a bool value.
      * @since 3.0.0
      */
-    public function processEvent(Event $event)
+    public function processEvent(Event $event): bool
     {
         /* @var StripeSubscription $stripeSubscription */
         $stripeSubscription = $event->data->object;
@@ -48,11 +50,11 @@ public function processEvent(Event $event)
 
         // only use this for next gen for now
         if (!$subscription || !$this->shouldProcessSubscription($subscription)) {
-            return;
+            return false;
         }
 
         // exit early to prevent legacy webhook
         // we don't need to do anything here at the moment because the subscription is already created & active
-        exit;
+        return true;
     }
 }
diff --git a/...ays/Stripe/StripePaymentElementGateway/Webhooks/Listeners/CustomerSubscriptionDeleted.php b/...ays/Stripe/StripePaymentElementGateway/Webhooks/Listeners/CustomerSubscriptionDeleted.php
@@ -21,6 +21,7 @@ class CustomerSubscriptionDeleted
      *
      * @see https://stripe.com/docs/api/events/types#event_types-customer.subscription.deleted
      *
+     * @unreleased Add exit statement only when the event is successfully processed.
      * @since 3.0.0
      *
      * @return void
@@ -29,19 +30,20 @@ class CustomerSubscriptionDeleted
     public function __invoke(Event $event)
     {
         try {
-            $this->processEvent($event);
+            if ($this->processEvent($event)) {
+                exit;
+            }
         } catch (Exception $exception) {
             $this->logWebhookError($event, $exception);
         }
-
-        exit;
     }
 
     /**
+     * @unreleased Return a bool value.
      * @since 3.0.0
      * @throws Exception
      */
-    public function processEvent(Event $event)
+    public function processEvent(Event $event): bool
     {
         /* @var StripeSubscription $stripeSubscription */
         $stripeSubscription = $event->data->object;
@@ -50,12 +52,14 @@ public function processEvent(Event $event)
 
         // only use this for next gen for now
         if (!$subscription || !$this->shouldProcessSubscription($subscription)) {
-            return;
+            return false;
         }
 
         if (!$subscription->status->isCancelled() && !$subscription->status->isCompleted()) {
             $subscription->status = SubscriptionStatus::COMPLETED();
             $subscription->save();
         }
+
+        return true;
     }
 }
diff --git a/...s/Gateways/Stripe/StripePaymentElementGateway/Webhooks/Listeners/InvoicePaymentFailed.php b/...s/Gateways/Stripe/StripePaymentElementGateway/Webhooks/Listeners/InvoicePaymentFailed.php
@@ -21,6 +21,7 @@ class InvoicePaymentFailed
      *
      * @see https://stripe.com/docs/api/events/types#event_types-invoice.payment_failed
      *
+     * @unreleased Add exit statement only when the event is successfully processed.
      * @since 3.0.0
      *
      * @return void
@@ -29,20 +30,21 @@ class InvoicePaymentFailed
     public function __invoke(Event $event)
     {
         try {
-            $this->processEvent($event);
+            if ($this->processEvent($event)) {
+                exit;
+            }
         } catch (Exception $exception) {
             $this->logWebhookError($event, $exception);
         }
-
-        exit;
     }
 
     /**
+     * @unreleased Return a bool value.
      * @since 3.0.0
      *
      * @throws Exception
      */
-    public function processEvent(Event $event)
+    public function processEvent(Event $event): bool
     {
         /* @var Invoice $invoice */
         $invoice = $event->data->object;
@@ -51,7 +53,7 @@ public function processEvent(Event $event)
 
         // only use this for next gen for now
         if (!$subscription || !$this->shouldProcessSubscription($subscription)) {
-            return;
+            return false;
         }
 
         if (
@@ -64,6 +66,8 @@ public function processEvent(Event $event)
             $subscription->status = SubscriptionStatus::FAILING();
             $subscription->save();
         }
+
+        return true;
     }
 
     /**

diff --git a/...ateways/Stripe/StripePaymentElementGateway/Webhooks/Listeners/InvoicePaymentSucceeded.php b/...ateways/Stripe/StripePaymentElementGateway/Webhooks/Listeners/InvoicePaymentSucceeded.php
@@ -25,27 +25,28 @@ class InvoicePaymentSucceeded
      *
      * @see https://stripe.com/docs/api/events/types#event_types-invoice.payment_succeeded
      *
+     * @unreleased Add exit statement only when the event is successfully processed.
      * @since 3.0.0
      *
-     * @return void
      * @throws \Exception
      */
     public function __invoke(Event $event)
     {
         try {
-            $this->processEvent($event);
+            if ($this->processEvent($event)) {
+                exit;
+            }
         } catch (Exception $exception) {
             $this->logWebhookError($event, $exception);
         }
-
-        exit;
     }
 
     /**
+     * @unreleased Return a bool value.
      * @since 3.0.0
      * @throws \Exception
      */
-    public function processEvent(Event $event)
+    public function processEvent(Event $event): bool
     {
         /* @var Invoice $invoice */
         $invoice = $event->data->object;
@@ -54,7 +55,7 @@ public function processEvent(Event $event)
 
         // only use this for next gen for now
         if (!$subscription || !$this->shouldProcessSubscription($subscription)) {
-            return;
+            return false;
         }
 
         if ($initialDonation = give()->donations->getByGatewayTransactionId($invoice->payment_intent)) {
@@ -71,6 +72,8 @@ public function processEvent(Event $event)
                 $subscriptionModel->handleSubscriptionCompleted();
             }
         }
+
+        return true;
     }
 
     /**

diff --git a/...ways/Stripe/StripePaymentElementGateway/Webhooks/Listeners/PaymentIntentPaymentFailed.php b/...ways/Stripe/StripePaymentElementGateway/Webhooks/Listeners/PaymentIntentPaymentFailed.php
@@ -22,6 +22,7 @@ class PaymentIntentPaymentFailed
      *
      * @see https://stripe.com/docs/api/events/types#event_types-payment_intent.payment_failed
      *
+     * @unreleased Add exit statement only when the event is successfully processed.
      * @since 3.0.0
      *
      * @return void
@@ -30,26 +31,27 @@ class PaymentIntentPaymentFailed
     public function __invoke(Event $event)
     {
         try {
-            $this->processEvent($event);
+            if ($this->processEvent($event)) {
+                exit;
+            }
         } catch (Exception $exception) {
             $this->logWebhookError($event, $exception);
         }
-
-        exit;
     }
 
     /**
+     * @unreleased Return a bool value.
      * @since 3.0.0
      */
-    public function processEvent(Event $event)
+    public function processEvent(Event $event): bool
     {
         /* @var PaymentIntent $paymentIntent */
         $paymentIntent = $event->data->object;
 
         $donation = give()->donations->getByGatewayTransactionId($paymentIntent->id);
 
         if (!$donation || !$this->shouldProcessDonation($donation)) {
-            return;
+            return false;
         }
 
         if ($donation->type->isSingle() && !$donation->status->isFailed()) {
@@ -61,5 +63,7 @@ public function processEvent(Event $event)
                 'content' => __('Payment failed in Stripe.', 'give'),
             ]);
         }
+
+        return true;
     }
 }
diff --git a/...Gateways/Stripe/StripePaymentElementGateway/Webhooks/Listeners/PaymentIntentSucceeded.php b/...Gateways/Stripe/StripePaymentElementGateway/Webhooks/Listeners/PaymentIntentSucceeded.php
@@ -22,6 +22,7 @@ class PaymentIntentSucceeded
      *
      * @see https://stripe.com/docs/api/events/types#event_types-invoice.payment_succeeded
      *
+     * @unreleased Add exit statement only when the event is successfully processed.
      * @since 3.0.0
      *
      * @return void
@@ -30,26 +31,27 @@ class PaymentIntentSucceeded
     public function __invoke(Event $event)
     {
         try {
-            $this->processEvent($event);
+            if ($this->processEvent($event)) {
+                exit;
+            }
         } catch (Exception $exception) {
             $this->logWebhookError($event, $exception);
         }
-
-        exit;
     }
 
     /**
+     * @unreleased Return a bool value.
      * @since 3.0.0
      */
-    public function processEvent(Event $event)
+    public function processEvent(Event $event): bool
     {
         /* @var PaymentIntent $paymentIntent */
         $paymentIntent = $event->data->object;
 
         $donation = give()->donations->getByGatewayTransactionId($paymentIntent->id);
 
         if (!$donation || !$this->shouldProcessDonation($donation)) {
-            return;
+            return false;
         }
 
         if ($donation->type->isSingle() && !$donation->status->isComplete()) {
@@ -61,5 +63,7 @@ public function processEvent(Event $event)
                 'content' => __('Payment succeeded in Stripe.', 'give'),
             ]);
         }
+
+        return true;
     }
 }