Closes #7069: 3.18 - Exclusions part

[Miraeld]

Description

Fixes #7069
It allows the user to use a new filter rocket_exclude_locally_host_fonts to exclude some fonts from the feature.

Type of change

• New feature (non-breaking change which adds functionality).

Detailed scenario

Just add some fonts to exclusiosn through the new filter (rocket_exclude_locally_host_fonts), and it won't be downloaded.

Technical description

Documentation

This pull request introduces a new feature to exclude specific fonts from being rewritten in the media fonts optimization process. The changes involve adding methods to handle font exclusions and updating relevant tests to ensure the new functionality works as expected.

New Feature: Font Exclusions

• inc/Engine/Media/Fonts/Frontend/Controller.php: Added methods get_exclusions and is_excluded to obtain and check font exclusion patterns, and updated rewrite_fonts to skip excluded fonts. [1] [2]
• inc/Engine/Optimization/DynamicLists/DynamicLists.php: Added method get_exclude_media_fonts to retrieve excluded font templates.
• inc/Engine/Optimization/DynamicLists/Subscriber.php: Subscribed to the rocket_media_fonts_exclusions event and added add_media_fonts_exclusions method to include media font exclusions. [1] [2]

Tests and Fixtures Updates

• tests/Fixtures/inc/Engine/Media/Fonts/Frontend/Subscriber/HTML/expected_v1_excluded_v2.php: Added a new fixture for testing the exclusion of V2 fonts while rewriting V1 fonts.
• tests/Fixtures/inc/Engine/Media/Fonts/Frontend/Subscriber/rewriteFonts.php: Added a new test case testShouldRewriteV1AndExcludeV2Fonts to verify the exclusion functionality.
• tests/Integration/inc/Engine/Media/Fonts/Frontend/Subscriber/rewriteFonts.php: Updated setup and teardown methods to include the new rocket_exclude_locally_host_fonts filter, and added the exclude_locally_host_fonts method. [1] [2]

New dependencies

None

Risks

None

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.

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.05% (target: -0.10%)	✅ 91.67% (target: 50.00%)

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (ea1eee8)	38495	16909	43.93%
Head commit (8637808)	38500 (+5)	16929 (+20)	43.97% (+0.05%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#7167)	48	44	91.67%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

[jeawhanlee]

I might be mistaken but I'm not sure this PR considers this thread here and the proposals following because as it is we might not be correctly excluding combined fonts or not?

[Miraeld]

@remyperona @jeawhanlee
Hello hello,

I've made modifications to comply with feedbacks.
Added, also, the exclusion to the Google Font combine feature so we won't combine excluded fonts.

---

Summary of changes by this PR:

This pull request introduces several enhancements to the font optimization process, specifically focusing on excluding certain fonts from being optimized based on user-defined patterns. These changes include updates to the core functionality, new methods for exclusion handling, and corresponding test cases.

Core Functionality Enhancements:

• inc/Engine/Media/Fonts/Frontend/Controller.php: Added methods get_exclusions and is_excluded to retrieve exclusion patterns and check if a font URL matches any exclusion pattern. Updated rewrite_fonts method to skip excluded fonts during font replacement. [1] [2]

Integration with Dynamic Lists:

• inc/Engine/Optimization/DynamicLists/DynamicLists.php: Introduced get_exclude_media_fonts method to fetch excluded font templates.
• inc/Engine/Optimization/DynamicLists/Subscriber.php: Added event subscription for rocket_media_fonts_exclusions and implemented add_media_fonts_exclusions to merge dynamic list exclusions with existing exclusions. [1] [2]

Google Fonts Optimization:

• inc/Engine/Optimization/GoogleFonts/AbstractGFOptimization.php: Added methods get_exclusions and is_excluded to handle exclusion patterns for Google Fonts optimization.
• inc/Engine/Optimization/GoogleFonts/Combine.php and CombineV2.php: Updated optimize method to filter out excluded fonts before processing. [1] [2]

Test Cases:

• Added new test fixtures and updated existing ones to validate the exclusion functionality. [1] [2] [3] [4] [5] [6] [7]
• Updated integration tests to include the new exclusion filters and ensure they are applied correctly. [1] [2] [3] [4] [5] [6]

[hanna-meda]

@Miraeld, thank you for this PR.
I could only make the filter work using font family name, i.e. $exclusions[] = 'Roboto';
Based on this AC The exclusion should be regex compatible, we should also cover expressions such as:
$exclusions[] = 'https://fonts.googleapis.com/css?family=.*';
$exclusions[] = 'fonts.googleapis.com/.*';
$exclusions[] = 'https://fonts.googleapis.com/css?family=Noto%20Sans%3A400%2C700%7CMontserrat%3A700&display=swap';
$exclusions[] = 'https://fonts.googleapis.com/css?family=Rob.*';

Returning this back to In Progress based on this comment. cc @piotrbak

[piotrbak]

@hanna-meda after discussion on the daily, since the URL doesn't matter for the exclusions, we'll match the regex after it:

• family(.*)Montserrat%3A700&display=swap
  -family=Rob(.*)o

cc @jeawhanlee

[Mai-Saad]

Thanks for the update.
[WIP] exploratory test notes:

1. If the HTML have already combined file , the feature won't be applied ex this page (no font is downloaded nor rewritten) https://new.rocketlabsqa.ovh/combinedalready
2. Exclusion is now case sensitive i.eMontserratwill work while montserrat won't (test page https://new.rocketlabsqa.ovh/combine_gf_v2new)
3. Using exclusion like this $exclusions[] = 'family=Oswald&#038'; won't make the feature work at all (nothing is downloaded nor rewritten, only combined external) here https://new.rocketlabsqa.ovh/combine_gf_v2new
4. Exclusion by argument is not working i.e $exclusions[]= 'testRobo'; here https://new.rocketlabsqa.ovh/combine_gf_v2new
5. If the filter returns [""], the feature won't work at all (fonts will be there , not combined nor locally hosted) and nothing in debug.log about that

@piotrbak What do you think is a must to be fixed here? or other GH

Note: these exclusions are working fine here https://new.rocketlabsqa.ovh/combine_gf_v2new (partial match of the font URL, partial match with regex)

$exclusions[] = 'Lora'; 
$exclusions[] = 'family=Phetsarath';
$exclusions[] = 'family=R(.*)';
$exclusions[] = 'family=Phetsarath:wght@400;700&display=swap';

[piotrbak]

@Mai-Saad

1. Seems to be a markup issue, lack of "
2. That's fine

Points 3 and 4 seem to be related, is it possible that we're trying to exclude after the combination process 🤔 ?

5. It's fine

[Mai-Saad]

For 3 family=Phetsarath:wght@400;700&display=swap is working {excluding only related font} but family=Phetsarath:wght@400;700&display=swap is not working (the one not working is from the combined file in HTML , while the working one is when we open combined in browser)

[remyperona]

Point 4 is not working because the exclusion is done against the URL only, not attributes of the link tag.

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
❌ -0.16% (target: -0.10%)	✅ 91.67% (target: 50.00%)

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (2c51c61)	38621	17048	44.14%
Head commit (7ec0b4e)	38544 (-77)	16954 (-94)	43.99% (-0.16%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#7167)	48	44	91.67%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

[remyperona]

I fixed point 2 with the latest commit.

Point 3 happens because of the difference between & and &.

The combine GF and self-host use the same exclusion filter, but the format of the URL is different between them: combine gf uses & and then transform the URL to use &

So if you use &, the exclusion won't work for combine GF, but will work for self-host, excluding the full combined URL.