Respect http-client-global-logger.enabled config option also in variant 3 HttpClientLogger::addRequestMiddleware()

Prepare for v1.1.0

Author: onlime

CHANGELOG.md

@@ -1,9 +1,13 @@
 # CHANGELOG
 
-## [v1.0.x (Unreleased)](https://github.com/onlime/laravel-http-client-global-logger/compare/v1.0.1...main)
+## [v1.1.x (Unreleased)](https://github.com/onlime/laravel-http-client-global-logger/compare/v1.1.0...main)
 
 - ...
 
+## [v1.1.0 (2023-11-09)](https://github.com/onlime/laravel-http-client-global-logger/compare/v1.0.2...v1.1.0)
+
+- Feature | HTTP Request Middleware to log Requests after Global Middleware by @pascalbaljet in #1
+
 ## [v1.0.2 (2023-07-17)](https://github.com/onlime/laravel-http-client-global-logger/compare/v1.0.1...v1.0.2)
 
 - Drop Laravel 9 support

README.md

@@ -52,9 +52,14 @@ Using the logger will log both the request and response of an external HTTP requ
 - **Variant 2: Mixin** (`HTTP_CLIENT_GLOBAL_LOGGER_MIXIN=true`)
   - Enabled only on individual HTTP Client instances, using `Http::log()` - no global logging.
   - Log channel name can be set per HTTP Client instance by passing a name to `Http::log($name)`
+- **Variant 3: Global HTTP Middleware**
+  - Can be used in combination with other `Http::globalRequestMiddleware()` calls in your `AppServiceProvider`'s `boot()` method, after registering your [Global Middleware](https://laravel.com/docs/10.x/http-client#global-middleware).
+
 
 ## Usage
 
+> **NOTE:** For all 3 variants below, you need to keep the HTTP Client Global Logger enabled (not setting `HTTP_CLIENT_GLOBAL_LOGGER_ENABLED=false` in your `.env`). The `http-client-global-logger.enabled` config option is a global on/off switch for all 3 variants, not just the "global" variants. Our project name might be misleading in that context.
+
 ### Variant 1: Global Logging
 
 **Just use Laravel HTTP Client as always - no need to configure anything!**
@@ -105,7 +110,7 @@ $response = $client->get('/user');
 
 ### Variant 3: Global HTTP Middleware
 
-If you use [Global Middleware](https://laravel.com/docs/10.x/http-client#global-middleware), you should be aware that *Variant 1* uses Laravel's `RequestSending` event to log HTTP requests. This event is fired **before** Global Middleware is executed. Therefore, any modifications to the request made by Global Middleware will not be logged. To overcome this, this package provides a middleware that you may add after your Global Middleware.
+If you use [Global Middleware](https://laravel.com/docs/10.x/http-client#global-middleware) (`Http::globalRequestMiddleware()` and `Http::globalResponseMiddleware()` methods), you should be aware that *Variant 1* uses Laravel's `RequestSending` event to log HTTP requests. This event is fired **before** Global Middleware is executed. Therefore, any modifications to the request made by Global Middleware will not be logged. To overcome this, this package provides a middleware that you may add after your Global Middleware.
 
 You may add the middleware using the static `addRequestMiddleware()` method on the `HttpClientLogger` class:
 

src/HttpClientLogger.php

@@ -18,6 +18,10 @@ class HttpClientLogger
 
     public static function addRequestMiddleware(): void
     {
+        if (! config('http-client-global-logger.enabled')) {
+            return;
+        }
+
         Http::globalRequestMiddleware(
             fn (RequestInterface $psrRequest) => tap($psrRequest, function (RequestInterface $psrRequest) {
                 // Wrap PSR-7 request into Laravel's HTTP Client Request object

src/Listeners/LogRequestSending.php

@@ -12,10 +12,8 @@ class LogRequestSending
 {
     /**
      * Handle the event if the middleware was not added manually.
-     *
-     * @return void
      */
-    public function handle(RequestSending $event)
+    public function handle(RequestSending $event): void
     {
         if (!HttpClientLogger::requestMiddlewareWasAdded()) {
             $this->handleEvent($event);
@@ -24,10 +22,8 @@ public function handle(RequestSending $event)
 
     /**
      * Handle the event.
-     *
-     * @return void
      */
-    public function handleEvent(RequestSending $event)
+    public function handleEvent(RequestSending $event): void
     {
         $obfuscate  = config('http-client-global-logger.obfuscate.enabled');
         $psrRequest = $event->request->toPsrRequest();