no issue - introduce anonymizator Context, move salt into context

Author: pounard

CHANGELOG.md

@@ -3,6 +3,11 @@
 ## Next
 
 * [feature] 🌟 String pattern anonymizer, build complex strings by fetching values from other anonymizers.
+* [internal] introduce anonymizer context for carrying environment configuration to anonymizers (#235).
+* [bc] Salt in `AbstractAnonymizer::$option->get('salt')` in now in `AbstractAnonymizer::$context->salt` (#235).
+* [bc] `AbstractAnonymizer::__construct()` now expects an additional `$context` parameter (#235).
+* [bc] `Anonymizator::__construct()` `$salt` parameter was removed (#235).
+* [fix] Some minor PHP 8.4 deprecations.
 
 ## 2.0.3
 

src/Anonymization/Anonymizator.php

@@ -43,16 +43,17 @@ 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(),
+        ?Context $defaultContext = null,
     ) {
         $this->logger = new NullLogger();
         $this->output = new NullOutput();
+        $this->defaultContext = $defaultContext ?? new Context();
     }
 
     /**
@@ -73,14 +74,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();
     }
 
     /**
@@ -91,8 +88,7 @@ protected function createAnonymizer(AnonymizerConfig $config, Context $context):
         return $this->anonymizerRegistry->createAnonymizer(
             $config->anonymizer,
             $config,
-            // @todo "salt" should belong to context instead.
-            $context->withOptions($config->options->with(['salt' => $this->getSalt()])),
+            $context,
             $this->databaseSession
         );
     }

src/Anonymization/Anonymizer/AbstractAnonymizer.php

@@ -4,7 +4,6 @@
 
 namespace MakinaCorpus\DbToolsBundle\Anonymization\Anonymizer;
 
-use MakinaCorpus\DbToolsBundle\Anonymization\Anonymizator;
 use MakinaCorpus\QueryBuilder\DatabaseSession;
 use MakinaCorpus\QueryBuilder\Expression;
 use MakinaCorpus\QueryBuilder\ExpressionFactory;
@@ -18,30 +17,13 @@ abstract class AbstractAnonymizer
     public const JOIN_TABLE = '_target_table';
     public const TEMP_TABLE_PREFIX = '_db_tools_sample_';
 
-    /**
-     * @todo in 3.0 move this as a constructor-promoted property.
-     */
-    protected readonly Context $context;
-    protected readonly Options $options;
-
     final public function __construct(
         protected string $tableName,
         protected string $columnName,
         protected DatabaseSession $databaseSession,
-        /**
-         * @todo In 3.0, Options will be replaced with Context instead.
-         */
-        Options $options,
+        protected readonly Context $context,
+        protected readonly Options $options,
     ) {
-        if ($options instanceof Context) {
-            $this->context = $options;
-            $this->options = $options->options;
-        } 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->validateOptions();
     }
 
@@ -95,9 +77,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/AnonymizerRegistry.php

@@ -67,12 +67,12 @@ public function getAllAnonymizerMetadata(): array
     public function createAnonymizer(
         string $name,
         AnonymizerConfig $config,
-        Options $options,
+        Context $context,
         DatabaseSession $databaseSession,
     ): AbstractAnonymizer {
         $className = $this->getAnonymizerClass($name);
 
-        $ret = new $className($config->table, $config->targetName, $databaseSession, $options);
+        $ret = new $className($config->table, $config->targetName, $databaseSession, $context, $config->options);
         \assert($ret instanceof AbstractAnonymizer);
 
         if ($ret instanceof WithAnonymizerRegistry) {

src/Anonymization/Anonymizer/Context.php

@@ -4,108 +4,18 @@
 
 namespace MakinaCorpus\DbToolsBundle\Anonymization\Anonymizer;
 
-/**
- * @todo
- *   Remove "extends Options" in 3.0. Change AbstractAnonymizer::__construct() signature accordingly.
- */
-class Context extends Options
+class Context
 {
-    public function __construct(
-        public Options $options = new Options(),
-    ) {}
-
-    public function withOptions(Options $options): Context
-    {
-        return new self($options);
-    }
-
-    #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]
-    private function throwOptionsDeprecation(string $method): never
-    {
-        throw new \LogicException(\sprintf("Calling %s::%s() is forbidden, this method only exists for backward compatibility purpose..", static::class, $method));
-    }
-
-    #[\Override]
-    #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]
-    public function has(string $name): bool
-    {
-        $this->throwOptionsDeprecation(__METHOD__);
-    }
+    public readonly string $salt;
 
-    #[\Override]
-    #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]
-    public function get(string $name, mixed $default = null, bool $required = false): mixed
-    {
-        $this->throwOptionsDeprecation(__METHOD__);
-    }
-
-    #[\Override]
-    #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]
-    public function all(): array
-    {
-        $this->throwOptionsDeprecation(__METHOD__);
-    }
-
-    #[\Override]
-    #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]
-    public function count(): int
-    {
-        $this->throwOptionsDeprecation(__METHOD__);
-    }
-
-    #[\Override]
-    #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]
-    public function with(array $options): Options
-    {
-        $this->throwOptionsDeprecation(__METHOD__);
-    }
-
-    #[\Override]
-    #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]
-    public function toDisplayString(): string
-    {
-        $this->throwOptionsDeprecation(__METHOD__);
-    }
-
-    #[\Override]
-    #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]
-    public function getString(string $name, ?string $default = null, bool $required = false): ?string
-    {
-        $this->throwOptionsDeprecation(__METHOD__);
-    }
-
-    #[\Override]
-    #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]
-    public function getBool(string $name, ?bool $default = null, bool $required = false): ?bool
-    {
-        $this->throwOptionsDeprecation(__METHOD__);
-    }
-
-    #[\Override]
-    #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]
-    public function getInt(string $name, ?int $default = null, bool $required = false): ?int
-    {
-        $this->throwOptionsDeprecation(__METHOD__);
-    }
-
-    #[\Override]
-    #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]
-    public function getFloat(string $name, ?float $default = null, bool $required = false): ?float
-    {
-        $this->throwOptionsDeprecation(__METHOD__);
-    }
-
-    #[\Override]
-    #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]
-    public function getDate(string $name, ?\DateTimeImmutable $default = null, bool $required = false): ?\DateTimeImmutable
-    {
-        $this->throwOptionsDeprecation(__METHOD__);
+    public function __construct(
+        ?string $salt = null,
+    ) {
+        $this->salt = $salt ?? self::generateRandomSalt();
     }
 
-    #[\Override]
-    #[\Deprecated(message: "Only exists for class signature backward compatibility.", since: "2.1.0")]
-    public function getInterval(string $name, ?\DateInterval $default = null, bool $required = false): ?\DateInterval
+    public static function generateRandomSalt(): string
     {
-        $this->throwOptionsDeprecation(__METHOD__);
+        return \base64_encode(\random_bytes(12));
     }
 }

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.

src/Anonymization/Anonymizer/Core/StringPatternAnonymizer.php

@@ -192,14 +192,14 @@ private function getAnonymizer(string $anonymizer, ?Options $options = null, int
             return $ret;
         }
 
-        $config = new AnonymizerConfig($this->tableName, $this->columnName, $anonymizer, new Options());
+        $config = new AnonymizerConfig($this->tableName, $this->columnName, $anonymizer, $options ?? new Options());
 
         return $this->childAnonymizers[$key] = $this
             ->getAnonymizerRegistry()
             ->createAnonymizer(
                 $anonymizer,
                 $config,
-                $options ?? new Options(),
+                $this->context,
                 $this->databaseSession
             )
         ;

tests/Unit/Anonymization/Anonymizer/AbstractMultipleColumnAnonymizerTest.php

@@ -5,6 +5,7 @@
 namespace MakinaCorpus\DbToolsBundle\Tests\Unit\Anonymization\Anonymizer;
 
 use MakinaCorpus\DbToolsBundle\Anonymization\Anonymizer\AbstractMultipleColumnAnonymizer;
+use MakinaCorpus\DbToolsBundle\Anonymization\Anonymizer\Context;
 use MakinaCorpus\DbToolsBundle\Anonymization\Anonymizer\Options;
 use MakinaCorpus\DbToolsBundle\Attribute\AsAnonymizer;
 use MakinaCorpus\DbToolsBundle\Test\UnitTestCase;
@@ -17,6 +18,7 @@ public function testValidateOptionsOkWithAllColumnOption(): void
             'some_table',
             'some_column',
             $this->getDatabaseSession(),
+            new Context(),
             new Options([
                 'column_1' => 'actual_column_1',
                 'column_2' => 'actual_column_2',
@@ -32,6 +34,7 @@ public function testValidateOptionsOkWithSomeColumnOption(): void
             'some_table',
             'some_column',
             $this->getDatabaseSession(),
+            new Context(),
             new Options([
                 'column_2' => 'actual_column_2',
             ]),
@@ -48,7 +51,8 @@ public function testValidateOptionsKoWithNoOption(): void
             'some_table',
             'some_column',
             $this->getDatabaseSession(),
-            new Options([]),
+            new Context(),
+            new Options(),
         );
     }
 
@@ -60,6 +64,7 @@ public function testValidateOptionsKoWithColumnMapedTwice(): void
             'some_table',
             'some_column',
             $this->getDatabaseSession(),
+            new Context(),
             new Options([
                 'column_1' => 'actual_column_1',
                 'column_2' => 'actual_column_1',

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

@@ -4,6 +4,7 @@
 
 namespace MakinaCorpus\DbToolsBundle\Tests\Unit\Anonymization\Anonymizer\Core;
 
+use MakinaCorpus\DbToolsBundle\Anonymization\Anonymizer\Context;
 use MakinaCorpus\DbToolsBundle\Anonymization\Anonymizer\Core\ConstantAnonymizer;
 use MakinaCorpus\DbToolsBundle\Anonymization\Anonymizer\Options;
 use MakinaCorpus\DbToolsBundle\Test\UnitTestCase;
@@ -16,6 +17,7 @@ public function testValidateOptionsOkWithValueOption(): void
             'some_table',
             'some_column',
             $this->getDatabaseSession(),
+            new Context(),
             new Options([
                 'value' => 'test',
             ]),
@@ -32,6 +34,7 @@ public function testValidateOptionsKoWithValueOption(): void
             'some_table',
             'some_column',
             $this->getDatabaseSession(),
+            new Context(),
             new Options([]),
         );
     }