[TASK] Upgrade to Symfony 6.4 (#683)

With this commit, Datahub is finally upgraded to Symfony 6.4. All
Symfony packages have been upgraded, along with the following key
changes:

UUID
----

The previously used UUID implementation provided by `ramsey/uuid` and 
its related packages is replaced by `symfony/uid` in order to get a 
tighter coupling to Symfony. Naturally, Symfony wants to store UUIDs as
a binary value, which is not suitable for our use-cases as we need to 
search for specific UUIDs in the database via MySQL CLI. Therefore, a 
custom UUID Doctrine type is implemented that forces to write UUIDs as 
plain string values.

Doctrine
--------

All `doctrine/*` packages are updated to their respective latest
version. The upgrade of `doctrine/dbal` to v4 brought a major change how
`\DateTimeInterface` values are treated. It is now **mandatory** to set
the correct instance type, either `\DateTime` or `\DateTimeImmutable`
and use it consistently.

OpenAPI
-------

All OpenAPI annotations are migrated to PHP-native attributes. Since
there is no functional Rector configuration available, this tedious
migration was done manually.

Message Handling
----------------

Since Symfony 6.2 it's possible to configure rate limiting to a message
queue. This comes in handy for our Pretix integration as they have a
rate limit we're exceeding on a regular basis. A new message queue
`async_pretix` is established that now receives all messages
implementing `VoucherCodeMessageInterface`, having a rate limiter
configured according to Pretix's documentation.

Author: andreaskienast

composer.json

@@ -46,13 +46,13 @@
         "psr/log": "^1.0 || ^2.0 || ^3.0"
     },
     "require-dev": {
-        "drupol/phpermutations": "^1.3",
+        "drupol/phpermutations": "^1.4",
         "friendsofphp/php-cs-fixer": "^3.16",
         "guzzlehttp/guzzle": "^7.0",
-        "http-interop/http-factory-guzzle": "^1.0",
-        "monolog/monolog": "^2.0",
-        "phpunit/phpunit": "^10.1",
-        "symfony/serializer": "^5.4"
+        "http-interop/http-factory-guzzle": "^1.2",
+        "monolog/monolog": "^3.0",
+        "phpunit/phpunit": "^11.5",
+        "symfony/serializer": "^5.4 || ^6.4"
     },
     "extra": {
         "branch-alias": {
@@ -69,6 +69,9 @@
             "T3G\\DatahubApiLibrary\\Tests\\": "tests/"
         }
     },
+    "config": {
+        "sort-packages": true
+    },
     "scripts": {
         "t3g:cgl": [
             "php-cs-fixer fix --config .php-cs-fixer.dist.php -v --dry-run"

src/Demand/OrganizationSearchDemand.php

@@ -46,22 +46,6 @@ class OrganizationSearchDemand implements \JsonSerializable
      */
     private ?array $countries = null;
 
-    /**
-     * @param string|null $term
-     *
-     * @deprecated Setting term via constructor is deprecated, use ->setTerm() instead
-     */
-    public function __construct(?string $term = null)
-    {
-        if (null !== $term) {
-            $this->setTerm($term);
-            trigger_error(
-                sprintf('Calling %s with $term is deprecated, call setTerm() instead.', __METHOD__),
-                E_USER_DEPRECATED
-            );
-        }
-    }
-
     /**
      * @return array<string, mixed>
      */
@@ -110,42 +94,6 @@ public function isWithOrders(): bool
         return $this->withOrders;
     }
 
-    /**
-     * @param bool $withSubscriptions
-     *
-     * @return $this
-     *
-     * @deprecated use setSubscriptionTypes()
-     */
-    public function setWithSubscriptions(bool $withSubscriptions = true): self
-    {
-        trigger_error(
-            sprintf('Calling %s is deprecated, call setSubscriptionTypes() instead.', __METHOD__),
-            E_USER_DEPRECATED
-        );
-
-        if ($withSubscriptions) {
-            $this->setSubscriptionTypes([SubscriptionType::MEMBERSHIP, SubscriptionType::PSL]);
-        }
-
-        return $this;
-    }
-
-    /**
-     * @return bool
-     *
-     * @deprecated use getSubscriptionTypes()
-     */
-    public function isWithSubscriptions(): bool
-    {
-        trigger_error(
-            sprintf('Calling %s is deprecated, call getSubscriptionTypes() instead.', __METHOD__),
-            E_USER_DEPRECATED
-        );
-
-        return null !== $this->getSubscriptionTypes();
-    }
-
     /**
      * @param array<int, SubscriptionType::*> $subscriptionTypes
      *

src/Dto/Admin/CreateCompanyDto.php

@@ -12,19 +12,23 @@
 
 use Symfony\Component\Validator\Constraints as Assert;
 use T3G\DatahubApiLibrary\Dto\AbstractDto;
+use T3G\DatahubApiLibrary\Enum\CompanyType;
 
 class CreateCompanyDto extends AbstractDto
 {
     /**
      * @Assert\NotBlank
      */
+    #[Assert\NotBlank]
     public string $title;
 
     /**
      * @Assert\NotBlank
      *
      * @Assert\Choice(callback={"T3G\DatahubApiLibrary\Enum\CompanyType", "getAvailableOptions"})
      */
+    #[Assert\NotBlank]
+    #[Assert\Choice(callback: [CompanyType::class, 'getAvailableOptions'])]
     public string $companyType;
     public ?string $owner = null;
 }

