Refacto config files

.github/workflows/upgrade-cli.yml

@@ -93,10 +93,10 @@ jobs:
             \"channel\":\"${{ matrix.UPGRADE_CHANNEL }}\",
             \"archive_zip\":\"prestashop_${{ matrix.PS_VERSION_END }}.zip\",
             \"archive_xml\":\"prestashop_${{ matrix.PS_VERSION_END }}.xml\",
-            \"PS_AUTOUP_CUSTOM_MOD_DESACT\":\"true\",
+            \"disable_non_native_modules\":\"true\",
             \"PS_AUTOUP_CHANGE_DEFAULT_THEME\":\"false\",
-            \"PS_AUTOUP_KEEP_IMAGES\":\"true\",
-            \"PS_DISABLE_OVERRIDES\":\"true\"
+            \"keep_images\":\"true\",
+            \"disable_overrides\":\"true\"
           }' > modules/autoupgrade/config.json"
 
       - name: Update online

README.md

@@ -147,11 +147,11 @@ Here is an example of the different fields that can be found in it:
   "channel": "local",
   "archive_zip": "prestashop_8.0.0.zip",
   "archive_xml": "prestashop_8.0.0.xml",
-  "PS_AUTOUP_CUSTOM_MOD_DESACT": 1,
+  "disable_non_native_modules": 1,
   "PS_AUTOUP_CHANGE_DEFAULT_THEME": 0,
