Replace VatNumber validator with new one (#21)

Author: lruozzi9

README.md

@@ -11,20 +11,6 @@
 
 ## Installation
 
-0. This plugin requires the [MyOnlineStore/ViesBundle](https://github.com/MyOnlineStore/ViesBundle) but this is not actually compatible with Symfony 7, there is an open PR: https://github.com/MyOnlineStore/ViesBundle/pull/18
-
-   Thus, you have to run the following command to require a fork of the bundle which is compatible with Symfony 7:
-
-   ```bash
-   composer config repositories.sandwich/vies-bundle git https://github.com/mmenozzi/ViesBundle.git
-   ```
-   
-   and you have to run this command too to allow "dev" versions of the bundle (we need the "dev-patch-1" version):
-
-   ```bash
-   composer config minimum-stability dev
-   ```
-
 1. Require the plugin:
 
    ```bash
@@ -44,19 +30,19 @@
         - { resource: "@WebgriffeSyliusItalianInvoiceableOrderPlugin/config/config.yaml" }
     ```
 
-3. By default, the parameter `app.taxation.eu_zone_code` is set to "EU", as it must be the code of a zone representing the EU. This is used to determine if an order is invoiced to a company within the EU or not. Please change this parameter according to your Sylius's zone configuration if needed:
+4. By default, the parameter `app.taxation.eu_zone_code` is set to "EU", as it must be the code of a zone representing the EU. This is used to determine if an order is invoiced to a company within the EU or not. Please change this parameter according to your Sylius's zone configuration if needed:
 
    ```yaml
    # config/services.yaml
    parameters:
        app.taxation.eu_zone_code: 'EU' # Change it if needed
    ```
 
-4. Your `Address` entity must implement the `Webgriffe\SyliusItalianInvoiceableOrderPlugin\Model\ItalianInvoiceableAddressInterface` and the `Symfony\Component\Validator\GroupSequenceProviderInterface`. You can use the `Webgriffe\SyliusItalianInvoiceableOrderPlugin\Model\ItalianInvoiceableAddressTrait` as implementation for both interfaces.
+5. Your `Address` entity must implement the `Webgriffe\SyliusItalianInvoiceableOrderPlugin\Model\ItalianInvoiceableAddressInterface` and the `Symfony\Component\Validator\GroupSequenceProviderInterface`. You can use the `Webgriffe\SyliusItalianInvoiceableOrderPlugin\Model\ItalianInvoiceableAddressTrait` as implementation for both interfaces.
 
-5. Your `Order` entity must implement the `Webgriffe\SyliusItalianInvoiceableOrderPlugin\Model\ItalianInvoiceableOrderInterface`. You can use the `Webgriffe\SyliusItalianInvoiceableOrderPlugin\Model\ItalianInvoiceableOrderTrait` as default implementation for the interface.
+6. Your `Order` entity must implement the `Webgriffe\SyliusItalianInvoiceableOrderPlugin\Model\ItalianInvoiceableOrderInterface`. You can use the `Webgriffe\SyliusItalianInvoiceableOrderPlugin\Model\ItalianInvoiceableOrderTrait` as default implementation for the interface.
 
-6. You need to import the `Address` and `Order` validator configuration into your project by copying the configuration files provided by this plugin:
+7. You need to import the `Address` and `Order` validator configuration into your project by copying the configuration files provided by this plugin:
 
    ```bash
    mkdir -p config/validator/
@@ -77,12 +63,21 @@
     ```bash
     sed -i '' 's/Tests\\Webgriffe\\SyliusItalianInvoiceableOrderPlugin/App/g' config/validator/Address.xml config/validator/Order.xml
     ```
+   
+   If you already have some validator file for these entities you have to merge the configuration manually.
+   
+   *NB* Please, note that currently these validation rules are applied in strict mode. This means that if the VIES
+   service is not available for some reason, the validation of the VAT number will fail. This could occur frequently on
+   specific countries like Germany or France due
+   to this problem: https://viesapi.eu/vies-problems-with-verifying-companies-from-germany-de/.
+   If you want to avoid this strict behavior you can change the `strict` option of the
+   `Webgriffe\SyliusItalianInvoiceableOrderPlugin\Validator\Constraints\EuropeanVatNumber` constraint to `false` in the
+   validation configuration file. This way, if the VIES service is not available, the VAT number will be considered
+   valid and the checkout will not be blocked.
 
-   If you alread have some validator file for these entities you have to merge the configuration manually.
-
-7. Configure Sylius to use the `Italian tax calculation` tax calculation strategy.
+8. Configure Sylius to use the `Italian tax calculation` tax calculation strategy.
 
-8. To properly enable group sequence validation of your Address entity you must set the `Default` validation group instead of the `sylius` validation group:
+9. To properly enable group sequence validation of your Address entity you must set the `Default` validation group instead of the `sylius` validation group:
 
    ```yaml
    # config/parameters.yaml
@@ -93,28 +88,27 @@
 
    For more information see [here](https://symfony.com/doc/current/validation/sequence_provider.html).
 
-9. Run migration
+10. Run migration
 
    ```bash
-   bin/console cache:clear
    bin/console doctrine:migrations:migrate
    ```
 
-10. Add invoiceable fields to the address show template for admin. To do so you have to override this template:
+11. Add invoiceable fields to the address show template for admin. To do so you have to override this template:
 
     ```bash
     vendor/sylius/sylius/src/Sylius/Bundle/AdminBundle/templates/shared/helper/address.html.twig
     ```
-   
+
     by copying directly our implementation provided in the plugin:
 
     ```bash
     mkdir -p templates/bundles/SyliusAdminBundle/shared/helper/
     cp vendor/webgriffe/sylius-italian-invoiceable-order-plugin/tests/TestApplication/templates/bundles/SyliusAdminBundle/shared/helper/address.html.twig templates/bundles/SyliusAdminBundle/shared/helper/address.html.twig
     ```
-    
+
     or by copying the original template and adding the invoiceable fields by yourself. In this case your template should look like the following:
-    
+
     ```twig
     {% macro address(address) %}
         <address>

UPGRADE.md

@@ -4,4 +4,6 @@
 
 - The service `app.taxation.italian_tax_calculation_strategy` has been renamed to `webgriffe_sylius_italian_invoiceable_order.strategy.taxation.tax_calculation.italian_tax_calculation_strategy`.
 - The class `Webgriffe\SyliusItalianInvoiceableOrderPlugin\Model\ItalianTaxCalculationStrategy` has been moved to `Webgriffe\SyliusItalianInvoiceableOrderPlugin\Taxation\ItalianTaxCalculationStrategy`.
-- 
+- The package `sandwich/vies-bundle` has been removed.
+- The constraint `Symfony\Component\Validator\Constraints\Sandwich\ViesBundle\Validator\Constraint\VatNumber` has been replaced with `Webgriffe\SyliusItalianInvoiceableOrderPlugin\Validator\Constraints\EuropeanVatNumber`. Please update your validation rules accordingly with search and replace.
+  Please, note also that now is available a new strict option that allows you to block the checkout step if the VIES service is not available. You can enable it by setting the `strict` option to `true` in your validation rules.

composer.json

@@ -11,7 +11,6 @@
     "require": {
         "php": "^8.2",
         "dragonbe/vies": "^2.3.2",
-        "sandwich/vies-bundle": "dev-patch-1",
         "sylius/sylius": "^2.2",
         "webmozart/assert": "^1.9"
     },

config/services/validator.php

@@ -4,10 +4,18 @@
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
-use Webgriffe\SyliusElasticsearchPlugin\Validator\RequestValidator;
+use Webgriffe\SyliusItalianInvoiceableOrderPlugin\Validator\Constraints\EuropeanVatNumberValidator;
 
 return static function (ContainerConfigurator $containerConfigurator) {
     $services = $containerConfigurator->services();
 
-    $services->set('webgriffe.sylius_elasticsearch_plugin.validator.request', RequestValidator::class);
+    $services->set('webgriffe_sylius_italian_invoiceable_order.validator.european_vat_number', EuropeanVatNumberValidator::class)
+        ->args([
+            service('webgriffe_sylius_italian_invoiceable_order.vies'),
+            service('logger'),
+        ])
+        ->tag('validator.constraint_validator', [
+            'alias' => 'webgriffe_sylius_italian_invoiceable_order.european_vat_number_validator',
+        ])
+    ;
 };

config/services/vies.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+use DragonBe\Vies\Vies;
+
+return static function (ContainerConfigurator $containerConfigurator) {
+    $services = $containerConfigurator->services();
+
+    $services->set('webgriffe_sylius_italian_invoiceable_order.vies', Vies::class);
+};

psalm.xml

@@ -17,8 +17,9 @@
             <errorLevel type="suppress">
                 <file name="src/Comparator/ItalianInvoiceableAddressComparatorDecorator.php" />
                 <file name="src/Form/Extension/ItalianInvoiceableAddressTypeExtension.php" />
-                <file name="src/Model/ItalianTaxCalculationStrategy.php" />
+                <file name="src/Taxation/ItalianTaxCalculationStrategy.php" />
                 <file name="src/Modifier/AddressFormValuesModifier.php" />
+                <file name="src/Validator/Constraints/EuropeanVatNumberValidator.php" />
             </errorLevel>
         </UnusedClass>
     </issueHandlers>

src/Validator/Constraints/EuropeanVatNumber.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webgriffe\SyliusItalianInvoiceableOrderPlugin\Validator\Constraints;
+
+use Symfony\Component\Validator\Constraint;
+
+/**
+ * @psalm-suppress PropertyNotSetInConstructor
+ */
+final class EuropeanVatNumber extends Constraint
+{
+    public bool $strict = false;
+
+    public string $format = 'NL';
+
+    public string $message = 'webgriffe_sylius_italian_invoiceable_order.address.european_vat_number.valid';
+
+    public function isStrict(): bool
+    {
+        return $this->strict;
+    }
+
+    public function getFormat(): string
+    {
+        return $this->format;
+    }
+
+    #[\Override]
+    public function validatedBy(): string
+    {
+        return 'webgriffe_sylius_italian_invoiceable_order.european_vat_number_validator';
+    }
+}

src/Validator/Constraints/EuropeanVatNumberValidator.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webgriffe\SyliusItalianInvoiceableOrderPlugin\Validator\Constraints;
+
+use DragonBe\Vies\Vies;
+use DragonBe\Vies\ViesException;
+use DragonBe\Vies\ViesServiceException;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+
+/**
+ * @psalm-suppress PropertyNotSetInConstructor
+ */
+final class EuropeanVatNumberValidator extends ConstraintValidator
+{
+    public function __construct(
+        private readonly Vies $viesApi,
+        private readonly LoggerInterface $logger,
+    ) {
+    }
+
+    #[\Override]
+    public function validate(mixed $value, Constraint $constraint): void
+    {
+        if (!is_string($value) || $value === '') {
+            return;
+        }
+        if (!$constraint instanceof EuropeanVatNumber) {
+            return;
+        }
+
+        if (!$this->viesApi->getHeartBeat()->isAlive()) {
+            if ($constraint->isStrict()) {
+                $this->context->addViolation('webgriffe_sylius_italian_invoiceable_order.address.european_vat_number.vies_not_alive');
+            }
+
+            return;
+        }
+
+        $format = $constraint->getFormat();
+
+        try {
+            $isValidEuropeanVatNumber = $this->viesApi->validateVat(
+                $format,
+                str_replace($format, '', $value),
+            )->isValid();
+        } catch (ViesServiceException|ViesException $exception) {
+            $this->logger->warning($exception->getMessage());
+            if ($constraint->isStrict()) {
+                $this->context->addViolation('webgriffe_sylius_italian_invoiceable_order.address.european_vat_number.vies_not_alive');
+            }
+
+            return;
+        }
+        if ($isValidEuropeanVatNumber) {
+            return;
+        }
+
+        $this->context->addViolation($constraint->message, ['%format%' => $format]);
+    }
+}