Issue #2906360 by jackbravo, bojanz: Move OffsitePaymentGatewayInterface::onNotify to its own interface

Author: jackbravo

modules/payment/commerce_payment.routing.yml

@@ -70,7 +70,7 @@ entity.commerce_payment_method.collection:
 commerce_payment.checkout.return:
   path: '/checkout/{commerce_order}/{step}/return'
   defaults:
-    _controller: '\Drupal\commerce_payment\Controller\OffsitePaymentController::returnCheckoutPage'
+    _controller: '\Drupal\commerce_payment\Controller\PaymentCheckoutController::returnPage'
   requirements:
     _custom_access: '\Drupal\commerce_checkout\Controller\CheckoutController::checkAccess'
     _module_dependencies: commerce_checkout
@@ -82,7 +82,7 @@ commerce_payment.checkout.return:
 commerce_payment.checkout.cancel:
   path: '/checkout/{commerce_order}/{step}/cancel'
   defaults:
-    _controller: '\Drupal\commerce_payment\Controller\OffsitePaymentController::cancelCheckoutPage'
+    _controller: '\Drupal\commerce_payment\Controller\PaymentCheckoutController::cancelPage'
   requirements:
     _custom_access: '\Drupal\commerce_checkout\Controller\CheckoutController::checkAccess'
     _module_dependencies: commerce_checkout
@@ -94,7 +94,7 @@ commerce_payment.checkout.cancel:
 commerce_payment.notify:
   path: '/payment/notify/{commerce_payment_gateway}'
   defaults:
-    _controller: '\Drupal\commerce_payment\Controller\OffsitePaymentController::notifyPage'
+    _controller: '\Drupal\commerce_payment\Controller\PaymentNotificationController::notifyPage'
   requirements:
     _access: 'TRUE'
   options:

…/Controller/OffsitePaymentController.php …Controller/PaymentCheckoutController.phpmodules/payment/src/Controller/OffsitePaymentController.php renamed to modules/payment/src/Controller/PaymentCheckoutController.php modules/payment/src/Controller/OffsitePaymentController.php renamed to modules/payment/src/Controller/PaymentCheckoutController.php

@@ -4,19 +4,17 @@
 
 use Drupal\commerce_checkout\CheckoutOrderManagerInterface;
 use Drupal\commerce_order\Entity\OrderInterface;
-use Drupal\commerce_payment\Entity\PaymentGatewayInterface;
 use Drupal\commerce_payment\Exception\PaymentGatewayException;
 use Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\OffsitePaymentGatewayInterface;
 use Drupal\Core\Access\AccessException;
 use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
 
 /**
- * Provides endpoints for off-site payments.
+ * Provides checkout endpoints for off-site payments.
  */
