<!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>[24611] trunk/wp-admin: Revisions: Debounce fetching Diffs when revisions are updated.</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/24611">24611</a></dd>
<dt>Author</dt> <dd>koopersmith</dd>
<dt>Date</dt> <dd>2013-07-09 09:57:58 +0000 (Tue, 09 Jul 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Revisions: Debounce fetching Diffs when revisions are updated.
Fixes navigation and casting bugs.
See <a href="http://core.trac.wordpress.org/ticket/24425">#24425</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadminincludesrevisionphp">trunk/wp-admin/includes/revision.php</a></li>
<li><a href="#trunkwpadminjsrevisionsjs">trunk/wp-admin/js/revisions.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadminincludesrevisionphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/revision.php (24610 => 24611)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/revision.php 2013-07-09 08:58:52 UTC (rev 24610)
+++ trunk/wp-admin/includes/revision.php 2013-07-09 09:57:58 UTC (rev 24611)
</span><span class="lines">@@ -101,6 +101,6 @@
</span><span class="cx"> 'postId' => $post->ID,
</span><span class="cx"> 'nonce' => wp_create_nonce( 'revisions-ajax-nonce' ),
</span><span class="cx"> 'revisionData' => array_values( $revisions ),
</span><del>- 'selectedRevision' => (int) $selected_revision_id,
</del><ins>+ 'selectedRevision' => $selected_revision_id,
</ins><span class="cx"> );
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkwpadminjsrevisionsjs"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/js/revisions.js (24610 => 24611)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/js/revisions.js 2013-07-09 08:58:52 UTC (rev 24610)
+++ trunk/wp-admin/js/revisions.js 2013-07-09 09:57:58 UTC (rev 24611)
</span><span class="lines">@@ -8,7 +8,11 @@
</span><span class="cx"> // Link settings.
</span><span class="cx"> revisions.settings = typeof _wpRevisionsSettings === 'undefined' ? {} : _wpRevisionsSettings;
</span><span class="cx">
</span><ins>+ // wp_localize_script transforms top-level numbers into strings. Undo that.
+ if ( revisions.settings.selectedRevision )
+ revisions.settings.selectedRevision = parseInt( revisions.settings.selectedRevision, 10 );
</ins><span class="cx">
</span><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * ========================================================================
</span><span class="cx"> * MODELS
</span><span class="lines">@@ -37,6 +41,20 @@
</span><span class="cx">
</span><span class="cx"> comparator: function( revision ) {
</span><span class="cx"> return revision.id;
</span><ins>+ },
+
+ next: function( revision ) {
+ var index = this.indexOf( revision );
+
+ if ( index !== -1 && index !== this.length - 1 )
+ return this.at( index + 1 );
+ },
+
+ prev: function( revision ) {
+ var index = this.indexOf( revision );
+
+ if ( index !== -1 && index !== 0 )
+ return this.at( index - 1 );
</ins><span class="cx"> }
</span><span class="cx"> });
</span><span class="cx">
</span><span class="lines">@@ -198,19 +216,40 @@
</span><span class="cx">
</span><span class="cx"> revisions.model.FrameState = Backbone.Model.extend({
</span><span class="cx"> initialize: function( attributes, options ) {
</span><ins>+ var properties = {};
+
+ this._debouncedEnsureDiff = _.debounce( this._ensureDiff, 200 );
+
</ins><span class="cx"> this.revisions = options.revisions;
</span><span class="cx"> this.diffs = new revisions.model.Diffs( [], { revisions: this.revisions });
</span><del>- this.listenTo( this, 'change:from', this.updateDiff );
- this.listenTo( this, 'change:to', this.updateDiff );
</del><ins>+
+ // Set the initial revision provided through the settings.
+ properties.to = this.revisions.get( revisions.settings.selectedRevision );
+ properties.from = this.revisions.prev( properties.to );
+ this.set( properties );
+
+ // Start the router. This will trigger a navigate event and ensure that
+ // the `from` and `to` revisions accurately reflect the hash.
</ins><span class="cx"> this.router = new revisions.Router({ model: this });
</span><ins>+ Backbone.history.start();
+
+ this.listenTo( this, 'change:from', this.changeRevisionHandler );
+ this.listenTo( this, 'change:to', this.changeRevisionHandler );
+ this.updateDiff({ immediate: true });
</ins><span class="cx"> },
</span><span class="cx">
</span><ins>+ // Fetch the currently loaded diff.
+ diff: function() {
+ return this.diffs.get( this._diffId );
+ },
+
</ins><span class="cx"> // So long as `from` and `to` are changed at the same time, the diff
</span><span class="cx"> // will only be updated once. This is because Backbone updates all of
</span><span class="cx"> // the changed attributes in `set`, and then fires the `change` events.
</span><del>- updateDiff: function() {
- var from, to, diffId;
</del><ins>+ updateDiff: function( options ) {
+ var from, to, diffId, diff;
</ins><span class="cx">
</span><ins>+ options = options || {};
</ins><span class="cx"> from = this.get('from');
</span><span class="cx"> to = this.get('to');
</span><span class="cx"> diffId = ( from ? from.id : 0 ) + ':' + to.id;
</span><span class="lines">@@ -222,12 +261,31 @@
</span><span class="cx"> this._diffId = diffId;
</span><span class="cx"> this.trigger( 'update:revisions', from, to );
</span><span class="cx">
</span><del>- this.diffs.ensure( diffId, this ).done( function( diff ) {
- // Check if the current diff changed while the request was in flight.
- if ( this._diffId !== diff.id )
- return;
</del><ins>+ // If we already have the diff, then immediately trigger the update.
+ diff = this.diffs.get( diffId );
+ if ( diff ) {
+ this.trigger( 'update:diff', diff );
</ins><span class="cx">
</span><del>- this.trigger( 'update:diff', diff );
</del><ins>+ // Otherwise, fetch the diff.
+ } else {
+ if ( options.immediate )
+ this._ensureDiff();
+ else
+ this._debouncedEnsureDiff();
+ }
+ },
+
+ // A simple wrapper around `updateDiff` to prevent the change event's
+ // parameters from being passed through.
+ changeRevisionHandler: function( model, value, options ) {
+ this.updateDiff();
+ },
+
+ _ensureDiff: function() {
+ this.diffs.ensure( this._diffId, this ).done( function( diff ) {
+ // Make sure the current diff didn't change while the request was in flight.
+ if ( this._diffId === diff.id )
+ this.trigger( 'update:diff', diff );
</ins><span class="cx"> });
</span><span class="cx"> }
</span><span class="cx"> });
</span><span class="lines">@@ -245,6 +303,7 @@
</span><span class="cx"> template: wp.template('revisions-frame'),
</span><span class="cx">
</span><span class="cx"> initialize: function() {
</span><ins>+ // Generate the frame model.
</ins><span class="cx"> this.model = new revisions.model.FrameState({}, {
</span><span class="cx"> revisions: this.collection
</span><span class="cx"> });
</span><span class="lines">@@ -256,21 +315,13 @@
</span><span class="cx"> model: this.model
</span><span class="cx"> }) );
</span><span class="cx">
</span><ins>+ // TODO: The rest of this method should be rewritten and moved into the FrameState.
</ins><span class="cx"> if ( this.model.revisions.length ) {
</span><del>- var last = this.model.revisions.last(2);
- var attributes = { to: last.pop() };
-
- if ( last.length )
- attributes.from = last.pop();
-
- this.model.set( attributes );
-
</del><span class="cx"> // Load the rest: first 10, then the rest by 50
</span><span class="cx"> this.model.diffs.loadLastUnloaded( 10 ).always( _.bind( function() {
</span><span class="cx"> this.model.diffs.loadAllBy( 50 );
</span><span class="cx"> }, this ) );
</span><span class="cx"> }
</span><del>- Backbone.history.start();
</del><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> render: function() {
</span><span class="lines">@@ -807,7 +858,7 @@
</span><span class="cx"> this.model = options.model;
</span><span class="cx">
</span><span class="cx"> // Maintain state history when dragging
</span><del>- this.listenTo( this.model, 'renderDiff', _.debounce( this.updateUrl, 250 ) );
</del><ins>+ this.listenTo( this.model, 'update:diff', _.debounce( this.updateUrl, 250 ) );
</ins><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> routes: {
</span></span></pre>
</div>
</div>
</body>
</html>