Optimize matching zones to a given address

src/Sylius/Bundle/AddressingBundle/DependencyInjection/Configuration.php

@@ -19,6 +19,7 @@
 use Sylius\Bundle\AddressingBundle\Form\Type\ProvinceType;
 use Sylius\Bundle\AddressingBundle\Form\Type\ZoneMemberType;
 use Sylius\Bundle\AddressingBundle\Form\Type\ZoneType;
+use Sylius\Bundle\AddressingBundle\Repository\ZoneRepository;
 use Sylius\Bundle\ResourceBundle\Controller\ResourceController;
 use Sylius\Bundle\ResourceBundle\SyliusResourceBundle;
 use Sylius\Component\Addressing\Model\Address;
@@ -142,7 +143,7 @@ private function addResourcesSection(ArrayNodeDefinition $node): void
                                         ->scalarNode('model')->defaultValue(Zone::class)->cannotBeEmpty()->end()
                                         ->scalarNode('interface')->defaultValue(ZoneInterface::class)->cannotBeEmpty()->end()
                                         ->scalarNode('controller')->defaultValue(ResourceController::class)->cannotBeEmpty()->end()
-                                        ->scalarNode('repository')->cannotBeEmpty()->end()
+                                        ->scalarNode('repository')->defaultValue(ZoneRepository::class)->cannotBeEmpty()->end()
                                         ->scalarNode('factory')->defaultValue(Factory::class)->end()
                                         ->scalarNode('form')->defaultValue(ZoneType::class)->cannotBeEmpty()->end()
                                     ->end()

src/Sylius/Bundle/AddressingBundle/Repository/ZoneRepository.php

@@ -0,0 +1,121 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. o o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\AddressingBundle\Repository;
+
+use Doctrine\ORM\QueryBuilder;
+use Sylius\Bundle\ResourceBundle\Doctrine\ORM\EntityRepository;
+use Sylius\Component\Addressing\Model\AddressInterface;
+use Sylius\Component\Addressing\Model\Scope;
+use Sylius\Component\Addressing\Model\ZoneInterface;
+use Sylius\Component\Addressing\Repository\ZoneRepositoryInterface;
+
+/**
+ * @implements ZoneRepositoryInterface<ZoneInterface>
+ */
+class ZoneRepository extends EntityRepository implements ZoneRepositoryInterface
+{
+    public function findOneByAddressAndType(AddressInterface $address, string $type, ?string $scope = null): ?ZoneInterface
+    {
+        $queryBuilder = $this->createByAddressQueryBuilder($address, $scope);
+
+        $queryBuilder
+            ->andWhere($queryBuilder->expr()->eq('o.type', ':type'))
+            ->setParameter('type', $type)
+            ->setMaxResults(1)
+        ;
+
+        return $queryBuilder->getQuery()->getOneOrNullResult();
+    }
+
+    /** @return ZoneInterface[] */
+    public function findByAddress(AddressInterface $address, ?string $scope = null): array
+    {
+        return $this->createByAddressQueryBuilder($address, $scope)->getQuery()->getResult();
+    }
+
+    public function createByAddressQueryBuilder(AddressInterface $address, ?string $scope = null): QueryBuilder
+    {
+        $queryBuilder = $this->createQueryBuilder('o')
+            ->select('o', 'members')
+            ->leftJoin('o.members', 'members')
+        ;
+
+        if (null !== $scope) {
+            $queryBuilder
+                ->andWhere($queryBuilder->expr()->in('o.scope', ':scopes'))
+                ->setParameter('scopes', array_unique([$scope, Scope::ALL]))
+            ;
+        }
+
+        $orConditions = [];
+
+        if ($address->getCountryCode() !== null) {
+            $orConditions[] = $queryBuilder->expr()->andX(
+                $queryBuilder->expr()->eq('o.type', ':country'),
+                $queryBuilder->expr()->eq('members.code', ':countryCode'),
+            );
+
+            $queryBuilder->setParameter('country', ZoneInterface::TYPE_COUNTRY);
+            $queryBuilder->setParameter('countryCode', $address->getCountryCode());
+        }
+
+        if ($address->getProvinceCode() !== null) {
+            $orConditions[] = $queryBuilder->expr()->andX(
+                $queryBuilder->expr()->eq('o.type', ':province'),
+                $queryBuilder->expr()->eq('members.code', ':provinceCode'),
+            );
+
+            $queryBuilder->setParameter('province', ZoneInterface::TYPE_PROVINCE);
+            $queryBuilder->setParameter('provinceCode', $address->getProvinceCode());
+        }
+
+        $queryBuilder->andWhere($queryBuilder->expr()->orX(...$orConditions));
+
+        return $queryBuilder;
+    }
+
+    /**
+     * @param array<ZoneInterface> $members
+     *
+     * @return array<ZoneInterface>
+     */
+    public function findByMembers(array $members, ?string $scope = null): array
+    {
+        $zonesCodes = array_map(
+            fn (ZoneInterface $zone): string => $zone->getCode(),
+            $members,
+        );
+
+        $queryBuilder = $this->createQueryBuilder('o')
+            ->select('o', 'members')
+            ->leftJoin('o.members', 'members')
+        ;
+
+        if (null !== $scope) {
+            $queryBuilder
+                ->andWhere($queryBuilder->expr()->in('o.scope', ':scopes'))
+                ->setParameter('scopes', array_unique([$scope, Scope::ALL]))
+            ;
+        }
+
+        $queryBuilder
+            ->andWhere('o.type = :type')
+            ->andWhere($queryBuilder->expr()->in('members.code', ':zones'))
+            ->setParameter('type', ZoneInterface::TYPE_ZONE)
+            ->setParameter('zones', $zonesCodes)
+        ;
+
+        return $queryBuilder->getQuery()->getResult();
+    }
+}

