Initialize full Symfony layout in Back Office

.github/actions/setup-prestashop-env/action.yml

@@ -31,6 +31,10 @@ inputs:
     required: false
     description: GITHUB_TOKEN to be used by composer
     default: ""
+  backoffice-layout:
+    description: Backoffice layout
+    required: false
+    default: 'legacy'
 
 runs:
   using: "composite"
@@ -112,6 +116,12 @@ runs:
         echo "Disabling DEV mode ...";
         sed -ie "s/define('_PS_MODE_DEV_', true);/define('_PS_MODE_DEV_',\ false);/g" config/defines.inc.php
 
+    - name: Adapt Back Office layout
+      if: inputs.backoffice-layout == 'symfony'
+      shell: bash
+      run: |
+        sudo runuser -g www-data -u www-data -- echo USE_SYMFONY_LAYOUT=1 >> .env
+
     - name: Install PrestaShop
       if: inputs.ps-auto-install == 'true'
       shell: bash
@@ -123,3 +133,17 @@ runs:
         --password="$ADMIN_PASSWD" --email="demo@prestashop.com" \
         --language="en" --country="fr" \
         --ssl=1
+
+    - name: Clear and warmup cache for dev mode
+      if: inputs.ps-dev-mode == 'true'
+      shell: bash
+      run: |
+        sudo runuser -g www-data -u www-data -- php -d memory_limit=-1 ./bin/console cache:clear --env=dev
+        sudo runuser -g www-data -u www-data -- php -d memory_limit=-1 ./bin/console cache:warmup --env=dev
+
+    - name: Clear and warmup cache for prod mode
+      if: inputs.ps-dev-mode == 'false'
+      shell: bash
+      run: |
+        sudo runuser -g www-data -u www-data -- php -d memory_limit=-1 ./bin/console cache:clear --env=prod
+        sudo runuser -g www-data -u www-data -- php -d memory_limit=-1 ./bin/console cache:warmup --env=prod

.github/workflows/sanity-symfony-layout.yml

@@ -0,0 +1,56 @@
+name: UI tests (Symfony layout)
+on: [ push, pull_request ]
+permissions:
+  contents: read   #   to fetch code (actions/checkout)
+concurrency:
+  group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+jobs:
+  sanity:
+    permissions:
+      contents: read   #   to fetch code (actions/checkout)
+    runs-on: ubuntu-latest
+    name: Sanity Symfony Layout
+    strategy:
+      matrix:
+        php: [ '8.1' ]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup environment
+        uses: ./.github/actions/setup-prestashop-env
+        with:
+          php-version: ${{ matrix.php }}
+          mysql-version: '5.7'
+          mysql-database: 'prestashop'
+          mysql-root-password: 'password'
+          node-version: '16'
+          npm-version: '7'
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          backoffice-layout: symfony
+
+      - name: Cache Playwright browsers
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/ms-playwright/
+          key: ${{ runner.os }}-browsers
+
+      - name: Use .env.ci
+        run: mv .env.ci .env
+        working-directory: ./tests/UI
+
+      - name: Run tests even with install since the symfony layout is enabled via .env
+        run: npm ci && npm run test:sanity:fast-fail && npm run test:sanity:productV2:fast-fail
+        working-directory: ./tests/UI
+        env:
+          ENABLE_SSL: true
+
+      - uses: actions/upload-artifact@v3
+        if: ${{ always() }}
+        with:
+          name: artifacts-${{ matrix.php }}
+          path: |
+            ./tests/UI/screenshots/
+            var/logs/

.gitignore

@@ -214,3 +214,5 @@ tools/build/releases/*
 # Docker configuration
 install.lock
 docker-compose.override.yml
+
+.env

admin-dev/index.php

@@ -24,6 +24,7 @@
  * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
  */
 use PrestaShopBundle\Api\Api;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\ErrorHandler\Debug;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
@@ -70,6 +71,17 @@
 if (_PS_MODE_DEV_) {
     Debug::enable();
 }
+
+// Loads .env file from the root of project if present
+$dotEnvFile = dirname(__FILE__, 2) . '/.env';
+if (file_exists($dotEnvFile)) {
+    (new Dotenv())
+        // DO NOT use putEnv
+        ->usePutenv(false)
+        ->loadEnv($dotEnvFile)
+    ;
+}
+
 require_once __DIR__ . '/../app/AppKernel.php';
 
 $kernel = new AppKernel(_PS_ENV_, _PS_MODE_DEV_);

admin-dev/themes/default/template/header.tpl

