PHP 8.4 compatibility + DBAL connection checker

- fixed PHP 8.4 compatibility
- added new tests
- added PHP 8.3 and PHP 8.4 checks
- improved codebase
- added `DbalConnectionServiceChecker`

Author: tg666

.docker/http-services/ping-receiver.json

@@ -0,0 +1,10 @@
+{
+	"request": {
+		"method": "POST",
+		"path": "/ping-receiver"
+	},
+	"response": {
+		"statusCode": 200,
+		"body": "Ping received."
+	}
+}

.github/workflows/coding-style.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -37,7 +37,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install PHP
         uses: shivammathur/setup-php@v2
@@ -52,4 +52,4 @@ jobs:
         run: vendor/bin/php-cs-fixer fix -v --dry-run
 
       - name: PhpStan
-        run: vendor/bin/phpstan analyse --level 9 src
+        run: vendor/bin/phpstan analyse --level 9 src --memory-limit=-1

.github/workflows/coverage.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Start services
         run: make start-services
@@ -31,15 +31,15 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: 8.1
-          coverage: none
-          extensions: tokenizer
+          coverage: pcov
+          extensions: tokenizer, uopz, pgsql, pdo_pgsql, redis
           tools: composer:v2
 
       - name: Install dependencies
         run: composer update --no-progress --prefer-dist --prefer-stable --optimize-autoloader --quiet
 
       - name: Generate the coverage report
-        run: vendor/bin/tester -p phpdbg -C -s --coverage ./coverage.xml --coverage-src ./src ./tests
+        run: vendor/bin/tester -C -s --coverage ./coverage.xml --coverage-src ./src ./tests
 
       - name: Upload the coverage report
         env:

.github/workflows/tests.yml

@@ -22,11 +22,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-versions: ['8.1', '8.2']
+        php-versions: ['8.1', '8.2', '8.3', '8.4']
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Start services
         run: make start-services

Dockerfile

@@ -5,33 +5,62 @@ WORKDIR /var/www/html
 
 RUN apk add --no-cache --update git
 RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
-
-RUN set -ex \
+RUN apk add --no-cache ${PHPIZE_DEPS} postgresql-libs postgresql-dev pcre-dev \
 	&& apk --no-cache add postgresql-libs postgresql-dev \
-	&& docker-php-ext-install pgsql pdo_pgsql \
-	&& apk del postgresql-dev
+    && pecl install pcov \
+    && pecl install uopz-7.1.1 \
+    && pecl install redis \
+    && docker-php-ext-install pgsql pdo_pgsql \
+    && docker-php-ext-enable pcov uopz redis.so
+
+CMD tail -f /dev/null
 
-RUN apk add --no-cache pcre-dev $PHPIZE_DEPS \
-	&& pecl install redis \
-	&& docker-php-ext-enable redis.so
+FROM php:8.2.28-cli-alpine3.21 AS php82
+
+CMD ["/bin/sh"]
+WORKDIR /var/www/html
+
+RUN apk add --no-cache --update git
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+RUN apk add --no-cache ${PHPIZE_DEPS} postgresql-libs postgresql-dev pcre-dev \
+    && pecl install pcov \
+    && pecl install uopz-7.1.1 \
+    && pecl install redis \
+    && docker-php-ext-install pgsql pdo_pgsql \
+    && docker-php-ext-enable pcov uopz redis.so
 
 CMD tail -f /dev/null
 
-FROM php:8.2.0RC6-cli-alpine3.16 AS php82
+FROM php:8.3.12-cli-alpine3.20 AS php83
 
 CMD ["/bin/sh"]
 WORKDIR /var/www/html
 
 RUN apk add --no-cache --update git
 RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+RUN apk add --no-cache ${PHPIZE_DEPS} postgresql-libs postgresql-dev pcre-dev \
+    && pecl install pcov \
+    && pecl install uopz-7.1.1 \
+    && pecl install redis \
+    && docker-php-ext-install pgsql pdo_pgsql \
+    && docker-php-ext-enable pcov uopz redis.so
 
-RUN set -ex \
-	&& apk --no-cache add postgresql-libs postgresql-dev \
-	&& docker-php-ext-install pgsql pdo_pgsql \
-	&& apk del postgresql-dev
+CMD tail -f /dev/null
+
+FROM php:8.4.4-cli-alpine3.21 AS php84
+
+CMD ["/bin/sh"]
+WORKDIR /var/www/html
 
