Merge pull request #2 from chocofamilyme/bug.fix

Fix route /health/extended

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 2.0.1
+ - Fix route /health/extended. Update your config healthcheck.php
+
 ## 2.0.0
  - Laravel 8 support
  - Minimum PHP version is set to 7.4

README.md

@@ -4,7 +4,7 @@ For example you want to check "Database Connection" of your microservice.
 
 # Installation
 ```bash
-composer require chocofamilyme/laravel-healthcheck ^0.0
+composer require chocofamilyme/laravel-healthcheck ^2.0
 ```
 
 # Publishing the configuration (optional)
@@ -28,7 +28,7 @@ php artisan vendor:publish --provider="Chocofamilyme\LaravelHealthCheck\Provider
   "STORAGE": "OK"
 }
 ```
-- /health/extendet
+- /health/extended
 ```json
 {
   "DB": {
@@ -67,7 +67,7 @@ return [
 
 # Responses
 There is a configuration param which describes which response class to use to output the response. For example
-- /health - Chocofamilyme\LaravelHealthCheck\Responses\DefaultResponse::class
+- /health - Chocofamilyme\LaravelHealthCheck\Responses\Response::class
 output would look like this
 ```json
 {
@@ -78,13 +78,10 @@ output would look like this
 }
 ```
 
-- /health - Chocofamilyme\LaravelHealthCheck\Responses\ChocofamilyResponse::class
+- /health - Chocofamilyme\LaravelHealthCheck\Responses\Response::class
 output would look like this
 ```json
 {
-    "error_code": 0,
-    "status": "success",
-    "message": "Everything is fine",
     "data": {
         "DB": "OK",
         "CACHE": "OK",
@@ -94,4 +91,4 @@ output would look like this
 }
 ```
 
-Feel free to add your responses, if you want for example to output it in a view instead json.
+Feel free to add your responses, if you want for example to output it in a view instead json.

composer.json

@@ -26,7 +26,7 @@
   },
   "require-dev": {
     "squizlabs/php_codesniffer": "^3.5",
-    "vimeo/psalm": "^3.18"
+    "vimeo/psalm": "^4.3"
   },
   "autoload": {
     "psr-4": {

src/Controllers/HealthCheckController.php

@@ -3,6 +3,7 @@
 namespace Chocofamilyme\LaravelHealthCheck\Controllers;
 
 use Illuminate\Contracts\Config\Repository;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Routing\Controller;
 use Chocofamilyme\LaravelHealthCheck\Services\ComponentCheckService;
 
@@ -23,9 +24,9 @@ public function __construct(Repository $config)
     }
 
     /**
-     * @return \Illuminate\Http\JsonResponse
+     * @return JsonResponse
      */
-    public function simple(): \Illuminate\Http\JsonResponse
+    public function simple(): JsonResponse
     {
         $checks        = $this->componentCheck->getResponse();
         $responseClass = $this->config->get('healthcheck.response');
@@ -34,17 +35,17 @@ public function simple(): \Illuminate\Http\JsonResponse
     }
 
     /**
-     * @return \Illuminate\Http\JsonResponse
+     * @return JsonResponse
      */
-    public function extendet(): ?\Illuminate\Http\JsonResponse
+    public function extended(): ?JsonResponse
     {
-        if (!$this->config->get('healthcheck.extendet')) {
+        if (!$this->config->get('healthcheck.extended')) {
             return null;
         }
 
         $checks        = $this->componentCheck->getResponse();
         $responseClass = $this->config->get('healthcheck.response');
 
-        return (new $responseClass())->extendetResponse($checks);
+        return (new $responseClass())->extendedResponse($checks);
     }
 }

src/Providers/HealthCheckServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace Chocofamilyme\LaravelHealthCheck\Providers;
 
+use Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Support\ServiceProvider;
 
 class HealthCheckServiceProvider extends ServiceProvider
@@ -10,15 +11,15 @@ class HealthCheckServiceProvider extends ServiceProvider
      * Register services.
      *
      * @return void
-     * @throws \Illuminate\Contracts\Container\BindingResolutionException
+     * @throws BindingResolutionException
      */
     public function register()
     {
         // Route
         $this->loadRoutesFrom(__DIR__ . '/../routes/web.php');
 
         // Controller
-        $this->app->make('Chocofamilyme\LaravelHealthCheck\Controllers\HealthCheckController');
+        $this->app->make(\Chocofamilyme\LaravelHealthCheck\Controllers\HealthCheckController::class);
 
         // Merge our config with application config
         $this->mergeConfigFrom(

src/Responses/Response.php

@@ -37,7 +37,7 @@ public function simpleResponse(array $checks): SymfonyResponse
     }
 
     /**
-     * Return data in extendet way
+     * Return data in extended way
      *
      * @psalm-suppress UndefinedFunction
      *

src/config/healthcheck.php

@@ -15,14 +15,14 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Route for the extendet response
+    | Route for the extended response
     |--------------------------------------------------------------------------
     |
-    | Specify route for the extendet response
+    | Specify route for the extended response
     |
     */
 
-    'routeextendet' => '/health/extendet',
+    'routeextended' => '/health/extended',
 
     /*
     |--------------------------------------------------------------------------
@@ -39,16 +39,16 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Enable extendet health check endpoint
+    | Enable extended health check endpoint
     |--------------------------------------------------------------------------
     |
-    | Enable extendet endpoint for healthchecks with more information what
+    | Enable extended endpoint for healthchecks with more information what
     | went wrong, this is dangerous because in the exception messages may be
     | confidential information
     |
     */
 
-    'extendet' => false,
+    'extended' => true,
 
     /*
     |--------------------------------------------------------------------------
@@ -64,9 +64,9 @@
     */
 
     'componentChecks' => [
-        'DB' => Chocofamilyme\LaravelHealthCheck\Services\Checks\DatabaseComponentCheck::class,
-        'CACHE' => Chocofamilyme\LaravelHealthCheck\Services\Checks\CacheComponentCheck::class,
-        'SESSIONS' => Chocofamilyme\LaravelHealthCheck\Services\Checks\SessionsComponentCheck::class,
+        //'DB' => Chocofamilyme\LaravelHealthCheck\Services\Checks\DatabaseComponentCheck::class,
+        //'CACHE' => Chocofamilyme\LaravelHealthCheck\Services\Checks\CacheComponentCheck::class,
+        //'SESSIONS' => Chocofamilyme\LaravelHealthCheck\Services\Checks\SessionsComponentCheck::class,
         //'STORAGE' => Chocofamilyme\LaravelHealthCheck\Services\Checks\StorageComponentCheck::class,
     ]
 ];

src/routes/web.php

@@ -12,6 +12,6 @@
 
 /** @psalm-suppress UndefinedFunction */
 Route::get(
-    config('healthcheck.routeextendet', '/health/extendet'),
-    'Chocofamilyme\LaravelHealthCheck\Controllers\HealthCheckController@extendet'
+    config('healthcheck.routeextended', '/health/extended'),
+    'Chocofamilyme\LaravelHealthCheck\Controllers\HealthCheckController@extended'
 );