@@ -76,8 +76,8 @@
 		var employee_token = '{getAdminToken tab='AdminEmployees'}';
 		var choose_language_translate = '{l|escape s='Choose language:' js=1 d='Admin.Actions'}';
 		var default_language = '{$default_language|intval}';
-		var admin_notification_get_link = adminNotificationGetLink = '{$link->getAdminLink("AdminCommon")|addslashes}';
-		var admin_notification_push_link = adminNotificationPushLink ='{$link->getAdminLink("AdminCommon", true, ['route' => 'admin_common_notifications_ack'])|addslashes}';
+		var admin_notification_get_link = adminNotificationGetLink = '{$link->getAdminLink('AdminCommon', true, ['route' => 'admin_common_notifications'])|addslashes}';
+		var admin_notification_push_link = adminNotificationPushLink ='{$link->getAdminLink('AdminCommon', true, ['route' => 'admin_common_notifications_ack'])|addslashes}';
 		var update_success_msg = '{l|escape s='Successful update' js=1 d='Admin.Notifications.Success'}';
 		var search_product_msg = '{l|escape s='Search for a product' js=1 d='Admin.Orderscustomers.Feature'}';
 	</script>

admin-dev/themes/new-theme/.webpack/common.js

@@ -417,6 +417,7 @@ module.exports = {
         },
       },
     }),
