Font Library: ensure merged fontFace data is enconded as an array instead of an object

[matiasbenedetto]

What?

• Ensure merged fontFace data is JSON encoded as an array instead of an object.
• Add a test case to ensure that.

Why?

To fix a bug consisting of fontFace data being JSON encoded as an object ( {...} ) instead of an array ( [...] ).

When we remove duplicates, we could end up with missing sequential array keys in the fontFace list.

Because of the nature of PHP arrays and how they are encoded into JSON. In PHP, arrays can behave like indexed arrays or associative arrays (hashmaps). When they are encoded into JSON, indexed arrays become JSON arrays (e.g., [...]), while associative arrays become JSON objects (e.g., {...}).

The reason fontFace is being encoded as an object in your JSON output is due to the non-sequential keys.

How?

To ensure that fontFace is always encoded as a JSON array, I reset the keys of the $unique_faces array using array_values() before assigning it to $merged_font['fontFace']. This will reindex the keys and make sure they are sequential.

Testing Instructions

Run PHP unit tests with and without calling array_values() on this line:

$merged_font['fontFace'] = array_values( $unique_faces );

$merged_font['fontFace'] =  $unique_faces;

The added test case should fail when array_values() is not used.

[github-actions]

This pull request has changed or added PHP files. Please confirm whether these changes need to be synced to WordPress Core, and therefore featured in the next release of WordPress.

If so, it is recommended to create a new Trac ticket and submit a pull request to the WordPress Core Github repository soon after this pull request is merged.

If you're unsure, you can always ask for help in the #core-editor channel in WordPress Slack.

Thank you! ❤️

View changed files

❔ lib/experimental/fonts/font-library/class-wp-font-family-utils.php
❔ phpunit/tests/fonts/font-library/wpFontFamilyUtils/mergeFontsData.php

[github-actions]

Flaky tests detected in 6d894c4.
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/6175255285
📝 Reported issues:

• [Flaky Test] image inserted via link should appear in the frontend published post content #52030 in /test/e2e/specs/editor/blocks/image.spec.js
• [Flaky Test] should partially select with shift + click (@webkit) #53524 in /test/e2e/specs/editor/various/multi-block-selection.spec.js

[jffng]

Makes sense to me, I ran into a similar bug working on the duplicate variants issue, which was fixed by using array_values. Thanks!