Changeset 51911

Timestamp:

10/15/2021 10:52:43 PM (20 months ago)

Author:

hellofromTonya

Message:

FileSystem API: Fix autovivification deprecation notice in recurse_dirsize().

PHP natively allows for autovivification (auto-creation of arrays from falsey values). This feature is very useful and used in a lot of PHP projects, especially if the variable is undefined. However, there is a little oddity that allows creating an array from a false and null value.

The above quote is from the PHP 8.1 RFC and the (accepted) RFC changes the behaviour described above to deprecated auto creation of arrays from false. As it is deprecated, it _will_ still work for the time being, but as of PHP 9.0, this will become a Fatal Error, so we may as well fix it now.

The recurse_dirsize() function retrieves a transient and places it in the $directory_cache variable, but the get_transient() function in WP returns false when the transient doesn't exist, which subsequently can lead to the above mentioned deprecation notice.

By verifying that the $directory_cache variable is an array before assigning to it and initializing it to an empty array, if it's not, we prevent the deprecation notice, as well as harden the function against potentially corrupted transients where this transient would not return the expected array format, but some other variable type.

Includes adding dedicated unit tests for both the PHP 8.1 issue, as well as the hardening against corrupted transients.

Includes some girl-scouting: touching up a parameter description and some code layout.

Refs:

• ​https://wiki.php.net/rfc/autovivification_false
• ​https://developer.wordpress.org/reference/functions/get_transient/

Follow-up to [49212], [49744].

Props jrf, hellofromTonya.
See #53635.

Location:

trunk

Files:

• src/wp-includes/functions.php (modified) (3 diffs)
• tests/phpunit/tests/functions/cleanDirsizeCache.php (modified) (4 diffs)
• tests/phpunit/tests/functions/fixtures (added)
• tests/phpunit/tests/functions/fixtures/dummy.txt (added)

trunk/src/wp-includes/functions.php

@@ -8121 +8121 @@
  * @param string|array $exclude            Optional. Full path of a subdirectory to exclude from the total,
  *                                         or array of paths. Expected without trailing slash(es).
- * @param int          $max_execution_time Maximum time to run before giving up. In seconds. The timeout is global
- *                                         and is measured from the moment WordPress started to load.
+ * @param int          $max_execution_time Optional. Maximum time to run before giving up. In seconds.
+ *                                         The timeout is global and is measured from the moment
+ *                                         WordPress started to load.
  * @param array        $directory_cache    Optional. Array of cached directory paths.
  *
@@ -8195 +8196 @@
                     }
 
-                    if ( $max_execution_time > 0 && microtime( true ) - WP_START_TIMESTAMP > $max_execution_time ) {
+                    if ( $max_execution_time > 0 &&
+                        ( microtime( true ) - WP_START_TIMESTAMP ) > $max_execution_time
+                    ) {
                         // Time exceeded. Give up instead of risking a fatal timeout.
                         $size = null;
@@ -8204 +8207 @@
             closedir( $handle );
         }
+    }
+
+    if ( ! is_array( $directory_cache ) ) {
+        $directory_cache = array();
     }
 

trunk/tests/phpunit/tests/functions/cleanDirsizeCache.php

@@ -4 +4 @@
  * Tests specific to the directory size caching.
  *
- * @covers ::clean_dirsize_cache
  * @group functions.php
  */
@@ -13 +12 @@
      *
      * @ticket 52241
+     *
+     * @covers ::clean_dirsize_cache
      *
      * @dataProvider data_clean_dirsize_cache_with_invalid_inputs
@@ -56 +57 @@
      *
      * @ticket 52241
+     *
+     * @covers ::clean_dirsize_cache
      *
      * @dataProvider data_clean_dirsize_cache_with_non_path_string
@@ -101 +104 @@
         );
     }
+
+    /**
+     * Test the behaviour of the function when the transient doesn't exist.
+     *
+     * @ticket 52241
+     * @ticket 53635
+     *
+     * @covers ::recurse_dirsize
+     */
+    public function test_recurse_dirsize_without_transient() {
+        delete_transient( 'dirsize_cache' );
+
+        $size = recurse_dirsize( __DIR__ . '/fixtures' );
+
+        $this->assertGreaterThan( 10, $size );
+    }
+
+    /**
+     * Test the behaviour of the function when the transient does exist, but is not an array.
+     *
+     * In particular, this tests that no PHP TypeErrors are being thrown.
+     *
+     * @ticket 52241
+     * @ticket 53635
+     *
+     * @covers ::recurse_dirsize
+     */
+    public function test_recurse_dirsize_with_invalid_transient() {
+        set_transient( 'dirsize_cache', 'this is not a valid transient for dirsize cache' );
+
+        $size = recurse_dirsize( __DIR__ . '/fixtures' );
+
+        $this->assertGreaterThan( 10, $size );
+    }
 }