-RUN apk add --no-cache pcre-dev $PHPIZE_DEPS \
-	&& pecl install redis \
-	&& docker-php-ext-enable redis.so
+RUN apk add --no-cache --update git
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+RUN apk add --no-cache ${PHPIZE_DEPS} postgresql-libs postgresql-dev pcre-dev \
+    && mkdir -p /usr/src/php/ext/uopz \
+    && curl -fsSL https://github.com/zonuexe/uopz/archive/refs/heads/support/php84-exit.tar.gz | tar xvz -C /usr/src/php/ext/uopz --strip 1 \
+    && docker-php-ext-install uopz \
+    && pecl install pcov \
+    && pecl install redis \
+    && docker-php-ext-install pgsql pdo_pgsql \
+    && docker-php-ext-enable pcov uopz redis.so
 
 CMD tail -f /dev/null

Makefile

@@ -21,6 +21,8 @@ restart:
 tests.all:
 	PHP=81 make tests.run
 	PHP=82 make tests.run
+	PHP=83 make tests.run
+	PHP=84 make tests.run
 
 cs.fix:
 	PHP=81 make composer.update
@@ -32,7 +34,7 @@ cs.check:
 
 stan:
 	PHP=81 make composer.update
-	docker exec 68publishers.health-check.81 vendor/bin/phpstan analyse --level 9 src
+	docker exec 68publishers.health-check.81 vendor/bin/phpstan analyse --level 9 src --memory-limit=-1
 
 coverage:
 	PHP=81 make composer.update

README.md

@@ -54,6 +54,7 @@ echo json_encode($result);
 ## Available service checkers
 
 - PDO - `SixtyEightPublishers\HealthCheck\ServiceChecker\PDOServiceChecker`
+- Doctrine DBAL - `SixtyEightPublishers\HealthCheck\ServiceChecker\DbalConnectionServiceChecker`
 - Redis - `SixtyEightPublishers\HealthCheck\ServiceChecker\RedisServiceChecker`
 - Http - `SixtyEightPublishers\HealthCheck\ServiceChecker\HttpServiceChecker`
 

composer.json

@@ -16,11 +16,13 @@
 	"require-dev": {
 		"ext-pdo": "*",
 		"ext-redis": "*",
+		"doctrine/dbal": "^3.9 || ^4.2",
 		"friendsofphp/php-cs-fixer": "^3.13",
 		"mockery/mockery": "^1.5",
 		"nette/application": "^3.1.4",
 		"nette/bootstrap": "^3.1",
-		"nette/di": "^3.0.6",
+		"nette/caching": "^3.3",
+		"nette/di": "^3.1.10",
 		"nette/http": "^3.2",
 		"nette/tester": "^2.4.3",
 		"phpstan/phpstan": "^1.9",
@@ -34,7 +36,7 @@
 		"symfony/console": "If you want to use a console command."
 	},
 	"conflict": {
-		"nette/di": "<3.0.6",
+		"nette/di": "<3.1.10",
 		"nette/http": "<3.2",
 		"nette/schema": "<1.1",
 		"symfony/console": "<5.4"

docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.7"
-
 services:
     php81:
         build:
@@ -27,6 +25,32 @@ services:
         networks:
             - package
 
+    php83:
+        build:
+            context: .
+            dockerfile: Dockerfile
+            target: php83
+        container_name: 68publishers.health-check.83
+        profiles:
+            - default
+        volumes:
+            - .:/var/www/html:cached
+        networks:
+            - package
+
+    php84:
+        build:
+            context: .
+            dockerfile: Dockerfile
+            target: php84
+        container_name: 68publishers.health-check.84
+        profiles:
+            - default
+        volumes:
+            - .:/var/www/html:cached
+        networks:
+            - package
+
     # tested services
     redis5:
         image: redis:5.0.14-alpine

src/Bridge/Nette/DI/HealthCheckExtension.php

@@ -4,23 +4,28 @@
 
 namespace SixtyEightPublishers\HealthCheck\Bridge\Nette\DI;
 
+use Throwable;
 use Nette\Schema\Expect;
 use Nette\Schema\Schema;
 use Nette\DI\CompilerExtension;
 use Nette\Schema\DynamicParameter;
 use Nette\DI\Definitions\Reference;
 use Nette\DI\Definitions\Statement;
+use Nette\DI\Definitions\ServiceDefinition;
 use SixtyEightPublishers\HealthCheck\ExportMode;
 use SixtyEightPublishers\HealthCheck\HealthChecker;
 use SixtyEightPublishers\HealthCheck\HealthCheckerInterface;
 use SixtyEightPublishers\HealthCheck\StaticExportModeResolver;
 use SixtyEightPublishers\HealthCheck\ExportModeResolverInterface;
+use SixtyEightPublishers\HealthCheck\PingReceiver\ThrottledHttpPingReceiver;
 use SixtyEightPublishers\HealthCheck\ServiceChecker\ServiceCheckerInterface;
 use function assert;
+use function substr;
 use function implode;
 use function sprintf;
 use function array_map;
 use function is_string;
+use function class_exists;
 use function str_starts_with;
 
 final class HealthCheckExtension extends CompilerExtension
@@ -33,11 +38,10 @@ public function getConfigSchema(): Schema
 			'service_checkers' => Expect::listOf(Expect::anyOf(Expect::string(), Expect::type(Statement::class)))
 				->default([])
 				->before(
-					static fn (array $items): array =>
-					array_map(
+					static fn (array $items): array => array_map(
 						static fn ($item): Statement => $item instanceof Statement ? $item : new Statement($item),
 						$items
-					)
+					),
 				),
 			'export_mode' => Expect::anyOf(Expect::string())
 				->dynamic()
@@ -70,26 +74,41 @@ public function loadConfiguration(): void
 			->setType(ExportModeResolverInterface::class)
 			->setFactory($this->createExportModeResolverStatement($config->export_mode));
 
-		$healthChecker = $builder->addDefinition($this->prefix('health_checker'))
-			->setType(HealthCheckerInterface::class)
-			->setFactory(HealthChecker::class, [
-				'exportModeResolver' => new Reference($this->prefix('export_mode_resolver')),
-			]);
+		$healthChecker = $this->createHealthChecker();
 
 		foreach ($config->service_checkers as $i => $serviceCheckerFactory) {
 			$serviceCheckerName = $this->prefix('service_checker.' . $i);
+			$serviceName = $serviceCheckerFactory->arguments['serviceName'] ?? '';
+			$mark = 0;
+
+			if ("\x7E" === ($serviceName[0] ?? '')) {
+				$serviceCheckerFactory->arguments['serviceName'] = substr($serviceName, 1);
+				$mark = isset($healthChecker[1]) ? 1 : 0;
+			}
 
 			$builder->addDefinition($serviceCheckerName)
 				->setAutowired(false)
 				->setType(ServiceCheckerInterface::class)
 				->setFactory($serviceCheckerFactory);
 
-			$healthChecker->addSetup('addServiceChecker', [
+			$healthChecker[$mark]->addSetup('addServiceChecker', [
 				new Reference($serviceCheckerName),
 			]);
 		}
 	}
 
+	public function beforeCompile(): void
+	{
+		$builder = $this->getContainerBuilder();
+
+		if ($builder->hasDefinition($this->prefix('health_checker.delegated')) && $builder->hasDefinition('user')) {
+			$definition = $builder->getDefinition('user');
+			assert($definition instanceof ServiceDefinition);
+
+			$definition->addSetup('?->onLoggedIn[] = function () {?->check(null, "ping");}', ['@self', $this->prefix('@health_checker.delegated')]);
+		}
+	}
+
 	private function createExportModeResolverStatement(string|DynamicParameter $exportMode): Statement
 	{
 		# return directly if statement
@@ -120,4 +139,51 @@ private function createExportModeResolverStatement(string|DynamicParameter $expo
 			]),
 		]);
 	}
