Merge pull request payplug#196 from payplug/qa

Release 1.5

Author: aimeestone

.github/workflows/ci.yaml

@@ -82,8 +82,8 @@ jobs:
             fail-fast: false
             matrix:
                 php: [7.4, 8.0]
-                sylius: [1.9.0, 1.10.0]
-                symfony: [4.4, 5.2, 5.3]
+                sylius: [1.9.0, 1.10.0, 1.11.0]
+                symfony: [4.4, 5.2, 5.3, 5.4]
                 node: [10.x]
                 exclude:
                     - sylius: 1.9.0
@@ -95,9 +95,14 @@ jobs:
                       symfony: 5.3
                     - sylius: 1.10.0
                       symfony: 4.4
-#TODO: rollback this exclusion when fixed
                     - sylius: 1.10.0
                       symfony: 5.2
+                    - sylius: 1.11.0
+                      php: 7.4
+                    - sylius: 1.11.0
+                      symfony: 5.2
+                    - sylius: 1.11.0
+                      symfony: 5.3
 
         env:
             APP_ENV: test
@@ -110,7 +115,7 @@ jobs:
                   php-version: "${{ matrix.php }}"
                   ini-values: date.timezone=UTC
                   extensions: intl
-                  tools: symfony, flex
+                  tools: symfony
                   coverage: none
 
             - name: Setup Node
@@ -162,7 +167,7 @@ jobs:
             - name: Install Sylius-Standard and Plugin
               env:
                 SYMFONY_REQUIRE: ${{ matrix.symfony }}.*
-              run: make install -e SYLIUS_VERSION=${{ matrix.sylius }} SYMFONY_VERSION=${{ matrix.symfony }}
+              run: make install -e SYLIUS_VERSION=${{ matrix.sylius }} SYMFONY_VERSION=${{ matrix.symfony }} PHP_VERSION=${{ matrix.php }}
 
             - name: Output PHP version for Symfony CLI
               working-directory: ./tests/Application

Makefile

@@ -1,20 +1,20 @@
 .DEFAULT_GOAL := help
 SHELL=/bin/bash
 COMPOSER_ROOT=composer
+PLUGIN_NAME=payplug/sylius-payplug-plugin
+SYLIUS_VERSION=1.11.0
+SYMFONY_VERSION=5.4
+PHP_VERSION=8.0
 TEST_DIRECTORY=tests/Application
+YARN=cd tests/Application && yarn
 CONSOLE=cd tests/Application && php bin/console -e test
 COMPOSER=cd tests/Application && composer
-YARN=cd tests/Application && yarn
-
-SYLIUS_VERSION=1.10.0
-SYMFONY_VERSION=5.2
-PLUGIN_NAME=payplug/sylius-payplug-plugin
 
 ###
 ### DEVELOPMENT
 ### ¯¯¯¯¯¯¯¯¯¯¯
 
-install: sylius ## Install Plugin on Sylius [SyliusVersion=1.9] [SymfonyVersion=5.2]
+install: sylius ## Install Plugin on Sylius [SyliusVersion=1.11] [SymfonyVersion=5.4] [PHP_VERSION=8.0]
 .PHONY: install
 
 reset: ## Remove dependencies
@@ -32,20 +32,21 @@ sylius: sylius-standard update-dependencies install-plugin install-sylius
 .PHONY: sylius
 
 sylius-standard:
-	SYMFONY_REQUIRE=${SYMFONY_VERSION}.* ${COMPOSER_ROOT} create-project sylius/sylius-standard ${TEST_DIRECTORY} "~${SYLIUS_VERSION}"
+	${COMPOSER_ROOT} create-project sylius/sylius-standard ${TEST_DIRECTORY} "~${SYLIUS_VERSION}" --no-install --no-scripts
+	${COMPOSER} require sylius/sylius:"~${SYLIUS_VERSION}"
 
 update-dependencies:
 	${COMPOSER} config extra.symfony.require "^${SYMFONY_VERSION}"
 	${COMPOSER} require --dev donatj/mock-webserver:^2.1 --no-scripts --no-update
 # FIX since https://github.com/Sylius/Sylius/pull/13215 is not merged
 	${COMPOSER} require doctrine/dbal:"^2.6" doctrine/orm:"^2.9" --no-scripts --no-update
