<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[49628] trunk: Docs: Adjust comments for `recurse_dirsize()` and related tests per the documentation standards.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/49628">49628</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/49628","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-11-17 15:36:02 +0000 (Tue, 17 Nov 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Adjust comments for `recurse_dirsize()` and related tests per the documentation standards.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/49212">[49212]</a>, <a href="https://core.trac.wordpress.org/changeset/49616">[49616]</a>.
See <a href="https://core.trac.wordpress.org/ticket/19879">#19879</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunktestsphpunittestsmultisitecleanDirsizeCachephp">trunk/tests/phpunit/tests/multisite/cleanDirsizeCache.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2020-11-17 10:19:29 UTC (rev 49627)
+++ trunk/src/wp-includes/functions.php 2020-11-17 15:36:02 UTC (rev 49628)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7607,13 +7607,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Get the size of a directory recursively.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Used by get_dirsize() to get a directory's size when it contains
- * other directories.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Used by get_dirsize() to get a directory size when it contains other directories.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU (3.0.0)
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 4.3.0 $exclude parameter added.
- * @since 5.2.0 $max_execution_time parameter added.
- * @since 5.6.0 $directory_cache parameter added.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.3.0 The `$exclude` parameter was added.
+ * @since 5.2.0 The `$max_execution_time` parameter was added.
+ * @since 5.6.0 The `$directory_cache` parameter was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $directory Full path of a directory.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $exclude Optional. Full path of a subdirectory to exclude from the total,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7668,14 +7667,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filters the amount of storage space used by one directory and all it's children, in megabytes.
- * Return the actual used space to shortcircuit the recursive PHP file size calculation and use something else
- * like a CDN API or native operating system tools for better performance
- *
- * @since 5.6.0
- *
- * @param int|false $space_used The amount of used space, in bytes. Default 0.
- */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the amount of storage space used by one directory and all its children, in megabytes.
+ *
+ * Return the actual used space to short-circuit the recursive PHP file size calculation
+ * and use something else, like a CDN API or native operating system tools for better performance.
+ *
+ * @since 5.6.0
+ *
+ * @param int|false $space_used The amount of used space, in bytes. Default 0.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $size = apply_filters( 'calculate_current_dirsize', $size, $directory, $exclude, $max_execution_time, $directory_cache );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 0 === $size ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7705,7 +7705,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $directory_cache[ $cache_path ] = $size;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Only write the transient on the top level call and not on recursive calls
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Only write the transient on the top level call and not on recursive calls.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $save_cache ) {
</span><span class="cx" style="display: block; padding: 0 10px"> set_transient( 'dirsize_cache', $directory_cache );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7714,10 +7714,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Invalidates entries within the dirsize_cache
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Cleans directory size cache used by recurse_dirsize().
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Remove the current directory and all parent directories
- * from the dirsize_cache transient.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Removes the current directory and all parent directories from the `dirsize_cache` transient.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunktestsphpunittestsmultisitecleanDirsizeCachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/multisite/cleanDirsizeCache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/multisite/cleanDirsizeCache.php 2020-11-17 10:19:29 UTC (rev 49627)
+++ trunk/tests/phpunit/tests/multisite/cleanDirsizeCache.php 2020-11-17 15:36:02 UTC (rev 49628)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3,8 +3,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_multisite() ) :
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Tests specific to the dirsize caching in multisites
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Tests specific to the directory size caching in multisite.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 19879
</ins><span class="cx" style="display: block; padding: 0 10px"> * @group multisite
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_Multisite_Dirsize_Cache extends WP_UnitTestCase {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,16 +23,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> parent::tearDown();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * Test whether the values from the dirsize_cache will be used correctly using a more complex dirsize cache mock
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Test whether dirsize_cache values are used correctly with a more complex dirsize cache mock.
+ *
+ * @ticket 19879
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_get_dirsize_cache_in_recurse_dirsize_mock() {
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = self::factory()->blog->create();
</span><span class="cx" style="display: block; padding: 0 10px"> switch_to_blog( $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Our comparison of space relies on an initial value of 0. If a previous test has failed or if the
- // src directory already contains a content directory with site content, then the initial expectation
- // will be polluted. We create sites until an empty one is available.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Our comparison of space relies on an initial value of 0. If a previous test has failed
+ * or if the `src` directory already contains a content directory with site content, then
+ * the initial expectation will be polluted. We create sites until an empty one is available.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> while ( 0 !== get_space_used() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> restore_current_blog();
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = self::factory()->blog->create();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -38,15 +43,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> switch_to_blog( $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Clear the dirsize_cache
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Clear the dirsize cache.
</ins><span class="cx" style="display: block; padding: 0 10px"> delete_transient( 'dirsize_cache' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Set the dirsize cache to our mock
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set the dirsize cache to our mock.
</ins><span class="cx" style="display: block; padding: 0 10px"> set_transient( 'dirsize_cache', $this->_get_mock_dirsize_cache_for_site( $blog_id ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $upload_dir = wp_upload_dir();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Check recurse_dirsize against the mock. The cache should match
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check recurse_dirsize() against the mock. The cache should match.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 21, recurse_dirsize( $upload_dir['basedir'] . '/2/1' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 22, recurse_dirsize( $upload_dir['basedir'] . '/2/2' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 2, recurse_dirsize( $upload_dir['basedir'] . '/2' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,28 +61,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 1, recurse_dirsize( $upload_dir['basedir'] . '/1' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 42, recurse_dirsize( $upload_dir['basedir'] . '/custom_directory' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // No cache match, upload folder should be empty and return 0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // No cache match, upload directory should be empty and return 0.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 0, recurse_dirsize( $upload_dir['basedir'] ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // No cache match on non existing folder should return false
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // No cache match on non existing directory should return false.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( false, recurse_dirsize( $upload_dir['basedir'] . '/does_not_exist' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Cleanup
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Cleanup.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->remove_added_uploads();
</span><span class="cx" style="display: block; padding: 0 10px"> restore_current_blog();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * Test whether the invalidation of the dirsize_cache works
- * Given a file path as input
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Test whether the dirsize_cache invalidation works given a file path as input.
+ *
+ * @ticket 19879
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_clean_dirsize_cache_file_input_mock() {
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = self::factory()->blog->create();
</span><span class="cx" style="display: block; padding: 0 10px"> switch_to_blog( $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Our comparison of space relies on an initial value of 0. If a previous test has failed or if the
- // src directory already contains a content directory with site content, then the initial expectation
- // will be polluted. We create sites until an empty one is available.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Our comparison of space relies on an initial value of 0. If a previous test has failed
+ * or if the `src` directory already contains a content directory with site content, then
+ * the initial expectation will be polluted. We create sites until an empty one is available.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> while ( 0 !== get_space_used() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> restore_current_blog();
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = self::factory()->blog->create();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -87,10 +95,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $upload_dir = wp_upload_dir();
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_key_prefix = untrailingslashit( str_replace( ABSPATH, '', $upload_dir['basedir'] ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Clear the dirsize_cache
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Clear the dirsize cache.
</ins><span class="cx" style="display: block; padding: 0 10px"> delete_transient( 'dirsize_cache' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Set the dirsize cache to our mock
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set the dirsize cache to our mock.
</ins><span class="cx" style="display: block; padding: 0 10px"> set_transient( 'dirsize_cache', $this->_get_mock_dirsize_cache_for_site( $blog_id ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( true, array_key_exists( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -97,32 +105,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( true, array_key_exists( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( true, array_key_exists( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Invalidation should also respect the directory tree up
- // Should work fine with path to folder OR file
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Invalidation should also respect the directory tree up.
+ // Should work fine with path to directory OR file.
</ins><span class="cx" style="display: block; padding: 0 10px"> clean_dirsize_cache( $upload_dir['basedir'] . '/2/1/file.dummy' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( false, array_key_exists( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( false, array_key_exists( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Other cache paths should not be invalidated
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Other cache paths should not be invalidated.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( true, array_key_exists( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Cleanup
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Cleanup.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->remove_added_uploads();
</span><span class="cx" style="display: block; padding: 0 10px"> restore_current_blog();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * Test whether the invalidation of the dirsize_cache works
- * Given a folder path as input
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Test whether the dirsize_cache invalidation works given a directory path as input.
+ *
+ * @ticket 19879
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_clean_dirsize_cache_folder_input_mock() {
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = self::factory()->blog->create();
</span><span class="cx" style="display: block; padding: 0 10px"> switch_to_blog( $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Our comparison of space relies on an initial value of 0. If a previous test has failed or if the
- // src directory already contains a content directory with site content, then the initial expectation
- // will be polluted. We create sites until an empty one is available.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Our comparison of space relies on an initial value of 0. If a previous test has failed
+ * or if the `src` directory already contains a content directory with site content, then
+ * the initial expectation will be polluted. We create sites until an empty one is available.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> while ( 0 !== get_space_used() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> restore_current_blog();
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = self::factory()->blog->create();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -132,10 +143,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $upload_dir = wp_upload_dir();
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_key_prefix = untrailingslashit( str_replace( ABSPATH, '', $upload_dir['basedir'] ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Clear the dirsize_cache
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Clear the dirsize cache.
</ins><span class="cx" style="display: block; padding: 0 10px"> delete_transient( 'dirsize_cache' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Set the dirsize cache to our mock
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set the dirsize cache to our mock.
</ins><span class="cx" style="display: block; padding: 0 10px"> set_transient( 'dirsize_cache', $this->_get_mock_dirsize_cache_for_site( $blog_id ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( true, array_key_exists( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -142,31 +153,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( true, array_key_exists( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( true, array_key_exists( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Invalidation should also respect the directory tree up
- // Should work fine with path to folder OR file
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Invalidation should also respect the directory tree up.
+ // Should work fine with path to directory OR file.
</ins><span class="cx" style="display: block; padding: 0 10px"> clean_dirsize_cache( $upload_dir['basedir'] . '/2/1' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( false, array_key_exists( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( false, array_key_exists( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Other cache paths should not be invalidated
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Other cache paths should not be invalidated.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( true, array_key_exists( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Cleanup
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Cleanup.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->remove_added_uploads();
</span><span class="cx" style="display: block; padding: 0 10px"> restore_current_blog();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Test whether the values from the dirsize_cache will be used correctly using a simple real upload
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test whether dirsize_cache values are used correctly with a simple real upload.
+ *
+ * @ticket 19879
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_get_dirsize_cache_in_recurse_dirsize_upload() {
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = self::factory()->blog->create();
</span><span class="cx" style="display: block; padding: 0 10px"> switch_to_blog( $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Our comparison of space relies on an initial value of 0. If a previous test has failed or if the
- // src directory already contains a content directory with site content, then the initial expectation
- // will be polluted. We create sites until an empty one is available.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Our comparison of space relies on an initial value of 0. If a previous test has failed
+ * or if the `src` directory already contains a content directory with site content, then
+ * the initial expectation will be polluted. We create sites until an empty one is available.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> while ( 0 !== get_space_used() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> restore_current_blog();
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = self::factory()->blog->create();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -173,7 +188,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> switch_to_blog( $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Clear the dirsize_cache
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Clear the dirsize cache.
</ins><span class="cx" style="display: block; padding: 0 10px"> delete_transient( 'dirsize_cache' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $upload_dir = wp_upload_dir();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -180,7 +195,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 0, recurse_dirsize( $upload_dir['path'] ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Upload a file to the new site using wp_upload_bits.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Upload a file to the new site using wp_upload_bits().
</ins><span class="cx" style="display: block; padding: 0 10px"> $filename = __FUNCTION__ . '.jpg';
</span><span class="cx" style="display: block; padding: 0 10px"> $contents = __FUNCTION__ . '_contents';
</span><span class="cx" style="display: block; padding: 0 10px"> $file = wp_upload_bits( $filename, null, $contents );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -189,18 +204,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $size = filesize( $file['file'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $size, $calc_size );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // dirsize_cache should now be filled after upload and recurse_dirsize call
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // `dirsize_cache` should now be filled after upload and recurse_dirsize() call.
</ins><span class="cx" style="display: block; padding: 0 10px"> $cache_path = untrailingslashit( str_replace( ABSPATH, '', $upload_dir['path'] ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( true, is_array( get_transient( 'dirsize_cache' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $size, get_transient( 'dirsize_cache' )[ $cache_path ] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Cleanup
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Cleanup.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->remove_added_uploads();
</span><span class="cx" style="display: block; padding: 0 10px"> restore_current_blog();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * Test whether the filter to calculate space for an existing directory works as expected
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Test whether the filter to calculate space for an existing directory works as expected.
+ *
+ * @ticket 19879
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_recurse_dirsize_calculate_current_dirsize_filter() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'calculate_current_dirsize', array( $this, '_filter_calculate_current_dirsize' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -228,4 +245,5 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> endif;
</span></span></pre>
</div>
</div>
</body>
</html>