jenkins-bot has submitted this change and it was merged.
Change subject: Prevent defaults from clobbering event properties
..
Prevent defaults from clobbering event properties
As Matt Flaschen noted in 48248, the event object and the defaults object are
passed to $.extend() in the wrong order, causing the defaults to clobber event
data for properties that are defined in both objects. This change reversed the
order of the two parameters, causing event properties to clobber the defaults,
as intended. The change also updates one of the test cases to cover this
particular scenario.
Also corrects comment which advertises a feature that was not implemented (or
was implemented and then reverted -- can't remember).
Bug: 48248
Change-Id: Id14ba276329272c41370458d5330599a725f5419
---
M modules/ext.eventLogging.core.js
M tests/ext.eventLogging.tests.js
2 files changed, 9 insertions(+), 4 deletions(-)
Approvals:
Ori.livneh: Looks good to me, approved
Mattflaschen: Looks good to me, but someone else must approve
jenkins-bot: Verified
diff --git a/modules/ext.eventLogging.core.js b/modules/ext.eventLogging.core.js
index a876e57..56a3e86 100644
--- a/modules/ext.eventLogging.core.js
+++ b/modules/ext.eventLogging.core.js
@@ -191,7 +191,7 @@
*
* @method setDefaults
* @param {String} schemaName Canonical schema name.
-* @param {Object|null} schemaDefaults Defaults, or null to
clear.
+* @param {Object} schemaDefaults Default values for schema's
events.
* @return {Object} Updated defaults for schema.
*/
setDefaults: function ( schemaName, schemaDefaults ) {
@@ -221,7 +221,7 @@
schema = self.declareSchema( schemaName );
}
- event = $.extend( true, {}, event, schema.defaults );
+ event = $.extend( true, {}, schema.defaults, event );
return {
event: event,
diff --git a/tests/ext.eventLogging.tests.js b/tests/ext.eventLogging.tests.js
index f774c3c..f05ebf3 100644
--- a/tests/ext.eventLogging.tests.js
+++ b/tests/ext.eventLogging.tests.js
@@ -128,19 +128,24 @@
QUnit.asyncTest( 'setDefaults', 2, function ( assert ) {
assert.deepEqual( mw.eventLog.setDefaults( 'earthquake', {
+ article: '[[1960 Valdivia earthquake]]',
epicenter: 'Valdivia'
- } ), { epicenter: 'Valdivia' }, 'setDefaults returns defaults'
);
+ } ), {
+ article: '[[1960 Valdivia earthquake]]',
+ epicenter: 'Valdivia'
+ }, 'setDefaults returns defaults' );
mw.eventLog.logEvent( 'earthquake', {
+ article: '[[1575 Valdivia earthquake]]',
magnitude: 9.5
} ).always( function ( e ) {
assert.deepEqual( e.event, {
+ article: '[[1575 Valdivia earthquake]]',
epicenter: 'Valdivia',
magnitude: 9.5
}, 'Logged event is annotated with defaults' );
QUnit.start();
} );
-
} );
--
To view, visit https://gerrit.wikimedia.org/r/62793
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Id14ba276329272c41370458d5330599a725f5419
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/extensions/EventLogging
Gerrit-Branch: master
Gerrit-Owner: Ori.livneh o...@wikimedia.org
Gerrit-Reviewer: Mattflaschen mflasc...@wikimedia.org
Gerrit-Reviewer: Ori.livneh o...@wikimedia.org
Gerrit-Reviewer: Spage sp...@wikimedia.org
Gerrit-Reviewer: jenkins-bot
___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