src/Sylius/Bundle/AddressingBundle/Tests/Matcher/ZoneMatcherTest.php

@@ -0,0 +1,85 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\AddressingBundle\Tests\Matcher;
+
+use Doctrine\Common\DataFixtures\Purger\ORMPurger;
+use Doctrine\ORM\EntityManagerInterface;
+use Fidry\AliceDataFixtures\LoaderInterface;
+use Fidry\AliceDataFixtures\Persistence\PurgeMode;
+use Sylius\Component\Addressing\Model\Address;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+
+final class ZoneMatcherTest extends KernelTestCase
+{
+    protected function setUp(): void
+    {
+        $this->loadFixtures();
+    }
+
+    /** @test */
+    public function it_matches_all_zones_with_their_parents(): void
+    {
+        $address = new Address();
+        $address->setCountryCode('PL');
+        $address->setProvinceCode('MA');
+
+        $zoneMatcher = self::getContainer()->get('sylius.zone_matcher');
+        $matchedZones = [];
+
+        foreach ($zoneMatcher->matchAll($address) as $zone) {
+            $matchedZones[$zone->getCode()] = $zone;
+        }
+
+        $this->assertCount(4, $matchedZones);
+        $this->assertArrayHasKey('EU', $matchedZones);
+        $this->assertArrayHasKey('VISEGRAD_GROUP', $matchedZones);
+        $this->assertArrayHasKey('PL', $matchedZones);
+        $this->assertArrayHasKey('NATO', $matchedZones);
+    }
+
+    /** @test */
+    public function it_matches_all_zones_with_their_parents_with_restricting_by_scope(): void
+    {
+        $address = new Address();
+        $address->setCountryCode('PL');
+        $address->setProvinceCode('MA');
+
+        $zoneMatcher = self::getContainer()->get('sylius.zone_matcher');
+        $matchedZones = [];
+
+        foreach ($zoneMatcher->matchAll($address, 'shipping') as $zone) {
+            $matchedZones[$zone->getCode()] = $zone;
+        }
+
+        $this->assertCount(3, $matchedZones);
+        $this->assertArrayHasKey('NATO', $matchedZones);
+        $this->assertArrayHasKey('PL', $matchedZones);
+        $this->assertArrayHasKey('VISEGRAD_GROUP', $matchedZones);
+    }
+
+    private function loadFixtures(): void
+    {
+        /** @var LoaderInterface $fixtureLoader */
+        $fixtureLoader = self::getContainer()->get('fidry_alice_data_fixtures.loader.doctrine');
+
+        /** @var EntityManagerInterface $manager */
+        $manager = self::getContainer()->get('doctrine.orm.default_entity_manager');
+
+        (new ORMPurger($manager))->purge();
+
+        $fixtureLoader->load([
+            __DIR__ . '/ZoneMatcherTest/fixtures.yaml',
+        ], [], [], PurgeMode::createDeleteMode());
+    }
+}

src/Sylius/Bundle/AddressingBundle/Tests/Matcher/ZoneMatcherTest/fixtures.yaml

@@ -0,0 +1,42 @@
+Sylius\Component\Addressing\Model\Country:
+    country_PL:
+        code: PL
+
+Sylius\Component\Addressing\Model\Province:
+    province_{MA, LD, MZ, DS}:
+        code: <current()>
+        name: <current()>
+        abbreviation: <current()>
+        country: "@country_PL"
+
+Sylius\Component\Addressing\Model\ZoneMember:
+    member_province_{MA, LD, MZ, DS}:
+        code: <current()>
+    member_{poland_visegrad_group, poland_nato}:
+        code: PL
+    member_visegrad_group:
+        code: "VISEGRAD_GROUP"
+
+Sylius\Component\Addressing\Model\Zone:
+    zone_poland:
+        code: PL
+        name: Poland
+        type: province
+        members: ["@member_province_MA", "@member_province_LD", "@member_province_MZ", "@member_province_DS"]
+    zone_visegrad_group:
+        code: VISEGRAD_GROUP
+        name: Visegrad Group
+        type: zone
+        members: ["@member_poland_visegrad_group"]
+    zone_eu:
+        code: EU
+        name: European Union
+        type: zone
+        members: ["@member_visegrad_group"]
+        scope: 'tax'
+    zone_nato:
+        code: NATO
+        name: NATO
+        type: zone
+        members: ["@member_poland_nato"]
+        scope: 'shipping'