Task/piwoo 473 refactor payments api #969

mmaymo · 2024-12-17T07:54:27Z

Handles PIWOO-473
It also adds the payment-gateway library and refactors part of the code base into new classes and folders

The SubscriptionModule was missing

Biont

The actual payment gateway library is not present in this branch, right?

Biont · 2024-12-17T08:35:04Z

src/Gateway/Voucher/MaybeDisableGateway.php

@@ -47,7 +50,7 @@ public function maybeDisableMealVoucherGateway(?array $gateways): array
        }
        $mealVoucherGatewayIndex = false;
        foreach ($gateways as $key => $gateway) {
-            if (!($gateway instanceof MolliePaymentGateway)) {
+            if (!($gateway instanceof PaymentGateway)) {


I believe it would be wiser to match against a list of $gateway->id here.
The instanceof check might cause trouble if mollie is used among another gateway that uses our library.

Biont · 2024-12-17T08:39:04Z

src/Gateway/MolliePaymentGatewayHandler.php

@@ -25,7 +25,7 @@
 use WC_Payment_Gateway;
 use WP_Error;

-class MolliePaymentGateway extends WC_Payment_Gateway implements MolliePaymentGatewayI
+class MolliePaymentGatewayHandler extends WC_Payment_Gateway implements MolliePaymentGatewayI


From what I gather, you no longer need to extend WC_Payment_Gateway here, right? This class is being reduced to "a bucket of utility functions" that are in the process of being refactored to a more fitting place...?

In other words, this is no longer acting as a payment gateway by itself..?
Just for my understanding :)

Biont · 2024-12-17T08:42:35Z

src/Gateway/MolliePaymentGatewayHandler.php

-            $amount,
-            $reason
-        );
+        return $this->refundProcessor->process_refund($order_id, $amount, $reason);


$this->refundProcessor is never set and RefundProcessorInterface does not have a process_refund method, but a refundOrderPayment.

It also seems to contradict my earlier question about whether this is now a utility class (if it actively carries out refunds instead of aiding with it I mean)

Is this dead code?

Biont · 2024-12-17T09:00:07Z

src/Gateway/OldGatewayBuilder.php

+use Psr\Container\ContainerInterface;
+use Psr\Log\LoggerInterface as Logger;
+
+class OldGatewayBuilder


Can you explain how this interacts with the payment gateway library?
It is used by the gateway.instances service (as opposed to the payment_gateways service).
If I am still correct in my assumption that MolliePaymentGatewayI is mostly defining a "common toolbox until everything is refactored", then it might make sense to avoid confusion in the service/classnames.

Perhaps a __deprecated.gateway_helpers => fn() => new DeprecatedGatewayHelper() would work wonders giving clarity about the nature of things and the intent behind them.

In two years, it might be hard to dissect that this is a middle step during refactoring.

Biont · 2024-12-17T09:27:28Z

src/Subscription/MollieSubscriptionGatewayHandler.php

@@ -26,7 +27,7 @@
 use Mollie\WooCommerce\PaymentMethods\Constants;
 use WC_Order;

-class MollieSubscriptionGateway extends MolliePaymentGateway
+class MollieSubscriptionGatewayHandler extends MolliePaymentGatewayHandler


This looks a little dangerous to me

This class implements WC_Payment_Gateway and sets up required hooks for $this->scheduled_subscription_payment() and others.

Some of these contain calls to the parent:: method, for example process_subscription_payment and process_payment

As a consequence, these methods do not go through the service locator and the API of the payment gateway library, but rather through the (assumed deprecated) old implementation. Am I seeing this correctly?

Maybe this is all dead code (the WC_Payment_Gateway methods I mean) that you haven't removed yet, though. Removing this in the next step would help me see clearer.

now uses callbacks to container objects namespaces were fixed dependencies fixed

Thankyou and instructions hooks out of deprecated helper

Now we send the description of the new gateway to the default strategy

Biont · 2025-01-02T07:18:23Z

src/Payment/PaymentProcessor.php

    public function setGateway($gateway)
    {
-        $this->gateway = $gateway;
+        $this->deprecatedGatewayHelper = $gateway;
    }


I believe this can be removed. It is only called by MollieSubscriptionGatewayHandler, but I could not find any usages of $this->paymentProcessor nor $this->paymentService() in that class - nor in the MolliePaymentGatewayHandler base class.

Biont · 2025-01-02T07:31:39Z

src/Payment/PaymentProcessor.php

+    public function handleSubscriptions(\Inpsyde\PaymentGateway\PaymentGateway $paymentGateway, ?int $orderId): void
+    {
+        if ($paymentGateway->supports('subscriptions')) {
+            $this->deprecatedGatewayHelper->addWcSubscriptionsFiltersForPayment();


I think such filters should be registered globally during bootstrap, not during an individual payment

Biont · 2025-01-02T07:33:04Z

src/Payment/PaymentProcessor.php

+            $this->deprecatedGatewayHelper->addWcSubscriptionsFiltersForPayment();
+            $isSubscription = $this->dataHelper->isSubscription($orderId);
+            if ($isSubscription) {
+                $this->deprecatedGatewayHelper->isSubscriptionPayment = true;


I could not find usaged of $isSubscriptionPayment. Is this even needed any longer?

Biont · 2025-01-02T07:36:59Z

src/Payment/Request/Decorators/AddressDecorator.php

+    public const MAXIMAL_LENGHT_ADDRESS = 100;
+    public const MAXIMAL_LENGHT_POSTALCODE = 20;
+    public const MAXIMAL_LENGHT_CITY = 200;
+    public const MAXIMAL_LENGHT_REGION = 200;


Spelling ("LENGTH")

Biont · 2025-01-02T07:46:51Z

src/Payment/Request/Strategies/PaymentRequestStrategy.php

+{
+    private $dataHelper;
+    private $settingsHelper;
+    private array $decorators;


Add proper type hints so the usage of RequestDecoratorInterface is found by the IDE

Biont · 2025-01-02T07:59:20Z

src/Payment/Request/Strategies/PaymentRequestStrategy.php

+
+        $context = 'payment';
+        foreach ($this->decorators as $decorator) {
+            $requestData = $decorator->decorate($requestData, $order, $context);


I think the term "decorator" is not the best fit for what you are doing here.
A decorator is applied to objects in order to transparently (->invisible from the outside) modify their behaviour without changing any code.

Here you are building/modifying scalar data (an array) with a structured approach. Maybe it is the middleware pattern you are looking for? - it would also give you two entrypoints for modification (before & after) so that one middleware can make changes to another middleware's output.

Biont · 2025-01-02T10:08:20Z

src/PaymentMethods/PaymentFieldsStrategies/PaymentFieldsManager.php


-class PaymentFieldsService
+class PaymentFieldsManager


I do not think there should be a public function setStrategy, allowing modifying the internal state from the outside. That sounds like a ticking timebomb, because there is no guarantee that executeStrategy yields the expected outcome when it can be changed from the outside at any moment.

It also seems that there is a 1:1 relation between payment method and payment fields, so the option to (re)set a specific strategy does not seem needed at all, this can be configured statically.

The dynamic instantiation based on $paymentMethod->id is pretty limiting - there is no way to pass constructor arguments and/or modify the returned instance in any way. Would it not be much more flexible if we could just delegate to the DI container here?

If there is a 1:1 mapping from payment method to fields strategy, why are we not simply defining many PaymentFieldsRenderer objects to begin with? Instead, we have a one-size-fits-all renderer that pipes all handling through this strategy manager. I think it would be better to simply define multiple 'payment_gateway.<METHOD_ID>.payment_fields_renderer' services. Is there anything that blocked you from going with this approach? Let me know if there's anything missing in the library.

# Conflicts: # src/Payment/MollieObject.php # tests/php/Functional/Payment/OrderRequestStrategyTest.php

Fix file names as per PSR-4

…-api' into task/PIWOO-473-refactor-payments-api

this is a middle step before removing the class

Biont

I still see some room for improving a few details, but I don't think it's worth blocking a merge for them. See comments

Biont · 2025-01-09T10:11:41Z

src/Assets/MollieCheckoutBlocksSupport.php

+                $className = 'Mollie\\WooCommerce\\PaymentMethods\\PaymentFieldsStrategies\\' . ucfirst($method->getProperty('id')) . 'FieldsStrategy';
+                $paymentFieldsStrategy = class_exists($className) ? new $className(
+                    $deprecatedGateway,
+                    $gateway->get_description(),
+                    $dataService
+                ) : new DefaultFieldsStrategy($deprecatedGateway, $gateway->get_description(), $dataService);
+                $issuers = $paymentFieldsStrategy->getFieldMarkup($deprecatedGateway, $dataService);


I can't find piece with this dynamic classname generation. It is not very flexible because it limits our naming options and forces all possible classes to come from a single namespace - and as a result, fom one single folder in our plugin.

If we would maintain a classmap in an external service like this:

$fieldStrategy = [ 'billie' => BillieFieldsStrategy::class, 'riverty' => RivertyFieldsStrategy::class, // more... ];

then we could just check if an entry exists in the array and we would no longer be tied to a single PSR-4 location: Strategies could be supplied by other modules. At the same time, we'd no longer be forced to follow a single naming convention.

Biont · 2025-01-09T10:27:42Z

src/Gateway/inc/services.php

+                $className = 'Mollie\\WooCommerce\\PaymentMethods\\PaymentFieldsStrategies\\' . ucfirst($paymentMethod->getProperty('id')) . 'FieldsStrategy';
+                return class_exists($className) ? new $className($deprecatedGatewayHelper, $gatewayDescription, $dataHelper) : new DefaultFieldsStrategy($deprecatedGatewayHelper, $gatewayDescription, $dataHelper);
+            }


Hm, we're even duplicating code here. A factory working off the aforementioned classmap/dictionary could be reused here.

Biont · 2025-01-09T10:40:05Z

src/Payment/Request/Middleware/AddCustomRequestFieldsMiddleware.php

+                $middlewareClass = 'Mollie\\WooCommerce\\Payment\\Request\\Middleware' . $field;
+                if (class_exists($middlewareClass)) {
+                    $middleware = $this->container->get($middlewareClass);


Is this doing anything? Looks it can only match MiddlewareHandler, but that does not feel intentional. Maybe I just don't understand what this is doing and how it works

Biont · 2025-01-09T10:58:19Z

src/Payment/Request/Middleware/MiddlewareHandler.php

+        return array_reduce(
+            array_reverse($middlewares),
+            static function ($next, $middleware) {
+                return static function ($requestData, $order, $context) use ($middleware, $next) {
+                    return $middleware($requestData, $order, $context, $next);
+                };
+            },
+            static function ($requestData) {
+                return $requestData;
+            }
+        );


Does psalm accept this? I feel this could really use some more typehints

mmaymo added 13 commits December 3, 2024 14:54

Add paymentGateway library

3b65a56

Fix refund

42b11f3

add translations fix

6ecab67

fix multi country settings field

293f86f

fix payment processor interface missing

4938698

fix subscription renewal

9701b5d

fix voucher show-hide

839441a

Remove old gateway mentions

b4ce8a7

Pass container to fix onMollieReturn

c9d7638

Rename subscription gateways to handlers

df17270

The SubscriptionModule was missing

Fix error on renaming

867b71a

Add decorators and strategies for request

6960bdf

Merge branch 'develop' into task/PIWOO-473-refactor-payments-api

e8e941e

mmaymo requested a review from Biont December 17, 2024 07:54

Biont reviewed Dec 17, 2024

View reviewed changes

mmaymo added 15 commits December 17, 2024 15:40

Add payment library to repo

150597e

Add missing decorators

3c71099

Update PaymentFactory

67df6cd

now uses callbacks to container objects namespaces were fixed dependencies fixed

Check if is mollie gateway by id and function

ed2e1e9

Rename gateway instances service to deprecated

e26ae66

Remove wc methods from deprecated gateway and fix around

f8d7085

Rename class

ef509c4

Remove refund processor from old gateway

791b58a

Remove gateway logic

75e5ab6

Add subscription handling in process payment

ea48f17

rename old gateway to deprecated

6c9277d

rename old gateway to deprecated

9cc28e0

Move subscription constructor filters

6e215c8

Use payment gateway for id

f18224b

Use id to check if is mollie gateway

863b1c9

mmaymo and others added 11 commits December 27, 2024 10:00

Fix tests

078b27c

Fix cs

31e7c62

Fix ApplePayButton file name

1b05cf4

Fix two more namespaces

8c1f22f

Move test overrides to a separate directory

bb02da6

Fix cs skip one test

a715994

Fix cs

d374e5f

Extract hooks to service

8a89466

Thankyou and instructions hooks out of deprecated helper

Fix description with surcharge

a730b03

Now we send the description of the new gateway to the default strategy

Fix components card token

5b61422

Fix cart amount filter for is available

c5c8e59

Biont requested changes Jan 2, 2025

View reviewed changes

mmaymo and others added 13 commits January 2, 2025 12:40

Fix subscriptions

4e21d13

Fix typo

bb97562

Unlink payment processor from deprecated helpers

51a6ffa

Remove fields manager use services

0fd207a

Turn decorators into middleware chain

e6a8f52

Merge branch 'develop' into task/PIWOO-473-refactor-payments-api

bcc379b

# Conflicts: # src/Payment/MollieObject.php # tests/php/Functional/Payment/OrderRequestStrategyTest.php

Merge branch 'task/PIWOO-473-refactor-payments-api' into follow-psr4

d9a8a74

Merge pull request #975 from szepeviktor/follow-psr4

1a3e23e

Fix file names as per PSR-4

Merge remote-tracking branch 'origin/task/PIWOO-473-refactor-payments…

8be5cea

…-api' into task/PIWOO-473-refactor-payments-api

Use new middleware in subscription

467c059

this is a middle step before removing the class

Update docblocks

17f39e8

Fix tests

b27ce4a

Fix cs, composer update

ea81951

mmaymo marked this pull request as ready for review January 7, 2025 14:59

mmaymo requested review from danielhuesken and Biont January 7, 2025 14:59

szepeviktor approved these changes Jan 7, 2025

View reviewed changes

Biont approved these changes Jan 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Task/piwoo 473 refactor payments api #969

Task/piwoo 473 refactor payments api #969

mmaymo commented Dec 17, 2024 •

edited by jira bot

Loading

Biont left a comment

Biont Dec 17, 2024

Biont Dec 17, 2024

Biont Dec 17, 2024

Biont Dec 17, 2024 •

edited

Loading

Biont Dec 17, 2024

Biont Jan 2, 2025

Biont Jan 2, 2025

Biont Jan 2, 2025

Biont Jan 2, 2025

Biont Jan 2, 2025

Biont Jan 2, 2025

Biont Jan 2, 2025

Biont left a comment

Biont Jan 9, 2025

Biont Jan 9, 2025

Biont Jan 9, 2025

Biont Jan 9, 2025

Task/piwoo 473 refactor payments api #969

Are you sure you want to change the base?

Task/piwoo 473 refactor payments api #969

Conversation

mmaymo commented Dec 17, 2024 • edited by jira bot Loading

Biont left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Biont Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Biont left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mmaymo commented Dec 17, 2024 •

edited by jira bot

Loading

Biont Dec 17, 2024 •

edited

Loading