Merge pull request #8 from bilfeldt/fix/refactor-config

bilfeldt · web-flow · commit 8f8e6f1afa21 · 2021-04-19T21:56:56.000+02:00
Refactor configuration
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,34 @@ All notable changes to `laravel-http-client-logger` will be documented in this f
 
 ## Upgrade guides
 
+### 0.3.0 => 1.0.0
+
+This release flattens the configuration variables. It is suggested to republish the configuration after upgrading.
+
+- `filtering.always` is renamed to `filter_all`
+- `filtering.2xx` is renamed to `filter_2xx`
+- `filtering.3xx` is renamed to `filter_3xx`
+- `filtering.4xx` is renamed to `filter_4xx`
+- `filtering.5xx` is renamed to `filter_5xx`
+- `filtering.slow` is renamed to `filter_slow`
+- `log_to_channel.enabled` has been removed, instead logging to channel is enabled when a channel is provided
+- `log_to_channel.channel` is renamed to `channel`
+- `log_to_disk.enabled` has been removed, instead logging to disk is enabled when a disk is provided
+- `log_to_disk.disk` is renamed to `disk`
+- `log_to_disk.separate` is renamed to `disk_separate_files`
+- `log_to_disk.timestamp` is renamed to `prefix_timestamp`
+- `log_to_disk.filename` is renamed to `filename`
+
+The following environment variables have been renamed:
+- `HTTP_CLIENT_LOGGER_FILTERING_ALWAYS` is renamed to `HTTP_CLIENT_LOGGER_FILTER_ALL`
+- `HTTP_CLIENT_LOGGER_FILTERING_2XX` is renamed to `HTTP_CLIENT_LOGGER_FILTER_2XX`
+- `HTTP_CLIENT_LOGGER_FILTERING_3XX` is renamed to `HTTP_CLIENT_LOGGER_FILTER_3XX`
+- `HTTP_CLIENT_LOGGER_FILTERING_4XX` is renamed to `HTTP_CLIENT_LOGGER_FILTER_4XX`
+- `HTTP_CLIENT_LOGGER_FILTERING_5XX` is renamed to `HTTP_CLIENT_LOGGER_FILTER_5XX`
+- `HTTP_CLIENT_LOGGER_FILTERING_SLOW` is renamed to `HTTP_CLIENT_LOGGER_FILTER_SLOW`
+- `HTTP_CLIENT_LOGGER_CHANNEL_LOG_ENABLED` removed in favor of `HTTP_CLIENT_LOGGER_CHANNEL`
+- `HTTP_CLIENT_LOGGER_DISK_LOG_ENABLED` removed in favor of `HTTP_CLIENT_LOGGER_DISK`
+
 ### 0.2.0 => 0.3.0
 
 This release includes breaking changes:
diff --git a/config/http-client-logger.php b/config/http-client-logger.php
@@ -34,19 +34,17 @@
     | that these settings are only used by the default filter.
     |
     */
-    'filtering' => [
-        'always' => env('HTTP_CLIENT_LOGGER_FILTERING_ALWAYS', false),
+    'filter_always' => env('HTTP_CLIENT_LOGGER_FILTER_ALL', false),
 
-        '2xx' => env('HTTP_CLIENT_LOGGER_FILTERING_2XX', true),
+    'filter_2xx' => env('HTTP_CLIENT_LOGGER_FILTER_2XX', true),
 
-        '3xx' => env('HTTP_CLIENT_LOGGER_FILTERING_3XX', true),
+    'filter_3xx' => env('HTTP_CLIENT_LOGGER_FILTER_3XX', true),
 
-        '4xx' => env('HTTP_CLIENT_LOGGER_FILTERING_4XX', true),
+    'filter_4xx' => env('HTTP_CLIENT_LOGGER_FILTER_4XX', true),
 
-        '5xx' => env('HTTP_CLIENT_LOGGER_FILTERING_5XX', true),
+    'filter_5xx' => env('HTTP_CLIENT_LOGGER_FILTER_5XX', true),
 
-        'slow' => env('HTTP_CLIENT_LOGGER_FILTERING_SLOW', 1.5), // Log requests that took longer than the setting (in sec)
-    ],
+    'filter_slow' => env('HTTP_CLIENT_LOGGER_FILTER_SLOW', 1.5), // Log requests that took longer than the setting (in sec)
 
     /*
     |--------------------------------------------------------------------------
@@ -62,32 +60,27 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Logger to channel
+    | Log to channel
     |--------------------------------------------------------------------------
     |
     | These settings determine how to log request/responses to the Laravel log.
     | Note that these settings are only used by the default logger.
+    | Set to false to disable the channel logging.
     |
     */