src/Dto/Admin/MergeCompanyDto.php

@@ -23,6 +23,8 @@ class MergeCompanyDto extends AbstractDto
      *
      * @Assert\Uuid
      */
+    #[Assert\NotBlank]
+    #[Assert\Uuid]
     public string $title = '';
 
     /**
@@ -33,6 +35,8 @@ class MergeCompanyDto extends AbstractDto
      *
      * @Assert\Uuid
      */
+    #[Assert\NotBlank]
+    #[Assert\Uuid]
     public string $slug = '';
 
     /**
@@ -43,6 +47,8 @@ class MergeCompanyDto extends AbstractDto
      *
      * @Assert\Uuid
      */
+    #[Assert\NotBlank]
+    #[Assert\Uuid]
     public string $companyType = '';
 
     /**
@@ -53,6 +59,8 @@ class MergeCompanyDto extends AbstractDto
      *
      * @Assert\Uuid
      */
+    #[Assert\NotBlank]
+    #[Assert\Uuid]
     public string $vatId = '';
 
     /**
@@ -63,6 +71,8 @@ class MergeCompanyDto extends AbstractDto
      *
      * @Assert\Uuid
      */
+    #[Assert\NotBlank]
+    #[Assert\Uuid]
     public string $domain = '';
 
     /**
@@ -72,5 +82,6 @@ class MergeCompanyDto extends AbstractDto
      *
      * @Assert\NotBlank
      */
+    #[Assert\NotBlank]
     public array $emails = [];
 }

src/Dto/Admin/TransferEntityDto.php

@@ -12,28 +12,34 @@
 
 use Symfony\Component\Validator\Constraints as Assert;
 use T3G\DatahubApiLibrary\Dto\AbstractDto;
+use T3G\DatahubApiLibrary\Enum\TransferableType;
 
 class TransferEntityDto extends AbstractDto
 {
     /**
      * @Assert\NotBlank
      */
+    #[Assert\NotBlank]
     public string $source = '';
 
     /**
      * @Assert\NotBlank
      */
+    #[Assert\NotBlank]
     public string $target = '';
 
     /**
      * @Assert\NotBlank
      *
      * @Assert\Choice(callback={"T3G\DatahubApiLibrary\Enum\TransferableType", "getAvailableOptions"})
      */
+    #[Assert\NotBlank]
+    #[Assert\Choice(callback: [TransferableType::class, 'getAvailableOptions'])]
     public string $type = '';
 
     /**
      * @Assert\NotBlank
      */
+    #[Assert\NotBlank]
     public string $entityDescriber = '';
 }

src/Dto/Admin/UpdateCompanyDto.php

@@ -12,19 +12,23 @@
 
 use Symfony\Component\Validator\Constraints as Assert;
 use T3G\DatahubApiLibrary\Dto\AbstractDto;
