wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-09-24 02:38:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Defer loading easy-deflate

Browse source 
Easy-Deflate.js and its dependency, Base64, are not needed for editor
activation. Defer loading these modules until the editor has been activated.

Also promisify prepareCacheKey.

Task: T94616
Change-Id: I2e754fc835a5608b27d81117e1fbc9ea97d5744b
This commit is contained in:
Ori Livneh 2015-03-31 12:52:14 -07:00 committed by Timo Tijhof
parent 57ed548503
commit 07001001be
3 changed files with 80 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
VisualEditor.php
View file

@ -313,7 +313,6 @@ $wgResourceModules += array(
'mediawiki.Uri',
'mediawiki.user',
'mediawiki.util',
'easy-deflate.deflate',
'user.options',
'user.tokens',
'moment',

9
modules/ve-mw/init/targets/ve.init.mw.ViewPageTarget.init.js
View file

@ -109,6 +109,15 @@
mw.log.warn( 'VisualEditor failed to load: ' + e );
} );
}
targetPromise.then( function () {
// Enqueue the loading of deferred modules (that is, modules which provide
// functionality that is not needed for loading the editor).
setTimeout( function () {
mw.loader.load( 'easy-deflate.deflate' );
}, 500 );
} );
return targetPromise;
}

106
modules/ve-mw/init/ve.init.mw.Target.js
View file

@ -864,6 +864,21 @@ ve.init.mw.Target.prototype.getHtml = function ( newDoc ) {
return '<!doctype html>' + ve.serializeXhtml( newDoc );
};
/**
* Get deflated HTML. This function is async because easy-deflate may not have finished loading yet.
*
* @param {HTMLDocument} newDoc Document to get HTML for
* @return {jQuery.Promise} Promise resolved with deflated HTML
* @see #getHtml
*/
ve.init.mw.Target.prototype.deflateHtml = function ( newDoc ) {
var html = this.getHtml( newDoc );
return mw.loader.using( 'easy-deflate.deflate' )
.then( function () {
return EasyDeflate.deflate( html );
} );
};
/**
* Load the editor.
*
@ -928,9 +943,9 @@ ve.init.mw.Target.prototype.clearState = function () {
* @returns {jQuery.Promise} Abortable promise, resolved with the cache key.
*/
ve.init.mw.Target.prototype.prepareCacheKey = function ( doc ) {
var xhr, html,
var xhr, deflated,
aborted = false,
start = ve.now(),
deferred = $.Deferred(),
target = this;
if ( this.preparedCacheKeyPromise && this.preparedCacheKeyPromise.doc === doc ) {
@ -938,38 +953,50 @@ ve.init.mw.Target.prototype.prepareCacheKey = function ( doc ) {
}
this.clearPreparedCacheKey();
html = EasyDeflate.deflate( this.getHtml( doc ) );
xhr = new mw.Api().post(
{
action: 'visualeditor',
paction: 'serializeforcache',
html: html,
page: this.pageName,
oldid: this.revid
},
{ contentType: 'multipart/form-data' }
)
.done( function ( response ) {
var trackData = { duration: ve.now() - start };
if ( response.visualeditor && typeof response.visualeditor.cachekey === 'string' ) {
target.events.track( 'performance.system.serializeforcache', trackData );
deferred.resolve( response.visualeditor.cachekey );
} else {
target.events.track( 'performance.system.serializeforcache.nocachekey', trackData );
deferred.reject();
this.preparedCacheKeyPromise = this.deflateHtml( doc )
.then( function ( deflatedHtml ) {
deflated = deflatedHtml;
if ( aborted ) {
return $.Deferred().reject();
}
xhr = new mw.Api().post(
{
action: 'visualeditor',
paction: 'serializeforcache',
html: deflatedHtml,
page: target.pageName,
oldid: target.revid
},
{ contentType: 'multipart/form-data' }
);
return xhr.then(
function ( response ) {
var trackData = { duration: ve.now() - start };
if ( response.visualeditor && typeof response.visualeditor.cachekey === 'string' ) {
target.events.track( 'performance.system.serializeforcache', trackData );
return response.visualeditor.cachekey;
} else {
target.events.track( 'performance.system.serializeforcache.nocachekey', trackData );
return $.Deferred().reject();
}
},
function () {
target.events.track( 'performance.system.serializeforcache.fail', { duration: ve.now() - start } );
}
);
} )
.fail( function () {
target.events.track( 'performance.system.serializeforcache.fail', { duration: ve.now() - start } );
deferred.reject();
.promise( {
abort: function () {
if ( xhr ) {
xhr.abort();
}
aborted = true;
},
getDeflatedHtml: function () {
return deflated;
},
doc: doc
} );
this.preparedCacheKeyPromise = deferred.promise( {
abort: xhr.abort,
html: html,
doc: doc
} );
return this.preparedCacheKeyPromise;
};
@ -1020,18 +1047,27 @@ ve.init.mw.Target.prototype.tryWithPreparedCacheKey = function ( doc, options, e
data = ve.extendObject( {}, options, { format: 'json' } );
function ajaxRequest( cachekey, isRetried ) {
var start = ve.now(),
fullEventName;
var fullEventName,
start = ve.now(),
deflatePromise = $.Deferred().resolve().promise();
if ( typeof cachekey === 'string' ) {
data.cachekey = cachekey;
} else {
// Getting a cache key failed, fall back to sending the HTML
data.html = preparedCacheKey && preparedCacheKey.html || EasyDeflate.deflate( target.getHtml( doc ) );
data.html = preparedCacheKey && preparedCacheKey.getDeflatedHtml && preparedCacheKey.getDeflatedHtml();
if ( !data.html ) {
deflatePromise = target.deflateHtml( doc ).then( function ( deflatedHtml ) {
data.html = deflatedHtml;
} );
}
// If using the cache key fails, we'll come back here with cachekey still set
delete data.cachekey;
}
return new mw.Api().post( data, { contentType: 'multipart/form-data' } )
return deflatePromise
.then( function () {
return new mw.Api().post( data, { contentType: 'multipart/form-data' } );
} )
.then(
function ( response, jqxhr ) {
var eventData = {