-    'log_to_channel' => [
-        'enabled' => env('HTTP_CLIENT_LOGGER_CHANNEL_LOG_ENABLED', true),
-        'channel' => env('HTTP_CLIENT_LOGGER_CHANNEL'), // Uses the default log channel unless specified
-    ],
+    'channel' => env('HTTP_CLIENT_LOGGER_CHANNEL', 'default'),
 
     /*
     |--------------------------------------------------------------------------
-    | Logger to disk
+    | Log to disk
     |--------------------------------------------------------------------------
     |
     | These settings determine how to log request/responses to a flysystem disk.
     | Note that these settings are only used by the default logger.
     |
     */
-    'log_to_disk' => [
-        'enabled' => env('HTTP_CLIENT_LOGGER_DISK_LOG_ENABLED', true),
-        'disk' => env('HTTP_CLIENT_LOGGER_DISK'), // uses the default filesystem disk if none is specified
-        'separate' => true,
-        'timestamp' => 'Y-m-d-Hisu', // Leaving empty will remove the timestamp
-        'filename' => '',
-    ],
+    'disk' => env('HTTP_CLIENT_LOGGER_DISK', false),
+    'disk_separate_files' => true,
+    'prefix_timestamp' => 'Y-m-d-Hisu', // Leaving empty will remove the timestamp
+    'filename' => '',
 ];
