Merge pull request #36 from synolia/bugfix/disable-maintenance-file-w…

…ithout-removing-it

fix: keep maintenance file alive when maintenance mode is disabled

README.md

@@ -89,6 +89,11 @@
       php bin/console maintenance:disable
       ```
 
+  4. Remove configuration file using CLI
+
+  By default, **maintenance.yaml** configuration file remains when running `maintenance:disable` or via admin panel using toggle disable
+  Nevertheless passing option `[-c|--clear]` to command line above will reset previous saved configuration
+
 ### You can also turn your website under maintenance in Back Office :     
 
 - Enable/disable the plugin

src/Command/DisableMaintenanceCommand.php

@@ -6,9 +6,12 @@
 
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Contracts\Cache\CacheInterface;
 use Symfony\Contracts\Translation\TranslatorInterface;
+use Synolia\SyliusMaintenancePlugin\Exporter\MaintenanceConfigurationExporter;
+use Synolia\SyliusMaintenancePlugin\Factory\MaintenanceConfigurationFactory;
 use Synolia\SyliusMaintenancePlugin\FileManager\ConfigurationFileManager;
 
 final class DisableMaintenanceCommand extends Command
@@ -19,22 +22,34 @@ public function __construct(
         private ConfigurationFileManager $configurationFileManager,
         private TranslatorInterface $translator,
         private CacheInterface $synoliaMaintenanceCache,
+        private MaintenanceConfigurationFactory $configurationFactory,
+        private MaintenanceConfigurationExporter $configurationExporter,
     ) {
         parent::__construct();
     }
 
     protected function configure(): void
     {
         $this
-            ->setDescription('Deactivate maintenance plugin')
-            ->setHelp('This command allows you to delete the maintenance.yaml')
+            ->setDescription('Disable maintenance plugin')
+            ->addOption('clear', 'c', InputOption::VALUE_NONE, 'Reset maintenance mode')
+            ->setHelp('This command allows you to disable or delete the maintenance.yaml')
         ;
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $this->configurationFileManager->deleteMaintenanceFile();
         $this->synoliaMaintenanceCache->delete(ConfigurationFileManager::MAINTENANCE_CACHE_KEY);
+        $maintenanceConfig = $this->configurationFactory->get();
+        $maintenanceConfig->setEnabled(false);
+        $this->configurationExporter->export($maintenanceConfig);
+
+        if (true === $input->getOption('clear')) {
+            $this->configurationFileManager->deleteMaintenanceFile();
+            $output->writeln($this->translator->trans('maintenance.ui.message_reset'));
+
+            return 0;
+        }
 
         $output->writeln($this->translator->trans('maintenance.ui.message_disabled'));
 

src/Exporter/MaintenanceConfigurationExporter.php

@@ -15,10 +15,6 @@ public function __construct(private ConfigurationFileManager $configurationFileM
 
     public function export(MaintenanceConfiguration $configuration): void
     {
-        $this->configurationFileManager->deleteMaintenanceFile();
-        if (!$configuration->isEnabled()) {
-            return;
-        }
         $dataToExport = [];
 
         $ipAddresses = $configuration->getArrayIpsAddresses();
@@ -40,6 +36,7 @@ public function export(MaintenanceConfiguration $configuration): void
         if ($configuration->allowBots()) {
             $dataToExport['allow_bots'] = true;
         }
+        $dataToExport['enabled'] = $configuration->isEnabled();
         $scheduler = $this->getSchedulerArray($configuration->getStartDate(), $configuration->getEndDate());
 
         $this->configurationFileManager->createMaintenanceFile(array_merge(

src/Factory/MaintenanceConfigurationFactory.php

@@ -46,6 +46,7 @@ public static function map(MaintenanceConfiguration $maintenanceConfiguration, ?
             'custom_message' => '',
             'token' => '',
             'allow_bots' => false,
+            'enabled' => true,
         ]);
         $options = $resolver->resolve($options);
 
@@ -67,6 +68,7 @@ public static function map(MaintenanceConfiguration $maintenanceConfiguration, ?
             ->setCustomMessage($options['custom_message'])
             ->setToken($options['token'])
             ->setAllowBots($options['allow_bots'])
+            ->setEnabled($options['enabled'])
         ;
     }
 }

src/Resources/translations/messages.en.yml

@@ -18,6 +18,7 @@ maintenance:
             allow_bots: Grant access to search bots during maintenance
         message_enabled: The maintenance plugin was successfully enabled.
         message_disabled: The maintenance plugin was successfully disabled.
+        message_reset: The maintenance plugin was successfully reset.
         message_success_ips: The ips were added to the file maintenance.yaml successfully.
         message_error_ips: An error occurred while adding ips addresses. Add one or multiple ips addresses separated with a comma.
         message_disabled_404: The plugin is disabled.

src/Resources/translations/messages.fr.yml

@@ -18,6 +18,7 @@ maintenance:
             allow_bots: Accorder l'accès aux robots de recherche pendant la maintenance
         message_enabled: Le plugin de maintenance a été activé avec succès.
         message_disabled: Le plugin de maintenance a été désactivé avec succès.
+        message_reset: Le plugin de maintenance a été réinitialisé avec succès.
         message_success_ips: Les adresses ip ont été ajoutés au fichier maintenance.yaml avec succès.
         message_error_ips: Une erreur s'est produite lors de l'ajout d'adresses ip. Ajouter une ou plusieurs adresses ip séparées par une virgule.
         message_disabled_404: Le plugin est désactivé.

tests/PHPUnit/MaintenanceNotEnabledTest.php

@@ -4,10 +4,24 @@
 
 namespace Tests\Synolia\SyliusMaintenancePlugin\PHPUnit;
 
+use Symfony\Component\Yaml\Yaml;
+
 final class MaintenanceNotEnabledTest extends AbstractWebTestCase
 {
-    public function testMaintenanceIsNotEnabled(): void
+    public function testMaintenanceIsNotEnabledWhenFileDoesNotExist(): void
+    {
+        self::$client->request('GET', '/en_US/');
+        $this->assertSiteIsUp();
+    }
+
+    public function testMaintenanceIsNotEnabledWhenFileIsNotEnabled(): void
     {
+        \file_put_contents(
+            $this->file,
+            Yaml::dump([
+                'enabled' => false,
+            ]),
+        );
         self::$client->request('GET', '/en_US/');
         $this->assertSiteIsUp();
     }