Changeset 54682 for branches/6.1/tests/phpunit/tests/l10n/loadTextdomainJustInTime.php

Timestamp:

10/24/2022 06:35:30 PM (4 years ago)

Author:

ocean90

Message:

I18N: Change how WP_Textdomain_Registry stores the default languages path.

WP_Textdomain_Registry was introduced in [53874] to store text domains and their language directory paths, addressing issues with just-in-time loading of textdomains when using locale switching and when usingload_*_textdomain() functions.

Said change has inadvertently caused a performance regression exactly when usingload_*_textdomain(), which still often is the case, where the cached information was not further used or even overridden.

This change addresses that issue by storing the default languages paths in a separate way, while at the same time making WP_Textdomain_Registry easier to maintain and adding new tests to catch future regressions.

Props flixos90, spacedmonkey, ocean90, SergeyBiryukov, costdev.
Merges [54669] to the 6.1 branch.
See #39210.

Location:

branches/6.1

Files:

• . (modified) (1 prop)
• tests/phpunit/tests/l10n/loadTextdomainJustInTime.php (modified) (6 diffs)

branches/6.1/tests/phpunit/tests/l10n/loadTextdomainJustInTime.php

@@ -9 +9 @@
         protected $theme_root;
         protected static $user_id;
-        private $locale_count;
 
         public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
@@ -25 +24 @@
                 $this->theme_root     = DIR_TESTDATA . '/themedir1';
                 $this->orig_theme_dir = $GLOBALS['wp_theme_directories'];
-                $this->locale_count   = 0;
 
                 // /themes is necessary as theme.php functions assume /themes is the root if there is only one root.
@@ -38 +36 @@
                 global $wp_textdomain_registry;
 
-                $wp_textdomain_registry->reset();
+                $wp_textdomain_registry = new WP_Textdomain_Registry();
         }
 
@@ -49 +47 @@
                 global $wp_textdomain_registry;
 
-                $wp_textdomain_registry->reset();
+                $wp_textdomain_registry = new WP_Textdomain_Registry();
 
                 parent::tear_down();
@@ -263 +261 @@
                 $textdomain = 'foo-bar-baz';
 
-                add_filter( 'locale', array( $this, '_filter_locale_count' ) );
+                $filter = new MockAction();
+                add_filter( 'locale', array( $filter, 'filter' ) );
 
                 __( 'Foo', $textdomain );
@@ -271 +270 @@
                 __( 'Foo Bar Baz', $textdomain );
 
-                remove_filter( 'locale', array( $this, '_filter_locale_count' ) );
-
                 $this->assertFalse( is_textdomain_loaded( $textdomain ) );
-                $this->assertSame( 1, $this->locale_count );
-        }
-
-        public function _filter_locale_count( $locale ) {
-                ++$this->locale_count;
-
-                return $locale;
+                $this->assertSame( 1, $filter->get_call_count() );
+        }
+
+        /**
+         * @ticket 37997
+         * @ticket 39210
+         *
+         * @covers ::_load_textdomain_just_in_time
+         */
+        public function test_get_locale_is_called_only_once_per_textdomain_with_custom_lang_dir() {
+                load_plugin_textdomain( 'custom-internationalized-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' );
+
+                $textdomain = 'custom-internationalized-plugin';
+
+                $filter = new MockAction();
+                add_filter( 'locale', array( $filter, 'filter' ) );
+
+                __( 'Foo', $textdomain );
+                __( 'Bar', $textdomain );
+                __( 'Baz', $textdomain );
+                __( 'Foo Bar', $textdomain );
+                __( 'Foo Bar Baz', $textdomain );
+
+                $this->assertFalse( is_textdomain_loaded( $textdomain ) );
+                $this->assertSame( 1, $filter->get_call_count() );
         }
 }