jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/360165 )
Change subject: Hygiene: SamplingRate -> BucketSize
......................................................................
Hygiene: SamplingRate -> BucketSize
In order to avoid further confusion, clarify that we're bucketing users
for experiments.
Bug: T167236
Depends-On: I752cdf068ca25bffb38229380785e7da1a208049
Change-Id: I6508ab8fa3d436ae295eb047e170fdc5417d25fc
---
M extension.json
M includes/FooterHooks.php
M resources/ext.relatedArticles.readMore.bootstrap/index.js
M resources/ext.relatedArticles.readMore.eventLogging/index.js
M tests/browser/LocalSettings.php
5 files changed, 18 insertions(+), 21 deletions(-)
Approvals:
Pmiazga: Looks good to me, but someone else must approve
Jhernandez: Looks good to me, but someone else must approve
jenkins-bot: Verified
Jdlrobson: Looks good to me, approved
diff --git a/extension.json b/extension.json
index b256e7b..eb217f2 100644
--- a/extension.json
+++ b/extension.json
@@ -166,8 +166,8 @@
"RelatedArticlesShowInFooter": false,
"RelatedArticlesUseCirrusSearch": false,
"RelatedArticlesOnlyUseCirrusSearch": false,
- "RelatedArticlesLoggingSamplingRate": 0.01,
- "RelatedArticlesEnabledSamplingRate": 1,
+ "RelatedArticlesLoggingBucketSize": 0.01,
+ "RelatedArticlesEnabledBucketSize": 1,
"@RelatedArticlesFooterWhitelistedSkins": "List of skin names
(e.g. 'minerva') where related articles will be shown in the footer.",
"RelatedArticlesFooterWhitelistedSkins": [ "minerva" ]
},
diff --git a/includes/FooterHooks.php b/includes/FooterHooks.php
index 61ac275..c19f506 100644
--- a/includes/FooterHooks.php
+++ b/includes/FooterHooks.php
@@ -158,10 +158,10 @@
public static function onResourceLoaderGetConfigVars( &$vars ) {
$config = MediaWikiServices::getInstance()->getConfigFactory()
->makeConfig( 'RelatedArticles' );
- $vars['wgRelatedArticlesLoggingSamplingRate'] =
- $config->get( 'RelatedArticlesLoggingSamplingRate' );
- $vars['wgRelatedArticlesEnabledSamplingRate']
- = $config->get( 'RelatedArticlesEnabledSamplingRate' );
+ $vars['wgRelatedArticlesLoggingBucketSize'] =
+ $config->get( 'RelatedArticlesLoggingBucketSize' );
+ $vars['wgRelatedArticlesEnabledBucketSize']
+ = $config->get( 'RelatedArticlesEnabledBucketSize' );
return true;
}
diff --git a/resources/ext.relatedArticles.readMore.bootstrap/index.js
b/resources/ext.relatedArticles.readMore.bootstrap/index.js
index 953a811..1c01ae4 100644
--- a/resources/ext.relatedArticles.readMore.bootstrap/index.js
+++ b/resources/ext.relatedArticles.readMore.bootstrap/index.js
@@ -15,26 +15,25 @@
shouldShowReadMore;
/**
- * Is RelatedArticles extension enabled for current user
+ * Gets whether the feature is enabled for the user.
*
- * Returns true if the user opted into the beta feature, otherwise
- * user's session ID is used to determine the eligibility for
RelatedArticles functionality,
- * based on the value of wgRelatedArticlesEnabledSamplingRate
- * thus the function will result the same outcome as long as the browser
- * hasn't been restarted or the cookie hasn't been cleared.
+ * The user's session ID is used to determine the eligibility for
+ * RelatedArticles functionality, based on the value of
+ * `$wgRelatedArticlesEnabledBucketSize`. The result of the function
will be
+ * the same for the duration of their session.
*
* @return {boolean}
*/
function isEnabledForCurrentUser() {
var bucket,
- samplingRate = mw.config.get(
'wgRelatedArticlesEnabledSamplingRate', 1 );
+ bucketSize = mw.config.get(
'wgRelatedArticlesEnabledBucketSize', 1 );
bucket = mw.experiments.getBucket( {
name: 'ext.relatedArticles.visibility',
enabled: true,
buckets: {
- control: 1 - samplingRate,
- A: samplingRate
+ control: 1 - bucketSize,
+ A: bucketSize
}
}, mw.user.sessionId() );
return bucket === 'A';
diff --git a/resources/ext.relatedArticles.readMore.eventLogging/index.js
b/resources/ext.relatedArticles.readMore.eventLogging/index.js
index 87ec230..004c492 100644
--- a/resources/ext.relatedArticles.readMore.eventLogging/index.js
+++ b/resources/ext.relatedArticles.readMore.eventLogging/index.js
@@ -25,9 +25,7 @@
* @return {boolean}
*/
function isEnabledForCurrentUser() {
-
- // TODO: Rename this and other instances to bucketingRate.
- var samplingRate = mw.config.get(
'wgRelatedArticlesLoggingSamplingRate', 0 );
+ var bucketSize = mw.config.get(
'wgRelatedArticlesLoggingBucketSize', 0 );
if ( !supportsBeacon() ) {
return false;
@@ -37,8 +35,8 @@
name: 'ext.relatedArticles.instrumentation',
enabled: true,
buckets: {
- control: 1 - samplingRate,
- A: samplingRate
+ control: 1 - bucketSize,
+ A: bucketSize
}
}, mw.user.sessionId() ) === 'A';
}
diff --git a/tests/browser/LocalSettings.php b/tests/browser/LocalSettings.php
index 9a2d8bc..968379d 100644
--- a/tests/browser/LocalSettings.php
+++ b/tests/browser/LocalSettings.php
@@ -1,6 +1,6 @@
<?php
-$wgRelatedArticlesLoggingSamplingRate = 1;
+$wgRelatedArticlesLoggingBucketSize = 1;
$wgRelatedArticlesShowInFooter = true;
$wgRelatedArticlesShowInSidebar = true;
$wgRelatedArticlesUseCirrusSearch = true;
--
To view, visit https://gerrit.wikimedia.org/r/360165
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I6508ab8fa3d436ae295eb047e170fdc5417d25fc
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/RelatedArticles
Gerrit-Branch: master
Gerrit-Owner: Phuedx <[email protected]>
Gerrit-Reviewer: Jdlrobson <[email protected]>
Gerrit-Reviewer: Jhernandez <[email protected]>
Gerrit-Reviewer: Pmiazga <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
