ensure clean imagify state before tagged smoke scenarios

[hanna-meda]

Description

Fixes #336
This PR adds a new precondition hook that uninstalls Imagify when present for selected smoke tests.

Type of change

• New feature (non-breaking change which adds functionality).
• Bug fix (non-breaking change which fixes an issue).
• Enhancement (non-breaking change which improves an existing functionality).
• Breaking change (fix or feature that would cause existing functionality to not work as before).
• Sub-task of #(issue number)
• Chore
• Release

Detailed scenario

What was tested

• Verified tagged smoke scenarios trigger the new precondition hook that uninstalls Imagify when present.
• Verified non-tagged smoke scenarios are unchanged.
• Ran command npm run test:smoke with wpr 3.20.3 to make sure the error described in PHP Warning: Undefined array key "svg" when validate license after being unbanned wp-rocket#7991 is now caught through smoke tests.

How to test

Run npm run test:smoke with wpr 3.20.3 as new_release. Expected: Smoke tests that install the plugin and visit settings fail, with an error in debug.log.

Affected Features & Quality Assurance Scope

• Smoke scenarios that install/activate WP Rocket and then visit settings or enable all settings.
• Hook execution flow for tagged smoke scenarios.

Technical description

Documentation

Added a new tag-scoped Before hook for selected smoke scenarios.
Hook checks whether Imagify is installed and uninstalls it if present.
Scope is limited using tag expression to avoid impacting unrelated scenarios.

New dependencies

None.

Risks

Extra setup time for tagged scenarios if Imagify is installed.
Tag drift if future smoke scenarios need the same precondition but are not tagged.

Mitigations:
Hook is narrowly scoped via tags.

Mandatory Checklist

Code validation

• I validated all the Acceptance Criteria. If possible, provide screenshots or videos.
• I triggered all changed lines of code at least once without new errors/warnings/notices.
• I implemented built-in tests to cover the new/changed code.

Code style

• I wrote a self-explanatory code about what it does.
• I protected entry points against unexpected inputs.
• I did not introduce unnecessary complexity.
• Output messages (errors, notices, logs) are explicit enough for users to understand the issue and are actionnable.

Unticked items justification

N/A

Additional Checks

• In the case of complex code, I wrote comments to explain it.
• When possible, I prepared ways to observe the implemented system (logs, data, etc.).
• I added error handling logic when using functions that could throw errors (HTTP/API request, filesystem, etc.)

[Copilot]

Pull request overview

Adds a tag-scoped Cucumber Before hook to ensure certain smoke scenarios run with a clean state by removing the Imagify plugin when present, aligning smoke runs with the failure mode described in issue #336 / wp-rocket#7991.

Changes:

• Added a new Before hook in src/support/hooks.ts scoped to @smoke + @requires-clean-imagify scenarios to uninstall Imagify.
• Introduced the @requires-clean-imagify tag on selected smoke scenarios/features that need this precondition.
• Scoped the hook to exclude @imagify-compatibility scenarios.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/support/hooks.ts	Adds tag-scoped precondition hook to uninstall Imagify before selected smoke scenarios.
src/features/settings-export-import.feature	Tags specific smoke scenarios to require clean Imagify state.
src/features/self-host-google-fonts.feature	Tags feature to require clean Imagify state during smoke run.
src/features/roll-back.feature	Tags feature to require clean Imagify state during smoke run.
src/features/enable-all-features.feature	Tags feature to require clean Imagify state during smoke run.
src/features/delete-plugin.feature	Tags one scenario to require clean Imagify state during smoke run.
src/features/broken-links.feature	Tags feature to require clean Imagify state during smoke run.

[Copilot]

Pull request overview

Adds a tag-scoped Cucumber precondition to ensure Imagify is uninstalled before specific smoke scenarios, improving smoke-test reliability for cases where Imagify’s presence can trigger WP Rocket debug.log errors (per #336 / wp-rocket#7991).

Changes:

• Added a Before hook scoped to @smoke + @requires-clean-imagify (excluding @imagify-compatibility) that uninstalls Imagify.
• Tagged selected smoke scenarios/features with @requires-clean-imagify to opt into the new precondition.
• Expanded coverage of “clean Imagify state” across multiple smoke paths (settings visits, enable-all, rollback, broken links, export/import).

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/support/hooks.ts	Adds a tag-scoped Before hook that uninstalls Imagify for selected smoke scenarios.
src/features/settings-export-import.feature	Tags two scenarios to require a clean Imagify state.
src/features/self-host-google-fonts.feature	Tags the smoke feature to require a clean Imagify state.
src/features/roll-back.feature	Tags the smoke feature to require a clean Imagify state.
src/features/enable-all-features.feature	Tags the smoke feature to require a clean Imagify state.
src/features/delete-plugin.feature	Tags the “installed and activated” scenario to require a clean Imagify state.
src/features/broken-links.feature	Tags the smoke feature to require a clean Imagify state.

[Copilot]

Pull request overview

Adds a tag-scoped Cucumber Before hook to ensure a clean environment (Imagify uninstalled) for selected smoke scenarios, so smoke runs can better surface WP Rocket debug.log errors like the one described in #336 / wp-rocket#7991.

Changes:

• Added a new Before hook scoped to @requires-clean-imagify scenarios to uninstall Imagify (while excluding @imagify-compatibility).
• Tagged selected smoke scenarios/features with @requires-clean-imagify so the precondition runs only where needed.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/support/hooks.ts	Adds the tag-scoped precondition hook to uninstall Imagify for selected scenarios.
src/features/settings-export-import.feature	Tags two scenarios to enforce a clean Imagify state before running them.
src/features/self-host-google-fonts.feature	Tags the smoke feature to enforce a clean Imagify state.
src/features/roll-back.feature	Tags the smoke feature to enforce a clean Imagify state.
src/features/enable-all-features.feature	Tags the smoke feature to enforce a clean Imagify state.
src/features/delete-plugin.feature	Tags the “installed and activated” scenario to enforce a clean Imagify state.
src/features/broken-links.feature	Tags the smoke feature to enforce a clean Imagify state.

[Mai-Saad]

if we need this run before smoke test , why not just use @smoke instead of @requires-clean-imagify?

[hanna-meda]

@Mai-Saad, I used requires-clean-imagify so this hook can be reused beyond smoke. It is currently applied only in smoke, but the precondition itself is not smoke-specific.

[hanna-meda]

Smoke results with 3.21.1 as new release (all green):

@Mai-Saad

[Mai-Saad]