feat: early capture request payload before transformation (#114)

Author: bhushan

README.md

@@ -166,6 +166,45 @@ alongside other features like: auto-generated documentation, error tracking, ana
 
 > See the [docs](https://docs.treblle.com/en/integrations/laravel) for this SDK to learn more.
 
+## Capturing Original Request Payloads
+
+Some applications use middleware to transform incoming request data before processing (e.g., converting legacy API formats to current formats). By default, Treblle captures the request data after all middleware has processed it, which means you'll see the transformed data rather than what the client originally sent.
+
+If you need to capture the **original request payload** before any transformations, you can use the `treblle.early` middleware alongside your regular `treblle` middleware.
+
+### When to use this feature
+
+- Your API has middleware that modifies incoming request data
+- You want to see what clients actually sent vs. what your application processed
+- You need to debug issues related to request transformations
+- You want complete visibility into your API's request lifecycle
+
+### How to use it
+
+Add the `treblle.early` middleware **before** any middleware that transforms request data, but keep your regular `treblle` middleware in its usual position:
+
+```php
+Route::middleware(['treblle.early', 'your-transformation-middleware', 'treblle'])->group(function () {
+  // YOUR API ROUTES GO HERE
+  Route::prefix('api')->group(function () {
+    Route::post('users', [UserController::class, 'store']);
+    Route::put('users/{id}', [UserController::class, 'update']);
+  });
+});
+```
+
+Or for individual routes:
+
+```php
+Route::post('/api/legacy-endpoint', [LegacyController::class, 'handle'])
+    ->middleware(['treblle.early', 'legacy-transformer', 'treblle']);
+```
+
+### Important notes
+
+- If you don't use `treblle.early`, everything works exactly as before
+- This feature is completely optional and backward compatible
+
 ## Available SDKs
 
 Treblle provides [open-source SDKs](https://docs.treblle.com/en/integrations) that let you seamlessly integrate Treblle with your REST-based APIs.

src/DataProviders/LaravelRequestDataProvider.php

@@ -32,8 +32,18 @@ public function getRequest(): Request
                 )->toArray()
             ),
             query: $this->fieldMasker->mask($this->request->query->all()),
-            body: $this->fieldMasker->mask($this->request->toArray()),
+            body: $this->fieldMasker->mask($this->getRequestBody()),
             route_path: $this->request->route()?->toSymfonyRoute()->getPath(),
         );
     }
+
+    private function getRequestBody(): array
+    {
+        // Prioritizing original payload if captured by TreblleEarlyMiddleware.
+        if ($this->request->attributes->has('treblle_original_payload')) {
+            return $this->request->attributes->get('treblle_original_payload');
+        }
+
+        return $this->request->toArray();
+    }
 }

src/Middlewares/TreblleEarlyMiddleware.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Treblle\Laravel\Middlewares;
+
+use Closure;
+use Illuminate\Http\Request;
+
+final class TreblleEarlyMiddleware
+{
+    public function handle(Request $request, Closure $next)
+    {
+        $request->attributes->set('treblle_original_payload', $request->all());
+
+        return $next($request);
+    }
+}

src/TreblleServiceProvider.php

@@ -6,10 +6,12 @@
 
 use function config;
 use Illuminate\Routing\Router;
+use Illuminate\Foundation\Http\Kernel;
 use Illuminate\Support\ServiceProvider;
 use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Foundation\Console\AboutCommand;
 use Treblle\Laravel\Middlewares\TreblleMiddleware;
+use Treblle\Laravel\Middlewares\TreblleEarlyMiddleware;
 use Illuminate\Contracts\Container\BindingResolutionException;
 
 final class TreblleServiceProvider extends ServiceProvider
@@ -35,6 +37,14 @@ public function boot(): void
             $router->aliasMiddleware('treblle', TreblleMiddleware::class);
         }
 
+        if (! isset($router->getMiddleware()['treblle.early'])) {
+            $router->aliasMiddleware('treblle.early', TreblleEarlyMiddleware::class);
+
+            /** @var Kernel $kernel */
+            $kernel = $this->app->make(Kernel::class);
+            $kernel->prependToMiddlewarePriority(TreblleEarlyMiddleware::class);
+        }
+
         /** @var Dispatcher $events */
         $events = $this->app->make(Dispatcher::class);