Font Library: load collection JSON data from a URL in the collection config #54067

matiasbenedetto · 2023-08-30T15:45:25Z

What?

Font Library: load collection JSON data from a URL in the collection config.

Why?

To avoid loading Google Fonts collection data from a file in the repo.

How?

Remove the data_json_file property from the font collection config and replace it by src property.
src property can have a value of a URL or a file path.
In both cases, if src is a URLor a file path it will be read by the backend and the data will be sent to the client.

Closes #53992

Testing instructions:

Use the UI to load Google Fonts collection:

Depends on:

Font Library: Font Collection backend #54098

Disclaimer

We are using this URL to load the google fonts collection data. When that file is hosted in wordpress.org that URL will be replaced.

Tracking issue:

[Tracking] Font Library. Stage 2: Fonts Library extensions #53307

Co-authored-by: Tonya Mork <tonya.mork@automattic.com>

* Ensures each required param is of the right data type. * Improves each param check error to include expected data type.

* Rechecking if "data_json_file" exists in the $config property shouldn't be necessary, as it's checked in the constructor. * If the file does not exist, bail out immediately as there's nothing more to do. * Adds a check and WP_Error for file_get_contents(): file_get_contents() returns false on failure. If there's nothing in the file, an empty string is returned. This change checks for both of these conditions and returns a WP_Error if either happens. * Internationalizes WP_Error error message for consistency in Core.

Co-authored-by: Tonya Mork <tonya.mork@automattic.com>

This reverts commit 0e6c026.

…n, remove try catch and raise the error if needed

github-actions · 2023-09-20T19:08:15Z

Flaky tests detected in a047eb7.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6253897039
📝 Reported issues:

[Flaky Test] should make the modal content focusable when it is scrollable #48067 in /test/e2e/specs/editor/various/a11y.spec.js

matiasbenedetto · 2023-09-20T19:32:47Z

This PR was updated with the latest trunk changes. It seems ready to review.
~~I think that adding one more test case for data loading from URLs is the only thing that needs to be added.~~ ✔️ Test added.

ironprogrammer · 2023-09-20T22:45:52Z

Works for me 👍🏻

Test Report

Steps to Test

Open the font management dialog and select the "Install Fonts" tab.
Compare the fonts listed, before and after patch.
Compare the response for the default-font-collection before and after patch (.../wp-json/wp/v2/fonts/collections/default-font-collection?_locale=user).

Environment

OS: macOS 13.5.2
Browser: Safari 16.6
Server: nginx/1.25.2
PHP: 7.4.33
WordPress: 6.4-alpha-56267-src
Theme: twentytwentythree v1.2
Active Plugins:
- gutenberg v16.7.0-rc.1 (compared trunk and this PR)

Actual Results

✅ Fonts displayed on the "Install Fonts" tab are consistent.
✅ The response data for default-font-collection is the same (used Postman to query and persist results to disk, then diffed in terminal).

anton-vlasenko

Please find my code review below.

lib/experimental/fonts/font-library/class-wp-font-collection.php

phpunit/tests/fonts/font-library/wpFontCollection/getData.php

Co-authored-by: Anton Vlasenko <43744263+anton-vlasenko@users.noreply.github.com>

matiasbenedetto · 2023-09-21T20:49:58Z

@anton-vlasenko I committed your code changes.
Thank you for the review.

pbking

🚢

