New Content
`, + parent_to_update: 'parent', + add_script: 'additional_script' + }; + + hydration.hydrate(response); + + expect(updateRouteScriptMock).not.toHaveBeenCalled(); + expect(loadScriptMock).toHaveBeenCalledWith('additional_script'); + }); + it('should call routeHandler.setNewRoute when new_route is provided and fromPopState is false', () => { const response: ApiResponseHydration = { hydration: true, @@ -133,6 +158,34 @@ describe('Hydration', () => { }) ); }); + + it('should refresh the modal container if a new page is loaded', () => { + const response: ApiResponseHydration = { + hydration: true, + new_content: `New Content
`, + parent_to_update: 'parent', + new_route: 'new_route_value' + }; + + hydration.hydrate(response); + + expect(modalContainer.beforeDestroy).toHaveBeenCalledTimes(1); + // Called on Init + refresh + expect(modalContainer.mount).toHaveBeenCalledTimes(2); + }); + + it('should not refresh the modal container if the DOM is untouched', () => { + const response: ApiResponseHydration = { + hydration: true, + new_content: `New Content
`, + parent_to_update: 'non_existent_id' + }; + + hydration.hydrate(response); + + // Called on Init + expect(modalContainer.mount).toHaveBeenCalledTimes(1); + }); }); describe('Hydration and scripts lifecycle', () => { diff --git a/_dev/tsconfig.json b/_dev/tsconfig.json index 252f8bc30..1bb686364 100644 --- a/_dev/tsconfig.json +++ b/_dev/tsconfig.json @@ -19,7 +19,7 @@ "esModuleInterop": true, "lib": ["ESNext", "DOM"], "skipLibCheck": true, - "types": ["jest", "node"], + "types": ["jest", "node", "jquery", "bootstrap"], }, "include": [ "src/ts/**/*.ts", diff --git a/classes/AjaxResponseBuilder.php b/classes/AjaxResponseBuilder.php index 73849ac3b..4ed749fd0 100644 --- a/classes/AjaxResponseBuilder.php +++ b/classes/AjaxResponseBuilder.php @@ -6,7 +6,10 @@ class AjaxResponseBuilder { - public static function hydrationResponse(string $parentToUpdate, string $newContent, ?string $newRoute = null): JsonResponse + /** + * @param array{newRoute?:string, addScript?:string} $options + */ + public static function hydrationResponse(string $parentToUpdate, string $newContent, ?array $options = []): JsonResponse { $arrayToReturn = [ 'hydration' => true, @@ -14,8 +17,12 @@ public static function hydrationResponse(string $parentToUpdate, string $newCont 'new_content' => $newContent, ]; - if ($newRoute) { - $arrayToReturn['new_route'] = $newRoute; + if ($options['newRoute']) { + $arrayToReturn['new_route'] = $options['newRoute']; + } + + if ($options['addScript']) { + $arrayToReturn['add_script'] = $options['addScript']; } return new JsonResponse($arrayToReturn); diff --git a/classes/Router/Router.php b/classes/Router/Router.php index 51e6b456d..1be451291 100644 --- a/classes/Router/Router.php +++ b/classes/Router/Router.php @@ -98,6 +98,26 @@ public function __construct(UpgradeContainer $upgradeContainer) 'controller' => UpdatePageBackupController::class, 'method' => 'step', ], + Routes::UPDATE_STEP_BACKUP_SAVE_OPTION => [ + 'controller' => UpdatePageBackupController::class, + 'method' => 'saveOption', + ], + Routes::UPDATE_STEP_BACKUP_SUBMIT_BACKUP => [ + 'controller' => UpdatePageBackupController::class, + 'method' => 'submitBackup', + ], + Routes::UPDATE_STEP_BACKUP_SUBMIT_UPDATE => [ + 'controller' => UpdatePageBackupController::class, + 'method' => 'submitUpdate', + ], + Routes::UPDATE_STEP_BACKUP_CONFIRM_BACKUP => [ + 'controller' => UpdatePageBackupController::class, + 'method' => 'startBackup', + ], + Routes::UPDATE_STEP_BACKUP_CONFIRM_UPDATE => [ + 'controller' => UpdatePageBackupController::class, + 'method' => 'startUpdate', + ], Routes::UPDATE_PAGE_UPDATE => [ 'controller' => UpdatePageUpdateController::class, 'method' => 'index', diff --git a/classes/Router/Routes.php b/classes/Router/Routes.php index 60740aa45..494d6b02d 100644 --- a/classes/Router/Routes.php +++ b/classes/Router/Routes.php @@ -24,6 +24,11 @@ class Routes /* step: backup */ const UPDATE_PAGE_BACKUP = 'update-page-backup'; const UPDATE_STEP_BACKUP = 'update-step-backup'; + const UPDATE_STEP_BACKUP_SAVE_OPTION = 'update-step-backup-save-option'; + const UPDATE_STEP_BACKUP_SUBMIT_BACKUP = 'update-step-backup-submit-backup'; + const UPDATE_STEP_BACKUP_SUBMIT_UPDATE = 'update-step-backup-submit-update'; + const UPDATE_STEP_BACKUP_CONFIRM_BACKUP = 'update-step-backup-confirm-backup'; + const UPDATE_STEP_BACKUP_CONFIRM_UPDATE = 'update-step-backup-confirm-update'; /* step: update */ const UPDATE_PAGE_UPDATE = 'update-page-update'; diff --git a/classes/Twig/PageSelectors.php b/classes/Twig/PageSelectors.php index 38d659cbc..1c0131ee4 100644 --- a/classes/Twig/PageSelectors.php +++ b/classes/Twig/PageSelectors.php @@ -7,6 +7,7 @@ class PageSelectors public const PAGE_PARENT_ID = 'update_assistant'; public const STEP_PARENT_ID = 'ua_container'; public const STEPPER_PARENT_ID = 'stepper_content'; + public const MODAL_PARENT_ID = 'ua_modal'; public const RADIO_CARD_ONLINE_PARENT_ID = 'radio_card_online'; public const RADIO_CARD_ARCHIVE_PARENT_ID = 'radio_card_archive'; @@ -19,6 +20,7 @@ public static function getAllSelectors(): array 'page_parent_id' => self::PAGE_PARENT_ID, 'step_parent_id' => self::STEP_PARENT_ID, 'stepper_parent_id' => self::STEPPER_PARENT_ID, + 'modal_parent_id' => self::MODAL_PARENT_ID, 'radio_card_online_parent_id' => self::RADIO_CARD_ONLINE_PARENT_ID, 'radio_card_archive_parent_id' => self::RADIO_CARD_ARCHIVE_PARENT_ID, ]; diff --git a/classes/Twig/UpdateSteps.php b/classes/Twig/UpdateSteps.php index 3164668a3..7645e9a18 100644 --- a/classes/Twig/UpdateSteps.php +++ b/classes/Twig/UpdateSteps.php @@ -38,7 +38,7 @@ public function setSteps(): void 'title' => $this->translator->trans('Update options'), ], self::STEP_BACKUP => [ - 'title' => $this->translator->trans('Backup'), + 'title' => $this->translator->trans('Back up your store'), ], self::STEP_UPDATE => [ 'title' => $this->translator->trans('Update'), diff --git a/controllers/admin/self-managed/AbstractPageController.php b/controllers/admin/self-managed/AbstractPageController.php index c4830672c..f6fb6445a 100644 --- a/controllers/admin/self-managed/AbstractPageController.php +++ b/controllers/admin/self-managed/AbstractPageController.php @@ -96,7 +96,7 @@ public function index() $this->getPageTemplate(), $this->getParams() ), - $this->displayRouteInUrl() + ['newRoute' => $this->displayRouteInUrl()] ); } diff --git a/controllers/admin/self-managed/AbstractPageWithStepController.php b/controllers/admin/self-managed/AbstractPageWithStepController.php index d9ea1ea6c..766444281 100644 --- a/controllers/admin/self-managed/AbstractPageWithStepController.php +++ b/controllers/admin/self-managed/AbstractPageWithStepController.php @@ -53,7 +53,7 @@ public function step() '@ModuleAutoUpgrade/steps/' . $this->getStepTemplate() . '.html.twig', $params ), - $this->displayRouteInUrl() + ['newRoute' => $this->displayRouteInUrl()] ); } diff --git a/controllers/admin/self-managed/UpdatePageBackupController.php b/controllers/admin/self-managed/UpdatePageBackupController.php index e9016daa8..0a30e002f 100644 --- a/controllers/admin/self-managed/UpdatePageBackupController.php +++ b/controllers/admin/self-managed/UpdatePageBackupController.php @@ -27,7 +27,14 @@ namespace PrestaShop\Module\AutoUpgrade\Controller; +use PrestaShop\Module\AutoUpgrade\AjaxResponseBuilder; +use PrestaShop\Module\AutoUpgrade\Parameters\UpgradeConfiguration; +use PrestaShop\Module\AutoUpgrade\Parameters\UpgradeFileNames; +use PrestaShop\Module\AutoUpgrade\Router\Routes; +use PrestaShop\Module\AutoUpgrade\Twig\PageSelectors; use PrestaShop\Module\AutoUpgrade\Twig\UpdateSteps; +use PrestaShop\Module\AutoUpgrade\Twig\ValidatorToFormFormater; +use Symfony\Component\HttpFoundation\JsonResponse; class UpdatePageBackupController extends AbstractPageWithStepController { @@ -43,6 +50,64 @@ protected function getStepTemplate(): string return self::CURRENT_STEP; } + protected function displayRouteInUrl(): ?string + { + return Routes::UPDATE_PAGE_BACKUP; + } + + public function submitBackup(): JsonResponse + { + $imagesIncluded = $this->upgradeContainer->getUpgradeConfiguration()->shouldBackupImages(); + + return $this->displayModal($imagesIncluded ? 'modal-backup-all' : 'modal-backup', [ + 'modalId' => 'modal-confirm-backup', + ]); + } + + public function submitUpdate(): JsonResponse + { + return $this->displayModal('modal-update', [ + 'noBackUp' => !$this->request->request->getBoolean('backupDone', false), + 'modalId' => 'modal-confirm-update', + + 'form_route_to_confirm' => Routes::UPDATE_STEP_BACKUP_CONFIRM_UPDATE, + + // TODO: assets_base_path is provided by all controllers. What about a asset() twig function instead? + 'assets_base_path' => $this->upgradeContainer->getAssetsEnvironment()->getAssetsBaseUrl($this->request), + ]); + } + + public function startBackup(): JsonResponse + { + return AjaxResponseBuilder::nextRouteResponse(Routes::UPDATE_STEP_BACKUP); + } + + public function startUpdate(): JsonResponse + { + return AjaxResponseBuilder::nextRouteResponse(Routes::UPDATE_STEP_UPDATE); + } + + public function saveOption(): JsonResponse + { + $upgradeConfiguration = $this->upgradeContainer->getUpgradeConfiguration(); + $upgradeConfigurationStorage = $this->upgradeContainer->getUpgradeConfigurationStorage(); + + $config = [ + UpgradeConfiguration::PS_AUTOUP_KEEP_IMAGES => $this->request->request->getBoolean(UpgradeConfiguration::PS_AUTOUP_KEEP_IMAGES, false), + ]; + + $errors = $this->upgradeContainer->getConfigurationValidator()->validate($config); + if (empty($errors)) { + $upgradeConfiguration->merge($config); + $upgradeConfigurationStorage->save($upgradeConfiguration, UpgradeFileNames::CONFIG_FILENAME); + } + + return $this->getRefreshOfForm(array_merge( + $this->getParams(), + ['errors' => ValidatorToFormFormater::format($errors)] + )); + } + /** * @return array * @@ -50,15 +115,50 @@ protected function getStepTemplate(): string */ protected function getParams(): array { + $upgradeConfiguration = $this->upgradeContainer->getUpgradeConfiguration(); $updateSteps = new UpdateSteps($this->upgradeContainer->getTranslator()); return array_merge( $updateSteps->getStepParams($this::CURRENT_STEP), [ - // TODO - 'default_backup_files_and_database' => true, - 'default_include_images' => false, + 'form_route_to_save' => Routes::UPDATE_STEP_BACKUP_SAVE_OPTION, + 'form_route_to_submit_backup' => Routes::UPDATE_STEP_BACKUP_SUBMIT_BACKUP, + 'form_route_to_submit_update' => Routes::UPDATE_STEP_BACKUP_SUBMIT_UPDATE, + 'form_route_to_confirm_backup' => Routes::UPDATE_STEP_BACKUP_CONFIRM_BACKUP, + + 'form_fields' => [ + 'include_images' => [ + 'field' => UpgradeConfiguration::PS_AUTOUP_KEEP_IMAGES, + 'value' => $upgradeConfiguration->shouldBackupImages(), + ], + ], ] ); } + + private function getRefreshOfForm(array $params): JsonResponse + { + return AjaxResponseBuilder::hydrationResponse( + PageSelectors::STEP_PARENT_ID, + $this->getTwig()->render( + '@ModuleAutoUpgrade/steps/' . $this->getStepTemplate() . '.html.twig', + $params + ), + ['newRoute' => $this->displayRouteInUrl()] + ); + } + + private function displayModal(string $modalName, array $params): JsonResponse + { + $options = $modalName === 'modal-update' ? ['addScript' => 'start-update-modal'] : null; + + return AjaxResponseBuilder::hydrationResponse( + PageSelectors::MODAL_PARENT_ID, + $this->getTwig()->render( + '@ModuleAutoUpgrade/modals/' . $modalName . '.html.twig', + $params + ), + $options + ); + } } diff --git a/controllers/admin/self-managed/UpdatePageUpdateOptionsController.php b/controllers/admin/self-managed/UpdatePageUpdateOptionsController.php index 5e1d991cb..8bdd53199 100644 --- a/controllers/admin/self-managed/UpdatePageUpdateOptionsController.php +++ b/controllers/admin/self-managed/UpdatePageUpdateOptionsController.php @@ -85,7 +85,7 @@ public function saveOption(): JsonResponse public function submit(): JsonResponse { - return AjaxResponseBuilder::nextRouteResponse(Routes::UPDATE_PAGE_BACKUP); + return AjaxResponseBuilder::nextRouteResponse(Routes::UPDATE_STEP_BACKUP); } /** @@ -131,7 +131,7 @@ private function getRefreshOfForm(array $params): JsonResponse '@ModuleAutoUpgrade/steps/' . $this->getStepTemplate() . '.html.twig', $params ), - $this->displayRouteInUrl() + ['newRoute' => $this->displayRouteInUrl()] ); } } diff --git a/storybook/stories/components/Modal.stories.js b/storybook/stories/components/Modal.stories.js index d1706094e..66cb3bcc6 100644 --- a/storybook/stories/components/Modal.stories.js +++ b/storybook/stories/components/Modal.stories.js @@ -45,6 +45,8 @@ export const Default = { modalSize: "lg", psBaseUri: "/", modalDanger: false, + + assets_base_path: "", }, }; diff --git a/storybook/stories/components/ModalBackup.stories.js b/storybook/stories/components/ModalBackup.stories.js index ab1abdf1c..69df828b6 100644 --- a/storybook/stories/components/ModalBackup.stories.js +++ b/storybook/stories/components/ModalBackup.stories.js @@ -34,8 +34,6 @@ export default { export const Backup = { args: { ...Modal.args, - title: "Start backup?", - message: "Your files and database will be backed up.", modalSize: "md", }, }; diff --git a/storybook/stories/components/ModalBackupAll.stories.js b/storybook/stories/components/ModalBackupAll.stories.js index e6f203ff2..2fa04d230 100644 --- a/storybook/stories/components/ModalBackupAll.stories.js +++ b/storybook/stories/components/ModalBackupAll.stories.js @@ -34,8 +34,6 @@ export default { export const BackupWithImg = { args: { ...Modal.args, - title: "Start backup?", - message: "Your files, database, and images will be backed up.", modalSize: "md", }, }; diff --git a/storybook/stories/components/ModalUpdate.stories.js b/storybook/stories/components/ModalUpdate.stories.js index c7e682c26..efa384241 100644 --- a/storybook/stories/components/ModalUpdate.stories.js +++ b/storybook/stories/components/ModalUpdate.stories.js @@ -34,8 +34,6 @@ export default { export const Update = { args: { ...Modal.args, - title: "Start update?", - message: "You are about to launch the update, do you want to continue?", modalSize: "lg", noBackUp: false, }, diff --git a/storybook/stories/pages/Backup.stories.js b/storybook/stories/pages/Backup.stories.js index 228c06ede..aec239e44 100644 --- a/storybook/stories/pages/Backup.stories.js +++ b/storybook/stories/pages/Backup.stories.js @@ -39,8 +39,17 @@ export const Backup = { code: "backup", title: "Backup", }, - default_backup_files_and_database: true, - default_include_images: false, + + form_fields: { + include_images: { + field: 'PS_AUTOUP_KEEP_IMAGES', + value: true, + }, + }, + + form_route_to_save: "update-step-update-options-save-option", + form_route_to_submit: "update-step-update-options-submit-form", + step_parent_id: "ua_container", // Stepper ...Stepper.args, diff --git a/tests/unit/Twig/ValidatorToFormFormaterTest.php b/tests/unit/Twig/ValidatorToFormFormaterTest.php new file mode 100644 index 000000000..62686e06f --- /dev/null +++ b/tests/unit/Twig/ValidatorToFormFormaterTest.php @@ -0,0 +1,102 @@ + + * @copyright Since 2007 PrestaShop SA and Contributors + * @license https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0) + */ + +namespace PrestaShop\Module\AutoUpgrade\Tests\Twig; + +use PHPUnit\Framework\TestCase; +use PrestaShop\Module\AutoUpgrade\Twig\ValidatorToFormFormater; + +class ValidatorToFormFormaterTest extends TestCase +{ + public function testEmptyArray() + { + $input = []; + $expected = []; + + $actual = ValidatorToFormFormater::format($input); + + $this->assertSame($expected, $actual); + } + + public function testErrorsForSpecificFields() + { + $input = [ + [ + 'message' => 'Oh no', + 'target' => 'oneDisgustingField', + ], + ]; + $expected = [ + 'oneDisgustingField' => 'Oh no', + ]; + + $actual = ValidatorToFormFormater::format($input); + + $this->assertSame($expected, $actual); + } + + public function testGlobalErrors() + { + $input = [ + [ + 'message' => 'Eww', + ], + ]; + $expected = [ + 'global' => 'Eww', + ]; + + $actual = ValidatorToFormFormater::format($input); + + $this->assertSame($expected, $actual); + } + + public function testMixedErrors() + { + $input = [ + [ + 'message' => 'This field cannot be blank', + 'target' => 'theMandatoryField', + ], + [ + 'message' => 'Eww', + ], + [ + 'message' => 'Oh no', + 'target' => 'oneDisgustingField', + ], + ]; + $expected = [ + 'theMandatoryField' => 'This field cannot be blank', + 'global' => 'Eww', + 'oneDisgustingField' => 'Oh no', + ]; + + $actual = ValidatorToFormFormater::format($input); + + $this->assertSame($expected, $actual); + } +} diff --git a/views/templates/layouts/page.html.twig b/views/templates/layouts/page.html.twig index 994933b2a..9e45528bb 100644 --- a/views/templates/layouts/page.html.twig +++ b/views/templates/layouts/page.html.twig @@ -20,4 +20,6 @@ {% endblock %} + + {% endblock %} diff --git a/views/templates/modals/modal-backup-all.html.twig b/views/templates/modals/modal-backup-all.html.twig index ed8d46185..046f826d9 100644 --- a/views/templates/modals/modal-backup-all.html.twig +++ b/views/templates/modals/modal-backup-all.html.twig @@ -1,18 +1,6 @@ -{% extends "@ModuleAutoUpgrade/components/modal.html.twig" %} +{% extends "@ModuleAutoUpgrade/modals/modal-backup.html.twig" %} -{% block modal_extra_content %}{% endblock %} - -{% block modal_footer %} - +{% block modal_content %} + {% set message = 'Your files, database, and images will be backed up.'|trans({}) %} + {{ parent() }} {% endblock %} diff --git a/views/templates/modals/modal-backup.html.twig b/views/templates/modals/modal-backup.html.twig index ed8d46185..d62456500 100644 --- a/views/templates/modals/modal-backup.html.twig +++ b/views/templates/modals/modal-backup.html.twig @@ -1,4 +1,10 @@ {% extends "@ModuleAutoUpgrade/components/modal.html.twig" %} +{% set title = 'Start backup?'|trans({}) %} +{% set message = 'Your files and database will be backed up.'|trans({}) %} + +{% block modal_content %} + {{ parent() }} +{% endblock %} {% block modal_extra_content %}{% endblock %} diff --git a/views/templates/modals/modal-update.html.twig b/views/templates/modals/modal-update.html.twig index 803e09981..92b60aab7 100644 --- a/views/templates/modals/modal-update.html.twig +++ b/views/templates/modals/modal-update.html.twig @@ -1,11 +1,21 @@ {% extends "@ModuleAutoUpgrade/components/modal.html.twig" %} +{% set title = 'Start update?'|trans({}) %} + {% block modal_content %} +