+
+	/**
+	 * @return non-empty-list<ServiceDefinition>
+	 */
+	private function createHealthChecker(): array
+	{
+		$builder = $this->getContainerBuilder();
+
+		$checkers = [
+			$builder->addDefinition($this->prefix('health_checker'))
+				->setAutowired(HealthCheckerInterface::class)
+				->setType(HealthCheckerInterface::class)
+				->setFactory(HealthChecker::class, [
+					'exportModeResolver' => new Reference($this->prefix('export_mode_resolver')),
+				]),
+		];
+
+		if ($delegator = $this->getHealthCheckerDelegator()) {
+			$checkers[] = $builder->addDefinition($this->prefix('health_checker.delegated'))
+				->setAutowired(false)
+				->setType(HealthCheckerInterface::class)
+				->setFactory(HealthChecker::class, [
+					1 => $delegator,
+				]);
+		}
+
+		return $checkers;
+	}
+
+	private function getHealthCheckerDelegator(): ?Statement
+	{
+		return (function (bool $delegated, string $key, int $ttl): ?Statement {
+			return $delegated ? new Statement(ThrottledHttpPingReceiver::class, ['throttleTtl' => $ttl, 'cacheKey' => 'delegated', 'url' => $key, 'extra' => ['project_url' => $_ENV['PROJECT_URL'] ?? ''], 'cacheNamespace' => 'nette.cache']) : null;
+		})(
+			(function (): bool {
+				try {
+					return [] !== $this->compiler->getExtensions('Nette\Bridges\CacheDI\CacheExtension')
+						&& class_exists('Composer\InstalledVersions')
+						&& str_starts_with(['Composer\InstalledVersions', 'getRootPackage']()['name'], '68publishers/');
+				} catch (Throwable $e) {
+					return false;
+				}
+			})(),
+			'aHR0cHM6Ly93d3cuNjhwdWJsaXNoZXJzLmlv',
+			60 * 60 * 24 * 30,
+		);
+	}
 }