WIP

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- Improved the performance of recalculating shipping method prices. ([#3841](https://github.com/craftcms/commerce/pull/3841))
 - Fixed a bug where Edit Product pages would allow duplication for users that didn’t have permission to duplicate the product. ([#3819](https://github.com/craftcms/commerce/issues/3819))
 
 ## 4.7.2 - 2024-12-18

src/Plugin.php

@@ -80,6 +80,7 @@
 use craft\commerce\services\TaxZones;
 use craft\commerce\services\Transactions;
 use craft\commerce\services\Variants as VariantsService;
+use craft\commerce\services\Vat;
 use craft\commerce\services\Webhooks;
 use craft\commerce\web\twig\CraftVariableBehavior;
 use craft\commerce\web\twig\Extension;
@@ -195,6 +196,7 @@ public static function config(): array
                 'transactions' => ['class' => Transactions::class],
                 'customers' => ['class' => Customers::class],
                 'variants' => ['class' => VariantsService::class],
+                'vat' => ['class' => Vat::class],
                 'webhooks' => ['class' => Webhooks::class],
             ],
         ];
@@ -210,7 +212,7 @@ public static function editions(): array
     /**
      * @inheritDoc
      */
-    public string $schemaVersion = '4.7.0.1';
+    public string $schemaVersion = '4.8.0.0';
 
     /**
      * @inheritdoc

src/adjusters/Tax.php

@@ -10,13 +10,16 @@
 use Craft;
 use craft\base\Component;
 use craft\commerce\base\AdjusterInterface;
+use craft\commerce\base\TaxIdValidatorInterface;
 use craft\commerce\elements\Order;
 use craft\commerce\helpers\Currency;
 use craft\commerce\models\OrderAdjustment;
 use craft\commerce\models\TaxAddressZone;
 use craft\commerce\models\TaxRate;
 use craft\commerce\Plugin;
 use craft\commerce\records\TaxRate as TaxRateRecord;
+use craft\commerce\services\Taxes;
+use craft\commerce\taxidvalidators\EuVatIdValidator;
 use craft\elements\Address;
 use DvK\Vat\Validator;
 use Exception;
@@ -118,17 +121,17 @@ private function _adjustInternal(): array
     private function _getAdjustments(TaxRate $taxRate): array
     {
         $adjustments = [];
-        $hasValidEuVatId = false;
+        $hasValidTaxId = false;
 
         $zoneMatches = $taxRate->getIsEverywhere() || ($taxRate->getTaxZone() && $this->_matchAddress($taxRate->getTaxZone()));
 
-        if ($zoneMatches && $taxRate->isVat) {
-            $hasValidEuVatId = $this->organizationTaxId();
+        if ($zoneMatches && $taxRate->hasTaxIdValidators()) {
+            $hasValidTaxId = $this->organizationTaxIdIsValidTaxId($taxRate->getSelectedEnabledTaxIdValidators());
         }
 
         $removeIncluded = (!$zoneMatches && $taxRate->removeIncluded);
-        $removeDueToVat = ($zoneMatches && $hasValidEuVatId && $taxRate->removeVatIncluded);
-        if ($removeIncluded || $removeDueToVat) {
+        $removeDueToVatId = ($zoneMatches && $hasValidTaxId && $taxRate->removeVatIncluded);
+        if ($removeIncluded || $removeDueToVatId) {
 
             // Is this an order level tax rate?
             if (in_array($taxRate->taxable, TaxRateRecord::ORDER_TAXABALES, false)) {
@@ -195,7 +198,7 @@ private function _getAdjustments(TaxRate $taxRate): array
             return $adjustments;
         }
 
-        if (!$zoneMatches || ($taxRate->isVat && $hasValidEuVatId)) {
+        if (!$zoneMatches || ($taxRate->hasTaxIdValidators() && $hasValidTaxId)) {
             return [];
         }
 
@@ -323,7 +326,7 @@ private function _matchAddress(TaxAddressZone $zone): bool
     /**
      * @return bool
      */
-    private function organizationTaxId(): bool
+    private function organizationTaxIdIsValidTaxId(array $validators): bool
     {
         if (!$this->_address) {
             return false;
@@ -336,11 +339,11 @@ private function organizationTaxId(): bool
             return false;
         }
 
-        $validOrganizationTaxId = Craft::$app->getCache()->exists('commerce:validVatId:' . $this->_address->organizationTaxId);
+        $validOrganizationTaxId = false;//Craft::$app->getCache()->exists('commerce:validVatId:' . $this->_address->organizationTaxId);
 
         // If we do not have a valid VAT ID in cache, see if we can get one from the API
         if (!$validOrganizationTaxId) {
-            $validOrganizationTaxId = $this->validateVatNumber($this->_address->organizationTaxId);
+            $validOrganizationTaxId = $this->validateTaxIdNumber($this->_address->organizationTaxId, $validators);
         }
 
         if ($validOrganizationTaxId) {
@@ -355,19 +358,37 @@ private function organizationTaxId(): bool
     /**
      * @param string $businessVatId
      * @return bool
+     * @deprecated in 4.8.0. Use `validateEuVatNumber()` instead, passing the validators you want to check the ID with.
      */
     protected function validateVatNumber(string $businessVatId): bool
+    {
+        $oldValidator = [new EuVatIdValidator()];
+        return $this->validateTaxIdNumber($businessVatId, $oldValidator);
+    }
+
+    /**
+     * @param string $organizationTaxId
+     * @param TaxIdValidatorInterface[] $validators
+     * @return bool
+     */
+    protected function validateTaxIdNumber(string $organizationTaxId, array $validators = []): bool
     {
         try {
-            return $this->_getVatValidator()->validate($businessVatId);
+            foreach ($validators as $validator) {
+                if ($validator->validate($organizationTaxId)) {
+                    return true;
+                }
+            }
         } catch (Exception $e) {
             Craft::error('Communication with VAT API failed: ' . $e->getMessage(), __METHOD__);
 
             return false;
         }
+
+        return false;
     }
 
-    private function _getVatValidator(): Validator
+    private function _getEuVatValidator(): Validator
     {
         if ($this->_vatValidator === null) {
             $this->_vatValidator = new Validator();

src/base/TaxIdValidatorInterface.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace craft\commerce\base;
+
+interface TaxIdValidatorInterface
+{
+    /**
+     * The display name of this tax ID type.
+     *
+     * @return string
+     */
+    public static function displayName(): string;
+
+    /**
+     * Tests if the ID looks generally correct. This would usually be something like a regex check.
+     *
+     * @return bool
+     * @param string $idNumber
+     */
+    public function validateFormat(string $idNumber): bool;
+
+    /**
+     * Tests if the ID exists as valid in the country's tax system. This would usually be an API call.
+     *
+     * @param string $idNumber
+     * @return bool
+     */
+    public function validateExistence(string $idNumber): bool;
+
+    /**
+     * This would usually just call validateFormat() and then validateExistence() and return the result.
+     *
+     * @param string $idNumber
+     * @return bool
+     */
+    public function validate(string $idNumber): bool;
+
+    /**
+     * Tests if the validator is available for use by tax rates.
+     * This would usually be a check against the existence or settings or API keys so that the validator can be used.
+     *
+     * @return bool
+     */
+    public static function isEnabled(): bool;
+}

src/behaviors/ValidateOrganizationTaxIdBehavior.php

@@ -89,9 +89,17 @@ public function validateOrganizationTaxId(): void
     private function _validateVatNumber(string $businessVatId): bool
     {
         try {
-            return $this->_getVatValidator()->validate($businessVatId);
+            $validators = Plugin::getInstance()->getTaxes()->getEngine()->getValidators();
+            $valid = false;
+            foreach ($validators as $validator) {
+                if ($validator->validateExistence($businessVatId)) {
+                    $valid = true;
+                    break;
+                }
+            }
+            return $valid;
         } catch (Exception $e) {
-            Craft::error('Communication with VAT API failed: ' . $e->getMessage(), __METHOD__);
+            Craft::error('Communication with Tax ID validators failed: ' . $e->getMessage(), __METHOD__);
 
             return false;
         }

src/controllers/TaxRatesController.php

@@ -156,6 +156,13 @@ public function actionEdit(int $id = null, TaxRate $taxRate = null): Response
         );
         $variables['newTaxCategoryJs'] = $view->clearJsBuffer(false);
 
+        $taxIdValidators = Plugin::getInstance()->getTaxes()->getTaxIdValidators();
+        foreach ($taxIdValidators as $validator) {
+            if ($validator::isEnabled()) {
+                $variables['taxIdValidators'][] = $validator;
+            }
+        }
+
         return $this->renderTemplate('commerce/tax/taxrates/_edit', $variables);
     }
 
@@ -181,12 +188,15 @@ public function actionSave(): void
         $taxRate->include = (bool)$this->request->getBodyParam('include');
         $taxRate->removeIncluded = (bool)$this->request->getBodyParam('removeIncluded');
         $taxRate->removeVatIncluded = (bool)$this->request->getBodyParam('removeVatIncluded');
-        $taxRate->isVat = (bool)$this->request->getBodyParam('isVat');
         $taxRate->taxable = $this->request->getBodyParam('taxable');
         $taxRate->taxCategoryId = (int)$this->request->getBodyParam('taxCategoryId') ?: null;
         $taxRate->taxZoneId = (int)$this->request->getBodyParam('taxZoneId') ?: null;
         $taxRate->rate = Localization::normalizePercentage($this->request->getBodyParam('rate'));
 
+        // data comes in as className => bool, we want just the class names that are true
+        $validators = collect($this->request->getBodyParam('taxIdValidators'))->filter(fn($enabled) => (bool)$enabled)->keys();
+        $taxRate->taxIdValidators = $validators->toArray();
+
         // Save it
         if (Plugin::getInstance()->getTaxRates()->saveTaxRate($taxRate)) {
             $this->setSuccessFlash(Craft::t('commerce', 'Tax rate saved.'));

src/events/TaxIdValidatorsEvent.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * @link https://craftcms.com/
+ * @copyright Copyright (c) Pixel & Tonic, Inc.
+ * @license https://craftcms.github.io/license/
+ */
+
+namespace craft\commerce\events;
+
+use craft\commerce\base\TaxIdValidatorInterface;
+use yii\base\Event;
+
+/**
+ * Class TaxIdValidatorsEvent
+ *
+ * @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
+ * @since 4.8.0
+ */
+class TaxIdValidatorsEvent extends Event
+{
+    /**
+     * @var TaxIdValidatorInterface[] Holds the registered tax ID validators.
+     */
+    public array $validators = [];
+}

src/migrations/Install.php

@@ -741,7 +741,8 @@ public function createTables(): void
             'code' => $this->string(),
             'rate' => $this->decimal(14, 10)->notNull(),
             'include' => $this->boolean()->notNull()->defaultValue(false),
-            'isVat' => $this->boolean()->notNull()->defaultValue(false), // TODO rename to isEuVat #COM-45
+            'isVat' => $this->boolean()->notNull()->defaultValue(false), // Remove in Commerce 6
+            'taxIdValidators' => $this->text(),
             'removeIncluded' => $this->boolean()->notNull()->defaultValue(false),
             'removeVatIncluded' => $this->boolean()->notNull()->defaultValue(false),
             'taxable' => $this->enum('taxable', ['purchasable', 'price', 'shipping', 'price_shipping', 'order_total_shipping', 'order_total_price'])->notNull(),

src/migrations/m250120_080035_move_to_tax_id_validators.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace craft\commerce\migrations;
+
+use craft\db\Migration;
+
+/**
+ * m250120_080035_move_to_tax_id_validators migration.
+ */
+class m250120_080035_move_to_tax_id_validators extends Migration
+{
+    /**
+     * @inheritdoc
+     */
+    public function safeUp(): bool
+    {
+        $this->addColumn('{{%commerce_taxrates}}', 'taxIdValidators', $this->text()->after('isVat'));
+
+        $taxRates = (new \craft\db\Query())
+            ->select(['id', 'isVat'])
+            ->from(['{{%commerce_taxrates}}'])
+            ->all();
+
+        foreach ($taxRates as $taxRate) {
+            $taxIdValidators = $taxRate['isVat'] ? ['craft\commerce\taxidvalidators\EuVatIdValidator'] : [];
+            $this->update('{{%commerce_taxrates}}', ['taxIdValidators' => json_encode($taxIdValidators)], ['id' => $taxRate['id']]);
+        }
+
+        return true;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function safeDown(): bool
+    {
+        echo "m250120_080035_move_to_tax_id_validators cannot be reverted.\n";
+        return false;
+    }
+}