<!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>[41669] trunk/src/wp-includes/js/wp-emoji-loader.js: Emoji: Refactor browser support tests.</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 { 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/41669">41669</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/41669","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-10-02 03:59:50 +0000 (Mon, 02 Oct 2017)</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'>Emoji: Refactor browser support tests.

Moves the repeated code in the emoji browser support test to a function to reduced the potential for errors and follow DRY principles.

Renames the "emoji4" test "emoji" as unicode version specific tests were removed in <a href="https://core.trac.wordpress.org/changeset/38869">[38869]</a>.

Props peterwilsoncc, pento for code review.
Fixes <a href="https://core.trac.wordpress.org/ticket/41156">#41156</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjswpemojiloaderjs">trunk/src/wp-includes/js/wp-emoji-loader.js</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjswpemojiloaderjs"></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/js/wp-emoji-loader.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/wp-emoji-loader.js       2017-10-02 03:37:29 UTC (rev 41668)
+++ trunk/src/wp-includes/js/wp-emoji-loader.js 2017-10-02 03:59:50 UTC (rev 41669)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9,25 +9,44 @@
</span><span class="cx" style="display: block; padding: 0 10px">        var context = canvas.getContext && canvas.getContext( '2d' );
</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">+         * Check if two sets of Emoji characters render the same.
+        *
+        * @param set1 array Set of Emoji characters.
+        * @param set2 array Set of Emoji characters.
+        * @returns {boolean} True if the two sets render the same.
+        */
+       function emojiSetsRenderIdentically( set1, set2 ) {
+               var stringFromCharCode = String.fromCharCode;
+
+               // Cleanup from previous test.
+               context.clearRect( 0, 0, canvas.width, canvas.height );
+               context.fillText( stringFromCharCode.apply( this, set1 ), 0, 0 );
+               var rendered1 = canvas.toDataURL();
+
+               // Cleanup from previous test.
+               context.clearRect( 0, 0, canvas.width, canvas.height );
+               context.fillText( stringFromCharCode.apply( this, set2 ), 0, 0 );
+               var rendered2 = canvas.toDataURL();
+
+               return rendered1 === rendered2;
+       }
+
+       /**
</ins><span class="cx" style="display: block; padding: 0 10px">          * Detect if the browser supports rendering emoji or flag emoji. Flag emoji are a single glyph
</span><span class="cx" style="display: block; padding: 0 10px">         * made of two characters, so some browsers (notably, Firefox OS X) don't support them.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 4.2.0
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param type {String} Whether to test for support of "flag" or "emoji4" emoji.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param type {String} Whether to test for support of "flag" or "emoji".
</ins><span class="cx" style="display: block; padding: 0 10px">          * @return {Boolean} True if the browser can render emoji, false if it cannot.
</span><span class="cx" style="display: block; padding: 0 10px">         */
</span><span class="cx" style="display: block; padding: 0 10px">        function browserSupportsEmoji( type ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                var stringFromCharCode = String.fromCharCode,
-                       flag, flag2, emoji41, emoji42;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         var isIdentical;
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                if ( ! context || ! context.fillText ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        return false;
</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">-                // Cleanup from previous test.
-               context.clearRect( 0, 0, canvas.width, canvas.height );
-
</del><span class="cx" style="display: block; padding: 0 10px">                 /*
</span><span class="cx" style="display: block; padding: 0 10px">                 * Chrome on OS X added native emoji rendering in M41. Unfortunately,
</span><span class="cx" style="display: block; padding: 0 10px">                 * it doesn't work when the font is bolder than 500 weight. So, we
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -45,16 +64,12 @@
</span><span class="cx" style="display: block; padding: 0 10px">                                 * To test for support, we try to render it, and compare the rendering to how it would look if
</span><span class="cx" style="display: block; padding: 0 10px">                                 * the browser doesn't render it correctly ([U] + [N]).
</span><span class="cx" style="display: block; padding: 0 10px">                                 */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                context.fillText( stringFromCharCode( 55356, 56826, 55356, 56819 ), 0, 0 );
-                               flag = canvas.toDataURL();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                         isIdentical = emojiSetsRenderIdentically(
+                                       [ 55356, 56826, 55356, 56819 ],
+                                       [ 55356, 56826, 8203, 55356, 56819 ]
+                               );
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                context.clearRect( 0, 0, canvas.width, canvas.height );
-
-                               // Add a zero width space between the characters, to force rendering as characters.
-                               context.fillText( stringFromCharCode( 55356, 56826, 8203, 55356, 56819 ), 0, 0 );
-                               flag2 = canvas.toDataURL();
-
-                               if ( flag === flag2 ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                         if ( isIdentical ) {
</ins><span class="cx" style="display: block; padding: 0 10px">                                         return false;
</span><span class="cx" style="display: block; padding: 0 10px">                                }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -65,19 +80,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">                                 * To test for support, we try to render it, and compare the rendering to how it would look if
</span><span class="cx" style="display: block; padding: 0 10px">                                 * the browser doesn't render it correctly (black flag emoji + [G] + [B] + [E] + [N] + [G]).
</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 from previous test.
-                               context.clearRect( 0, 0, canvas.width, canvas.height );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                         isIdentical = emojiSetsRenderIdentically(
+                                       [ 55356, 57332, 56128, 56423, 56128, 56418, 56128, 56421, 56128, 56430, 56128, 56423, 56128, 56447 ],
+                                       [ 55356, 57332, 8203, 56128, 56423, 8203, 56128, 56418, 8203, 56128, 56421, 8203, 56128, 56430, 8203, 56128, 56423, 8203, 56128, 56447 ]
+                               );
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                context.fillText( stringFromCharCode( 55356, 57332, 56128, 56423, 56128, 56418, 56128, 56421, 56128, 56430, 56128, 56423, 56128, 56447 ), 0, 0 );
-                               flag = canvas.toDataURL();
-
-                               context.clearRect( 0, 0, canvas.width, canvas.height );
-
-                               context.fillText( stringFromCharCode( 55356, 57332, 8203, 56128, 56423, 8203, 56128, 56418, 8203, 56128, 56421, 8203, 56128, 56430, 8203, 56128, 56423, 8203, 56128, 56447 ), 0, 0 );
-                               flag2 = canvas.toDataURL();
-
-                               return flag !== flag2;
-                       case 'emoji4':
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                         return ! isIdentical;
+                       case 'emoji':
</ins><span class="cx" style="display: block; padding: 0 10px">                                 /*
</span><span class="cx" style="display: block; padding: 0 10px">                                 * Emoji 5 has fairies of all genders.
</span><span class="cx" style="display: block; padding: 0 10px">                                 *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,15 +94,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">                                 * it to how it would look if the browser doesn't render it correctly
</span><span class="cx" style="display: block; padding: 0 10px">                                 * (fairy + male sign).
</span><span class="cx" style="display: block; padding: 0 10px">                                 */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                context.fillText( stringFromCharCode( 55358, 56794, 8205, 9794, 65039 ), 0, 0 );
-                               emoji41 = canvas.toDataURL();
-
-                               context.clearRect( 0, 0, canvas.width, canvas.height );
-
-                               context.fillText( stringFromCharCode( 55358, 56794, 8203, 9794, 65039 ), 0, 0 );
-                               emoji42 = canvas.toDataURL();
-
-                               return emoji41 !== emoji42;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                         isIdentical = emojiSetsRenderIdentically(
+                                       [ 55358, 56794, 8205, 9794, 65039 ],
+                                       [ 55358, 56794, 8203, 9794, 65039 ]
+                               );
+                               return ! isIdentical;
</ins><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">                return false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -107,7 +112,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                document.getElementsByTagName( 'head' )[0].appendChild( script );
</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 = Array( 'flag', 'emoji4' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ tests = Array( 'flag', 'emoji' );
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        settings.supports = {
</span><span class="cx" style="display: block; padding: 0 10px">                everything: true,
</span></span></pre>
</div>
</div>

</body>
</html>