Migrate to PHP 8.1 and PHPUnit 10

cybercog · Aug 26, 2023 · db64453 · db64453
1 parent 9d0ab85
commit db64453
Show file tree

Hide file tree

Showing 11 changed files with 161 additions and 204 deletions.
diff --git a/.docker/php/Dockerfile b/.docker/php/Dockerfile
@@ -1,7 +1,7 @@
 # ----------------------
 # The FPM base container
 # ----------------------
-FROM php:7.4-fpm-alpine AS dev
+FROM php:8.1-fpm-alpine AS dev
 
 # Install build dependencies
 RUN apk add --no-cache --virtual .build-deps \

diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 /.docker-volume-postgres
 /.idea
+/.phpunit.cache
 /vendor
 .DS_STORE
 .phpunit.result.cache

diff --git a/composer.json b/composer.json
@@ -30,11 +30,11 @@
         "docs": "https://github.com/cybercog/php-db-locker"
     },
     "require": {
-        "php": "^7.4|^8.0",
+        "php": "^8.1",
         "ext-pdo": "*"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5"
+        "phpunit/phpunit": "^10.0"
     },
     "autoload": {
         "psr-4": {

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,15 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         colors="true"
-         stopOnFailure="false"
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
+        bootstrap="vendor/autoload.php"
+        colors="true"
+        stopOnFailure="false"
+        cacheDirectory=".phpunit.cache"
 >
-    <coverage processUncoveredFiles="true">
-        <include>
-            <directory suffix=".php">./src</directory>
-        </include>
-    </coverage>
+    <coverage/>
     <testsuites>
         <testsuite name="Unit">
             <directory suffix="Test.php">./test</directory>
@@ -23,4 +21,9 @@
         <env name="DB_POSTGRES_PASSWORD" value="secret"/>
         <env name="DB_POSTGRES_DATABASE" value="php_db_locker"/>
     </php>
+    <source>
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </source>
 </phpunit>
diff --git a/src/LockId/LockId.php b/src/LockId/LockId.php
@@ -17,17 +17,10 @@
 
 final class LockId
 {
-    private string $key;
-
-    private string $value;
-
     public function __construct(
-        string $key,
-        string $value = ''
+        public readonly string $key,
+        public readonly string $value = '',
     ) {
-        $this->key = $key;
-        $this->value = $value;
-
         if ($key === '') {
             throw new InvalidArgumentException('LockId key is empty');
         }

diff --git a/src/LockId/PostgresLockId.php b/src/LockId/PostgresLockId.php
@@ -17,46 +17,36 @@
 
 final class PostgresLockId
 {
-    private const MIN_DB_INT_VALUE = 0;
-    private const MAX_DB_INT_VALUE = 9223372036854775807;
-
-    private int $id;
-
-    private string $humanReadableValue;
+    private const DB_INT_VALUE_MIN = 0;
+    private const DB_INT_VALUE_MAX = 9223372036854775807;
+    private const DB_INT32_VALUE_MAX = 2147483647;
 
     public function __construct(
-        int $id,
-        string $humanReadableValue = ''
+        public readonly int $id,
+        public readonly string $humanReadableValue = '',
     ) {
-        $this->id = $id;
-        $this->humanReadableValue = $humanReadableValue;
-
-        if ($id < self::MIN_DB_INT_VALUE) {
+        if ($id < self::DB_INT_VALUE_MIN) {
             throw new InvalidArgumentException('Out of bound exception (id is too small)');
         }
-        if ($id > self::MAX_DB_INT_VALUE) {
+        if ($id > self::DB_INT_VALUE_MAX) {
             throw new InvalidArgumentException('Out of bound exception (id is too big)');
         }
     }
 
-    public function id(): int
-    {
-        return $this->id;
-    }
-
-    public function humanReadableValue(): string
-    {
-        return $this->humanReadableValue;
-    }
-
     public static function fromLockId(
         LockId $lockId
     ): self {
         $humanReadableValue = (string)$lockId;
 
         return new self(
-            crc32($humanReadableValue),
+            self::generateIdFromString($humanReadableValue),
             $humanReadableValue
         );
     }
+
+    private static function generateIdFromString(
+        string $string,
+    ): int {
+        return crc32($string);
+    }
 }
diff --git a/src/Locker/PostgresAdvisoryLocker.php b/src/Locker/PostgresAdvisoryLocker.php
@@ -21,7 +21,7 @@ final class PostgresAdvisoryLocker
 {
     public function acquireLock(
         PDO $dbConnection,
-        PostgresLockId $postgresLockId
+        PostgresLockId $postgresLockId,
     ): bool {
         $statement = $dbConnection->prepare(
             <<<SQL
@@ -30,7 +30,7 @@ public function acquireLock(
         );
         $statement->execute(
             [
-                'lock_id' => $postgresLockId->id(),
+                'lock_id' => $postgresLockId->id,
             ]
         );
 
@@ -39,10 +39,10 @@ public function acquireLock(
 
     public function acquireLockWithinTransaction(
         PDO $dbConnection,
-        PostgresLockId $postgresLockId
+        PostgresLockId $postgresLockId,
     ): bool {
         if ($dbConnection->inTransaction() === false) {
-            $lockId = $postgresLockId->humanReadableValue();
+            $lockId = $postgresLockId->humanReadableValue;
 
             throw new LogicException(
                 "Transaction-level advisory lock `$lockId` cannot be acquired outside of transaction"
@@ -56,7 +56,7 @@ public function acquireLockWithinTransaction(
         );
         $statement->execute(
             [
-                'lock_id' => $postgresLockId->id(),
+                'lock_id' => $postgresLockId->id,
             ]
         );
 
@@ -65,7 +65,7 @@ public function acquireLockWithinTransaction(
 
     public function releaseLock(
         PDO $dbConnection,
-        PostgresLockId $postgresLockId
+        PostgresLockId $postgresLockId,
     ): bool {
         $statement = $dbConnection->prepare(
             <<<SQL
@@ -74,15 +74,15 @@ public function releaseLock(
         );
         $statement->execute(
             [
-                'lock_id' => $postgresLockId->id(),
+                'lock_id' => $postgresLockId->id,
             ]
         );
 
         return $statement->fetchColumn(0);
     }
 
     public function releaseAllLocks(
-        PDO $dbConnection
+        PDO $dbConnection,
     ): void {
         $statement = $dbConnection->prepare(
             <<<SQL

diff --git a/test/Integration/AbstractIntegrationTestCase.php b/test/Integration/AbstractIntegrationTestCase.php
@@ -31,7 +31,7 @@ protected function tearDown(): void
         parent::tearDown();
     }
 
-    protected function createPostgresPdoConnection(): PDO
+    protected function initPostgresPdoConnection(): PDO
     {
         $dsn = implode(';', [
             'dbname=' . getenv('DB_POSTGRES_DATABASE'),
@@ -52,7 +52,7 @@ protected function assertPgAdvisoryLockExistsInConnection(
     ): void {
         $row = $this->findPostgresAdvisoryLockInConnection($dbConnection, $postgresLockId);
 
-        $lockIdString = $postgresLockId->humanReadableValue();
+        $lockIdString = $postgresLockId->humanReadableValue;
 
         $this->assertTrue(
             $row !== null,
@@ -66,7 +66,7 @@ protected function assertPgAdvisoryLockMissingInConnection(
     ): void {
         $row = $this->findPostgresAdvisoryLockInConnection($dbConnection, $postgresLockId);
 
-        $lockIdString = $postgresLockId->humanReadableValue();
+        $lockIdString = $postgresLockId->humanReadableValue;
 
         $this->assertTrue(
             $row === null,
@@ -91,7 +91,7 @@ private function findPostgresAdvisoryLockInConnection(
         PDO $dbConnection,
         PostgresLockId $postgresLockId
     ): ?object {
-        $id = $postgresLockId->id();
+        $id = $postgresLockId->id;
 
         $lockObjectId = $id % self::POSTGRES_BLOCK_SIZE;
         $lockCatalogId = ($id - $lockObjectId) / self::POSTGRES_BLOCK_SIZE;
@@ -127,7 +127,7 @@ private function findPostgresAdvisoryLockInConnection(
 
     private function findAllPostgresAdvisoryLocks(): array
     {
-        $dbConnection = $this->createPostgresPdoConnection();
+        $dbConnection = $this->initPostgresPdoConnection();
 
         $statement = $dbConnection->prepare(
             <<<SQL
@@ -148,7 +148,7 @@ private function findAllPostgresAdvisoryLocks(): array
 
     private function closeAllPostgresPdoConnections(): void
     {
-        $this->createPostgresPdoConnection()->query(
+        $this->initPostgresPdoConnection()->query(
             <<<SQL
             SELECT pg_terminate_backend(pid) 
             FROM pg_stat_activity