+    // Smarty preload
     new HtmlWebpackPlugin({
       filename: 'preload.tpl',
       templateContent: '{{{preloadLinks}}}',
@@ -433,6 +434,19 @@ module.exports = {
       // eslint-disable-next-line
       replaceCallback: ({indexSource, linksAsString}) => indexSource.replace('{{{preloadLinks}}}', linksAsString.replace(/href="/g, 'href="{$admin_dir}')),
     }),
+    // Twig preload
+    new HtmlWebpackPlugin({
+      filename: 'preload.html.twig',
+      templateContent: '{{{preloadLinks}}}',
+      inject: false,
+    }),
+    new FontPreloadPlugin({
+      index: 'preload.html.twig',
+      extensions: ['woff2'],
+      filter: /preload/,
+      // eslint-disable-next-line
+      replaceCallback: ({indexSource, linksAsString}) => indexSource.replace('{{{preloadLinks}}}', linksAsString.replace(/href="([^"]+)"/g, 'href="{{ asset(\'themes/new-theme/public/$1\') }}"')),
+    }),
     new CssoWebpackPlugin({
       forceMediaMerge: true,
     }),

admin-dev/themes/new-theme/template/header.tpl

@@ -66,9 +66,9 @@
     var employee_token = '{getAdminToken tab='AdminEmployees'}';
     var choose_language_translate = '{l s='Choose language:' js=1 d='Admin.Actions'}';
     var default_language = '{$default_language|intval}';
-    var admin_modules_link = '{$link->getAdminLink("AdminModulesSf", true, ['route' => "admin_module_manage"])|addslashes}';
-    var admin_notification_get_link = '{$link->getAdminLink("AdminCommon")|addslashes}';
-    var admin_notification_push_link = adminNotificationPushLink = '{$link->getAdminLink("AdminCommon", true, ['route' => 'admin_common_notifications_ack'])|addslashes}';
+    var admin_modules_link = '{$link->getAdminLink('AdminModulesSf', true, ['route' => 'admin_module_manage'])|addslashes}';
+    var admin_notification_get_link = '{$link->getAdminLink('AdminCommon', true, ['route' => 'admin_common_notifications'])|addslashes}';
+    var admin_notification_push_link = adminNotificationPushLink = '{$link->getAdminLink('AdminCommon', true, ['route' => 'admin_common_notifications_ack'])|addslashes}';
     var update_success_msg = '{l s='Update successful' js=1 d='Admin.Notifications.Success'}';
     var search_product_msg = '{l s='Search for a product' js=1 d='Admin.Orderscustomers.Feature'}';
   </script>

app/config/config.yml

@@ -12,13 +12,16 @@ parameters:
   translator.class: PrestaShopBundle\Translation\Translator
   translator.data_collector: PrestaShopBundle\Translation\DataCollectorTranslator
   prestashop_views: "%kernel.project_dir%/src/PrestaShopBundle/Resources/views"
+  # This is hard-coded for now but it should be dynamic wince admin folder name changes in prod environments
+  admin_themes_folder: "%kernel.project_dir%/admin-dev/themes"
   admin_page: "%prestashop_views%/Admin"
   env(PS_LOG_OUTPUT): "%kernel.logs_dir%/%kernel.environment%.log"
   env(PS_LOG_MAX_FILES): '30'
   mail_themes_uri: "/mails/themes"
   mail_themes_dir: "%kernel.project_dir%%mail_themes_uri%"
   modules_translation_paths: [ ]
   api_base_path: !php/const PrestaShopBundle\Api\Api::API_BASE_PATH
+  env(USE_SYMFONY_LAYOUT): 'false'
 
 # Autowires Core controllers
 services:
@@ -85,6 +88,7 @@ twig:
     '%kernel.project_dir%/modules': Modules
     '%mail_themes_dir%': MailThemes
     '%prestashop_views%': PrestaShopCore
+    '%admin_themes_folder%': AdminThemes
   globals:
     webpack_server: false
     multistore_field_prefix: !php/const PrestaShopBundle\Service\Form\MultistoreCheckboxEnabler::MULTISTORE_FIELD_PREFIX

classes/lang/KeysReference/FeatureFlagLang.php

@@ -94,3 +94,6 @@
 
 trans('Features', 'Admin.Advparameters.Feature');
 trans('Enable or disable the migrated features page.', 'Admin.Advparameters.Help');
+
+trans('Symfony layout', 'Admin.Advparameters.Feature');
+trans('Enable / Disable symfony layout (in opposition to legacy layout).', 'Admin.Advparameters.Help');

config/services/front/services_prod.yml

@@ -57,3 +57,6 @@ services:
       class: PrestaShopBundle\Translation\TranslatorLanguageLoader
       arguments:
         - '@prestashop.adapter.module.repository.module_repository'
+
+    PrestaShopBundle\Bridge\SymfonyLayoutFeatureInterface:
+      class: PrestaShopBundle\Bridge\DisabledSymfonyLayoutFeature

config/services/webservice/services_prod.yml

@@ -1,2 +1,6 @@
 imports:
     - { resource: ../common.yml }
+
+services:
+  PrestaShopBundle\Bridge\SymfonyLayoutFeatureInterface:
+    class: PrestaShopBundle\Bridge\DisabledSymfonyLayoutFeature

docker-compose.yml

@@ -56,6 +56,7 @@ services:
       PS_ERASE_DB: ${PS_ERASE_DB:-0}
       ADMIN_MAIL: ${ADMIN_MAIL:-demo@prestashop.com}
       ADMIN_PASSWD: ${ADMIN_PASSWD:-Correct Horse Battery Staple}
+      USE_SYMFONY_LAYOUT: ${USE_SYMFONY_LAYOUT:-0}
     command: ["/tmp/wait-for-it.sh", "--timeout=60", "--strict", "mysql:3306", "--", "/tmp/docker_run_git.sh"]
     ports:
       - "8001:80"

install-dev/controllers/http/smarty_compile.php

@@ -23,7 +23,9 @@
  * @copyright Since 2007 PrestaShop SA and Contributors
  * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
  */
-define('_PS_DO_NOT_LOAD_CONFIGURATION_', true);
+if (!defined('_PS_DO_NOT_LOAD_CONFIGURATION_')) {
+    define('_PS_DO_NOT_LOAD_CONFIGURATION_', true);
+}
 if (Tools::getValue('bo')) {
     if (!is_dir(_PS_ROOT_DIR_ . '/admin/')) {
         exit;

install-dev/data/xml/feature_flag.xml

@@ -25,5 +25,6 @@
     <feature_flag id="customer_threads" name="customer_threads" label_wording="Customer threads" label_domain="Admin.Advparameters.Feature" description_wording="Enable / Disable the migrated customer threads page." description_domain="Admin.Advparameters.Help" state="0" stability="beta" />
     <feature_flag id="order_state" name="order_state" label_wording="Order states" label_domain="Admin.Advparameters.Feature" description_wording="Enable / Disable the migrated order states page." description_domain="Admin.Advparameters.Help" state="0" stability="beta" />
     <feature_flag id="feature" name="feature" label_wording="Features" label_domain="Admin.Advparameters.Feature" description_wording="Enable / Disable the migrated features page." description_domain="Admin.Advparameters.Help" state="0" stability="beta" />
+    <feature_flag id="symfony_layout" name="symfony_layout" label_wording="Symfony layout" label_domain="Admin.Advparameters.Feature" description_wording="Enable / Disable symfony layout (in opposition to legacy layout)." description_domain="Admin.Advparameters.Help" state="0" stability="beta" />
   </entities>
 </entity_feature_flag>