diff --git a/src/HttpLogger.php b/src/HttpLogger.php
@@ -36,14 +36,14 @@ public function log(
         $this->response = $response;
         $this->sec = $sec;
         $this->context = $context;
-        $this->config = array_replace_recursive(config('http-client-logger'), $config); // Note this does not work optimally!
+        $this->config = array_merge(config('http-client-logger'), $config);
 
-        if (Arr::get($this->config, 'log_to_channel.enabled')) {
-            $this->logToChannel(Arr::get($this->config, 'log_to_channel.channel') ?? config('logging.default'));
+        if (Arr::get($this->config, 'channel')) {
+            $this->logToChannel(($channel = Arr::get($this->config, 'channel')) == 'default' ? config('logging.default') : $channel);
         }
 
-        if (Arr::get($this->config, 'log_to_disk.enabled')) {
-            $this->logToDisk(Arr::get($this->config, 'log_to_disk.disk') ?? config('filesystems.default'));
+        if (Arr::get($this->config, 'disk')) {
+            $this->logToDisk(($disk = Arr::get($this->config, 'disk')) == 'default' ? config('filesystems.default') : $disk);
         }
     }
 
@@ -54,8 +54,8 @@ protected function getReplace(): array
 
     protected function getFileName(): string
     {
-        return (Arr::get($this->config, 'log_to_disk.timestamp') ? now()->format(Arr::get($this->config, 'log_to_disk.timestamp')) : '')
-            .Arr::get($this->config, 'log_to_disk.filename');
+        return (Arr::get($this->config, 'prefix_timestamp') ? now()->format(Arr::get($this->config, 'prefix_timestamp')) : '')
+            .Arr::get($this->config, 'filename');
     }
 
     protected function getMessage(): string
@@ -82,7 +82,7 @@ protected function logToChannel(string $channel): void
 
     protected function logToDisk(string $disk): void
     {
-        if (Arr::get($this->config, 'log_to_disk.separate')) {
+        if (Arr::get($this->config, 'disk_separate_files')) {
             Storage::disk($disk)->put(
                 $this->getFileName().'-request'.Str::start($this->fileExt, '.'),
                 $this->psrMessageStringConverter->toString($this->request, $this->getReplace())
diff --git a/src/HttpLoggingFilter.php b/src/HttpLoggingFilter.php
@@ -18,27 +18,27 @@ public function shouldLog(
             return false;
         }
 
-        if (config('http-client-logger.filtering.always')) {
+        if (config('http-client-logger.filter_always')) {
             return true;
         }
 
-        if (config('http-client-logger.filtering.2xx') && $response->getStatusCode() >= 200 && $response->getStatusCode() < 300) {
+        if (config('http-client-logger.filter_2xx') && $response->getStatusCode() >= 200 && $response->getStatusCode() < 300) {
             return true;
         }
 
-        if (config('http-client-logger.filtering.3xx') && $response->getStatusCode() >= 300 && $response->getStatusCode() < 400) {
+        if (config('http-client-logger.filter_3xx') && $response->getStatusCode() >= 300 && $response->getStatusCode() < 400) {
             return true;
         }
 
-        if (config('http-client-logger.filtering.4xx') && $response->getStatusCode() >= 400 && $response->getStatusCode() < 500) {
+        if (config('http-client-logger.filter_4xx') && $response->getStatusCode() >= 400 && $response->getStatusCode() < 500) {
             return true;
         }
 
-        if (config('http-client-logger.filtering.5xx') && $response->getStatusCode() >= 500 && $response->getStatusCode() < 600) {
+        if (config('http-client-logger.filter_5xx') && $response->getStatusCode() >= 500 && $response->getStatusCode() < 600) {
             return true;
         }
 
-        if (config('http-client-logger.filtering.slow') < $sec) {
+        if (config('http-client-logger.filter_slow') < $sec) {
             return true;
         }
 
diff --git a/tests/HttpLoggingFilterTest.php b/tests/HttpLoggingFilterTest.php
@@ -19,15 +19,15 @@ public function setUp(): void
 
     public function test_filter_log_2xx()
     {
-        config(['http-client-logger.filtering.2xx' => true]);
+        config(['http-client-logger.filter_2xx' => true]);
 
         $this->assertTrue($this->filter->shouldLog(
             new Request('GET', '/'),
             new Response(200),
             0
         ));
 
-        config(['http-client-logger.filtering.2xx' => false]);
+        config(['http-client-logger.filter_2xx' => false]);
 
         $this->assertFalse($this->filter->shouldLog(
             new Request('GET', '/'),
@@ -38,15 +38,15 @@ public function test_filter_log_2xx()
 
     public function test_filter_log_3xx()
     {
-        config(['http-client-logger.filtering.3xx' => true]);
+        config(['http-client-logger.filter_3xx' => true]);
 
         $this->assertTrue($this->filter->shouldLog(
             new Request('GET', '/'),
             new Response(300),
             0
         ));
 
-        config(['http-client-logger.filtering.3xx' => false]);
+        config(['http-client-logger.filter_3xx' => false]);
 
         $this->assertFalse($this->filter->shouldLog(
             new Request('GET', '/'),
@@ -57,15 +57,15 @@ public function test_filter_log_3xx()
 
     public function test_filter_log_4xx()
     {
-        config(['http-client-logger.filtering.4xx' => true]);
+        config(['http-client-logger.filter_4xx' => true]);
 
         $this->assertTrue($this->filter->shouldLog(
             new Request('GET', '/'),
             new Response(400),
             0
         ));
 
-        config(['http-client-logger.filtering.4xx' => false]);
+        config(['http-client-logger.filter_4xx' => false]);
 
         $this->assertFalse($this->filter->shouldLog(
             new Request('GET', '/'),
@@ -76,15 +76,15 @@ public function test_filter_log_4xx()
 
     public function test_filter_log_5xx()
     {
-        config(['http-client-logger.filtering.5xx' => true]);
+        config(['http-client-logger.filter_5xx' => true]);
 
         $this->assertTrue($this->filter->shouldLog(
             new Request('GET', '/'),
             new Response(500),
             0
         ));
 
-        config(['http-client-logger.filtering.5xx' => false]);
+        config(['http-client-logger.filter_5xx' => false]);
 
         $this->assertFalse($this->filter->shouldLog(
             new Request('GET', '/'),
@@ -95,8 +95,8 @@ public function test_filter_log_5xx()
 
     public function test_filter_log_slow()
     {
-        config(['http-client-logger.filtering.2xx' => false]);
-        config(['http-client-logger.filtering.slow' => 1.5]);
+        config(['http-client-logger.filter_2xx' => false]);
+        config(['http-client-logger.filter_slow' => 1.5]);
 
         $this->assertFalse($this->filter->shouldLog(
             new Request('GET', '/'),
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -13,11 +13,11 @@ public function setUp(): void
 
         parent::setUp();
 
-        config()->set('http-client-logger.filtering.2xx', true);
-        config()->set('http-client-logger.filtering.3xx', true);
-        config()->set('http-client-logger.filtering.4xx', true);
-        config()->set('http-client-logger.filtering.5xx', true);
-        config()->set('http-client-logger.filtering.slow', true);
+        config()->set('http-client-logger.filter_2xx', true);
+        config()->set('http-client-logger.filter_3xx', true);
+        config()->set('http-client-logger.filter_4xx', true);
+        config()->set('http-client-logger.filter_5xx', true);
+        config()->set('http-client-logger.filter_slow', true);
     }
 
     protected function getPackageProviders($app)

Original file line number	Diff line number	Diff line change
`@@ -36,14 +36,14 @@ public function log(`
`36`	`36`	`$this->response = $response;`
`37`	`37`	`$this->sec = $sec;`
`38`	`38`	`$this->context = $context;`
`39`		`- $this->config = array_replace_recursive(config('http-client-logger'), $config); // Note this does not work optimally!`
	`39`	`+ $this->config = array_merge(config('http-client-logger'), $config);`
`40`	`40`
`41`		`- if (Arr::get($this->config, 'log_to_channel.enabled')) {`
`42`		`- $this->logToChannel(Arr::get($this->config, 'log_to_channel.channel') ?? config('logging.default'));`
	`41`	`+ if (Arr::get($this->config, 'channel')) {`
	`42`	`+ $this->logToChannel(($channel = Arr::get($this->config, 'channel')) == 'default' ? config('logging.default') : $channel);`
`43`	`43`	`}`
`44`	`44`
`45`		`- if (Arr::get($this->config, 'log_to_disk.enabled')) {`
`46`		`- $this->logToDisk(Arr::get($this->config, 'log_to_disk.disk') ?? config('filesystems.default'));`
	`45`	`+ if (Arr::get($this->config, 'disk')) {`
	`46`	`+ $this->logToDisk(($disk = Arr::get($this->config, 'disk')) == 'default' ? config('filesystems.default') : $disk);`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`
`@@ -54,8 +54,8 @@ protected function getReplace(): array`
`54`	`54`
`55`	`55`	`protected function getFileName(): string`
`56`	`56`	`{`
`57`		`- return (Arr::get($this->config, 'log_to_disk.timestamp') ? now()->format(Arr::get($this->config, 'log_to_disk.timestamp')) : '')`
`58`		`- .Arr::get($this->config, 'log_to_disk.filename');`
	`57`	`+ return (Arr::get($this->config, 'prefix_timestamp') ? now()->format(Arr::get($this->config, 'prefix_timestamp')) : '')`
	`58`	`+ .Arr::get($this->config, 'filename');`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`protected function getMessage(): string`
`@@ -82,7 +82,7 @@ protected function logToChannel(string $channel): void`
`82`	`82`
`83`	`83`	`protected function logToDisk(string $disk): void`
`84`	`84`	`{`
`85`		`- if (Arr::get($this->config, 'log_to_disk.separate')) {`
	`85`	`+ if (Arr::get($this->config, 'disk_separate_files')) {`
`86`	`86`	`Storage::disk($disk)->put(`
`87`	`87`	`$this->getFileName().'-request'.Str::start($this->fileExt, '.'),`
`88`	`88`	`$this->psrMessageStringConverter->toString($this->request, $this->getReplace())`
Original file line number	Diff line number	Diff line change
`@@ -18,27 +18,27 @@ public function shouldLog(`
`18`	`18`	`return false;`
`19`	`19`	`}`
`20`	`20`
`21`		`- if (config('http-client-logger.filtering.always')) {`
	`21`	`+ if (config('http-client-logger.filter_always')) {`
`22`	`22`	`return true;`
`23`	`23`	`}`
`24`	`24`
`25`		`- if (config('http-client-logger.filtering.2xx') && $response->getStatusCode() >= 200 && $response->getStatusCode() < 300) {`
	`25`	`+ if (config('http-client-logger.filter_2xx') && $response->getStatusCode() >= 200 && $response->getStatusCode() < 300) {`
`26`	`26`	`return true;`
`27`	`27`	`}`
`28`	`28`
`29`		`- if (config('http-client-logger.filtering.3xx') && $response->getStatusCode() >= 300 && $response->getStatusCode() < 400) {`
	`29`	`+ if (config('http-client-logger.filter_3xx') && $response->getStatusCode() >= 300 && $response->getStatusCode() < 400) {`
`30`	`30`	`return true;`
`31`	`31`	`}`
`32`	`32`
`33`		`- if (config('http-client-logger.filtering.4xx') && $response->getStatusCode() >= 400 && $response->getStatusCode() < 500) {`
	`33`	`+ if (config('http-client-logger.filter_4xx') && $response->getStatusCode() >= 400 && $response->getStatusCode() < 500) {`
`34`	`34`	`return true;`
`35`	`35`	`}`
`36`	`36`
`37`		`- if (config('http-client-logger.filtering.5xx') && $response->getStatusCode() >= 500 && $response->getStatusCode() < 600) {`
	`37`	`+ if (config('http-client-logger.filter_5xx') && $response->getStatusCode() >= 500 && $response->getStatusCode() < 600) {`
`38`	`38`	`return true;`
`39`	`39`	`}`
`40`	`40`
`41`		`- if (config('http-client-logger.filtering.slow') < $sec) {`
	`41`	`+ if (config('http-client-logger.filter_slow') < $sec) {`
`42`	`42`	`return true;`
`43`	`43`	`}`
`44`	`44`