no issue - introduce anonymizator Context, move salt into context

Author: pounard

src/Anonymization/Anonymizator.php

@@ -43,16 +43,22 @@ class Anonymizator implements LoggerAwareInterface
     ];
 
     private OutputInterface $output;
+    private readonly Context $defaultContext;
 
     public function __construct(
         private DatabaseSession $databaseSession,
         private AnonymizerRegistry $anonymizerRegistry,
         private AnonymizationConfig $anonymizationConfig,
-        private ?string $salt = null,
-        private readonly Context $defaultContext = new Context(),
+        ?string $salt = null,
+        ?Context $defaultContext = null,
     ) {
         $this->logger = new NullLogger();
         $this->output = new NullOutput();
+
+        if ($salt) {
+            \trigger_deprecation('makinacorpus/db-tools-bundle', '2.1.0', \sprintf("%s::__construct() '\$salt' will be removed in 3.0, use %s class to pass a salt.", static::class, Context::class));
+        }
+        $this->defaultContext = $defaultContext ?? new Context($salt);
     }
 
     /**
@@ -73,14 +79,10 @@ public function setOutput(OutputInterface $output): self
         return $this;
     }
 
+    #[\Deprecated(message: "Will be removed in 3.0, use Context::generateRandomSalt() instead.", since: "2.1.0")]
     public static function generateRandomSalt(): string
     {
-        return \base64_encode(\random_bytes(12));
-    }
-
-    protected function getSalt(): string
-    {
-        return $this->salt ??= self::generateRandomSalt();
+        return Context::generateRandomSalt();
     }
 
     /**
@@ -92,7 +94,7 @@ protected function createAnonymizer(AnonymizerConfig $config, Context $context):
             $config->anonymizer,
             $config,
             // @todo "salt" should belong to context instead.
-            $context->withOptions($config->options->with(['salt' => $this->getSalt()])),
+            $context->withOptions($config->options),
             $this->databaseSession
         );
     }

src/Anonymization/Anonymizer/AbstractAnonymizer.php

@@ -35,11 +35,11 @@ final public function __construct(
     ) {
         if ($options instanceof Context) {
             $this->context = $options;
-            $this->options = $options->options;
+            $this->options = $options->options->with(['salt' => $options->salt]);
         } else {
             \trigger_deprecation('makinacorpus/db-tools-bundle', '2.1.0', \sprintf("%s::__construct() 'Options \$options' will be changed to 'Context \$context' in 3.0", static::class));
             $this->options = $options;
-            $this->context = new Context($options);
+            $this->context = new Context(salt: $options->getString('salt'));
         }
 
         $this->validateOptions();
@@ -95,9 +95,10 @@ protected function getJoinColumn(): Expression
     /**
      * Get a random, global salt for anonymizing hashed values.
      */
+    #[\Deprecated(message: "Will be removed in 3.0, use \$this->context->salt instead.", since: "2.1.0")]
     protected function getSalt(): string
     {
-        return $this->options->get('salt') ?? Anonymizator::generateRandomSalt();
+        return $this->context->salt;
     }
 
     /**

src/Anonymization/Anonymizer/Context.php

@@ -10,13 +10,26 @@
  */
 class Context extends Options
 {
+    public readonly string $salt;
+
     public function __construct(
+        ?string $salt = null,
+        /**
+         * @todo Remove this in 3.0.
+         */
         public Options $options = new Options(),
-    ) {}
+    ) {
+        $this->salt = $salt ?? self::generateRandomSalt();
+    }
+
+    public static function generateRandomSalt(): string
+    {
+        return \base64_encode(\random_bytes(12));
+    }
 
     public function withOptions(Options $options): Context
     {
-        return new self($options);
+        return new self($this->salt, $options);
     }
 
     #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]

src/Anonymization/Anonymizer/Core/EmailAnonymizer.php

@@ -38,7 +38,7 @@ public function createAnonymizeExpression(Update $update): Expression
             $userExpr = $expr->column($this->columnName, $this->tableName);
 
             if ($this->options->getBool('use_salt', true)) {
-                $userExpr = $expr->concat($userExpr, $expr->value($this->getSalt()));
+                $userExpr = $expr->concat($userExpr, $expr->value($this->context->salt));
             }
 
             $emailHashExpr = $expr->md5($userExpr);

src/Anonymization/Anonymizer/Core/Md5Anonymizer.php

@@ -27,7 +27,7 @@ public function createAnonymizeExpression(Update $update): Expression
         $columnExpr = $expr->column($this->columnName, $this->tableName);
 
         if ($this->options->get('use_salt', true)) {
-            $columnExpr = $expr->concat($columnExpr, $expr->value($this->getSalt()));
+            $columnExpr = $expr->concat($columnExpr, $expr->value($this->context->salt));
 
             // Work around some RDBMS not seeing the NULL value anymore
             // once we added the string concat.

tests/Unit/Anonymization/Anonymizer/Core/EmailAnonymizerTest.php

@@ -4,8 +4,9 @@
 
 namespace MakinaCorpus\DbToolsBundle\Tests\Unit\Anonymization\Anonymizer\Core;
 
-use MakinaCorpus\DbToolsBundle\Anonymization\Anonymizer\Options;
+use MakinaCorpus\DbToolsBundle\Anonymization\Anonymizer\Context;
 use MakinaCorpus\DbToolsBundle\Anonymization\Anonymizer\Core\EmailAnonymizer;
+use MakinaCorpus\DbToolsBundle\Anonymization\Anonymizer\Options;
 use MakinaCorpus\DbToolsBundle\Test\UnitTestCase;
 
 class EmailAnonymizerTest extends UnitTestCase
@@ -86,9 +87,9 @@ public function testAnonymizeWithDefaultDomain(): void
             'some_table',
             'email',
             $this->getDatabaseSession(),
-            new Options([
-                'salt' => 'my_salt',
-            ])
+            new Context(
+                salt: 'my_salt',
+            ),
         );
 
         $instance->anonymize($update);
@@ -121,10 +122,12 @@ public function testAnonymize(): void
             'some_table',
             'email',
             $this->getDatabaseSession(),
-            new Options([
-                'domain' => 'makina-corpus.com',
-                'salt' => 'my_salt',
-            ]),
+            new Context(
+                salt: 'my_salt',
+                options: new Options([
+                    'domain' => 'makina-corpus.com',
+                ]),
+            ),
         );
 
         $instance->anonymize($update);