From d2edbe02c0f83b81e67f5355f4ab56336576672e Mon Sep 17 00:00:00 2001
From: Daniel Subiabre <daniel.subiabre@platoniq.net>
Date: Wed, 17 Jul 2024 13:50:58 +0200
Subject: [PATCH] Update GatewayInterface

---
 .../Economy/Payment/GatewayInterface.php      | 41 ++++++++++++++++---
 1 file changed, 36 insertions(+), 5 deletions(-)

diff --git a/src/Library/Economy/Payment/GatewayInterface.php b/src/Library/Economy/Payment/GatewayInterface.php
index 13f0f74..3ef010a 100644
--- a/src/Library/Economy/Payment/GatewayInterface.php
+++ b/src/Library/Economy/Payment/GatewayInterface.php
@@ -3,8 +3,24 @@
 namespace App\Library\Economy\Payment;
 
 use App\Entity\GatewayCheckout;
+use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 
+/**
+ * Gateway interfaces are in charge of connecting with payment gateways to send them the data in `GatewayCheckout` instances.\
+ * \
+ * The flow is:
+ * 1. A client app creates a `GatewayCheckout` record
+ * 2. `App\State\GatewayCheckoutProcessor` calls the `sendData` method of the respective interface for the new `GatewayCheckout`
+ * 3. The interface connects with the gateway and sends the data for the `GatewayCheckout`
+ * 4. The interface updates the `GatewayCheckout` with the checkout url and reference given by the gateway for the checkout session
+ * 5. `App\State\GatewayCheckoutProcessor` returns the response data to the client app
+ * 6. The client app redirects the user to the payment with the gateway
+ * 7. The gateway processes the payment and redirects the user back to v4
+ * 8. `App\Controller\GatewayController` catches the redirection and calls the `handleRedirect` method of the respective interface
+ * 9. `App\Controller\GatewayController` also catches webhook events sent by the gateway and calls the `handleWebhook` method 
+ */
 interface GatewayInterface
 {
     /**
@@ -13,16 +29,31 @@ interface GatewayInterface
     public static function getName(): string;
 
     /**
-     * Connects with the payment gateway and creates a checkout session to process payment.
+     * Connects with the payment gateway and creates a checkout session so the gateway can process the payment.
      *
-     * Gateways are trusted to have secured the funds in the GatewayCheckout.
+     * @param GatewayCheckout $checkout The GatewayCheckout with the data for the payment to be charged
+     * @return GatewayCheckout The GatewayCheckout updated with the data given by the gateway
      */
-    public function create(GatewayCheckout $checkout): GatewayCheckout;
+    public function sendData(GatewayCheckout $checkout): GatewayCheckout;
 
     /**
-     * Updates a GatewayCheckout after the payment gateway redirects the user.
+     * When a user is redirected by the gateway we must handle the redirection
+     * and then redirect the user back to a GUI.\
+     * \
+     * IMPORTANT: Redirection shouldn't be the only source of truth for gateway flow completion. 
+     * Webhook handling is the preferred method.\
+     * This should, ideally, only handle redirections of the user back to the desired web app.
      *
      * @param Request $request The HTTP Request object
+     * @return Response A RedirectResponse object to where the user should be redirected
      */
-    public function handleRedirect(Request $request): GatewayCheckout;
+    public function handleRedirect(Request $request): RedirectResponse;
+
+    /**
+     * When supported by the gateway, webhook events should be the preferred method to receive gateway flow updates.
+     * 
+     * @param Request $request The HTTP Request object of the webhook event
+     * @return Response A Response object to send back to the gateway
+     */
+    public function handleWebhook(Request $request): Response;
 }