Merge pull request #53 from MacPaw/develop

Release v1.0.1

Author: Yozhef

README.md

@@ -68,6 +68,8 @@ Configurating health check - all available you can see [here](https://github.com
 symfony_health_check:
     health_checks:
         - id: symfony_health_check.doctrine_check
+    ping_checks:
+        - id: symfony_health_check.status_up_check
 ```
 
 Create Symfony Health Check Bundle Routing Config:
@@ -93,6 +95,9 @@ If you are using [symfony/security](https://symfony.com/doc/current/security.htm
         healthcheck:
             pattern: ^/health
             security: false
+        ping:
+            pattern: ^/ping
+            security: false
 ```
 
 Step 4: Additional settings
@@ -109,13 +114,13 @@ declare(strict_types=1);
 
 namespace YourProject\Check;
 
+use SymfonyHealthCheckBundle\Dto\Response;
+
 class CustomCheck implements CheckInterface
 {
-    private const CHECK_RESULT_KEY = 'customConnection';
-    
-    public function check(): array
+    public function check(): Response
     {
-        return [self::CHECK_RESULT_KEY => true];
+        return new Response('status', true, 'up');
     }
 }
 ```
@@ -126,7 +131,7 @@ Then we add our custom health check to collection
 symfony_health_check:
     health_checks:
         - id: symfony_health_check.doctrine_check
-        - id: custom_health_check
+        - id: custom_health_check // custom service check id
 ```
 
 How Change Route:
@@ -137,6 +142,11 @@ health:
     path: /your/custom/url
     methods: GET
     controller: SymfonyHealthCheckBundle\Controller\HealthController::healthCheckAction
+    
+ping:
+    path: /your/custom/url
+    methods: GET
+    controller: SymfonyHealthCheckBundle\Controller\PingController::pingAction
 
 ```
 

UPGRADE-1.0.md

@@ -0,0 +1,116 @@
+Upgrade Symfony Health Check Bundle V1.0.0
+=================================
+
+Step 1: Update the Symfony Health Check Bundle via Composer
+----------------------------------
+```console
+$ "macpaw/symfony-health-check-bundle": "^v1.0.0"
+```
+
+### Next, use Composer to download new versions of the libraries:
+```console
+$ composer update "macpaw/symfony-health-check-bundle"
+```
+
+###Dependency Errors
+
+If you get a dependency error, it may mean that you also need to upgrade other libraries that are dependencies of the libraries. To allow that, pass the --with-all-dependencies flag:
+```console
+$ composer update "macpaw/symfony-health-check-bundle" -with-all-dependencies
+```
+
+Step 2: Update the Symfony Health Check Bundle via Composer
+----------------------------------
+
+## Automatical
+
+Over time - and especially when you upgrade to a new version of a library - an updated version of the recipe may be available. These updates are usually minor - e.g. new comments in a configuration file - but it's a good idea to keep your files in sync with the recipes.
+
+Symfony Flex provides several commands to help upgrade your recipes. Be sure to commit any unrelated changes you're working on before starting:
+
+```console
+$ composer recipes
+
+
+$ composer recipes symfony/framework-bundle
+
+
+$ composer recipes:install symfony/framework-bundle --force -v
+```
+
+The tricky part of this process is that the recipe "update" does not perform any intelligent "upgrading" of your code. Instead, the updates process re-installs the latest version of the recipe which means that your custom code will be overridden completely. After updating a recipe, you need to carefully choose which changes you want, and undo the rest.
+
+## Manual:
+
+### Old Config:
+`config/packages/symfony_health_check.yaml`
+```yaml
+symfony_health_check:
+    health_checks:
+        - id: symfony_health_check.doctrine_check
+```
+
+### New Config:
+```yaml
+symfony_health_check:
+    health_checks:
+        - id: symfony_health_check.doctrine_check
+    ping_checks:
+        - id: symfony_health_check.status_up_check
+```
+
+Security Optional:
+----------------------------------
+`config/packages/security.yaml`
+
+### Old Config:
+```yaml
+    firewalls:
+        healthcheck:
+            pattern: ^/health
+            security: false
+```
+
+### New Config:
+```yaml
+    firewalls:
+        healthcheck:
+            pattern: ^/health
+            security: false
+        ping:
+            pattern: ^/ping
+            security: false
+```
+
+Step 3: Update Custom Health Check
+----------------------------------
+We need change return type array -> Response class
+
+
+### Old:
+```
+use SymfonyHealthCheckBundle\Dto\Response;
+
+class StatusUpCheck implements CheckInterface
+{
+    public function check(): array
+    {
+        return ['status' => 'up'];
+    }
+}
+```
+
+### New:
+```
+use SymfonyHealthCheckBundle\Dto\Response;
+
+class StatusUpCheck implements CheckInterface
+{
+    public function check(): Response
+    {
+        return new Response('status', true, 'up');
+    }
+}
+```
+
+

src/Check/CheckInterface.php

@@ -4,10 +4,9 @@
 
 namespace SymfonyHealthCheckBundle\Check;
 
+use SymfonyHealthCheckBundle\Dto\Response;
+
 interface CheckInterface
 {
-    /**
-     * @return array<string, mixed>
-     */
-    public function check(): array;
+    public function check(): Response;
 }

src/Check/DoctrineCheck.php

@@ -5,12 +5,12 @@
 namespace SymfonyHealthCheckBundle\Check;
 
 use Symfony\Component\DependencyInjection\ContainerInterface;
-use SymfonyHealthCheckBundle\Exception\ServiceNotFoundException;
+use SymfonyHealthCheckBundle\Dto\Response;
 use Throwable;
 
 class DoctrineCheck implements CheckInterface
 {
-    private const CHECK_RESULT_KEY = 'connection';
+    private const CHECK_RESULT_NAME = 'doctrine';
 
     private ContainerInterface $container;
 
@@ -19,35 +19,25 @@ public function __construct(ContainerInterface $container)
         $this->container = $container;
     }
 
-    /**
-     * @throws ServiceNotFoundException
-     */
-    public function check(): array
+    public function check(): Response
     {
-        $result = ['name' => 'doctrine'];
-
         if ($this->container->has('doctrine.orm.entity_manager') === false) {
-            throw new ServiceNotFoundException(
-                'Entity Manager Not Found.',
-                [
-                    'class' => 'doctrine.orm.entity_manager',
-                ]
-            );
+            return new Response(self::CHECK_RESULT_NAME, false, 'Entity Manager Not Found.');
         }
 
         $entityManager = $this->container->get('doctrine.orm.entity_manager');
 
         if ($entityManager === null) {
-            throw new ServiceNotFoundException('Entity Manager Not Found.');
+            return new Response(self::CHECK_RESULT_NAME, false, 'Entity Manager Not Found.');
         }
 
         try {
             $con = $entityManager->getConnection();
             $con->executeQuery($con->getDatabasePlatform()->getDummySelectSQL())->free();
         } catch (Throwable $e) {
-            return array_merge($result, [self::CHECK_RESULT_KEY => false]);
+            return new Response(self::CHECK_RESULT_NAME, false, $e->getMessage());
         }
 
-        return array_merge($result, [self::CHECK_RESULT_KEY => true]);
+        return new Response(self::CHECK_RESULT_NAME, true, 'ok');
     }
 }

src/Check/EnvironmentCheck.php

@@ -5,6 +5,7 @@
 namespace SymfonyHealthCheckBundle\Check;
 
 use Symfony\Component\DependencyInjection\ContainerInterface;
+use SymfonyHealthCheckBundle\Dto\Response;
 use Throwable;
 
 class EnvironmentCheck implements CheckInterface
@@ -18,16 +19,14 @@ public function __construct(ContainerInterface $container)
         $this->container = $container;
     }
 
-    public function check(): array
+    public function check(): Response
     {
-        $result = ['name' => self::CHECK_RESULT_KEY];
-
         try {
             $env = $this->container->getParameter('kernel.environment');
         } catch (Throwable $e) {
-            return array_merge($result, [self::CHECK_RESULT_KEY => 'Could not determine']);
+            return new Response(self::CHECK_RESULT_KEY, false, 'Could not determine');
         }
 
-        return array_merge($result, [self::CHECK_RESULT_KEY => $env]);
+        return new Response(self::CHECK_RESULT_KEY, true, 'ok', [$env]);
     }
 }

src/Check/StatusUpCheck.php

@@ -4,10 +4,12 @@
 
 namespace SymfonyHealthCheckBundle\Check;
 
+use SymfonyHealthCheckBundle\Dto\Response;
+
 class StatusUpCheck implements CheckInterface
 {
-    public function check(): array
+    public function check(): Response
     {
-        return ['status' => 'up'];
+        return new Response('status', true, 'up');
     }
 }

src/Controller/HealthController.php

@@ -33,7 +33,7 @@ public function healthCheckAction(): JsonResponse
     {
         $resultHealthCheck = [];
         foreach ($this->healthChecks as $healthCheck) {
-            $resultHealthCheck[] = $healthCheck->check();
+            $resultHealthCheck[] = $healthCheck->check()->toArray();
         }
 
         return new JsonResponse($resultHealthCheck, Response::HTTP_OK);

src/Controller/PingController.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SymfonyHealthCheckBundle\Controller;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+use SymfonyHealthCheckBundle\Check\CheckInterface;
+
+final class PingController extends AbstractController
+{
+    /**
+     * @var array<CheckInterface>
+     */
+    private array $checks = [];
+
+    public function addHealthCheck(CheckInterface $check): void
+    {
+        $this->checks[] = $check;
+    }
+
+    /**
+     * @Route(
+     *     path="/ping",
+     *     name="ping",
+     *     methods={"GET"}
+     * )
+     */
+    public function pingAction(): JsonResponse
+    {
+        $pingCheck = [];
+        foreach ($this->checks as $healthCheck) {
+            $pingCheck[] = $healthCheck->check()->toArray();
+        }
+
+        return new JsonResponse($pingCheck, Response::HTTP_OK);
+    }
+}

src/DependencyInjection/Configuration.php

@@ -28,6 +28,13 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->end()
                     ->end()
                 ->end()
+                ->arrayNode('ping_checks')
+                    ->prototype('array')
+                        ->children()
+                            ->scalarNode('id')->cannotBeEmpty()->end()
+                        ->end()
+                    ->end()
+                ->end()
             ->end()
         ;
 

src/DependencyInjection/SymfonyHealthCheckExtension.php

@@ -10,6 +10,7 @@
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use SymfonyHealthCheckBundle\Controller\HealthController;
+use SymfonyHealthCheckBundle\Controller\PingController;
 
 class SymfonyHealthCheckExtension extends Extension
 {
@@ -40,9 +41,16 @@ private function loadHealthChecks(
         $loader->load('health_checks.xml');
 
         $healthCheckCollection = $container->findDefinition(HealthController::class);
+
         foreach ($config['health_checks'] as $healthCheckConfig) {
             $healthCheckDefinition = new Reference($healthCheckConfig['id']);
             $healthCheckCollection->addMethodCall('addHealthCheck', [$healthCheckDefinition]);
         }
+
+        $pingCollection = $container->findDefinition(PingController::class);
+        foreach ($config['ping_checks'] as $healthCheckConfig) {
+            $healthCheckDefinition = new Reference($healthCheckConfig['id']);
+            $pingCollection->addMethodCall('addHealthCheck', [$healthCheckDefinition]);
+        }
     }
 }