Changeset 41043 for trunk/tests/phpunit/tests/formatting/Emoji.php

Timestamp:

07/14/2017 05:46:19 AM (8 years ago)

Author:

pento

Message:

Emoji: Port the Twemoji regex to PHP.

Previously, wp_encode_emoji() and wp_staticize_emoji() used inaccurate regular expressions to find emoji, and transform then into HTML entities or <img>s, respectively. This would result in emoji not being correctly transformed, or occasionally, non-emoji being incorrectly transformed.

This commit adds a new grunt task - grunt precommit:emoji. It finds the regex in twemoji.js, transforms it into a PHP-friendly version, and adds it to formatting.php. This task is also automatically run by grunt precommit, when it detects that twemoji.js has changed.

The new regex requires features introduced in PCRE 8.32, which was introduced in PHP 5.4.14, though it was also backported to later releases of the PHP 5.3 series. For versions of PHP that don't support this, it will fall back to an updated version of the loose-matching regex.

For short posts, the performance difference between the old and new regex is negligible. As the posts get longer, however, the new method is exponentially faster.

Fixes #35293.

File:

• trunk/tests/phpunit/tests/formatting/Emoji.php (modified) (5 diffs)

trunk/tests/phpunit/tests/formatting/Emoji.php

@@ -3 +3 @@
 /**
  * @group formatting
+ * @group emoji
  */
 class Tests_Formatting_Emoji extends WP_UnitTestCase {
+
+    private $png_cdn = 'https://s.w.org/images/core/emoji/2.3/72x72/';
+    private $svn_cdn = 'https://s.w.org/images/core/emoji/2.3/svg/';
+
     /**
      * @ticket 36525
      */
     public function test_unfiltered_emoji_cdns() {
-        $png_cdn = 'https://s.w.org/images/core/emoji/2.3/72x72/';
-        $svn_cdn = 'https://s.w.org/images/core/emoji/2.3/svg/';
-
         $output = get_echo( '_print_emoji_detection_script' );
 
-        $this->assertContains( wp_json_encode( $png_cdn ), $output );
-        $this->assertContains( wp_json_encode( $svn_cdn ), $output );
+        $this->assertContains( wp_json_encode( $this->png_cdn ), $output );
+        $this->assertContains( wp_json_encode( $this->svn_cdn ), $output );
     }
 
@@ -26 +28 @@
      */
     public function test_filtered_emoji_svn_cdn() {
-        $png_cdn = 'https://s.w.org/images/core/emoji/2.3/72x72/';
-        $svn_cdn = 'https://s.w.org/images/core/emoji/2.3/svg/';
-
         $filtered_svn_cdn = $this->_filtered_emoji_svn_cdn();
 
@@ -35 +34 @@
         $output = get_echo( '_print_emoji_detection_script' );
 
-        $this->assertContains( wp_json_encode( $png_cdn ), $output );
-        $this->assertNotContains( wp_json_encode( $svn_cdn ), $output );
+        $this->assertContains( wp_json_encode( $this->png_cdn ), $output );
+        $this->assertNotContains( wp_json_encode( $this->svn_cdn ), $output );
         $this->assertContains( wp_json_encode( $filtered_svn_cdn ), $output );
 
@@ -50 +49 @@
      */
     public function test_filtered_emoji_png_cdn() {
-        $png_cdn = 'https://s.w.org/images/core/emoji/2.3/72x72/';
-        $svn_cdn = 'https://s.w.org/images/core/emoji/2.3/svg/';
-
         $filtered_png_cdn = $this->_filtered_emoji_png_cdn();
 
@@ -60 +56 @@
 
         $this->assertContains( wp_json_encode( $filtered_png_cdn ), $output );
-        $this->assertNotContains( wp_json_encode( $png_cdn ), $output );
-        $this->assertContains( wp_json_encode( $svn_cdn ), $output );
+        $this->assertNotContains( wp_json_encode( $this->png_cdn ), $output );
+        $this->assertContains( wp_json_encode( $this->svn_cdn ), $output );
 
         remove_filter( 'emoji_url', array( $this, '_filtered_emoji_png_cdn' ) );
     }
 
+    /**
+     * @ticket 35293
+     */
+    public function test_wp_emoji_regex_returns_regexen() {
+        $default = wp_emoji_regex();
+        $this->assertNotEmpty( $default );
+
+        $codepoints = wp_emoji_regex( 'codepoints' );
+        $this->assertNotEmpty( $codepoints );
+
+        $this->assertSame( $default, $codepoints );
+
+        $entities = wp_emoji_regex( 'entities' );
+        $this->assertNotEmpty( $entities );
+
+        $this->assertNotSame( $default, $entities );
+    }
+
+    public function data_wp_encode_emoji() {
+        return array(
+            array(
+                // Not emoji
+                '’',
+                '’',
+            ),
+            array(
+                // Simple emoji
+                '🙂',
+                '🙂',
+            ),
+            array(
+                // Skin tone, gender, ZWJ, emoji selector
+                '👮🏼‍♀️',
+                '👮🏼‍♀️',
+            ),
+            array(
+                // Unicode 10
+                '🧚',
+                '🧚',
+            ),
+
+        );
+    }
+
+    /**
+     * @ticket 35293
+     * @dataProvider data_wp_encode_emoji
+     */
+    public function test_wp_encode_emoji( $emoji, $expected ) {
+        $this->assertSame( $expected, wp_encode_emoji( $emoji ) );
+    }
+
+    public function data_wp_staticize_emoji() {
+        return array(
+            array(
+                // Not emoji
+                '’',
+                '’',
+            ),
+            array(
+                // Simple emoji
+                '🙂',
+                '<img src="' . $this->png_cdn . '1f642.png" alt="🙂" class="wp-smiley" style="height: 1em; max-height: 1em;" />',
+            ),
+            array(
+                // Skin tone, gender, ZWJ, emoji selector
+                '👮🏼‍♀️',
+                '<img src="' . $this->png_cdn . '1f46e-1f3fc-200d-2640-fe0f.png" alt="👮🏼‍♀️" class="wp-smiley" style="height: 1em; max-height: 1em;" />',
+            ),
+            array(
+                // Unicode 10
+                '🧚',
+                '<img src="' . $this->png_cdn . '1f9da.png" alt="🧚" class="wp-smiley" style="height: 1em; max-height: 1em;" />',
+            ),
+
+        );
+    }
+
+    /**
+     * @ticket 35293
+     * @dataProvider data_wp_staticize_emoji
+     */
+    public function test_wp_staticize_emoji( $emoji, $expected ) {
+        $this->assertSame( $expected, wp_staticize_emoji( $emoji ) );
+    }
 }