Skip to content
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

Use IFRAME to display HTML responses for REST API storage request failures in Site Health test #1849

Merged
merged 8 commits into from
Feb 6, 2025
Merged

Use IFRAME to display HTML responses for REST API storage request failures in Site Health test #1849

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6dcb3c2
Update site health notice to use iframes
SohamPatel46 Feb 5, 2025
7ca73e8
Merge branch 'trunk' into add/iframe-for-raw-response
SohamPatel46 Feb 5, 2025
f450b98
Add test case, add empty body condition
SohamPatel46 Feb 6, 2025
6685c7a
Increase size of iframe
westonruter Feb 6, 2025
1f963a9
Add test case for multiple content-type headers
westonruter Feb 6, 2025
0befb42
Remove deprecated seamless attribute
westonruter Feb 6, 2025
0edd448
Factor out adding the DETAILS open and close tags
westonruter Feb 6, 2025
c748645
Improve test_rest_api_availability
westonruter Feb 6, 2025
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
27 changes: 25 additions & 2 deletions plugins/optimization-detective/site-health.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,10 @@ function od_compose_site_health_result( $response ): array {
$message = wp_remote_retrieve_response_message( $response );
$body = wp_remote_retrieve_body( $response );
$data = json_decode( $body, true );
$header = wp_remote_retrieve_header( $response, 'content-type' );
westonruter marked this conversation as resolved.
Show resolved Hide resolved
if ( is_array( $header ) ) {
$header = array_pop( $header );
}

$is_expected = (
400 === $code &&
Expand Down Expand Up @@ -156,7 +160,16 @@ function od_compose_site_health_result( $response ): array {
$result['description'] .= '<blockquote>' . esc_html( $data['message'] ) . '</blockquote>';
}

$result['description'] .= '<details><summary>' . esc_html__( 'Raw response:', 'optimization-detective' ) . '</summary><pre style="white-space: pre-wrap">' . esc_html( $body ) . '</pre></details>';
westonruter marked this conversation as resolved.
Show resolved Hide resolved
if ( '' !== $body ) {
$result['description'] .= '<details><summary>' . esc_html__( 'Raw response:', 'optimization-detective' ) . '</summary>';

if ( is_string( $header ) && str_contains( $header, 'html' ) ) {
$escaped_content = htmlspecialchars( $body, ENT_QUOTES, 'UTF-8' );
$result['description'] .= '<iframe srcdoc="' . $escaped_content . '" sandbox width="100%" height="300"></iframe></details>';
} else {
$result['description'] .= '<pre style="white-space: pre-wrap">' . esc_html( $body ) . '</pre></details>';
}
}
}
}
return $result;
Expand Down Expand Up @@ -238,14 +251,24 @@ function od_maybe_render_rest_api_health_check_admin_notice( bool $in_plugin_row
$message = "<details>$message</details>";
}

wp_admin_notice(
$notice = wp_get_admin_notice(
$message,
array(
'type' => 'warning',
'additional_classes' => $in_plugin_row ? array( 'inline', 'notice-alt' ) : array(),
'paragraph_wrap' => false,
)
);

echo wp_kses(
$notice,
array_merge(
wp_kses_allowed_html( 'post' ),
array(
'iframe' => array_fill_keys( array( 'srcdoc', 'sandbox', 'width', 'height' ), true ),
)
)
);
}

/**
Expand Down
25 changes: 25 additions & 0 deletions plugins/optimization-detective/tests/test-site-health.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,33 @@ public function data_provider_test_rest_api_availability(): array {
'code' => 403,
'message' => 'Forbidden',
),
'headers' => array(
'content-type' => 'text/html',
),
'body' => "<html>\n<head><title>403 Forbidden</title></head>\n<body>\n<center><h1>403 Forbidden</h1></center>\n<hr><center>nginx</center>\n</body>\n</html>",
),
'expected_option' => '1',
'expected_status' => 'recommended',
'expected_unavailable' => true,
),
'other_forbidden' => array(
'mocked_response' => array(
'response' => array(
'code' => 403,
'message' => 'Forbidden',
),
'headers' => array(
'content-type' => array(
'text/html; charset=utf-8',
'application/xhtml+xml',
),
),
'body' => '<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"><html><head><title>403 Forbidden</title></head><body><h1>Forbidden</h1><p>You don\'t have permission to access this resource.</p></body></html>',
),
'expected_option' => '1',
'expected_status' => 'recommended',
'expected_unavailable' => true,
),
'error' => array(
'mocked_response' => new WP_Error( 'bad', 'Something terrible has happened' ),
'expected_option' => '1',
Expand All @@ -151,6 +172,10 @@ public function test_rest_api_availability( $mocked_response, string $expected_o
$this->filter_rest_api_response( $mocked_response );

$result = od_test_rest_api_availability();
if ( 'nginx_forbidden' === $this->dataName() ) {
$notice = get_echo( 'od_render_rest_api_health_check_admin_notice_in_plugin_row', array( 'optimization-detective/load.php' ) );
$this->assertStringContainsString( '</iframe>', $notice );
}
$this->assertArrayHasKey( 'label', $result );
$this->assertArrayHasKey( 'status', $result );
$this->assertArrayHasKey( 'badge', $result );
Expand Down
Loading