<!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>[24732] trunk/wp-admin: Revisions: Better error handling.</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/24732">24732</a></dd>
<dt>Author</dt> <dd>markjaquith</dd>
<dt>Date</dt> <dd>2013-07-18 16:35:19 +0000 (Thu, 18 Jul 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Revisions: Better error handling.
* Shows an error message if the current diff can't be loaded.
* For bulk pre-loading, catches errors, and cuts subsequent requests in half, until eventually giving up.
* Some CSS fixes related to this, and the loading spinner.
* `wp.revisions.loadAll()` now returns a promise representing whether or not all revisions could be loaded.
Fixes <a href="http://core.trac.wordpress.org/ticket/24758">#24758</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadmincsswpadmincss">trunk/wp-admin/css/wp-admin.css</a></li>
<li><a href="#trunkwpadminjsrevisionsjs">trunk/wp-admin/js/revisions.js</a></li>
<li><a href="#trunkwpadminrevisionphp">trunk/wp-admin/revision.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadmincsswpadmincss"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/css/wp-admin.css (24731 => 24732)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/css/wp-admin.css 2013-07-18 14:31:25 UTC (rev 24731)
+++ trunk/wp-admin/css/wp-admin.css 2013-07-18 16:35:19 UTC (rev 24732)
</span><span class="lines">@@ -3554,16 +3554,24 @@
</span><span class="cx"> height: 140px;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+.revisions .diff-error {
+ position: absolute;
+ text-align: center;
+ margin: 0 auto;
+ width: 100%;
+ display: none;
+}
+
+.revisions.diff-error .diff-error {
+ display: block;
+}
+
</ins><span class="cx"> .revisions .loading-indicator {
</span><span class="cx"> position: absolute;
</span><del>- text-align: center;
</del><span class="cx"> vertical-align: middle;
</span><span class="cx"> opacity: 0;
</span><del>- margin: 0 auto;
</del><span class="cx"> width: 100%;
</span><del>- height: 32px;
</del><span class="cx"> top: 3em;
</span><del>- background: #fff url(../images/wpspin_light-2x.gif) no-repeat center top;
</del><span class="cx"> -webkit-transition: opacity 0.5s;
</span><span class="cx"> -moz-transition: opacity 0.5s;
</span><span class="cx"> -ms-transition: opacity 0.5s;
</span><span class="lines">@@ -3571,6 +3579,12 @@
</span><span class="cx"> transition: opacity 0.5s;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+.revisions .loading-indicator span.spinner {
+ display: block;
+ margin: 0 auto;
+ float: none;
+}
+
</ins><span class="cx"> .revisions.loading .loading-indicator {
</span><span class="cx"> opacity: 1;
</span><span class="cx"> }
</span><span class="lines">@@ -3587,6 +3601,10 @@
</span><span class="cx"> opacity: 0.5;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+.revisions.diff-error .diff {
+ visibility: hidden;
+}
+
</ins><span class="cx"> .revisions-meta {
</span><span class="cx"> margin-top: 15px;
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkwpadminjsrevisionsjs"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/js/revisions.js (24731 => 24732)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/js/revisions.js 2013-07-18 14:31:25 UTC (rev 24731)
+++ trunk/wp-admin/js/revisions.js 2013-07-18 16:35:19 UTC (rev 24732)
</span><span class="lines">@@ -233,7 +233,9 @@
</span><span class="cx">
</span><span class="cx"> request.done( _.bind( function() {
</span><span class="cx"> deferred.resolveWith( context, [ this.get( id ) ] );
</span><del>- }, this ) );
</del><ins>+ }, this ) ).fail( _.bind( function() {
+ deferred.reject();
+ }) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> return deferred.promise();
</span><span class="lines">@@ -256,13 +258,22 @@
</span><span class="cx"> diffs = _.first( this.getClosestUnloaded( allRevisionIds, centerId ), num );
</span><span class="cx"> if ( _.size( diffs ) > 0 ) {
</span><span class="cx"> this.load( diffs ).done( function() {
</span><del>- deferred.resolve();
- self._loadAll( allRevisionIds, centerId, num );
</del><ins>+ self._loadAll( allRevisionIds, centerId, num ).done( function() {
+ deferred.resolve();
+ });
+ }).fail( function() {
+ if ( 1 === num ) { // Already tried 1. This just isn't working. Give up.
+ deferred.reject();
+ } else { // Request fewer diffs this time
+ self._loadAll( allRevisionIds, centerId, Math.ceil( num / 2 ) ).done( function() {
+ deferred.resolve();
+ });
+ }
</ins><span class="cx"> });
</span><del>- return deferred.promise();
</del><span class="cx"> } else {
</span><del>- return deferred.reject().promise();
</del><ins>+ deferred.resolve();
</ins><span class="cx"> }
</span><ins>+ return deferred;
</ins><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> load: function( comparisons ) {
</span><span class="lines">@@ -314,12 +325,14 @@
</span><span class="cx"> revisions.model.FrameState = Backbone.Model.extend({
</span><span class="cx"> defaults: {
</span><span class="cx"> loading: false,
</span><ins>+ error: false,
</ins><span class="cx"> compareTwoMode: false
</span><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> initialize: function( attributes, options ) {
</span><span class="cx"> var properties = {};
</span><span class="cx">
</span><ins>+ _.bindAll( this, 'receiveDiff' );
</ins><span class="cx"> this._debouncedEnsureDiff = _.debounce( this._ensureDiff, 200 );
</span><span class="cx">
</span><span class="cx"> this.revisions = options.revisions;
</span><span class="lines">@@ -351,6 +364,7 @@
</span><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> updateLoadingStatus: function() {
</span><ins>+ this.set( 'error', false );
</ins><span class="cx"> this.set( 'loading', ! this.diff() );
</span><span class="cx"> },
</span><span class="cx">
</span><span class="lines">@@ -399,7 +413,7 @@
</span><span class="cx">
</span><span class="cx"> // If we already have the diff, then immediately trigger the update.
</span><span class="cx"> if ( diff ) {
</span><del>- this.trigger( 'update:diff', diff );
</del><ins>+ this.receiveDiff( diff );
</ins><span class="cx"> return $.Deferred().resolve().promise();
</span><span class="cx"> // Otherwise, fetch the diff.
</span><span class="cx"> } else {
</span><span class="lines">@@ -418,12 +432,20 @@
</span><span class="cx"> this.updateDiff();
</span><span class="cx"> },
</span><span class="cx">
</span><ins>+ receiveDiff: function( diff ) {
+ // Did we actually get a diff?
+ if ( _.isUndefined( diff ) || _.isUndefined( diff.id ) ) {
+ this.set({
+ loading: false,
+ error: true
+ });
+ } else if ( this._diffId === diff.id ) { // Make sure the current diff didn't change
+ this.trigger( 'update:diff', diff );
+ }
+ },
+
</ins><span class="cx"> _ensureDiff: function() {
</span><del>- return 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 );
- });
</del><ins>+ return this.diffs.ensure( this._diffId, this ).always( this.receiveDiff );
</ins><span class="cx"> }
</span><span class="cx"> });
</span><span class="cx">
</span><span class="lines">@@ -443,6 +465,7 @@
</span><span class="cx"> this.listenTo( this.model, 'update:diff', this.renderDiff );
</span><span class="cx"> this.listenTo( this.model, 'change:compareTwoMode', this.updateCompareTwoMode );
</span><span class="cx"> this.listenTo( this.model, 'change:loading', this.updateLoadingStatus );
</span><ins>+ this.listenTo( this.model, 'change:error', this.updateErrorStatus );
</ins><span class="cx">
</span><span class="cx"> this.views.set( '.revisions-control-frame', new revisions.view.Controls({
</span><span class="cx"> model: this.model
</span><span class="lines">@@ -470,6 +493,10 @@
</span><span class="cx"> this.$el.toggleClass( 'loading', this.model.get('loading') );
</span><span class="cx"> },
</span><span class="cx">
</span><ins>+ updateErrorStatus: function() {
+ this.$el.toggleClass( 'diff-error', this.model.get('error') );
+ },
+
</ins><span class="cx"> updateCompareTwoMode: function() {
</span><span class="cx"> this.$el.toggleClass( 'comparing-two-revisions', this.model.get('compareTwoMode') );
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkwpadminrevisionphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/revision.php (24731 => 24732)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/revision.php 2013-07-18 14:31:25 UTC (rev 24731)
+++ trunk/wp-admin/revision.php 2013-07-18 16:35:19 UTC (rev 24732)
</span><span class="lines">@@ -186,7 +186,8 @@
</span><span class="cx"> </script>
</span><span class="cx">
</span><span class="cx"> <script id="tmpl-revisions-diff" type="text/html">
</span><del>- <div class="loading-indicator"></div>
</del><ins>+ <div class="loading-indicator"><span class="spinner"></span></div>
+ <div class="diff-error"><?php _e( 'Sorry, something went wrong. The requested comparison could not be loaded.' ); ?></div>
</ins><span class="cx"> <div class="diff">
</span><span class="cx"> <# _.each( data.fields, function( field ) { #>
</span><span class="cx"> <h3>{{ field.name }}</h3>
</span></span></pre>
</div>
</div>
</body>
</html>