+use T3G\DatahubApiLibrary\Enum\CompanyType;
 
 class UpdateCompanyDto extends AbstractDto
 {
     /**
      * @Assert\NotBlank
      */
+    #[Assert\NotBlank]
     public string $title;
 
     /**
      * @Assert\NotBlank
      *
      * @Assert\Choice(callback={"T3G\DatahubApiLibrary\Enum\CompanyType", "getAvailableOptions"})
      */
+    #[Assert\NotBlank]
+    #[Assert\Choice(callback: [CompanyType::class, 'getAvailableOptions'])]
     public string $companyType;
     public ?string $vatId = null;
     public ?string $domain = null;

tests/Api/CompanyApiTest.php

@@ -119,8 +119,8 @@ public function testGetSearchCompanies(): void
         $handler = new MockHandler([
             require __DIR__ . '/../Fixtures/GetSearchCompanyResponse.php',
         ]);
-        $response = (new CompanyApi($this->getClient($handler)))
-            ->search(new OrganizationSearchDemand('Test Company'));
+        $searchDemand = (new OrganizationSearchDemand())->setTerm('Test Company');
+        $response = (new CompanyApi($this->getClient($handler)))->search($searchDemand);
         self::assertCount(2, $response);
     }
 

tests/Api/OrderApiTest.php

@@ -11,6 +11,7 @@
 namespace T3G\DatahubApiLibrary\Tests\Api;
 
 use GuzzleHttp\Handler\MockHandler;
+use PHPUnit\Framework\Attributes\DataProvider;
 use Psr\Http\Client\ClientExceptionInterface;
 use T3G\DatahubApiLibrary\Api\OrderApi;
 use T3G\DatahubApiLibrary\Demand\OrderSearchDemand;
@@ -43,9 +44,8 @@ public function testGetOrder(): void
      * @throws \JsonException
      * @throws ClientExceptionInterface
      * @throws DatahubResponseException
-     *
-     * @dataProvider searchOrdersDataProvider
      */
+    #[DataProvider('searchOrdersDataProvider')]
     public function testSearchOrders(string $fixtureFile, ?int $limit): void
     {
         $handler = new MockHandler([

tests/Demand/OrganizationSearchDemandTest.php

@@ -10,6 +10,7 @@
 
 namespace T3G\DatahubApiLibrary\Tests\Demand;
 
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use T3G\DatahubApiLibrary\Demand\OrganizationSearchDemand;
 use T3G\DatahubApiLibrary\Enum\SubscriptionType;
@@ -53,15 +54,12 @@ public function testNullValuesAreIgnoredFromSerialization(): void
     public function testWithSubscriptionsSetsValueAsExpected(): void
     {
         $demand = new OrganizationSearchDemand();
-        $demand->setWithSubscriptions();
+        $demand->setSubscriptionTypes([SubscriptionType::MEMBERSHIP, SubscriptionType::PSL]);
 
-        self::assertTrue($demand->isWithSubscriptions());
         self::assertSame([SubscriptionType::MEMBERSHIP, SubscriptionType::PSL], $demand->getSubscriptionTypes());
     }
 
-    /**
-     * @dataProvider setMembersRangeAsExpectedDataProvider
-     */
+    #[DataProvider('setMembersRangeAsExpectedDataProvider')]
     public function testSetMembersRangeAsExpected(array $input, ?array $expectation): void
     {
         $demand = new OrganizationSearchDemand();
@@ -79,9 +77,7 @@ public static function setMembersRangeAsExpectedDataProvider(): array
         ];
     }
 
-    /**
-     * @dataProvider setMembersRangeThrowsExceptionDataProvider
-     */
+    #[DataProvider('setMembersRangeThrowsExceptionDataProvider')]
     public function testSetMembersRangeThrowsException(array $input, string $expectedExceptionClass, int $expectedExceptionCode): void
     {
         $this->expectException($expectedExceptionClass);

tests/Demand/SubscriptionFilterQueryTest.php

@@ -10,6 +10,7 @@
 
 namespace T3G\DatahubApiLibrary\Tests\Demand;
 
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use T3G\DatahubApiLibrary\Demand\SubscriptionFilterQuery;
 
@@ -38,9 +39,7 @@ public static function getQueryAsStringDataProvider(): array
         ];
     }
 
-    /**
-     * @dataProvider getQueryAsStringDataProvider
-     */
+    #[DataProvider('getQueryAsStringDataProvider')]
     public function testGetQueryAsString(array $inputValues, string $expectedOutput): void
     {
         $subscriptionFilterQuery = new SubscriptionFilterQuery();