Refactor: Sanitize payloads optionally in Senders instead of Report

- Added shared sanitization behaviour into an AbstractSender class
  - Injected the PayloadSanitizer here
  - Optionally call it in the prepare payload method when configured
  - Used the existing config array to take in the option
  - added the logic from ReportSanitizer into JsonEncodableSanitizer
- Bound the sanitizer in the container

Author: YasserB94

shared/FakeSender.php

@@ -4,10 +4,10 @@
 
 use Closure;
 use Spatie\FlareClient\Enums\FlarePayloadType;
-use Spatie\FlareClient\Senders\Sender;
+use Spatie\FlareClient\Senders\AbstractSender;
 use Spatie\FlareClient\Senders\Support\Response;
 
-class FakeSender implements Sender
+class FakeSender extends AbstractSender
 {
     /** @var array<int, array{verb: string, fullUrl: string, headers: array<string, string>, arguments: array<string, mixed>}> */
     public static array $requests = [];
@@ -33,7 +33,7 @@ public function post(
             'verb' => 'POST',
             'fullUrl' => $endpoint,
             'headers' => ['X-API-KEY' => $apiToken],
-            'arguments' => $payload,
+            'arguments' => $this->preparePayloadForEncoding($payload),
         ];
 
         $callback(new Response(200, []));

src/FlareProvider.php

@@ -17,7 +17,9 @@
 use Spatie\FlareClient\Sampling\NeverSampler;
 use Spatie\FlareClient\Sampling\Sampler;
 use Spatie\FlareClient\Scopes\Scope;
+use Spatie\FlareClient\Senders\PayloadSanitizer;
 use Spatie\FlareClient\Senders\Sender;
+use Spatie\FlareClient\Senders\Support\JsonEncodableSanitizer;
 use Spatie\FlareClient\Support\BackTracer;
 use Spatie\FlareClient\Support\Container;
 use Spatie\FlareClient\Support\GracefulSpanEnder;
@@ -48,9 +50,15 @@ public function register(): void
     {
         $this->container ??= Container::instance();
 
-        $this->container->singleton(Sender::class, fn () => new $this->config->sender(
-            $this->config->senderConfig
-        ));
+        $this->container->singleton(PayloadSanitizer::class, fn () => new JsonEncodableSanitizer);
+
+        $this->container->singleton(
+            Sender::class,
+            fn () => new $this->config->sender(
+                config:$this->config->senderConfig,
+                sanitizer: $this->container->get(PayloadSanitizer::class)
+            )
+        );
 
         $this->container->singleton(Api::class, fn () => new Api(
             apiToken: $this->config->apiToken ?? 'No Api Token provided',

src/Report.php

@@ -5,7 +5,6 @@
 use Spatie\FlareClient\Contracts\FlareSpanEventType;
 use Spatie\FlareClient\Contracts\FlareSpanType;
 use Spatie\FlareClient\Enums\OverriddenGrouping;
-use Spatie\FlareClient\Support\ReportSanitizer;
 
 class Report
 {
@@ -57,6 +56,6 @@ public function toArray(): array
             $report['level'] = $this->level;
         }
 
-        return ReportSanitizer::sanitizePayload($report);
+        return $report;
     }
 }

src/Senders/AbstractSender.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Spatie\FlareClient\Senders;
+
+use Spatie\FlareClient\Senders\Support\JsonEncodableSanitizer;
+
+abstract class AbstractSender implements Sender
+{
+    protected bool $shouldSanitizePayloads;
+
+    /**
+     * @param  array<string,mixed>  $config
+     */
+    public function __construct(
+        protected array $config = [],
+        protected readonly PayloadSanitizer $sanitizer = new JsonEncodableSanitizer
+    ) {
+        $this->shouldSanitizePayloads = $this->config['sanitize_malformed_data'] ?? false;
+    }
+
+    /**
+     * Sanitizes the payload when applicable
+     *
+     * @template K of array-key
+     *
+     * @param  array<K,mixed>  $payload
+     * @return array<K,mixed>
+     */
+    protected function preparePayloadForEncoding(array $payload): array
+    {
+        if ($this->shouldSanitizePayloads) {
+            return $this->sanitizer->sanitize($payload);
+        }
+
+        return $payload;
+    }
+}

src/Senders/CurlSender.php

@@ -6,18 +6,22 @@
 use CurlHandle;
 use Spatie\FlareClient\Enums\FlarePayloadType;
 use Spatie\FlareClient\Senders\Exceptions\ConnectionError;
+use Spatie\FlareClient\Senders\Support\JsonEncodableSanitizer;
 use Spatie\FlareClient\Senders\Support\Response;
 
-class CurlSender implements Sender
+class CurlSender extends AbstractSender
 {
     protected int $timeout;
 
     /** @var array<int, mixed> */
     private array $curlOptions;
 
     public function __construct(
-        protected array $config = []
+        array $config = [],
+        PayloadSanitizer $sanitizer = new JsonEncodableSanitizer
     ) {
+        parent::__construct($config, $sanitizer);
+
         $this->timeout = $this->config['timeout'] ?? 10;
         $this->curlOptions = $this->config['curl_options'] ?? [];
     }
@@ -36,7 +40,9 @@ public function post(string $endpoint, string $apiToken, array $payload, FlarePa
 
         $curlHandle = $this->getCurlHandle($fullUrl, $headers);
 
-        $encoded = json_encode($payload);
+        $encoded = json_encode(
+            $this->preparePayloadForEncoding($payload)
+        );
 
         if (json_last_error() !== JSON_ERROR_NONE) {
             throw new ConnectionError('Invalid JSON payload provided');

src/Senders/GuzzleSender.php

@@ -5,15 +5,18 @@
 use Closure;
 use GuzzleHttp\Client;
 use Spatie\FlareClient\Enums\FlarePayloadType;
+use Spatie\FlareClient\Senders\Support\JsonEncodableSanitizer;
 use Spatie\FlareClient\Senders\Support\Response;
 
-class GuzzleSender implements Sender
+class GuzzleSender extends AbstractSender
 {
     protected Client $client;
 
     public function __construct(
-        protected array $config = []
+        array $config = [],
+        PayloadSanitizer $sanitizer = new JsonEncodableSanitizer
     ) {
+        parent::__construct($config, $sanitizer);
         $this->client = new Client($config);
     }
 
@@ -25,7 +28,7 @@ public function post(string $endpoint, string $apiToken, array $payload, FlarePa
                 'Content-Type' => 'application/json',
                 'x-api-token' => $apiToken,
             ],
-            'json' => $payload,
+            'json' => $this->preparePayloadForEncoding($payload),
         ]);
 
         $callback(new Response(

src/Senders/NullSender.php

@@ -6,7 +6,7 @@
 use Spatie\FlareClient\Enums\FlarePayloadType;
 use Spatie\FlareClient\Senders\Support\Response;
 
-class NullSender implements Sender
+class NullSender extends AbstractSender
 {
     public function post(string $endpoint, string $apiToken, array $payload, FlarePayloadType $type, Closure $callback): void
     {

src/Senders/PayloadSanitizer.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Spatie\FlareClient\Senders;
+
+interface PayloadSanitizer
+{
+    /**
+     * @template K of array-key
+     *
+     * @param  array<K,mixed>  $payload
+     * @return array<K,mixed>
+     */
+    public function sanitize(array $payload): array;
+}

src/Senders/Sender.php

@@ -9,7 +9,7 @@
 interface Sender
 {
     /**
-     * @param Closure(Response): void $callback
+     * @param  Closure(Response): void  $callback
      */
     public function post(
         string $endpoint,

src/Senders/Support/JsonEncodableSanitizer.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Spatie\FlareClient\Senders\Support;
+
+use JsonException;
+use Spatie\FlareClient\Senders\PayloadSanitizer;
+
+class JsonEncodableSanitizer implements PayloadSanitizer
+{
+    /**
+     * A prefix ensuing replaced values in sanitized payloads remain identifiable
+     */
+    const SANITIZED_PAYLOAD_ENTRY_REPLACEMENT_PREFIX = 'Spatie/Flare';
+
+    public function sanitize(array $payload): array
+    {
+        foreach ($payload as $key => $value) {
+            try {
+                json_encode($payload[$key], JSON_THROW_ON_ERROR);
+            } catch (JsonException $e) {
+                if (is_array($value)) {
+                    $payload[$key] = $this->sanitize($payload[$key]);
+
+                    continue;
+                }
+
+                $payload[$key] = $this->formattedReplacementMessage($value, $e->getMessage());
+            }
+
+        }
+
+        return $payload;
+    }
+
+    protected function formattedReplacementMessage(mixed $value, string $errorMessage): string
+    {
+        $valueInfo = is_string($value) ? strlen($value).' bytes' : gettype($value);
+
+        return sprintf(
+            '[%s Failed to encode]: %s - %s',
+            static::SANITIZED_PAYLOAD_ENTRY_REPLACEMENT_PREFIX,
+            $valueInfo,
+            $errorMessage
+        );
+    }
+}