Implement a replacement filter to cleanup private data in responses

Author: Olivier MICHAUD

src/Recorder/FilesystemRecorder.php

@@ -4,7 +4,7 @@
 
 namespace Http\Client\Plugin\Vcr\Recorder;
 
-use GuzzleHttp\Psr7;
+use GuzzleHttp\Psr7\Message;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
@@ -31,7 +31,12 @@ final class FilesystemRecorder implements RecorderInterface, PlayerInterface, Lo
      */
     private $filesystem;
 
-    public function __construct(string $directory, ?Filesystem $filesystem = null)
+    /**
+     * @var array
+     */
+    private $filters;
+
+    public function __construct(string $directory, ?Filesystem $filesystem = null,array $filters=[])
     {
         $this->filesystem = $filesystem ?? new Filesystem();
 
@@ -44,6 +49,7 @@ public function __construct(string $directory, ?Filesystem $filesystem = null)
         }
 
         $this->directory = realpath($directory).\DIRECTORY_SEPARATOR;
+        $this->filters = $filters;
     }
 
     public function replay(string $name): ?ResponseInterface
@@ -59,15 +65,19 @@ public function replay(string $name): ?ResponseInterface
 
         $this->log('Response replayed from {filename}', $context);
 
-        return Psr7\parse_response(file_get_contents($filename));
+        return Message::parseResponse(file_get_contents($filename));
     }
 
     public function record(string $name, ResponseInterface $response): void
     {
         $filename = "{$this->directory}$name.txt";
         $context = compact('name', 'filename');
 
-        $this->filesystem->dumpFile($filename, Psr7\str($response));
+        $content = Message::toString($response);
+        foreach ($this->filters as $regularExpression => $replacement) {
+            $content = preg_replace($regularExpression, $replacement, $content);
+        }
+        $this->filesystem->dumpFile($filename, $content);
 
         $this->log('Response for {name} stored into {filename}', $context);
     }

tests/Recorder/FilesystemRecorderTest.php

@@ -56,4 +56,27 @@ public function testRecord(): void
         $this->assertSame($original->getHeaders(), $replayed->getHeaders());
         $this->assertSame((string) $original->getBody(), (string) $replayed->getBody());
     }
+
+    public function testRecordWithFilter(): void
+    {
+        $original = new Response(200, ['X-Foo' => 'Bar', 'X-Bar' => 'private-token-065a1bb33f000032ab'], 'The content');
+
+        $recorder = new FilesystemRecorder($this->workspace, $this->filesystem, [
+            '!private-token-[0-9a-z]+!' => 'private-token-xxxx',
+            '!The content!' => 'The big content',
+        ]);
+        $recorder->record('my_awesome_response', $original);
+
+        $this->assertFileExists(sprintf('%s%smy_awesome_response.txt', $this->workspace, \DIRECTORY_SEPARATOR));
+
+        $replayed = (new FilesystemRecorder($this->workspace))->replay('my_awesome_response');
+
+        $this->assertNotNull($replayed, 'Response should not be null');
+
+        $this->assertSame($original->getStatusCode(), $replayed->getStatusCode());
+        $expectedHeaders = $original->getHeaders();
+        $expectedHeaders['X-Bar'] = ['private-token-xxxx'];
+        $this->assertSame($expectedHeaders, $replayed->getHeaders());
+        $this->assertSame('The big content', (string) $replayed->getBody());
+    }
 }