Merge pull request #307 from wp-media/develop

Mai-Saad · web-flow · commit 41ae35a1098f · 2025-12-02T09:12:15.000+02:00
Merge dev to trunk and release 1.2.1
diff --git a/config/wp.config.sample.ts b/config/wp.config.sample.ts
@@ -44,7 +44,11 @@ const BACKWPUP_INFOS = {
         password: '',
         port: '21',
         ssl: false,
-        passiveMode: true
+        passiveMode: true,
+		// Set this to string with the path of the FTP root directory if SSH access is available for it
+		sshDirectory: null,
+		// Set this to the SSH username if SSH access is available for it
+		sshUsername: null
     }
 } as const;
 
diff --git a/package.json b/package.json
@@ -26,6 +26,7 @@
     "test:test": "$npm_package_config_testCommand --tags @test",
     "test:lrc": "$npm_package_config_testCommand --tags @lrc",
     "test:cpcss": "$npm_package_config_testCommand --tags @cpcss",
+    "test:cdn": "$npm_package_config_testCommand --tags @cdn",
     "test:performancehints": "$npm_package_config_testCommand --tags @performancehints",
     "healthcheck": "ts-node healthcheck.ts",
     "push-report": "ts-node report.ts",
diff --git a/src/backwpup/features/backup.feature b/src/backwpup/features/backup.feature
@@ -16,4 +16,16 @@ Feature: Should be able to backup
     And I should see 'mixed' job cards
     Then the backup should be added to the table
     When I click on common backup now button
-    Then '1' backup is generated and added to history
+    Then '1' backup is generated and added to history
+
+  Scenario: Schedule backup job to generate backup
+    Given I install plugin 'https://github.com/wp-media/wp-rocket-e2e-test-helper/raw/main/helper-plugin/show-time.zip'
+    And plugin 'show-time' is activated
+    And I go '/wp-admin/admin.php?page=backwpup'
+    When I click '.js-backwpup-onboarding-step-2' button to continue
+    And I click '.js-backwpup-onboarding-step-3' button to continue
+    When I Configure web server storage
+    And I go '/wp-admin/admin.php?page=backwpup'
+    And I Schedule backup
+    And I go '/wp-admin/admin.php?page=backwpup'
+    Then '1' backup is generated and added to history
diff --git a/src/backwpup/features/delete-plugin.feature b/src/backwpup/features/delete-plugin.feature
@@ -3,20 +3,19 @@ Feature: Should successfully delete BackWPup plugin
 
     Background:
         Given I am logged in
+        And I delete backwpup plugin
+        And plugin is installed 'backwpup-pro'
 
     Scenario: Should delete the plugin successfully after install
-        Given plugin is installed 'backwpup-pro'
         When I delete backwpup plugin
         Then backwpup should delete successfully
 
     Scenario: Should delete the plugin successfully after activate
-        Given plugin is installed 'backwpup-pro'
         And plugin is activated
         When I delete backwpup plugin
         Then backwpup should delete successfully
 
     Scenario: Should delete the plugin successfully after 1st backup
-        Given plugin is installed 'backwpup-pro'
         And plugin is activated
         When I go '/wp-admin/admin.php?page=backwpup'
         And I click '.js-backwpup-onboarding-step-2' button to continue
diff --git a/src/backwpup/steps/general.ts b/src/backwpup/steps/general.ts
@@ -112,8 +112,35 @@ When('I click on manual backup of a job', async function (this: ICustomWorld) {
     await this.page.waitForLoadState('networkidle');
 });
 
