feat(env-var): Deprecate EnvVarEncryptedProcessor service and Encrypt…

…Command command
ekino · Jul 3, 2020 · a2db82a · a2db82a
1 parent ad86f0b
commit a2db82a
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 master
 ------
 
+* Deprecate EnvVarEncryptedProcessor and EncryptCommand
 * Improve message in case of encryption error
 * Add command to encrypt secrets
 * Drop support for PHP 7.1

diff --git a/Command/EncryptCommand.php b/Command/EncryptCommand.php
@@ -19,10 +19,18 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+@trigger_error(
+    'The '.__NAMESPACE__.'\EncryptCommand class is deprecated, use symfony secrets management commands instead',
+    E_USER_DEPRECATED
+);
+
 /**
  * Class EncryptCommand
  *
  * @author Christian Kollross <christian.kollross@ekino.com>
+ *
+ * @deprecated use symfony secrets management commands instead.
+ * @see https://github.com/symfony/symfony/pull/33997
  */
 final class EncryptCommand extends Command
 {

diff --git a/DependencyInjection/EkinoDataProtectionExtension.php b/DependencyInjection/EkinoDataProtectionExtension.php
@@ -60,11 +60,17 @@ private function configureEncryptor(array $config, ContainerBuilder $container):
     }
 
     /**
+     * @deprecated
      * @param array            $config
      * @param ContainerBuilder $container
      */
     private function configureEncryptCommand(array $config, ContainerBuilder $container): void
     {
+        @trigger_error(
+            'The '.__METHOD__.' method is deprecated command will be removed, use symfony secret management commands instead.',
+            E_USER_DEPRECATED
+        );
+
         $container
             ->findDefinition('ekino_data_protection.command.encryptor')
             ->replaceArgument(0, $config['method'])

diff --git a/DependencyInjection/EnvVarEncryptedProcessor.php b/DependencyInjection/EnvVarEncryptedProcessor.php
@@ -17,8 +17,16 @@
 use Symfony\Component\DependencyInjection\EnvVarProcessorInterface;
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 
+@trigger_error(
+    'The '.__NAMESPACE__.'\EnvVarEncryptedProcessor class is deprecated, use symfony secrets management instead',
+    E_USER_DEPRECATED
+);
+
 /**
  * @author Rémi Marseille <remi.marseille@ekino.com>
+ *
+ * @deprecated use symfony secrets instead.
+ * @see https://github.com/symfony/symfony/pull/33997
  */
 final class EnvVarEncryptedProcessor implements EnvVarProcessorInterface
 {

diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -18,12 +18,14 @@
             <argument />
             <argument />
             <tag name="console.command" command="ekino-data-protection:encrypt"/>
+            <deprecated>The "%service_id%" service is deprecated, use symfony secrets management commands instead</deprecated>
         </service>
 
         <service id="ekino_data_protection.dependency_injection.env_var_encrypted_processor" class="Ekino\DataProtectionBundle\DependencyInjection\EnvVarEncryptedProcessor" public="false">
             <argument type="service" id="ekino_data_protection.encryptor" />
 
             <tag name="container.env_var_processor" />
+            <deprecated>The "%service_id%" service is deprecated, use symfony secrets management instead</deprecated>
         </service>
 
         <service id="ekino_data_protection.monolog.processor.gdpr" class="Ekino\DataProtectionBundle\Monolog\Processor\GdprProcessor" public="false">

diff --git a/Tests/Command/EncryptCommandTest.php b/Tests/Command/EncryptCommandTest.php
@@ -20,10 +20,17 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+@trigger_error(
+    'The '.__NAMESPACE__.'\EncryptCommandTest class is deprecated since command is deprecated',
+    E_USER_DEPRECATED
+);
+
 /**
  * Class EncryptCommandTest
  *
  * @author Christian Kollross <christian.kollross@ekino.com>
+ *
+ * @deprecated since EncryptCommand class is deprecated.
  */
 class EncryptCommandTest extends TestCase
 {