Changeset 57287 for trunk/tests/phpunit/tests/l10n/wpTextdomainRegistry.php

Timestamp:

01/15/2024 07:03:27 PM (2 years ago)

Author:

swissspidy

Message:

I18N: Cache list of language file paths in WP_Textdomain_Registry.

Loading a list of language file paths using glob() can be expensive if involving thousands of files.

Expands scope of WP_Textdomain_Registry to cache list of language file paths in object cache and provides a way to invalidate that cache upon translation updates. Plugins can clear the cache using calls such as wp_cache_delete( 'cached_mo_files_' . md5( $path ), 'translations' );

Props mreishus, swissspidy
Fixes #58919

File:

• trunk/tests/phpunit/tests/l10n/wpTextdomainRegistry.php (modified) (6 diffs)

trunk/tests/phpunit/tests/l10n/wpTextdomainRegistry.php

@@ -19 +19 @@
     }
 
+    public function tear_down() {
+        wp_cache_delete( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/foobar/' ), 'translations' );
+        wp_cache_delete( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/plugins/' ), 'translations' );
+        wp_cache_delete( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/themes/' ), 'translations' );
+        wp_cache_delete( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) ), 'translations' );
+
+        parent::tear_down();
+    }
+
     /**
      * @covers ::has
@@ -25 +34 @@
      */
     public function test_set_custom_path() {
-        $reflection          = new ReflectionClass( $this->instance );
-        $reflection_property = $reflection->getProperty( 'cached_mo_files' );
-        $reflection_property->setAccessible( true );
-
-        $this->assertEmpty(
-            $reflection_property->getValue( $this->instance ),
-            'Cache not empty by default'
-        );
-
         $this->instance->set_custom_path( 'foo', WP_LANG_DIR . '/bar' );
 
@@ -49 +49 @@
             'Custom path for textdomain not returned'
         );
-        $this->assertArrayHasKey(
-            WP_LANG_DIR . '/bar',
-            $reflection_property->getValue( $this->instance ),
-            'Custom path missing from cache'
+        $this->assertNotFalse(
+            wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . 'bar/' ), 'translations' ),
+            'List of files in custom path not cached'
         );
     }
@@ -61 +60 @@
      */
     public function test_get( $domain, $locale, $expected ) {
-        $reflection          = new ReflectionClass( $this->instance );
-        $reflection_property = $reflection->getProperty( 'cached_mo_files' );
-        $reflection_property->setAccessible( true );
-
         $actual = $this->instance->get( $domain, $locale );
         $this->assertSame(
@@ -70 +65 @@
             $actual,
             'Expected languages directory path not matching actual one'
-        );
-
-        $this->assertArrayHasKey(
-            WP_LANG_DIR . '/plugins',
-            $reflection_property->getValue( $this->instance ),
-            'Default plugins path missing from cache'
         );
     }
@@ -90 +79 @@
             $this->instance->get( 'foo-plugin', 'de_DE' )
         );
+    }
+
+    /**
+     * @covers ::get_language_files_from_path
+     */
+    public function test_get_language_files_from_path_caches_results() {
+        $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) . '/foobar/' );
+        $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) . '/plugins/' );
+        $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) . '/themes/' );
+        $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) );
+
+        $this->assertNotFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/plugins/' ), 'translations' ) );
+        $this->assertNotFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/themes/' ), 'translations' ) );
+        $this->assertNotFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/foobar/' ), 'translations' ) );
+        $this->assertNotFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) ), 'translations' ) );
+    }
+
+    /**
+     * @covers ::get_language_files_from_path
+     */
+    public function test_get_language_files_from_path_short_circuit() {
+        add_filter( 'pre_get_language_files_from_path', '__return_empty_array' );
+        $result = $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) . '/plugins/' );
+        remove_filter( 'pre_get_language_files_from_path', '__return_empty_array' );
+
+        $cache = wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/plugins/' ), 'translations' );
+
+        $this->assertEmpty( $result );
+        $this->assertFalse( $cache );
+    }
+
+    /**
+     * @covers ::invalidate_mo_files_cache
+     */
+    public function test_invalidate_mo_files_cache() {
+        $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) . '/plugins/' );
+        $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) . '/themes/' );
+        $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) );
+
+        $this->instance->invalidate_mo_files_cache(
+            null,
+            array(
+                'type'         => 'translation',
+                'translations' => array(
+                    (object) array(
+                        'type'     => 'plugin',
+                        'slug'     => 'internationalized-plugin',
+                        'language' => 'de_DE',
+                        'version'  => '99.9.9',
+                    ),
+                    (object) array(
+                        'type'     => 'theme',
+                        'slug'     => 'internationalized-theme',
+                        'language' => 'de_DE',
+                        'version'  => '99.9.9',
+                    ),
+                    (object) array(
+                        'type'     => 'core',
+                        'slug'     => 'default',
+                        'language' => 'es_ES',
+                        'version'  => '99.9.9',
+                    ),
+                ),
+            )
+        );
+
+        $this->assertFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/plugins/' ), 'translations' ) );
+        $this->assertFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/themes/' ), 'translations' ) );
+        $this->assertFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) ), 'translations' ) );
     }