-class OffsitePaymentController implements ContainerInjectionInterface {
+class PaymentCheckoutController implements ContainerInjectionInterface {
 
   /**
    * The checkout order manager.
@@ -26,7 +24,7 @@ class OffsitePaymentController implements ContainerInjectionInterface {
   protected $checkoutOrderManager;
 
   /**
-   * Constructs a new CheckoutController object.
+   * Constructs a new PaymentCheckoutController object.
    *
    * @param \Drupal\commerce_checkout\CheckoutOrderManagerInterface $checkout_order_manager
    *   The checkout order manager.
@@ -54,7 +52,7 @@ public static function create(ContainerInterface $container) {
    * @param \Symfony\Component\HttpFoundation\Request $request
    *   The request.
    */
-  public function returnCheckoutPage(OrderInterface $commerce_order, Request $request) {
+  public function returnPage(OrderInterface $commerce_order, Request $request) {
     /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $payment_gateway */
     $payment_gateway = $commerce_order->get('payment_gateway')->entity;
     $payment_gateway_plugin = $payment_gateway->getPlugin();
@@ -88,7 +86,7 @@ public function returnCheckoutPage(OrderInterface $commerce_order, Request $requ
    * @param \Symfony\Component\HttpFoundation\Request $request
    *   The request.
    */
-  public function cancelCheckoutPage(OrderInterface $commerce_order, Request $request) {
+  public function cancelPage(OrderInterface $commerce_order, Request $request) {
     /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $payment_gateway */
     $payment_gateway = $commerce_order->get('payment_gateway')->entity;
     $payment_gateway_plugin = $payment_gateway->getPlugin();
@@ -105,31 +103,4 @@ public function cancelCheckoutPage(OrderInterface $commerce_order, Request $requ
     $checkout_flow_plugin->redirectToStep($previous_step_id);
   }
 
-  /**
-   * Provides the "notify" page.
-   *
-   * Called the "IPN" or "status" page by some payment providers.
-   *
-   * @param \Drupal\commerce_payment\Entity\PaymentGatewayInterface $commerce_payment_gateway
-   *   The payment gateway.
-   * @param \Symfony\Component\HttpFoundation\Request $request
-   *   The request.
-   *
-   * @return \Symfony\Component\HttpFoundation\Response
-   *   The response.
-   */
-  public function notifyPage(PaymentGatewayInterface $commerce_payment_gateway, Request $request) {
-    $payment_gateway_plugin = $commerce_payment_gateway->getPlugin();
-    if (!$payment_gateway_plugin instanceof OffsitePaymentGatewayInterface) {
-      throw new AccessException('Invalid payment gateway provided.');
-    }
-
-    $response = $payment_gateway_plugin->onNotify($request);
-    if (!$response) {
-      $response = new Response('', 200);
-    }
-
-    return $response;
-  }
-
 }

modules/payment/src/Controller/PaymentNotificationController.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Drupal\commerce_payment\Controller;
+
+use Drupal\commerce_payment\Entity\PaymentGatewayInterface;
+use Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\SupportsNotificationsInterface;
+use Drupal\Core\Access\AccessException;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * Provides the endpoint for payment notifications.
+ */
+class PaymentNotificationController {
+
+  /**
+   * Provides the "notify" page.
+   *
+   * Also called the "IPN", "status", "webhook" page by payment providers.
+   *
+   * @param \Drupal\commerce_payment\Entity\PaymentGatewayInterface $commerce_payment_gateway
+   *   The payment gateway.
+   * @param \Symfony\Component\HttpFoundation\Request $request
+   *   The request.
+   *
+   * @return \Symfony\Component\HttpFoundation\Response
+   *   The response.
+   */
+  public function notifyPage(PaymentGatewayInterface $commerce_payment_gateway, Request $request) {
+    $payment_gateway_plugin = $commerce_payment_gateway->getPlugin();
+    if (!$payment_gateway_plugin instanceof SupportsNotificationsInterface) {
+      throw new AccessException('Invalid payment gateway provided.');
+    }
+
+    $response = $payment_gateway_plugin->onNotify($request);
+    if (!$response) {
+      $response = new Response('', 200);
+    }
+
+    return $response;
+  }
+
+}

modules/payment/src/Plugin/Commerce/PaymentGateway/OffsitePaymentGatewayInterface.php

@@ -24,7 +24,7 @@
  * the payment at the payment provider, they will be redirected back to the
  * cancel url.
  */
-interface OffsitePaymentGatewayInterface extends PaymentGatewayInterface {
+interface OffsitePaymentGatewayInterface extends PaymentGatewayInterface, SupportsNotificationsInterface {
 
   /**
    * Gets the URL to the "notify" page.
@@ -63,21 +63,4 @@ public function onReturn(OrderInterface $order, Request $request);
    */
   public function onCancel(OrderInterface $order, Request $request);
 
-  /**
-   * Processes the "notify" request.
-   *
-   * Note:
-   * This method can't throw exceptions on failure because some payment
-   * providers expect an error response to be returned in that case.
-   * Therefore, the method can log the error itself and then choose which
-   * response to return.
-   *
-   * @param \Symfony\Component\HttpFoundation\Request $request
-   *   The request.
-   *
-   * @return \Symfony\Component\HttpFoundation\Response|null
-   *   The response, or NULL to return an empty HTTP 200 response.
-   */
-  public function onNotify(Request $request);
-
 }

modules/payment/src/Plugin/Commerce/PaymentGateway/SupportsNotificationsInterface.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Drupal\commerce_payment\Plugin\Commerce\PaymentGateway;
+
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Defines the interface for gateways which support notifications.
+ *
+ * Payment providers can use the notification URL (commerce_payment.notify)
+ * to inform the site that a new pending/complete payment should be created
+ * (if the payment happened off-site), or to provide information about an
+ * existing payment (refunds, disputes, etc).
+ */
+interface SupportsNotificationsInterface {
+
+  /**
+   * Processes the notification request.
+   *
+   * Note:
+   * This method can't throw exceptions on failure because some payment
+   * providers expect an error response to be returned in that case.
+   * Therefore, the method can log the error itself and then choose which
+   * response to return.
+   *
+   * @param \Symfony\Component\HttpFoundation\Request $request
+   *   The request.
+   *
+   * @return \Symfony\Component\HttpFoundation\Response|null
+   *   The response, or NULL to return an empty HTTP 200 response.
+   */
+  public function onNotify(Request $request);
+
+}