Changeset 52837 for trunk/tests/phpunit/tests/image/functions.php

Timestamp:

03/10/2022 01:08:19 PM (3 years ago)

Author:

spacedmonkey

Message:

Media: Store attachment’s file size in metadata.

Store the file size of all newly uploaded attachments, as part of the metadata stored in post meta. Storing file size means, developers will not have to resort to doing filesize function calls, that can be time consuming on assets on offloaded to services like Amazon’s S3.

This change also introduces a new helper function called, wp_filesize. This is a wrapper around the filesize php function, that adds some helpful filters and ensures the return value is an integer.

Props Cybr, Spacedmonkey, SergeyBiryukov, johnwatkins0, swissspidy, desrosj, joemcgill, azaozz, antpb, adamsilverstein, uday17035.
Fixes #49412.

File:

• trunk/tests/phpunit/tests/image/functions.php (modified) (13 diffs)

trunk/tests/phpunit/tests/image/functions.php

@@ -480 +480 @@
         $this->assertNotEmpty( $attachment_id );
 
+        $temp_dir = get_temp_dir();
+
+        $metadata = wp_generate_attachment_metadata( $attachment_id, $test_file );
+
         $expected = array(
-            'sizes' => array(
+            'sizes'    => array(
                 'full'      => array(
                     'file'      => 'wordpress-gsoc-flyer-pdf.jpg',
@@ -487 +491 @@
                     'height'    => 1408,
                     'mime-type' => 'image/jpeg',
+                    'filesize'  => wp_filesize( $temp_dir . 'wordpress-gsoc-flyer-pdf.jpg' ),
                 ),
                 'medium'    => array(
@@ -493 +498 @@
                     'height'    => 300,
                     'mime-type' => 'image/jpeg',
+                    'filesize'  => wp_filesize( $temp_dir . 'wordpress-gsoc-flyer-pdf-232x300.jpg' ),
                 ),
                 'large'     => array(
@@ -499 +505 @@
                     'height'    => 1024,
                     'mime-type' => 'image/jpeg',
+                    'filesize'  => wp_filesize( $temp_dir . 'wordpress-gsoc-flyer-pdf-791x1024.jpg' ),
                 ),
                 'thumbnail' => array(
@@ -505 +512 @@
                     'height'    => 150,
                     'mime-type' => 'image/jpeg',
+                    'filesize'  => wp_filesize( $temp_dir . 'wordpress-gsoc-flyer-pdf-116x150.jpg' ),
                 ),
             ),
-        );
-
-        $metadata = wp_generate_attachment_metadata( $attachment_id, $test_file );
+            'filesize' => wp_filesize( $test_file ),
+        );
+
         $this->assertSame( $expected, $metadata );
 
         unlink( $test_file );
-        $temp_dir = get_temp_dir();
         foreach ( $metadata['sizes'] as $size ) {
             unlink( $temp_dir . $size['file'] );
@@ -550 +557 @@
         $this->assertNotEmpty( $attachment_id );
 
+        $temp_dir = get_temp_dir();
+
+        $metadata = wp_generate_attachment_metadata( $attachment_id, $test_file );
+
         $expected = array(
-            'sizes' => array(
+            'sizes'    => array(
                 'full'      => array(
                     'file'      => 'wordpress-gsoc-flyer-pdf.jpg',
@@ -557 +568 @@
                     'height'    => 1408,
                     'mime-type' => 'image/jpeg',
+                    'filesize'  => wp_filesize( $temp_dir . 'wordpress-gsoc-flyer-pdf.jpg' ),
                 ),
                 'medium'    => array(
@@ -563 +575 @@
                     'height'    => 300,
                     'mime-type' => 'image/jpeg',
+                    'filesize'  => wp_filesize( $temp_dir . 'wordpress-gsoc-flyer-pdf-300x300.jpg' ),
                 ),
                 'large'     => array(
@@ -569 +582 @@
                     'height'    => 1024,
                     'mime-type' => 'image/jpeg',
+                    'filesize'  => wp_filesize( $temp_dir . 'wordpress-gsoc-flyer-pdf-791x1024.jpg' ),
                 ),
                 'thumbnail' => array(
@@ -575 +589 @@
                     'height'    => 150,
                     'mime-type' => 'image/jpeg',
+                    'filesize'  => wp_filesize( $temp_dir . 'wordpress-gsoc-flyer-pdf-116x150.jpg' ),
                 ),
             ),
-        );
-
-        $metadata = wp_generate_attachment_metadata( $attachment_id, $test_file );
+            'filesize' => wp_filesize( $test_file ),
+        );
+
         $this->assertSame( $expected, $metadata );
 
         unlink( $test_file );
         foreach ( $metadata['sizes'] as $size ) {
-            unlink( get_temp_dir() . $size['file'] );
+            unlink( $temp_dir . $size['file'] );
         }
     }
@@ -617 +632 @@
         add_image_size( 'test-size', 100, 100 );
         add_filter( 'fallback_intermediate_image_sizes', array( $this, 'filter_fallback_intermediate_image_sizes' ), 10, 2 );
+
+        $metadata = wp_generate_attachment_metadata( $attachment_id, $test_file );
+
+        $temp_dir = get_temp_dir();
 
         $expected = array(
@@ -623 +642 @@
             'height'    => 100,
             'mime-type' => 'image/jpeg',
-        );
-
-        $metadata = wp_generate_attachment_metadata( $attachment_id, $test_file );
+            'filesize'  => wp_filesize( $temp_dir . 'wordpress-gsoc-flyer-pdf-77x100.jpg' ),
+        );
+
+        // Different environments produce slightly different filesize results.
+        $this->assertSame( $metadata['sizes']['test-size'], $expected );
+
         $this->assertArrayHasKey( 'test-size', $metadata['sizes'], 'The `test-size` was not added to the metadata.' );
         $this->assertSame( $expected, $metadata['sizes']['test-size'] );
@@ -633 +655 @@
 
         unlink( $test_file );
-        $temp_dir = get_temp_dir();
         foreach ( $metadata['sizes'] as $size ) {
             unlink( $temp_dir . $size['file'] );