[CYS on Core] Conditionally change the default fonts available based on user consent #44532

nefeline · 2024-02-11T13:13:00Z

Submission Review Guidelines:

I have followed the WooCommerce Contributing Guidelines and the WordPress Coding Standards.
I have checked to ensure there aren't other open Pull Requests for the same update/change.
I have reviewed my code for security best practices.
Following the above guidelines will result in quick merges and clear and detailed feedback when appropriate.

Changes proposed in this Pull Request:

Introduce the feature for conditionally changing the default font pairings available based on user consent and the WordPress version.

Closes #44187

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

Initial Setup

Enable the WooCommerce Beta Tester plugin if you don't have it enabled yet
On your Dashboard, head over to Tools > WCA Test Helper > Features and enable the customize-store
Ensure you have the Gutenberg plugin installed from the latest trunk (or install it from this zip file: gutenberg.zip

1. The store owner gave consent (`woocommerce_allow_tracking` is true) but has an outdated version of WordPress/Gutenberg or Gutenberg is not installed

Access the database for your local install and make sure the 'woocommerce_allow_tracking' option is set to yes:
select * from wp_options where option_name = 'woocommerce_allow_tracking';

Since WP 6.5 wasn't released yet, just make sure the Gutenberg plugin is disabled in your local install.
Access your Dashboard and head over to WooCommerce > Home
Click on the "Customize Your Store" button
Click on "Start designing"
Make sure you see the following:

Screen.Recording.2024-02-23.at.10.50.58.mov

⚠️ At this point, WordPress 6.5 hasn't been released yet, so the store owner is led to the WordPress core update screen, but they can't really perform any actions just yet: this is expected. This feature is only shipping with WooCommerce 8.8, after the release of WordPress 6.5, so we should be all set here.

2. User did not give us consent (`woocommerce_allow_tracking` is false) and also has an outdated version of WordPress (earlier than 6.5).

Access the database for your local install and make sure the 'woocommerce_allow_tracking' option is set to no:
select * from wp_options where option_name = 'woocommerce_allow_tracking';

Ensure the Gutenberg plugin is DISABLED in your local install.
Access your Dashboard and head over to WooCommerce > Home
Click on the "Customize Your Store" button
Click on "Start designing"
Make sure you see the following:

Copy on the sidebar:

Copy for the newly introduced Opt-in modal:

The checkbox is unchecked, the Opt-in button is disabled:

Screen.Recording.2024-02-23.at.10.57.26.mov

3. User did not give us consent (`woocommerce_allow_tracking` is false) and has the latest version of WP/GB installed.

Access the database for your local install and make sure the 'woocommerce_allow_tracking' option is set to no:
select * from wp_options where option_name = 'woocommerce_allow_tracking';

Make sure the Gutenberg plugin is ACTIVE on your local install.
Access your Dashboard and head over to WooCommerce > Home
Click on the "Customize Your Store" button
Click on "Start designing"
Make sure you see the following:

Copy on the sidebar and available font pairings:

The two font pairings are being inherited from the TT4 theme:

Cardo (H), System sans-serif (B) — TT4 default
Inter (H), Cardo (B) — TT4 Fossil Style

⚠️ Known issue: the font pairings on the sidebar are not showing the correct styles & the body text in the editor either: a separate PR will be opened to address this.

4. User gave consent and has the latest version of WordPress and/or GB plugin installed

Access the database for your local install and make sure the 'woocommerce_allow_tracking' option is set to yes:
select * from wp_options where option_name = 'woocommerce_allow_tracking';

Ensure the Gutenberg plugin is ENABLED in your local install.
Access your Dashboard and head over to WooCommerce > Home
Click on the "Customize Your Store" button
Click on "Start designing"
Make sure you see the following:

Question to @verofasulo: I believe the 2 font pairings from the TT4 theme should be preserved in the list of options in this case instead of replacing them with our default ones, WDYT?

Changelog entry

Automatically create a changelog entry from the details below.

Significance

Patch
Minor
Major

Type

Fix - Fixes an existing bug
Add - Adds functionality
Update - Update existing functionality
Dev - Development related task
Tweak - A minor adjustment to the codebase
Performance - Address performance issues
Enhancement - Improvement to existing functionality

Message

Customize Your Store: Introduce the feature for conditionally changing the default font pairings available based on user consent and the WordPress version.

Comment

…the user did not grant us consent.

github-actions · 2024-02-11T13:27:35Z

Test Results Summary

Commit SHA: d14a3fe

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	0m 37s
E2E Tests	335	0	0	10	0	345	7m 22s

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

…rade-notice class.

…g-modal

…hecked.

…racking-modal

…ing wasn't allowed.

…y is unavailable.

…ever the user opts in.

…alled for them.

…default-fonts-available-based-on-user-consent

…Update the link to download the latest version of the core of WordPress.

…default-fonts-available-based-on-user-consent

…mmerce

github-actions · 2024-02-23T11:12:46Z

Hi @albarin, @gigitux, @kmanijak,

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

…edirect is not triggered before the option is saved to the database.

…default-fonts-available-based-on-user-consent

albarin

Great job!

verofasulo · 2024-03-04T09:51:30Z

Question to @verofasulo: I believe the 3 font pairings from the TT4 theme should be preserved in the list of options in this case instead of replacing them with our default ones, WDYT?

Good question, @nefeline. Right now, we are using TT4 as the default theme for patter assembler, but we could use Creatio, Assembler 2 or whatever other theme. The logic you proposed should be in place once we implement the pattern assembler experience for all the block themes IMO. Right now, it's detached from a specific theme and its style, so I would default to what we have already implemented. Thanks!

…on user consent (#44532) * Add upgrade notice for the fonts feature whenever WP is outdateed or the user did not grant us consent. * Add styles for the woocommerce-customize-store_sidebar-typography-upgrade-notice class. * Update the upgrade conditionals. * Introduce the new modal for the user to opt in to usage tracking. * Add the CSS for the woocommerce-customize-store__opt-in-usage-tracking-modal * Implement the sendEvent to OptInDataSharing * Fix typo. * Make sure the opt in button is disabled if the opt in checkbox is unchecked. * Update the styles for the woocommerce-customize-store__opt-in-usage-tracking-modal * Update the styles to allow changes to the link * Set Cardo + System Sans-serif as the default fonts if the usage tracking wasn't allowed. * Set Cardo + System Sans-serif as the default fonts if the Font Library is unavailable. * Add the Jost + Instrument Sans font pairing. * Update copy for the upgrade notice to remove mentions to Gutenberg. * Replace the Link component with the Button component. * Ensure the woocommerce_allow_tracking option is properly updated whenever the user opts in. * Add the new Inter + Cardo font pairing. * Redirect user to the loading screen so all relevant fonts can be installed for them. * Render the FontPairing component only if the isFontLibraryAvailable. Update the link to download the latest version of the core of WordPress. * update the fontPairings constant. * Update styles for buttons and links. * Add changefile(s) from automation for the following project(s): woocommerce * Make sure the dispatch for updating the option is async so the page redirect is not triggered before the option is saved to the database. * Fix lint error --------- Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: Alba Rincón <alba.rincon@automattic.com>

Add upgrade notice for the fonts feature whenever WP is outdateed or …

bff530f

…the user did not grant us consent.

nefeline linked an issue Feb 11, 2024 that may be closed by this pull request

[CYS on Core] Conditionally change the default fonts available based on user consent. #44187

Closed

nefeline self-assigned this Feb 11, 2024

nefeline added plugin: woocommerce Issues related to the WooCommerce Core plugin. focus: customize-your-store Issues related to the Customize Your Store onboarding flow. type: enhancement The issue is a request for an enhancement. labels Feb 11, 2024

Add styles for the woocommerce-customize-store_sidebar-typography-upg…

af41875

…rade-notice class.

github-actions bot removed the plugin: woocommerce Issues related to the WooCommerce Core plugin. label Feb 11, 2024

nefeline added 21 commits February 11, 2024 17:52

Update the upgrade conditionals.

998d4dd

Introduce the new modal for the user to opt in to usage tracking.

765bbcd

Add the CSS for the woocommerce-customize-store__opt-in-usage-trackin…

6f5ca9d

…g-modal

Implement the sendEvent to OptInDataSharing

bf92fc5

Fix typo.

b64d3d9

Make sure the opt in button is disabled if the opt in checkbox is unc…

fcec3b9

…hecked.

Update the styles for the woocommerce-customize-store__opt-in-usage-t…

250239b

…racking-modal

Update the styles to allow changes to the link

a94ba5b

Set Cardo + System Sans-serif as the default fonts if the usage track…

f5018b1

…ing wasn't allowed.

Set Cardo + System Sans-serif as the default fonts if the Font Librar…

0fe8228

…y is unavailable.

Add the Jost + Instrument Sans font pairing.

8a31a82

Merge latest trunk

faf7910

Update copy for the upgrade notice to remove mentions to Gutenberg.

310d3cf

Replace the Link component with the Button component.

6338ccd

Ensure the woocommerce_allow_tracking option is properly updated when…

73bf46d

…ever the user opts in.

Add the new Inter + Cardo font pairing.

b5f448b

Redirect user to the loading screen so all relevant fonts can be inst…

1c718d7

…alled for them.

Merge branch 'trunk' into 44187-cys-on-core-conditionally-change-the-…

d232271

…default-fonts-available-based-on-user-consent

Render the FontPairing component only if the isFontLibraryAvailable. …

8989c80

…Update the link to download the latest version of the core of WordPress.

update the fontPairings constant.

5de6291

Update styles for buttons and links.

2ed6b2e

Merge branch 'trunk' into 44187-cys-on-core-conditionally-change-the-…

23a0f4b

…default-fonts-available-based-on-user-consent

nefeline marked this pull request as ready for review February 23, 2024 11:12

Add changefile(s) from automation for the following project(s): wooco…

d83ac3e

…mmerce

woocommercebot requested review from a team and kmanijak and removed request for a team February 23, 2024 11:12

nefeline requested a review from albarin February 23, 2024 11:26

nefeline added the plugin: woocommerce Issues related to the WooCommerce Core plugin. label Feb 23, 2024

nefeline added 2 commits February 23, 2024 13:50

Make sure the dispatch for updating the option is async so the page r…

6d2a653

…edirect is not triggered before the option is saved to the database.

Merge branch 'trunk' into 44187-cys-on-core-conditionally-change-the-…

f10229b

…default-fonts-available-based-on-user-consent

nefeline requested review from gigitux and removed request for kmanijak February 25, 2024 23:55

nefeline added the status: blocker Blockers for other work. label Feb 25, 2024

albarin added 2 commits February 26, 2024 11:16

Merge branch 'trunk' into 44187-cys-on-core-conditionally-change-the-…

6591df7

…default-fonts-available-based-on-user-consent

Fix lint error

d14a3fe

albarin approved these changes Feb 26, 2024

View reviewed changes

gigitux merged commit fe0b918 into trunk Feb 26, 2024
30 checks passed

gigitux deleted the 44187-cys-on-core-conditionally-change-the-default-fonts-available-based-on-user-consent branch February 26, 2024 15:01

github-actions bot added this to the 8.8.0 milestone Feb 26, 2024

github-actions bot added the needs: analysis Indicates if the PR requires a PR testing scrub session. label Feb 26, 2024

gigitux mentioned this pull request Feb 26, 2024

[CYS - Core] Font Preview and Site Preview Fail to load fonts when user opts out of tracking #45138

Closed

alvarothomas added needs: internal testing Indicates if the PR requires further testing conducted by Solaris status: analysis complete Indicates if a PR has been analysed by Solaris and removed needs: analysis Indicates if the PR requires a PR testing scrub session. labels Feb 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CYS on Core] Conditionally change the default fonts available based on user consent #44532

[CYS on Core] Conditionally change the default fonts available based on user consent #44532

nefeline commented Feb 11, 2024 •

edited

github-actions bot commented Feb 11, 2024 •

edited

github-actions bot commented Feb 23, 2024 •

edited

albarin left a comment

verofasulo commented Mar 4, 2024

[CYS on Core] Conditionally change the default fonts available based on user consent #44532

[CYS on Core] Conditionally change the default fonts available based on user consent #44532

Conversation

nefeline commented Feb 11, 2024 • edited

Submission Review Guidelines:

Changes proposed in this Pull Request:

How to test the changes in this Pull Request:

Initial Setup

1. The store owner gave consent (woocommerce_allow_tracking is true) but has an outdated version of WordPress/Gutenberg or Gutenberg is not installed

2. User did not give us consent (woocommerce_allow_tracking is false) and also has an outdated version of WordPress (earlier than 6.5).

3. User did not give us consent (woocommerce_allow_tracking is false) and has the latest version of WP/GB installed.

4. User gave consent and has the latest version of WordPress and/or GB plugin installed

Changelog entry

Significance

Type

Message

Comment

github-actions bot commented Feb 11, 2024 • edited

Test Results Summary

github-actions bot commented Feb 23, 2024 • edited

albarin left a comment

Choose a reason for hiding this comment

verofasulo commented Mar 4, 2024

nefeline commented Feb 11, 2024 •

edited

1. The store owner gave consent (`woocommerce_allow_tracking` is true) but has an outdated version of WordPress/Gutenberg or Gutenberg is not installed

2. User did not give us consent (`woocommerce_allow_tracking` is false) and also has an outdated version of WordPress (earlier than 6.5).

3. User did not give us consent (`woocommerce_allow_tracking` is false) and has the latest version of WP/GB installed.

github-actions bot commented Feb 11, 2024 •

edited

github-actions bot commented Feb 23, 2024 •

edited