Skip to content

Improve Interactivity API store JSON encoding #6520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sirreal wants to merge 12 commits into from
Closed

Improve Interactivity API store JSON encoding #6520

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a99ec25
Improve Interactivity API store JSON encoding
sirreal May 7, 2024
8a6d30f
Only set unescaped unicode with UTF-8
sirreal May 8, 2024
312d6ea
Remove JSON_HEX_AMP
sirreal May 9, 2024
3e30117
Add JSON_UNESCAPED_LINE_TERMINATORS
sirreal May 9, 2024
cf29aa6
Add comments
sirreal May 9, 2024
76c7a5e
Smaller config in test
sirreal May 9, 2024
f2b07eb
Fix heredoc end
sirreal May 9, 2024
5c2d273
Remove bad function arg trailing comma
sirreal May 9, 2024
b9cd850
Add more details to comments
sirreal May 9, 2024
8a7e4e0
Remove redundant tear_down method.
sirreal May 10, 2024
67bd236
Merge branch 'trunk' into add/iapi-better-json-encoding
dmsnell May 15, 2024
7ecc709
Rearrange comment and set UTF-8 as the normative encoding.
dmsnell May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add JSON_UNESCAPED_LINE_TERMINATORS
  • Loading branch information
@sirreal
sirreal committed May 9, 2024
commit 3e301171b2b54cb8cf137ba9e760cae9c0eddb33
2 changes: 1 addition & 1 deletion src/wp-includes/interactivity-api/class-wp-interactivity-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ public function print_client_interactivity_data() {
if ( ! empty( $interactivity_data ) ) {
$json_encode_flags = JSON_HEX_TAG | JSON_UNESCAPED_SLASHES;
if ( 'UTF-8' === get_option( 'blog_charset' ) ) {
Copy link
Member

@dmsnell dmsnell May 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sadly this check is insufficient, as there are common case variants and the hyphen may not be present. The common example is below, but I am so unnerved by this pattern that I'm currently prepping a patch to WordPress to add a new semantic check.

$charset = get_option( 'blog_charset' );
if ( in_array( $charset, array( 'utf8', 'utf-8', 'UTF8' ), true ) ) {
	$charset = 'UTF-8';
}

Copy link
Member

@dmsnell dmsnell May 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#6535

Copy link
Member Author

@sirreal sirreal May 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! It looks like the _canonical_charset() function (intended to normalize to "UTF-8") is applied as a filter by default, so maybe this is sufficient as is? Your proposed patch would make that filter more robust without any changes here:

wordpress-develop/src/wp-includes/default-filters.php

Line 292 in 12dc165

add_filter( 'option_blog_charset', '_canonical_charset' );

If the encoding is UTF-8 and we fail to it, it will do little harm. The only issue is that valid unicode would be escaped to its \u1234 form.

$json_encode_flags |= JSON_UNESCAPED_UNICODE;
$json_encode_flags |= JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_LINE_TERMINATORS;
}

wp_print_inline_script_tag(
Expand Down