-ifeq ($(SYMFONY_VERSION), 4.4)
-	${COMPOSER} require sylius/admin-api-bundle --no-scripts --no-update
+ifeq ($(shell [[ $(SYMFONY_VERSION) == 4.4 && $(PHP_VERSION) == 7.4 ]] && echo true ),true)
+	${COMPOSER} require sylius/admin-api-bundle:1.10 --no-scripts --no-update
 endif
 ifeq ($(SYLIUS_VERSION), 1.8.0)
 	${COMPOSER} update --no-progress --no-scripts --prefer-dist -n
 endif
-	${COMPOSER} require symfony/asset --no-scripts --no-update
+	${COMPOSER} require symfony/asset:^${SYMFONY_VERSION} --no-scripts --no-update
 	${COMPOSER} update --no-progress -n
 
 install-plugin:
@@ -60,18 +61,27 @@ install-plugin:
 	sed -i "4a \ \ \ \ form_themes: ['form/form_gateway_config_row.html.twig']" ${TEST_DIRECTORY}/config/packages/twig.yaml
 	mkdir -p ${TEST_DIRECTORY}/templates/form/
 	cp -R src/Resources/views/form/* ${TEST_DIRECTORY}/templates/form/
+
+# As of sylius/refund-plugin 1.2 the folder does not exist anymore
+ifneq ($(PHP_VERSION), 8)
 	mkdir -p ${TEST_DIRECTORY}/templates/bundles/SyliusAdminBundle/
 	cp -R src/Resources/views/SyliusAdminBundle/* ${TEST_DIRECTORY}/templates/bundles/SyliusAdminBundle/
-
 	# For Refund Plugin
 	cp -R ${TEST_DIRECTORY}/vendor/sylius/refund-plugin/src/Resources/views/SyliusAdminBundle/* ${TEST_DIRECTORY}/templates/bundles/SyliusAdminBundle/
+endif
 
 install-sylius:
 	${CONSOLE} sylius:install -n -s default
 	${YARN} install
 	${YARN} build
+ifeq ($(shell expr $(value) \<= 5.3), 1)
 	${CONSOLE} translation:update en PayPlugSyliusPayPlugPlugin --dump-messages
 	${CONSOLE} translation:update fr PayPlugSyliusPayPlugPlugin --dump-messages
+else ifeq ($(shell expr $(value) \>= 5.4), 1)
+	${CONSOLE} translation:extract en PayPlugSyliusPayPlugPlugin --dump-messages
+	${CONSOLE} translation:extract fr PayPlugSyliusPayPlugPlugin --dump-messages
+endif
+
 	${CONSOLE} cache:clear
 
 phpunit-configure:

README.md

@@ -171,15 +171,23 @@ If you plan override them also, you should retrieve them in your application.
 
 Copy Sylius templates overridden in plugin to your templates directory (e.g templates/bundles/)
 
-   ```shell
-    mkdir -p templates/bundles/SyliusAdminBundle/
-    mkdir -p templates/bundles/SyliusShopBundle/
-    mkdir -p templates/bundles/SyliusUiBundle/
-    cp -R vendor/payplug/sylius-payplug-plugin/src/Resources/views/SyliusAdminBundle/* templates/bundles/SyliusAdminBundle/
-    cp -R vendor/payplug/sylius-payplug-plugin/src/Resources/views/SyliusShopBundle/* templates/bundles/SyliusShopBundle/
-    cp -R vendor/payplug/sylius-payplug-plugin/src/Resources/views/SyliusUiBundle/* templates/bundles/SyliusUiBundle/
-    ```
+```shell
+mkdir -p templates/bundles/SyliusAdminBundle/
+mkdir -p templates/bundles/SyliusShopBundle/
+mkdir -p templates/bundles/SyliusUiBundle/
+cp -R vendor/payplug/sylius-payplug-plugin/src/Resources/views/SyliusAdminBundle/* templates/bundles/SyliusAdminBundle/
+cp -R vendor/payplug/sylius-payplug-plugin/src/Resources/views/SyliusShopBundle/* templates/bundles/SyliusShopBundle/
+cp -R vendor/payplug/sylius-payplug-plugin/src/Resources/views/SyliusUiBundle/* templates/bundles/SyliusUiBundle/
+```
 
+You also need to edit your twig config to add your path to avoid our configuration to be prepended :
+```yaml
+twig:
+  paths:
+    '%kernel.project_dir%/templates/bundles/SyliusAdminBundle': SyliusAdmin
+    '%kernel.project_dir%/templates/bundles/SyliusShopBundle': SyliusShop
+    '%kernel.project_dir%/templates/bundles/SyliusUiBundle': SyliusUi
+```
 ## Development
 
 See [How to contribute](CONTRIBUTING.md).

composer.json

@@ -9,10 +9,10 @@
         "giggsey/libphonenumber-for-php": "^8.12",
         "payplug/payplug-php": "^3.1",
         "sylius/refund-plugin": "^1.0.0",
-        "sylius/sylius": "^1.9.0 || ^1.10.0",
-        "symfony/asset": "^4.3|^5.0",
-        "symfony/lock": "^4.3|^5.0",
-        "symfony/validator": "^4.3|^5.0"
+        "sylius/sylius": "^1.9.0 || ^1.10.0 || ^1.11.0",
+        "symfony/asset": "^4.4|^5.0",
+        "symfony/lock": "^4.4|^5.0",
+        "symfony/validator": "^4.4|^5.0"
     },
     "require-dev": {
         "behat/behat": "^3.7",
@@ -57,7 +57,13 @@
         }
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "phpstan/extension-installer": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "symfony/flex": true,
+            "symfony/thanks": true
+        }
     },
     "scripts": {
         "ecs": "ecs check -c rulesets/ecs.php --ansi --clear-cache .",

src/Action/NotifyAction.php

@@ -44,6 +44,8 @@ public function __construct(
 
     public function execute($request): void
     {
+        // Put notification asleep to prevent double processing while user is redirected manually
+        sleep(10);
         $details = ArrayObject::ensureArrayObject($request->getModel());
 
         $input = file_get_contents('php://input');

src/DependencyInjection/PayPlugSyliusPayPlugExtension.php

@@ -32,13 +32,21 @@ public function prepend(ContainerBuilder $container): void
         }
 
         $viewsPath = dirname(__DIR__) . '/Resources/views/';
-        // This add our override in twig paths with correct namespace. No need for final user to copy it
+        // This add our override in twig paths with correct namespace if there are not already overridden. No need for final user to copy it
         $paths = [
             $viewsPath . 'SyliusShopBundle' => 'SyliusShop',
             $viewsPath . 'SyliusAdminBundle' => 'SyliusAdmin',
             $viewsPath . 'SyliusUiBundle' => 'SyliusUi',
         ];
 
+        $twigConfig = $container->getExtensionConfig('twig');
+
+        foreach ($paths as $key => $path) {
+            if ($this->isPathAlreadyInConfiguration($path, $twigConfig)) {
+                unset($paths[$key]);
+            }
+        }
+
         $container->prependExtensionConfig('twig', [
             'paths' => $paths,
             'form_themes' => [
@@ -50,6 +58,27 @@ public function prepend(ContainerBuilder $container): void
         $this->prependDoctrineMigrations($container);
     }
 
+    /**
+     * Verify if a given namespace is alreay extented
+     *
+     * @param string $namespace The namespace to verify
+     * @param array  $configurations The given configurations
+     *
+     * @return bool
+     */
+    protected function isPathAlreadyInConfiguration(string $namespace, array $configurations): bool
+    {
+        foreach ($configurations as $configuration) {
+            foreach ($configuration as $parameter => $values) {
+                if ('paths' === $parameter && in_array($namespace, $values, true)) {
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
+
     protected function getMigrationsNamespace(): string
     {
         return 'PayPlug\SyliusPayPlugPlugin\Migrations';

src/Handler/PaymentNotificationHandler.php

@@ -5,6 +5,7 @@
 namespace PayPlug\SyliusPayPlugPlugin\Handler;
 
 use DateTimeImmutable;
+use Doctrine\ORM\EntityManagerInterface;
 use Payplug\Resource\IVerifiableAPIResource;
 use Payplug\Resource\Payment;
 use Payplug\Resource\PaymentAuthorization;
@@ -19,6 +20,7 @@
 use Sylius\Component\Resource\Factory\FactoryInterface;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
 use Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface;
+use Symfony\Component\Lock\LockFactory;
 
 class PaymentNotificationHandler
 {
@@ -37,18 +39,26 @@ class PaymentNotificationHandler
     /** @var \Sylius\Component\Core\Repository\CustomerRepositoryInterface */
     private $customerRepository;
 
+    private EntityManagerInterface $entityManager;
+
+    private LockFactory $lockFactory;
+
     public function __construct(
         LoggerInterface $logger,
         RepositoryInterface $payplugCardRepository,
         FactoryInterface $payplugCardFactory,
         CustomerRepositoryInterface $customerRepository,
-        FlashBagInterface $flashBag
+        FlashBagInterface $flashBag,
+        EntityManagerInterface $entityManager,
+        LockFactory $lockFactory
     ) {
         $this->logger = $logger;
         $this->payplugCardRepository = $payplugCardRepository;
         $this->payplugCardFactory = $payplugCardFactory;
         $this->flashBag = $flashBag;
         $this->customerRepository = $customerRepository;
+        $this->entityManager = $entityManager;
+        $this->lockFactory = $lockFactory;
     }
 
     public function treat(Generic $request, IVerifiableAPIResource $paymentResource, \ArrayObject $details): void
@@ -57,18 +67,33 @@ public function treat(Generic $request, IVerifiableAPIResource $paymentResource,
             return;
         }
 
+        $lock = $this->lockFactory->createLock('payment_'.$paymentResource->id);
+        $lock->acquire(true);
+
+        $this->entityManager->refresh($request->getFirstModel());
+
+        if (PayPlugApiClientInterface::STATUS_CREATED === $request->getFirstModel()->getDetails()) {
+            $lock->release();
+
+            return;
+        }
+
         if ($paymentResource->is_paid) {
             $details['status'] = PayPlugApiClientInterface::STATUS_CAPTURED;
             $details['created_at'] = $paymentResource->created_at;
 
             $this->saveCard($request->getFirstModel(), $paymentResource);
 
+            $lock->release();
+
             return;
         }
 
         if ($this->isResourceIsAuthorized($paymentResource)) {
             $details['status'] = PayPlugApiClientInterface::STATUS_AUTHORIZED;
 
+            $lock->release();
+
             return;
         }
 
@@ -80,6 +105,8 @@ public function treat(Generic $request, IVerifiableAPIResource $paymentResource,
                 'message' => $paymentResource->failure->message ?? '',
             ];
 
+            $lock->release();
+
             return;
         }
 
@@ -94,6 +121,7 @@ public function treat(Generic $request, IVerifiableAPIResource $paymentResource,
         }
 
         $details['status'] = PayPlugApiClientInterface::FAILED;
+        $lock->release();
     }
 
     private function saveCard(PaymentInterface $payment, IVerifiableAPIResource $paymentResource): void

src/PayPlugSyliusPayPlugPlugin.php

@@ -9,7 +9,7 @@
 
 final class PayPlugSyliusPayPlugPlugin extends Bundle
 {
-    public const VERSION = '1.4.0';
+    public const VERSION = '1.5.0';
 
     use SyliusPluginTrait;
 }