-  "PS_AUTOUP_REGEN_EMAIL": 1,
-  "PS_AUTOUP_KEEP_IMAGES": 1,
-  "PS_DISABLE_OVERRIDES": 1
+  "regenerate_email_templates": 1,
+  "keep_images": 1,
+  "disable_overrides": 1
 }
 ```
 
@@ -200,22 +200,26 @@ When using the command line interface (CLI), you can configure the module's beha
 parameters directly via CLI. Below is a detailed description of the available parameters, including their data types and
 impact.
 
-| Command                                     | Configuration file key                        | CLI option                     | Possible Values                                                                         | Description                                                                                                                                   |
-|---------------------------------------------|-----------------------------------------------|--------------------------------|-----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
-| `update:start`                              | `channel`                                     | `--channel`                    | `online`, `online_recommended` (default), `local`                                       | Defines the update channel to use. The `local` channel requires specific files to be placed in the download folder.                           |
-| `update:start`                              | `chain`                                       | `--chain`                      | `true` (default), `false`, `'true'`, `'false'`, `'1'`, `'0'`, `1`, `0`, `'on'`, `'off'` | True by default. Allows you to chain update commands automatically. The command will continue executing subsequent tasks without requiring manual intervention to restart the process. |
-| `update:start`, `update:check-requirements` | `archive_zip`                                 | `--zip`                        | Valid file name                                                                         | Name of the `ZIP` file to use for an update via the archive channel. This file must be placed in `[your-admin-dir]/autoupgrade/download`.     |
-| `update:start`, `update:check-requirements` | `archive_xml`                                 | `--xml`                        | Valid file name                                                                         | Name of the `XML` file corresponding to the ZIP file for the archive channel. Must also be placed in `[your-admin-dir]/autoupgrade/download`. |
-| `update:start`                              | `PS_AUTOUP_CUSTOM_MOD_DESACT`                 | `--disable-non-native-modules` | `true` (default), `false`, `'true'`, `'false'`, `'1'`, `'0'`, `1`, `0`, `'on'`, `'off'` | If enabled, disables all non-native modules before the update, reducing the risk of compatibility issues.                                     |
-| `update:start`                              | (DEPRECATED) `PS_AUTOUP_CHANGE_DEFAULT_THEME` | no option available            | `true`, `false` (default), `'true'`, `'false'`, `'1'`, `'0'`, `1`, `0`, `'on'`, `'off'` | If enabled, forces the use of the default PrestaShop theme after the update. If disabled, retains the current theme.                          |
-| `update:start`                              | `PS_AUTOUP_REGEN_EMAIL`                       | `--regenerate-email-templates` | `true` (default), `false`, `'true'`, `'false'`, `'1'`, `'0'`, `1`, `0`, `'on'`, `'off'` | If enabled, keeps the store's customized email templates. Otherwise, the templates are replaced with the default ones.                        |
-| `update:start`                              | `PS_DISABLE_OVERRIDES`                        | `--disable-all-overrides`      | `true` (default), `false`, `'true'`, `'false'`, `'1'`, `'0'`, `1`, `0`, `'on'`, `'off'` | If enabled, disables all PHP overrides in PrestaShop, ensuring better compatibility during the update process.                                |
-| `backup:create`                             | `PS_AUTOUP_KEEP_IMAGES`                       | `--include-images`             | `true` (default), `false`, `'true'`, `'false'`, `'1'`, `'0'`, `1`, `0`, `'on'`, `'off'` | If enabled, retains all images in the backup. This operation can take a long time depending on the storage of your images                     |
-| `backup:restore`                            | no option available                           | `--backup`                     | Valid file name                                                                         | Specify the backup name to restore. The allowed values can be found with backup:list command)                                                 |
-| `backup:delete`                             | no option available                           | `--backup`                     | Valid file name                                                                         | Specify the backup name to delete. The allowed values can be found with backup:list command)                                                  |
-| `update:check-modules`                      | no option available                           | `--channel`                    | `online`, `online_recommended` (default), `local`                                       | Selects the update channel for module compatibility checks. The `local` channel requires specific files to be placed in the download folder.  |
-| `update:check-modules`                      | no option available                           | `--zip`                        | Valid file name                                                                         | Sets the ZIP archive in local mode for module checking.                                                                                       |
-|                                             |                                               |                                |                                                                                         |                                                                                                                                               |
+| Command                                     | Configuration file key                        | CLI option                          | Possible Values                                                                         | Description                                                                                                                                                                            |
+|---------------------------------------------|-----------------------------------------------|-------------------------------------|-----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `update:start`                              | `channel`                                     | `--channel`                         | `online`, `online_recommended` (default), `local`                                       | Defines the update channel to use. The `local` channel requires specific files to be placed in the download folder.                                                                    |
+| `update:start`                              | `chain`                                       | `--chain`                           | `true` (default), `false`, `'true'`, `'false'`, `'1'`, `'0'`, `1`, `0`, `'on'`, `'off'` | True by default. Allows you to chain update commands automatically. The command will continue executing subsequent tasks without requiring manual intervention to restart the process. |
+| `update:start`, `update:check-requirements` | `archive_zip`                                 | `--zip`                             | Valid file name                                                                         | Name of the `ZIP` file to use for an update via the archive channel. This file must be placed in `[your-admin-dir]/autoupgrade/download`.                                              |
+| `update:start`, `update:check-requirements` | `archive_xml`                                 | `--xml`                             | Valid file name                                                                         | Name of the `XML` file corresponding to the ZIP file for the archive channel. Must also be placed in `[your-admin-dir]/autoupgrade/download`.                                          |
+| `update:start`                              | `disable_non_native_modules`                  | `--disable-non-native-modules`      | `true` (default), `false`, `'true'`, `'false'`, `'1'`, `'0'`, `1`, `0`, `'on'`, `'off'` | If enabled, disables all non-native modules before the update, reducing the risk of compatibility issues.                                                                              |
+| `update:start`                              | (DEPRECATED) `PS_AUTOUP_CHANGE_DEFAULT_THEME` | no option available                 | `true`, `false` (default), `'true'`, `'false'`, `'1'`, `'0'`, `1`, `0`, `'on'`, `'off'` | If enabled, forces the use of the default PrestaShop theme after the update. If disabled, retains the current theme.                                                                   |
+| `update:start`                              | `regenerate_email_templates`                  | `--regenerate-email-templates`      | `true` (default), `false`, `'true'`, `'false'`, `'1'`, `'0'`, `1`, `0`, `'on'`, `'off'` | If enabled, keeps the store's customized email templates. Otherwise, the templates are replaced with the default ones.                                                                 |
+| `update:start`                              | `disable_overrides`                           | `--disable-all-overrides`           | `true` (default), `false`, `'true'`, `'false'`, `'1'`, `'0'`, `1`, `0`, `'on'`, `'off'` | If enabled, disables all PHP overrides in PrestaShop, ensuring better compatibility during the update process.                                                                         |
+| `update:start`, `backup:create`             | `max_files_per_batch`                         | `--max-files-per-batch`             | `400`                                                                                   | Number of files to handle in a single call to avoid timeouts                                                                                                                           |
+| `backup:create`                             | `keep_images`                                 | `--include-images`                  | `true` (default), `false`, `'true'`, `'false'`, `'1'`, `'0'`, `1`, `0`, `'on'`, `'off'` | If enabled, retains all images in the backup. This operation can take a long time depending on the storage of your images                                                              |
+| `backup:create`                             | `max_file_size_allowed`                       | `--max-file-size-allowed`           | `15728640`                                                                              | Max file size allowed in backup                                                                                                                                                        |
+| `backup:create`                             | `max_sql_size_to_write_per_batch`             | `--max-sql-size-to-write-per-batch` | `4194304`                                                                               | Reference for SQL file creation, giving a file size before another request is needed                                                                                                   |
+| `backup:restore`                            | `backup_name`                                 | `--backup`                          | Valid file name                                                                         | Specify the backup name to restore. The allowed values can be found with backup:list command)                                                                                          |
+| `backup:restore`                            | `max_seconds_per_batch`                       | `--max-seconds-per-batch`           | `6`                                                                                     | Number of seconds allowed before having to make another request                                                                                                                        |
+| `backup:delete`                             | no option available                           | `--backup`                          | Valid file name                                                                         | Specify the backup name to delete. The allowed values can be found with backup:list command)                                                                                           |
+| `update:check-modules`                      | no option available                           | `--channel`                         | `online`, `online_recommended` (default), `local`                                       | Selects the update channel for module compatibility checks. The `local` channel requires specific files to be placed in the download folder.                                           |
+| `update:check-modules`                      | no option available                           | `--zip`                             | Valid file name                                                                         | Sets the ZIP archive in local mode for module checking.                                                                                                                                |
+|                                             |                                               |                                     |                                                                                         |                                                                                                                                                                                        |
 
 ### Back Office Environment Variables
 

_dev/src/ts/appUI/dialogs/StartBackupDialog.ts

@@ -48,7 +48,7 @@ export default class StartBackupDialog extends DialogAbstract {
     await api.post(form.dataset.routeToSubmit!, new FormData(form));
 
     analytics.track('[SUE] Backup configured', {
-      backup_images: !!dataOptions.get('PS_AUTOUP_KEEP_IMAGES')
+      backup_images: !!dataOptions.get('keep_images')
     });
 
     this.dispatchDialogContainerOkEvent(event);

_dev/src/ts/appUI/pages/UpdatePageUpdateOptions.ts

@@ -68,9 +68,9 @@ export default class UpdatePageUpdateOptions extends StepPage {
     const data = new FormData(this.#form);
 
     analytics.track('[SUE] Update options configured', {
-      disable_all_overrides: !!data.get('PS_DISABLE_OVERRIDES'),
-      disable_non_native_modules: !!data.get('PS_AUTOUP_CUSTOM_MOD_DESACT'),
-      regenerate_customized_email_templates: !!data.get('PS_AUTOUP_REGEN_EMAIL')
+      disable_all_overrides: !!data.get('disable_overrides'),
+      disable_non_native_modules: !!data.get('disable_non_native_modules'),
+      regenerate_customized_email_templates: !!data.get('regenerate_email_templates')
     });
 
     await api.post(this.#form.dataset.routeToSubmit!, data);

classes/AjaxResponse.php

@@ -22,7 +22,7 @@
 namespace PrestaShop\Module\AutoUpgrade;
 
 use PrestaShop\Module\AutoUpgrade\Log\Logger;
-use PrestaShop\Module\AutoUpgrade\Parameters\UpgradeConfiguration;
+use PrestaShop\Module\AutoUpgrade\Parameters\UpdateConfiguration;
 use PrestaShop\Module\AutoUpgrade\State\AbstractState;
 
 /**
@@ -63,9 +63,9 @@ class AjaxResponse
     const RESPONSE_FORMAT = 'json';
 
     /**
-     * @var UpgradeConfiguration
+     * @var UpdateConfiguration
      */
-    private $upgradeConfiguration;
+    private $updateConfiguration;
 
     /**
      * @var Logger
@@ -101,7 +101,7 @@ public function getResponse(): array
                 $this->state->export(),
                 [
                     'typeResult' => self::RESPONSE_FORMAT,
-                    'config' => $this->upgradeConfiguration->toArray(),
+                    'config' => $this->updateConfiguration->toArray(),
                 ]
             ),
         ];
@@ -145,9 +145,9 @@ public function getNextParams(): array
         return $this->nextParams;
     }
 
-    public function getUpgradeConfiguration(): UpgradeConfiguration
+    public function getUpdateConfiguration(): UpdateConfiguration
     {
-        return $this->upgradeConfiguration;
+        return $this->updateConfiguration;
     }
 
     // SETTERS
@@ -183,9 +183,9 @@ public function setNextParams(array $nextParams): AjaxResponse
         return $this;
     }
 
-    public function setUpgradeConfiguration(UpgradeConfiguration $upgradeConfiguration): AjaxResponse
+    public function setUpdateConfiguration(UpdateConfiguration $updateConfiguration): AjaxResponse
     {
-        $this->upgradeConfiguration = $upgradeConfiguration;
+        $this->updateConfiguration = $updateConfiguration;
 
         return $this;
     }

classes/Analytics.php

@@ -21,7 +21,8 @@
 
 namespace PrestaShop\Module\AutoUpgrade;
 
-use PrestaShop\Module\AutoUpgrade\Parameters\UpgradeConfiguration;
+use PrestaShop\Module\AutoUpgrade\Parameters\BackupConfiguration;
+use PrestaShop\Module\AutoUpgrade\Parameters\UpdateConfiguration;
 use PrestaShop\Module\AutoUpgrade\State\RestoreState;
 use PrestaShop\Module\AutoUpgrade\State\UpdateState;
 
@@ -48,10 +49,15 @@ class Analytics
     private $properties;
 
     /**
-     * @var UpgradeConfiguration
+     * @var UpdateConfiguration
      */
     private $updateConfiguration;
 
+    /**
+     * @var BackupConfiguration
+     */
+    private $backupConfiguration;
+
     /**
      * @var array{'restore': RestoreState, 'update': UpdateState}
      */
@@ -67,13 +73,15 @@ class Analytics
      * @param array{'restore': RestoreState, 'update': UpdateState} $states
      */
     public function __construct(
-        UpgradeConfiguration $updateConfiguration,
+        UpdateConfiguration $updateConfiguration,
+        BackupConfiguration $backupConfiguration,
         Environment $environment,
         array $states,
         string $anonymousUserId,
         array $options
     ) {
         $this->updateConfiguration = $updateConfiguration;
+        $this->backupConfiguration = $backupConfiguration;
         $this->states = $states;
 
         $this->anonymousId = $anonymousUserId;
@@ -122,7 +130,7 @@ public function getProperties($type): array
         switch ($type) {
             case self::WITH_BACKUP_PROPERTIES:
                 $additionalProperties = [
-                    'backup_images' => $this->updateConfiguration->shouldBackupImages(),
+                    'backup_images' => $this->backupConfiguration->shouldBackupImages(),
                 ];
                 $upgradeProperties = $this->properties[self::WITH_BACKUP_PROPERTIES] ?? [];
                 $additionalProperties = array_merge($upgradeProperties, $additionalProperties);