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

Jump to bottom

Fix | Slow load times due to svg_dimensions #154

Merged
merged 6 commits into from
Dec 12, 2023
Merged

Fix | Slow load times due to svg_dimensions #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ebc0531
refactor svg_dimensions function to calculate dimensions using existi…
sksaju Sep 25, 2023
daadc14
added safe_svg_pre_dimensions filter in the svg_dimensions function
sksaju Nov 27, 2023
cede2e8
fix phpcs issue on fix/75-slow-load-times-due-to-svgdimensions
sksaju Nov 27, 2023
b07176d
Merge branch 'develop' into fix/75-slow-load-times-due-to-svgdimensions
sksaju Nov 27, 2023
58ee0e8
fix php unit test issue
sksaju Dec 12, 2023
d0b5b8a
fix e2e test issue
sksaju Dec 12, 2023
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
16 changes: 15 additions & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@
"@wordpress/env": "^5.14.0",
"@wordpress/icons": "^9.20.0",
"@wordpress/scripts": "^26.0.0",
"cypress": "^13.3.0"
"cypress": "^13.3.0",
"mochawesome-json-to-md": "^0.7.2"
},
"dependencies": {
"cypress-mochawesome-reporter": "^3.4.0",
Expand Down
56 changes: 45 additions & 11 deletions safe-svg.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ protected function is_gzipped( $contents ) {
public function fix_admin_preview( $response, $attachment, $meta ) {

if ( 'image/svg+xml' === $response['mime'] ) {
$dimensions = $this->svg_dimensions( get_attached_file( $attachment->ID ) );
$dimensions = $this->svg_dimensions( $attachment->ID );

if ( $dimensions ) {
$response = array_merge( $response, $dimensions );
Expand Down Expand Up @@ -384,7 +384,7 @@ public function fix_admin_preview( $response, $attachment, $meta ) {
*/
public function one_pixel_fix( $image, $attachment_id, $size, $icon ) {
if ( get_post_mime_type( $attachment_id ) === 'image/svg+xml' ) {
$dimensions = $this->svg_dimensions( get_attached_file( $attachment_id ) );
$dimensions = $this->svg_dimensions( $attachment_id );

if ( $dimensions ) {
$image[1] = $dimensions['width'];
Expand Down Expand Up @@ -445,7 +445,7 @@ public function get_image_tag_override( $html, $id, $alt, $title, $align, $size
$width = $size[0];
$height = $size[1];
// phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.Found, Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure
} elseif ( 'full' === $size && $dimensions = $this->svg_dimensions( get_attached_file( $id ) ) ) {
} elseif ( 'full' === $size && $dimensions = $this->svg_dimensions( $id ) ) {
$width = $dimensions['width'];
$height = $dimensions['height'];
} else {
Expand Down Expand Up @@ -485,7 +485,7 @@ public function skip_svg_regeneration( $metadata, $attachment_id ) {
$relative_path = str_replace( trailingslashit( $upload_dir['basedir'] ), '', $svg_path );
$filename = basename( $svg_path );

$dimensions = $this->svg_dimensions( $svg_path );
$dimensions = $this->svg_dimensions( $attachment_id );

if ( ! $dimensions ) {
return $metadata;
Expand Down Expand Up @@ -560,19 +560,43 @@ public function metadata_error_fix( $data, $post_id ) {
/**
* Get SVG size from the width/height or viewport.
*
* @param string|false $svg The file path to where the SVG file should be, false otherwise.
* @param integer $attachment_id The attachment ID of the SVG being processed.
*
* @return array|bool
*/
protected function svg_dimensions( $svg ) {
protected function svg_dimensions( $attachment_id ) {
/**
* Calculate SVG dimensions and orientation.
*
* This filter allows you to implement your own sizing. By returning a non-false
* value, it will short-circuit this function and return your set value.
*
* @param boolean Default value of the filter.
* @param integer $attachment_id The attachment ID of the SVG being processed.
*
* @return array|false An array of SVG dimensions and orientation or false.
*/
$short_circuit = apply_filters( 'safe_svg_pre_dimensions', false, $attachment_id );

if ( false !== $short_circuit ) {
return $short_circuit;
}
Comment on lines +568 to +583
Copy link
Collaborator

Choose a reason for hiding this comment

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

praise (non-blocking): Nice work here!


if ( ! function_exists( 'simplexml_load_file' ) ) {
return false;
}

$svg = @simplexml_load_file( $svg ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
$width = 0;
$height = 0;
if ( $svg ) {
$svg = get_attached_file( $attachment_id );
$metadata = wp_get_attachment_metadata( $attachment_id );
$width = 0;
$height = 0;

if ( $svg && ! empty( $metadata['width'] ) && empty( $metadata['height'] ) ) {
Copy link
Collaborator

@dkotter dkotter Jan 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@sksaju Sorry, I know this is late and this PR is already merged but in looking at this prior to prepping the next release, on the surface it seems like this conditional is not correct. It checks $svg isn't null and then checks if the width isn't empty and the height is empty. Unless I'm thinking of this wrong, shouldn't it be checking if both width and height aren't empty, so like this:

if ( $svg && ! empty( $metadata['width'] ) && ! empty( $metadata['height'] ) ) {

Copy link
Member Author

Choose a reason for hiding this comment

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

@dkotter Yeah it should be ! empty, I've created a PR #174 to fix it, Apologies & Thanks

$width = floatval( $metadata['width'] );
$height = floatval( $metadata['height'] );
} elseif ( $svg ) {
$svg = @simplexml_load_file( $svg ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged

$attributes = $svg->attributes();

if ( isset( $attributes->viewBox ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
Expand Down Expand Up @@ -627,11 +651,21 @@ protected function svg_dimensions( $svg ) {
}
}

return array(
$dimensions = array(
'width' => $width,
'height' => $height,
'orientation' => ( $width > $height ) ? 'landscape' : 'portrait',
);

/**
* Calculate SVG dimensions and orientation.
*
* @param array $dimensions An array containing width, height, and orientation.
* @param string $svg The file path to the SVG.
*
* @return array An array of SVG dimensions and orientation.
*/
return apply_filters( 'safe_svg_dimensions', $dimensions, $svg );
Comment on lines +659 to +668
Copy link
Collaborator

Choose a reason for hiding this comment

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

@sksaju @10up/open-source-practice I like this filter, but what are your thoughts on introducing a safe_svg_pre_dimensions filter also?

My thinking is, if someone wants to override this value, forcing them through the overhead of loading and sizing the SVG seems a little odd.

Something like the following at the top of this method to allow the short-circuit might be useful:

/**
* Calculate SVG dimensions and orientation.
*
* This filter allows you to implement your own sizing. By returning a non-false
* value, it will short-circuit this function and return your set value.
*
* @param array  $attachment_id The attachment ID of the SVG being processed.
*
* @return array|false An array of SVG dimensions and orientation or false.
*/
$short_circuit = apply_filters( 'safe_svg_pre_dimensions', '__return_false' );

if ( false !== $short_circuit ) {
    return $short_circuit;
}

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks @darylldoyle I've updated the PR, please take a look again and let me know your feedback. could you also let me know how to fix this https://github.com/10up/safe-svg/actions/runs/7004501147/job/19052370329?pr=154 UnitTest issue? Thanks

}

/**
Expand Down
58 changes: 58 additions & 0 deletions tests/unit/test-safe-svg.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,64 @@ public function test_one_pixel_fix() {
)
);

\WP_Mock::userFunction(
'wp_get_attachment_metadata',
array(
'args' => 1,
'return_in_order' => array(
array(
'width' => 600,
'height' => 600,
'file' => __DIR__ . '/files/svgCleanOne.svg',
'sizes' => array(
'thumbnail' => array(
'width' => 150,
'height' => 150,
'crop' => 1,
'file' => 'svgCleanOne.svg',
'mime-type' => 'image/svg+xml',
),
'medium' => array(
'width' => 300,
'height' => 300,
'crop' => 0, // Set to 0 if you don't want to crop
'file' => 'svgCleanOne.svg',
'mime-type' => 'image/svg+xml',
),
'medium_large' => array(
'width' => 768,
'height' => 0,
'crop' => 0,
'file' => 'svgCleanOne.svg',
'mime-type' => 'image/svg+xml',
),
'large' => array(
'width' => 1024,
'height' => 1024,
'crop' => 0,
'file' => 'svgCleanOne.svg',
'mime-type' => 'image/svg+xml',
),
'1536x1536' => array(
'width' => 1536,
'height' => 1536,
'crop' => 0,
'file' => 'svgCleanOne.svg',
'mime-type' => 'image/svg+xml',
),
'2048x2048' => array(
'width' => 2048,
'height' => 2048,
'crop' => 0,
'file' => 'svgCleanOne.svg',
'mime-type' => 'image/svg+xml',
),
),
),
),
)
);

// Test SVG Dimensions
$image_sizes = $this->instance->one_pixel_fix( array(), 1, 'thumbnail', false );
if ( ! empty( $image_sizes ) ) {
Expand Down
Loading