+When('I Schedule backup', async function (this: ICustomWorld) {
+    this.initialBackups = await captureBackupTableData(this.page)
+    const timeText = await this.page.locator('#wp-admin-bar-current_time_display .ab-item').textContent();
+    const timeMatch = timeText.match(/(\d{2}):(\d{2}):(\d{2})/);
+    const currentHours = parseInt(timeMatch[1], 10);
+    const currentMinutes = parseInt(timeMatch[2], 10);
+
+    const totalMinutes = currentHours * 60 + currentMinutes + 2;
+    const scheduleHours = Math.floor(totalMinutes / 60) % 24;
+    const scheduleMinutes = totalMinutes % 60;
+
+    const timeValue = `${scheduleHours.toString().padStart(2, '0')}:${scheduleMinutes.toString().padStart(2, '0')}`;
+
+    await this.page.locator('button[data-content="frequency"].js-backwpup-load-and-open-sidebar').first().click();
+    await this.page.waitForSelector('#sidebar-frequency', { state: 'visible' });
+    await this.page.selectOption('#backwpup_frequency', 'daily');
+    await this.page.fill('input[name="start_time"]', timeValue);
+
+    await this.page.locator('button#save-job-settings').click();
+
+    await this.page.waitForLoadState('networkidle');
+
+    await this.page.waitForTimeout(3 * 60 * 1000);
+});
+
 const captureBackupTableData = async (page: Page): Promise<BackupRowData[]> => {
-    const rows = await page.locator('table tbody tr').all();
+    const selector = 'table tbody tr';
+    await page.locator(selector).first().waitFor({ state: 'visible' }).catch(() => null);
+    const rows = await page.locator(selector).all();
     const backups: BackupRowData[] = [];
 
     for (const row of rows) {
diff --git a/src/backwpup/support/hooks.ts b/src/backwpup/support/hooks.ts
@@ -5,10 +5,11 @@ import { PageUtils } from "../../../utils/page-utils";
 import { Before, After} from "@cucumber/cucumber";
 import {StorageUtils} from "../utils/storage";
 import {configurations} from "../../../utils/configurations";
-import {rm, testSshConnection} from "../../../utils/commands";
+import {rm, testSshConnection, uninstallPlugin} from "../../../utils/commands";
 import {WP_SSH_ROOT_DIR} from "../../../config/wp.config";
 import {Page} from "@playwright/test";
-
+import {BACKWPUP_INFOS} from "../../../config/wp.config";
+import { getFolderNameFromHost } from "../utils/helpers";
 
 /**
  * Before each test scenario with the @bwpupsetup tag, performs setup tasks.
@@ -26,7 +27,7 @@ Before({tags: '@bwpupsetup'}, async function(this: ICustomWorld, {pickle}) {
 /**
  * After every test, delete data
  */
-After(async function (this: ICustomWorld) {
+After({ tags: '@bwpup or @bwpupsetup' }, async function (this: ICustomWorld) {
     await deleteAllData(this.page);
     try {
         await testSshConnection();
@@ -35,16 +36,41 @@ After(async function (this: ICustomWorld) {
         await rm(backwpupFolder);
         const backwpupRestoreFolder = `${WP_SSH_ROOT_DIR}wp-content/uploads/backwpup-restore`;
         await rm(backwpupRestoreFolder);
+        // Remove any BackWPup plugin zip files that may have been uploaded during tests.
+        const backwpupPluginZips = `${WP_SSH_ROOT_DIR}wp-content/uploads/**/**/backwpup*.zip`;
+        await rm(backwpupPluginZips);
 
         // Remove BackWPup plugin
         await this.utils.deactivateBackWpViaUi();
         await this.utils.removeBackWpViaUi();
+        await uninstallPlugin('show-time');
     } catch (error) {
         console.error('Setup failed: ', error.message);
         throw new Error('Setup failed: ' + error.message);
     }
 });
 
+After({tags: '@bwpupstorageftp'}, async function(this: ICustomWorld) {
+    // Nothing to do if no SSH access for FTP is set
+    if (!BACKWPUP_INFOS.ftp.sshDirectory || !BACKWPUP_INFOS.ftp.sshUsername) return;
+    try {
+        // Clear FTP storage
+        const sshConfig = {
+            host: BACKWPUP_INFOS.ftp.host,
+            username: BACKWPUP_INFOS.ftp.sshUsername
+        };
+        await testSshConnection({...sshConfig});
+        const directoryName = getFolderNameFromHost();
+        const destination = `${BACKWPUP_INFOS.ftp.sshDirectory}/${directoryName}/*`;
+        await rm(destination, {
+            ...sshConfig
+        });
+    } catch (error) {
+        // Catch error and fail silently, as FTP cleanup is not critical
+        console.error('FTP Cleanup failed: ', error.message);
+    }
+});
+
 async function deleteAllData(page: Page): Promise<void> {
     const response = await page.goto(`${configurations.baseUrl}/wp-admin/admin.php?page=backwpup`);
     // We check status, because for some tests, the plugin will be uninstalled before getting here
diff --git a/src/backwpup/utils/helpers.ts b/src/backwpup/utils/helpers.ts
@@ -1,3 +1,4 @@
+import { configurations } from "../../../utils/configurations";
 import { ICustomWorld } from "../../common/custom-world";
 import { Page } from '@playwright/test';
 
@@ -107,3 +108,23 @@ export const configureWebServerStorage = async (page: ICustomWorld['page']): Pro
         await page.click('.js-backwpup-onboarding-submit-form');
         await waitForBackupJobCompletion(page);
 };
+
+/**
+ * Generates a filesystem-friendly folder name derived from the configured base URL's hostname.
+ *
+ * The function parses `configurations.baseUrl`, extracts the hostname portion, and replaces
+ * all dot characters ('.') with hyphens ('-') to produce a directory-safe name.
+ *
+ * Examples:
+ * - "https://example.com"         -> "example-com"
+ * - "https://sub.domain.co.uk"    -> "sub-domain-co-uk"
+ *
+ * @returns The directory name based on the hostname with dots replaced by hyphens.
+ * @throws {TypeError} If `configurations.baseUrl` is not a valid URL and the URL constructor fails.
+ * @remarks Relies on the global/module `configurations.baseUrl` value being available.
+ */
+export const getFolderNameFromHost = (): string => {
+    const domain = new URL(configurations.baseUrl).hostname;
+    const directoryName = domain.replace(/\./g, '-');
+    return directoryName;
+}
diff --git a/src/backwpup/utils/storage.ts b/src/backwpup/utils/storage.ts
@@ -2,6 +2,7 @@ import {Page} from "@playwright/test";
 import {Locators, Selector} from "../../../utils/types";
 import {Sections} from "../../common/sections";
 import {BACKWPUP_INFOS} from "../../../config/wp.config";
+import { getFolderNameFromHost } from "./helpers";
 
 export class StorageUtils {
     /**
@@ -125,10 +126,10 @@ export class StorageUtils {
         // Checkboxes
         await this.page.locator('#ftpssl').setChecked(BACKWPUP_INFOS.ftp.ssl, { force: true });
         await this.page.locator('#ftppasv').setChecked(BACKWPUP_INFOS.ftp.passiveMode, { force: true });
-        const currentValue = await this.page.locator('#ftpdir').inputValue();
         const timestamp = Date.now();
+        const directoryName = getFolderNameFromHost();
         // Changing the directory name to prevent old backups to appear and affect the test
-        await this.page.locator('#ftpdir').fill(`${currentValue}${timestamp}`);
+        await this.page.locator('#ftpdir').fill(`${directoryName}/${timestamp}`);
         await this.page.click('.js-backwpup-test-FTP-storage');
 
         await this.page.waitForResponse(response =>
diff --git a/src/common/selectors.ts b/src/common/selectors.ts
@@ -62,15 +62,7 @@ export const selectors: Selectors = {
                     await activateFromPopUp(page, state, "text=Activate combine CSS") 
                }
             },
-            cpcss:{
-                type: FieldType.checkbox,
-                element: "#optimize_css_delivery",
-                target: "label[for=optimize_css_delivery]",
-                after: async (page: Page): Promise<void> => {
-                    await page.locator("#wpr-radio-async_css").click();
-                },
-            },
-    
+
             rucss:{
                 type: FieldType.checkbox,
                 element: "#optimize_css_delivery",
@@ -83,6 +75,15 @@ export const selectors: Selectors = {
                     await page.locator("text=Activate Remove Unused CSS").click();
                 }
             },
+            cpcss:{
+                type: FieldType.checkbox,
+                element: "#optimize_css_delivery",
+                target: "label[for=optimize_css_delivery]",
+                after: async (page: Page): Promise<void> => {
+                    await page.locator("#wpr-radio-async_css").click();
+                },
+            },
+    
             minifyJs: {
                 type: FieldType.checkbox,
                 element: "#minify_js",
diff --git a/src/features/cdn-banner.feature b/src/features/cdn-banner.feature
@@ -0,0 +1,14 @@
+@cdn @setup 
+Feature: CDN banner
+
+  Background:
+    Given I am logged in
+    And plugin is installed 'new_release'
+    And plugin is activated
+    And I am on the page '/wp-admin/options-general.php?page=wprocket#page_cdn'
+
+  Scenario: Should validate that CDN purchase banner is displayed
+    Given I must see the banner 'High performance Content Delivery Network (CDN) with'
+    And I click on '.wpr-rocketcdn-open'
+    Then I must see the banner 'Login in to your WP Rocket Account to continue' in iframe '#rocketcdn-iframe'
+
diff --git a/src/features/delay-js.feature b/src/features/delay-js.feature
@@ -21,7 +21,7 @@ Feature: No Regression with delayjs script udpate
         And expand mobile menu 
         And I click on link
         Then page navigated to the new page 'about-us'
-        When I log in
+        When I am logged in
         And I go to 'wp-admin/plugins.php'
         And activate 'wpml-multilingual-cms' plugin
         And I go to 'wp-admin/admin.php?page=sitepress-multilingual-cms/menu/languages.php'
diff --git a/src/features/enable-all-features.feature b/src/features/enable-all-features.feature
@@ -11,5 +11,5 @@ Feature: C1205 - Enabling all WP Rocket features should not throw any fatal erro
         And I enable all settings
         And I log out
         Then page loads successfully
-        When I log in
+        When I am logged in
         Then I must not see any error in debug.log
diff --git a/src/features/lcp-beacon-script.feature b/src/features/lcp-beacon-script.feature
@@ -11,15 +11,15 @@ Feature: Beacon script captures the right images.
   Scenario: Beacon captures expected images in desktop
     When I log out
     And I visit the urls for 'desktop'
-    Then 'lcp and atf' should be as expected for 'desktop'
+    Then lcp and atf should be as expected for 'desktop'
 
   Scenario: Beacon captures expected images in mobile
     Given I install plugin 'https://github.com/wp-media/wp-rocket-e2e-test-helper/raw/main/helper-plugin/force-wp-mobile.zip'
     And plugin 'force-wp-mobile' is activated
     When I log out
     And I visit the urls for 'mobile'
     And plugin 'force-wp-mobile' is deactivated
-    Then 'lcp and atf' should be as expected for 'mobile'
+    Then lcp and atf should be as expected for 'mobile'
 
   @long-test
   Scenario Outline: Beacon applied and no console errors in desktop for <url>
diff --git a/src/features/preload-fonts.feature b/src/features/preload-fonts.feature
@@ -10,6 +10,6 @@ Feature: Beacon script captures the fonts ATF
 
     Scenario: Beacon captures expected atf fonts in desktop
         Given I log out
-        And I visit the urls for 'preloadfonts'
-        Then 'fonts' should be as expected for 'preloadfonts'
+        And I visit the urls for preload fonts
+        Then preload fonts should be as expected
 
diff --git a/src/features/settings-export-import.feature b/src/features/settings-export-import.feature
@@ -28,13 +28,24 @@ Feature: C2148 - Should not change the content of existing fields
         And I save settings 'media' 'lazyload'
         When I export data '3'
         Then data '3' is exported correctly
-        Then I must not see changes in exported files
+        Then Nothing changed in settings '3' compared to '2'
     
     Scenario: Visit homepage and other page
         Given plugin is installed 'new_release'
         And plugin is activated
         When I log out
         And I visit site url
         And I go to 'hello-world'
-        And I log in
-        Then I must not see any error in debug.log
+        And I am logged in
+        Then I must not see any error in debug.log
+
+    Scenario: Should not change enabled fields with update
+        Given plugin is installed 'previous_stable'
+        And plugin is activated
+        And I enable all settings
+        And I export data '1'
+        When I updated plugin to 'new_release'
+        And I go to 'wp-admin/options-general.php?page=wprocket#file_optimization'
+        And I save all settings
+        And I export data '2'
+        Then Nothing changed in settings '2' compared to '1'
diff --git a/src/support/hooks.ts b/src/support/hooks.ts
@@ -22,11 +22,20 @@ import { PageUtils } from "../../utils/page-utils";
 import { deleteFolder, isWprRelatedError } from "../../utils/helpers";
 import {WP_SSH_ROOT_DIR,} from "../../config/wp.config";
 import { After, AfterAll, Before, BeforeAll, Status, setDefaultTimeout } from "@cucumber/cucumber";
-import {rename, exists, rm, testSshConnection, installRemotePlugin, activatePlugin, uninstallPlugin, readFile} from "../../utils/commands";
+import {rename, exists, rm, testSshConnection, installRemotePlugin, activatePlugin, uninstallPlugin, readFile, isPluginActive} from "../../utils/commands";
 import type { Selectors } from "../../utils/types";
 import type { Section } from "../../utils/types";
 // import {configurations, getWPDir} from "../../utils/configurations";
 
+
+/**
+ * The name of the template loader plugin.
+ * This plugin must be active before running tests to avoid false positives.
+ * @constant {string}
+ */
+const TEMPLATE_LOADER_PLUGIN = 'template-loader-plugin-master';
+
+
 /**
  * The Playwright Chromium browser instance used for testing.
  */
@@ -55,7 +64,19 @@ BeforeAll(async function (this: ICustomWorld) {
         await rm(debugLogPath);
 
         await deleteFolder('./backstop_data/bitmaps_test');
+        
+        // Check if template loader plugin is active, activate if not
+        const isTemplateLoaderActive = await isPluginActive(TEMPLATE_LOADER_PLUGIN);
+        if (!isTemplateLoaderActive) {
+            console.log('Template loader plugin is not active, activating...');
+            await activatePlugin(TEMPLATE_LOADER_PLUGIN);
+        } else {
+            console.log('Template loader plugin is already active');
+        }
+        
         browser = await chromium.launch({ headless: false });
+
+        
     } catch (error) {
         console.error('Setup failed: ', error.message);
         throw new Error('Setup failed: ' + error.message);
diff --git a/src/support/results/expectedResultsDesktop.json b/src/support/results/expectedResultsDesktop.json
@@ -418,7 +418,7 @@
     "viewport": [
     "/wp-content/rocket-test-data/images/lcp/WF4.jpg.avif", "/wp-content/rocket-test-data/images/lcp/WF4.jpg.webp", 
     "/wp-content/rocket-test-data/images/lcp/WF4.jpg"],
-    "enabled": true
+    "enabled": false
   },
   "lcp_picture_responsive_type": {
     "comment": "Has a bug currently in UI#7547",
@@ -430,7 +430,7 @@
       "/wp-content/rocket-test-data/images/lcp/istockphoto-1148323720-612x612-1.jpg.webp 1024w, /wp-content/rocket-test-data/images/lcp/istockphoto-1148323720-612x612-1-450x380.jpg.webp 450w, /wp-content/rocket-test-data/images/lcp/istockphoto-1148323720-612x612-1-600x373.jpg.webp 600w",
       "https://new.rocketlabsqa.ovh/wp-content/rocket-test-data/images/lcp/istockphoto-1148323720-612x612-1.jpg"
   ],
-    "enabled": true
+    "enabled": false
   },
   "lcp_picture_template2_maxheight": {
     "lcp": [
diff --git a/src/support/results/expectedResultsPreloadFonts.json b/src/support/results/expectedResultsPreloadFonts.json
diff --git a/src/support/steps/general.ts b/src/support/steps/general.ts
diff --git a/src/support/steps/lcp-beacon-script.ts b/src/support/steps/lcp-beacon-script.ts
diff --git a/src/support/steps/settings-export-import.ts b/src/support/steps/settings-export-import.ts
diff --git a/src/support/steps/steps.ts b/src/support/steps/steps.ts
diff --git a/utils/commands.ts b/utils/commands.ts
diff --git a/utils/page-utils.ts b/utils/page-utils.ts
diff --git a/utils/types.ts b/utils/types.ts
