Added new logging of response and request headers

Author: qschmick

.github/workflows/php-cs-fixer.yml

@@ -8,7 +8,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
 

.github/workflows/phpstan.yml

@@ -14,7 +14,7 @@ jobs:
 
     steps:
       - name: "Checkout"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: PHPStan
         uses: docker://oskarstark/phpstan-ga

README.md

@@ -18,6 +18,19 @@ You can install the package via composer:
 composer require always-open/laravel-request-logger
 ```
 
+### Breaking change
+If you are upgrading to 3.x or newer, the following steps must be taken as new fields have been added to the logging tables.
+- Create a migration for each logging tables with the following
+```php
+// The headers that were part of the request
+$table->json('request_headers')
+    ->nullable();
+// The headers that were part of the response
+$table->json('response_headers')
+    ->nullable();
+```
+Run this migration prior to upgrading the package.
+
 ## Configuration
 
 ``` php
@@ -74,6 +87,35 @@ function makeFacebookApiCall(array $body, Client $facebook_client)
     $request_log->save();
 }
 ```
+
+Instead of manually setting the response data you can instead leverage the `updateFromRequest` method:
+```php
+function makeFacebookApiCall(array $body, Client $facebook_client)
+{
+    $request_headers = [
+        'api-key' => $config->apiKey,
+        'Content-Type' => 'application/json',
+    ];
+
+    $versioned_path = self::buildVersionedUrlPath($path);
+
+    $encoded_body = json_encode($body, JSON_UNESCAPED_SLASHES);
+
+    $request = new Request(
+        'GET',
+        '/v1/users',
+        $request_headers,
+        $encoded_body,
+    );
+    
+    $request_log = FacebookRequestLog::makeFromGuzzle($request);
+    
+    $response = $client->send($request);
+    $request_log->updateFromResponse($response);
+}
+```
+
+
 You can also manually set each property and then save the log instance.
 
 ### Testing

src/Models/RequestLogBaseModel.php

@@ -5,6 +5,7 @@
 use AlwaysOpen\RequestLogger\Observers\RequestLogObserver;
 use GuzzleHttp\Psr7\Request;
 use Illuminate\Database\Eloquent\Model;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * AlwaysOpen\RequestLogger\Models\RequestLogBaseModel
@@ -14,7 +15,9 @@
  * @property string               $http_method
  * @property int|null             $response_code
  * @property array|string|null    $body
+ * @property array|string|null    $request_headers
  * @property array|string|null    $response
+ * @property array|string|null    $response_headers
  * @property string|null          $exception
  * @property \Carbon\Carbon|null  $occurred_at
  */
@@ -25,7 +28,9 @@ class RequestLogBaseModel extends Model
         'created_at' => 'datetime',
         'updated_at' => 'datetime',
         'body' => 'json',
+        'request_headers' => 'json',
         'response' => 'json',
+        'response_headers' => 'json',
     ];
 
     protected $guarded = [
@@ -56,7 +61,18 @@ public static function makeFromGuzzle(Request $request) : static
         $instance->path = $request->getUri()->getPath();
         $instance->http_method = $request->getMethod();
         $instance->body = $request->getBody()->getContents();
+        $instance->request_headers = $request->getHeaders();
 
         return $instance;
     }
+
+    public function updateFromResponse(ResponseInterface $response): self {
+        $this->response = json_decode($response->getBody()->getContents(), true);
+        $this->response_code = $response->getStatusCode();
+        $this->response_headers = $response->getHeaders();
+
+        $this->save();
+
+        return $this;
+    }
 }

stubs/migration.stub

@@ -19,7 +19,7 @@ class {CLASS_NAME} extends Migration
             $table->string('path', 191)
                 ->index();
             // What parameters were passed in (e.g. ?status=new)
-            $table->string('params')
+            $table->string('params', 512)
                 ->nullable()
                 ->fulltext();
             // HTTP method (e.g. POST/PUT/DELETE)
@@ -32,9 +32,15 @@ class {CLASS_NAME} extends Migration
             // The entire JSON encoded payload of the request
             $table->json('body')
                 ->nullable();
+            // The headers that were part of the request
+            $table->json('request_headers')
+                ->nullable();
             // The entire JSON encoded responses
             $table->json('response')
                 ->nullable();
+            // The headers that were part of the response
+            $table->json('response_headers')
+                ->nullable();
             // Internal exceptions that occurred during the request
             $table->string('exception')
                 ->nullable();