…config (#54067) * Adding Font Collection class * php formatting and linting * Adding tests for collections routes * Adding tests for WP_Font_Collection constructor * adding tests for WP_Font_Collection get_data() * adding tests for WP_Font_Library register_font_collection() * get font collection tests * adding 'wp_' prefix to the 'register_font_collection' filter name * fix callback name * making class property private * registering filter from font-library.php file * removing superfluous comment * moving files to according changes in trunk * config without a json file should fail * fix property name in tests * name fix Co-authored-by: Tonya Mork <tonya.mork@automattic.com> * comment update Co-authored-by: Tonya Mork <tonya.mork@automattic.com> * Adds WP_Error to return type * Improves contructor error handling. * Ensures each required param is of the right data type. * Improves each param check error to include expected data type. * FontCollection::get_data(): Improves error handling * Rechecking if "data_json_file" exists in the $config property shouldn't be necessary, as it's checked in the constructor. * If the file does not exist, bail out immediately as there's nothing more to do. * Adds a check and WP_Error for file_get_contents(): file_get_contents() returns false on failure. If there's nothing in the file, an empty string is returned. This change checks for both of these conditions and returns a WP_Error if either happens. * Internationalizes WP_Error error message for consistency in Core. * Removes empty space for wpcs * adding filter in a simpler way Co-authored-by: Tonya Mork <tonya.mork@automattic.com> * micro-optimization Co-authored-by: Tonya Mork <tonya.mork@automattic.com> * reuse WP_Error response instead of creating a new one Co-authored-by: Tonya Mork <tonya.mork@automattic.com> * Eliminates try/catch * Revert "Eliminates try/catch" commit This reverts commit 0e6c026. * Remove wp_register_font_collection and replace it by a global function, remove try catch and raise the error if needed * adding function comment and guard agains re-declaration * php format * fixing docblock coments * removing param comment * re-adding parameter comment removed by mistake * format php * updating WP_Font_Collection __construct tests * updating WP_Font_Collection get_data tests * updating tests * php format * array check Co-authored-by: Tonya Mork <tonya.mork@automattic.com> * Documents config array structure * adding tests for /fonts/collections endpoint * adding /fonts/collections/<id> endpoint test * format * format * add test for missing collection * removing not needed variables * Add more tests and split the test for WP_REST_Font_Library_Controller * lint * try to create dir for tests in CI * renane config property to src and handle URLs apart from file paths * Add the ability to load collection JSON data from a URL * remove unwanted comment * fix missing merge * fix merge with trunk * removing test file after merge with trunk * removing duplicated test files after merge with trunk * decode data to make availanle in the client as json * update google fonts collection source * format php' * removing the default font collection (google fonts) json file from repo * fixing logic to get data from url * add tests to try the font collection fetching from url * update test * format comments * replacing existing url in test with a mock url * early return Co-authored-by: Anton Vlasenko <43744263+anton-vlasenko@users.noreply.github.com> * remove not needed filter Co-authored-by: Anton Vlasenko <43744263+anton-vlasenko@users.noreply.github.com> * rewording error message Co-authored-by: Anton Vlasenko <43744263+anton-vlasenko@users.noreply.github.com> --------- Co-authored-by: Tonya Mork <tonya.mork@automattic.com> Co-authored-by: Anton Vlasenko <43744263+anton-vlasenko@users.noreply.github.com>

mikachan · 2023-09-22T16:58:27Z

I just cherry-picked this PR to the release/16.7 branch to get it included in the next release: ead73c8

anton-vlasenko · 2023-09-22T17:37:47Z

Oops, this has already been merged.
I didn’t notice this during my initial code review, but

if ( false !== strpos( $this->config['src'], 'http' ) && false !== strpos( $this->config['src'], '://' ) ) {

could be replaced with

if ( str_contains( $this->config['src'], 'http' ) && str_contains( $this->config['src'], '://' ) ) {

for better readability.
But this is more of a nitpick.

matiasbenedetto · 2023-09-26T13:38:19Z

could be replaced with

if ( str_contains( $this->config['src'], 'http' ) && str_contains( $this->config['src'], '://' ) ) {

Thank yo so much for the new review @anton-vlasenko !

str_contains() was introduced in PHP 8, so I don't think it is the right move to use it here. https://www.php.net/manual/en/function.str-contains.php because it's not available on PHP < 8.

ironprogrammer · 2023-09-26T14:35:30Z

@matiasbenedetto, this should be okay, as a polyfill for str_contains was introduced to Core in https://core.trac.wordpress.org/ticket/49652.

matiasbenedetto · 2023-09-26T15:14:28Z

@ironprogrammer Good to know. Changed here: #54832

matiasbenedetto and others added 30 commits August 18, 2023 12:35

Adding Font Collection class

79d6af7

php formatting and linting

fd1c967

Adding tests for collections routes

0cfac6c

Adding tests for WP_Font_Collection constructor

6bb2f8b

adding tests for WP_Font_Collection get_data()

4a67d0b

adding tests for WP_Font_Library register_font_collection()

b26cb63

get font collection tests

0cfddb2

adding 'wp_' prefix to the 'register_font_collection' filter name

7ba6f61

fix callback name

454f9a5

making class property private

932064f

registering filter from font-library.php file

b184398

Merge branch 'trunk' into try/font-collections

6a2dfa0

removing superfluous comment

36ab188

moving files to according changes in trunk

ac938c9

config without a json file should fail

a9c7b6a

fix property name in tests

b2deb14

name fix

4765538

Co-authored-by: Tonya Mork <tonya.mork@automattic.com>

comment update

3fb8b0a

Co-authored-by: Tonya Mork <tonya.mork@automattic.com>

Adds WP_Error to return type

3fadd9d

Improves contructor error handling.

bdaacf8

* Ensures each required param is of the right data type. * Improves each param check error to include expected data type.

Removes empty space for wpcs

4ae9af6

adding filter in a simpler way

de053da

Co-authored-by: Tonya Mork <tonya.mork@automattic.com>

micro-optimization

21dfbe3

Co-authored-by: Tonya Mork <tonya.mork@automattic.com>

reuse WP_Error response instead of creating a new one

fb913af

Co-authored-by: Tonya Mork <tonya.mork@automattic.com>

Eliminates try/catch

0e6c026

Revert "Eliminates try/catch" commit

f79212d

This reverts commit 0e6c026.

Remove wp_register_font_collection and replace it by a global functio…

4e952e3

…n, remove try catch and raise the error if needed

adding function comment and guard agains re-declaration

196459a

php format

a76d943

matiasbenedetto added 6 commits September 20, 2023 16:51

removing the default font collection (google fonts) json file from repo

0022826

fixing logic to get data from url

bdd756f

add tests to try the font collection fetching from url

d51a3ff

update test

44acc0c

format comments

08fc24b

replacing existing url in test with a mock url

a047eb7

mikachan added the Backport to Gutenberg RC Pull request that needs to be backported to a Gutenberg release candidate (RC) label Sep 21, 2023

anton-vlasenko self-requested a review September 21, 2023 19:56

anton-vlasenko reviewed Sep 21, 2023

View reviewed changes

matiasbenedetto and others added 3 commits September 21, 2023 17:46

early return

241f2a6

Co-authored-by: Anton Vlasenko <43744263+anton-vlasenko@users.noreply.github.com>

remove not needed filter

baa8114

Co-authored-by: Anton Vlasenko <43744263+anton-vlasenko@users.noreply.github.com>

rewording error message

e4d7565

Co-authored-by: Anton Vlasenko <43744263+anton-vlasenko@users.noreply.github.com>

pbking approved these changes Sep 22, 2023

View reviewed changes

matiasbenedetto merged commit 8a82a37 into trunk Sep 22, 2023
49 checks passed

matiasbenedetto deleted the try/font-collections-url branch September 22, 2023 16:44

github-actions bot added this to the Gutenberg 16.8 milestone Sep 22, 2023

mikachan removed the Backport to Gutenberg RC Pull request that needs to be backported to a Gutenberg release candidate (RC) label Sep 22, 2023

mikachan modified the milestones: Gutenberg 16.8, Gutenberg 16.7 Sep 22, 2023

matiasbenedetto mentioned this pull request Sep 26, 2023

Font Library: syntax refactor repace strpos with str_contains #54832

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Font Library: load collection JSON data from a URL in the collection config #54067

Font Library: load collection JSON data from a URL in the collection config #54067

matiasbenedetto commented Aug 30, 2023 •

edited

github-actions bot commented Sep 20, 2023 •

edited

matiasbenedetto commented Sep 20, 2023 •

edited

ironprogrammer commented Sep 20, 2023

anton-vlasenko left a comment

matiasbenedetto commented Sep 21, 2023

pbking left a comment

mikachan commented Sep 22, 2023

anton-vlasenko commented Sep 22, 2023

matiasbenedetto commented Sep 26, 2023

ironprogrammer commented Sep 26, 2023

matiasbenedetto commented Sep 26, 2023

Font Library: load collection JSON data from a URL in the collection config #54067

Font Library: load collection JSON data from a URL in the collection config #54067

Conversation

matiasbenedetto commented Aug 30, 2023 • edited

What?

Why?

How?

Testing instructions:

Depends on:

Disclaimer

Tracking issue:

github-actions bot commented Sep 20, 2023 • edited

matiasbenedetto commented Sep 20, 2023 • edited

ironprogrammer commented Sep 20, 2023

Test Report

Steps to Test

Environment

Actual Results

anton-vlasenko left a comment

Choose a reason for hiding this comment

matiasbenedetto commented Sep 21, 2023

pbking left a comment

Choose a reason for hiding this comment

mikachan commented Sep 22, 2023

anton-vlasenko commented Sep 22, 2023

matiasbenedetto commented Sep 26, 2023

ironprogrammer commented Sep 26, 2023

matiasbenedetto commented Sep 26, 2023

matiasbenedetto commented Aug 30, 2023 •

edited

github-actions bot commented Sep 20, 2023 •

edited

matiasbenedetto commented Sep 20, 2023 •

edited