wikimedia/mediawiki-extensions-WikiEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/WikiEditor synced 2024-11-27 09:42:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update EventLogging code for Edit->EditAttemptStep schema migration

Browse source 
The schema itself is being renamed, and many of the field names are
different.

Bug: T207803
Depends-On: I2949c9782669b75cf17978698c8cef21fdee6dea
Change-Id: I07d9bc1530005914043911b7906c1602522c9162
This commit is contained in:
Roan Kattouw 2018-10-26 13:48:55 -07:00
parent ddcc8b2430
commit d700202f85
2 changed files with 67 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
includes/WikiEditorHooks.php
View file

@ -16,7 +16,8 @@ class WikiEditorHooks {
/* Static Methods */
/**
* Log stuff to EventLogging's Schema:Edit - see https://meta.wikimedia.org/wiki/Schema:Edit
* Log stuff to EventLogging's Schema:EditAttemptStep -
* see https://meta.wikimedia.org/wiki/Schema:EditAttemptStep
* If you don't have EventLogging installed, does nothing.
*
* @param string $action
@ -25,16 +26,16 @@ class WikiEditorHooks {
* @return bool Whether the event was logged or not.
*/
public static function doEventLogging( $action, $article, $data = [] ) {
global $wgVersion, $wgWMESchemaEditSamplingRate;
global $wgVersion, $wgWMESchemaEditAttemptStepSamplingRate;
$extensionRegistry = ExtensionRegistry::getInstance();
if ( !$extensionRegistry->isLoaded( 'EventLogging' ) ) {
return false;
}
// Sample 6.25%
$samplingRate = $wgWMESchemaEditSamplingRate ?? 0.0625;
$inSample = EventLogging::sessionInSample( 1 / $samplingRate, $data['editingSessionId'] );
$samplingRate = $wgWMESchemaEditAttemptStepSamplingRate ?? 0.0625;
$inSample = EventLogging::sessionInSample( 1 / $samplingRate, $data['editing_session_id'] );
$shouldOversample = $extensionRegistry->isLoaded( 'WikimediaEvents' ) &&
WikimediaEventsHooks::shouldSchemaEditOversample( $article->getContext() );
WikimediaEventsHooks::shouldSchemaEditAttemptStepOversample( $article->getContext() );
if ( !$inSample && !$shouldOversample ) {
return false;
}
@ -46,24 +47,24 @@ class WikiEditorHooks {
$data = [
'action' => $action,
'version' => 1,
'isOversample' => !$inSample,
'editor' => 'wikitext',
'is_oversample' => !$inSample,
'editor_interface' => 'wikitext',
'platform' => 'desktop', // FIXME
'integration' => 'page',
'page.id' => $page->getId(),
'page.title' => $title->getPrefixedText(),
'page.ns' => $title->getNamespace(),
'page.revid' => $page->getRevision() ? $page->getRevision()->getId() : 0,
'user.id' => $user->getId(),
'user.editCount' => $user->getEditCount() ?: 0,
'mediawiki.version' => $wgVersion
'page_id' => $page->getId(),
'page_title' => $title->getPrefixedText(),
'page_ns' => $title->getNamespace(),
'revision_id' => $page->getRevision() ? $page->getRevision()->getId() : 0,
'user_id' => $user->getId(),
'user_editcount' => $user->getEditCount() ?: 0,
'mw_version' => $wgVersion,
] + $data;
if ( $user->isAnon() ) {
$data['user.class'] = 'IP';
$data['user_class'] = 'IP';
}
return EventLogging::logEvent( 'Edit', 18476212, $data );
return EventLogging::logEvent( 'EditAttemptStep', 18530416, $data );
}
/**
@ -95,20 +96,20 @@ class WikiEditorHooks {
// changes.
if ( ExtensionRegistry::getInstance()->isLoaded( 'EventLogging' ) && !$request->wasPosted() ) {
$data = [];
$data['editingSessionId'] = self::getEditingStatsId();
$data['editing_session_id'] = self::getEditingStatsId();
if ( $request->getVal( 'section' ) ) {
$data['action.init.type'] = 'section';
$data['init_type'] = 'section';
} else {
$data['action.init.type'] = 'page';
$data['init_type'] = 'page';
}
if ( $request->getHeader( 'Referer' ) ) {
if ( $request->getVal( 'section' ) === 'new' || !$article->exists() ) {
$data['action.init.mechanism'] = 'new';
$data['init_mechanism'] = 'new';
} else {
$data['action.init.mechanism'] = 'click';
$data['init_mechanism'] = 'click';
}
} else {
$data['action.init.mechanism'] = 'url';
$data['init_mechanism'] = 'url';
}
self::doEventLogging( 'init', $article, $data );
@ -291,7 +292,7 @@ class WikiEditorHooks {
self::doEventLogging(
'saveAttempt',
$article,
[ 'editingSessionId' => $request->getVal( 'editingStatsId' ) ]
[ 'editing_session_id' => $request->getVal( 'editingStatsId' ) ]
);
}
@ -310,7 +311,7 @@ class WikiEditorHooks {
$request = $article->getContext()->getRequest();
if ( $request->getVal( 'editingStatsId' ) ) {
$data = [];
$data['editingSessionId'] = $request->getVal( 'editingStatsId' );
$data['editing_session_id'] = $request->getVal( 'editingStatsId' );
if ( $status->isOK() ) {
$action = 'saveSuccess';
@ -319,24 +320,24 @@ class WikiEditorHooks {
$errors = $status->getErrorsArray();
if ( isset( $errors[0][0] ) ) {
$data['action.saveFailure.message'] = $errors[0][0];
$data['save_failure_message'] = $errors[0][0];
}
if ( $status->value === EditPage::AS_CONFLICT_DETECTED ) {
$data['action.saveFailure.type'] = 'editConflict';
$data['save_failure_type'] = 'editConflict';
} elseif ( $status->value === EditPage::AS_ARTICLE_WAS_DELETED ) {
$data['action.saveFailure.type'] = 'editPageDeleted';
$data['save_failure_type'] = 'editPageDeleted';
} elseif ( isset( $errors[0][0] ) && $errors[0][0] === 'abusefilter-disallowed' ) {
$data['action.saveFailure.type'] = 'extensionAbuseFilter';
$data['save_failure_type'] = 'extensionAbuseFilter';
} elseif ( isset( $editPage->getArticle()->getPage()->ConfirmEdit_ActivateCaptcha ) ) {
// TODO: :(
$data['action.saveFailure.type'] = 'extensionCaptcha';
$data['save_failure_type'] = 'extensionCaptcha';
} elseif ( isset( $errors[0][0] ) && $errors[0][0] === 'spamprotectiontext' ) {
$data['action.saveFailure.type'] = 'extensionSpamBlacklist';
$data['save_failure_type'] = 'extensionSpamBlacklist';
} else {
// Catch everything else... We don't seem to get userBadToken or
// userNewUser through this hook.
$data['action.saveFailure.type'] = 'responseUnknown';
$data['save_failure_type'] = 'responseUnknown';
}
}
self::doEventLogging( $action, $article, $data );

58
modules/ext.wikiEditor.js
View file

@ -3,57 +3,69 @@
*/
( function ( $, mw ) {
var editingSessionId;
var editingSessionId,
actionPrefixMap = {
saveIntent: 'save_intent',
saveAttempt: 'save_attempt',
saveSuccess: 'save_success',
saveFailure: 'save_failure'
};
function logEditEvent( action, data ) {
if ( mw.loader.getState( 'schema.Edit' ) === null ) {
if ( mw.loader.getState( 'schema.EditAttemptStep' ) === null ) {
return;
}
mw.loader.using( [ 'schema.Edit', 'ext.eventLogging.subscriber' ] ).done( function () {
mw.loader.using( [ 'schema.EditAttemptStep', 'ext.eventLogging.subscriber' ] ).done( function () {
// Sampling
// We have to do this on the client too because the unload handler
// can cause an editingSessionId to be generated on the client
// Not using mw.eventLog.inSample() because we need to be able to pass our own editingSessionId
var inSample = mw.eventLog.randomTokenMatch(
1 / mw.config.get( 'wgWMESchemaEditSamplingRate' ),
editingSessionId
);
if ( !inSample && !mw.config.get( 'wgWMESchemaEditOversample' ) ) {
1 / mw.config.get( 'wgWMESchemaEditAttemptStepSamplingRate' ),
editingSessionId
),
actionPrefix = actionPrefixMap[ action ] || action;
if ( !inSample && !mw.config.get( 'wgWMESchemaEditAttemptStepOversample' ) ) {
return;
}
/* eslint-disable camelcase */
data = $.extend( {
version: 1,
action: action,
isOversample: !inSample,
editingSessionId: editingSessionId,
editor: 'wikitext',
is_oversample: !inSample,
editing_session_id: editingSessionId,
page_token: mw.user.getPageviewToken(),
session_token: mw.user.sessionId(),
editor_interface: 'wikitext',
platform: 'desktop', // FIXME
integration: 'page',
'page.id': mw.config.get( 'wgArticleId' ),
'page.title': mw.config.get( 'wgPageName' ),
'page.ns': mw.config.get( 'wgNamespaceNumber' ),
'page.revid': mw.config.get( 'wgRevisionId' ),
'user.id': mw.user.getId(),
'user.editCount': mw.config.get( 'wgUserEditCount', 0 ),
'mediawiki.version': mw.config.get( 'wgVersion' )
page_id: mw.config.get( 'wgArticleId' ),
page_title: mw.config.get( 'wgPageName' ),
page_ns: mw.config.get( 'wgNamespaceNumber' ),
revision_id: mw.config.get( 'wgRevisionId' ),
user_id: mw.user.getId(),
user_editcount: mw.config.get( 'wgUserEditCount', 0 ),
mw_version: mw.config.get( 'wgVersion' )
}, data );
if ( mw.user.isAnon() ) {
data[ 'user.class' ] = 'IP';
data.user_class = 'IP';
}
data[ 'action.' + action + '.type' ] = data.type;
data[ 'action.' + action + '.mechanism' ] = data.mechanism;
data[ 'action.' + action + '.timing' ] = data.timing === undefined ?
0 : Math.floor( data.timing );
data[ actionPrefix + '_type' ] = data.type;
data[ actionPrefix + '_mechanism' ] = data.mechanism;
data[ actionPrefix + '_timing' ] = data.timing === undefined ? 0 : Math.floor( data.timing );
/* eslint-enable camelcase */
// Remove renamed properties
delete data.type;
delete data.mechanism;
delete data.timing;
mw.eventLog.logEvent( 'Edit', data );
mw.eventLog.logEvent( 'EditAttemptStep', data );
} );
}