Add Vector Zebra Design A/B Test

Adds Zebra A/B test configuration

Bug: T333493
Change-Id: I56f66e19dd3fab2007de50d665f077a4ee01a6e4

includes/Constants.php

@@ -258,6 +258,13 @@ final class Constants {
 	 */
 	public const CONFIG_ZEBRA_DESIGN = 'VectorZebraDesign';
 
+	/**
+	 * Requirement that checks the value of ABTestEnrollment.
+	 *
+	 * @var string
+	 */
+	public const REQUIREMENT_ZEBRA_AB_TEST = 'VectorZebraDesign';
+
 	/**
 	 * This class is for namespacing constants only. Forbid construction.
 	 * @throws FatalError

includes/FeatureManagement/Requirements/ABRequirement.php

@@ -0,0 +1,103 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @since 1.35
+ */
+
+namespace MediaWiki\Skins\Vector\FeatureManagement\Requirements;
+
+use Config;
+use MediaWiki\Skins\Vector\FeatureManagement\Requirement;
+use User;
+
+/**
+ * @package MediaWiki\Skins\Vector\FeatureManagement\Requirements
+ * @internal
+ */
+class ABRequirement implements Requirement {
+	/**
+	 * @var Config
+	 */
+	private $config;
+
+	/**
+	 * @var User
+	 */
+	private $user;
+
+	/**
+	 * @var string The name of the requirement
+	 */
+	private $name;
+
+	/**
+	 * @var string The name of the experiment
+	 */
+	private $experimentName;
+
+	/**
+	 * @param Config $config
+	 * @param User $user
+	 * @param string $name The name of the requirement
+	 * @param string $experimentName The name of the experiment
+	 */
+	public function __construct(
+		Config $config,
+		User $user,
+		string $name,
+		string $experimentName
+	) {
+		$this->config = $config;
+		$this->user = $user;
+		$this->name = $name;
+		$this->experimentName = $experimentName;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getName(): string {
+		return $this->name;
+	}
+
+	/**
+	 * Returns true if the user is logged-in and false otherwise.
+	 *
+	 * @inheritDoc
+	 */
+	public function isMet(): bool {
+		// Get the experiment configuration from the config object.
+		$experiment = $this->config->get( 'VectorWebABTestEnrollment' );
+
+		// Check if the experiment is not enabled or does not match the specified name.
+		if ( !$experiment['enabled'] || $experiment['name'] !== $this->experimentName ) {
+			// If the experiment is not enabled or does not match the specified name,
+			// return true, indicating that the metric is "met"
+			return true;
+		} else {
+			// If the experiment is enabled and matches the specified name,
+			// calculate the user's variant based on their ID
+			$variant = $this->user->getID() % 2;
+
+			// Cast the variant value to a boolean and return it, indicating whether
+			// the user is in the "control" or "test" group.
+			return (bool)$variant;
+		}
+	}
+}

includes/ServiceWiring.php

@@ -25,6 +25,7 @@
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Skins\Vector\Constants;
 use MediaWiki\Skins\Vector\FeatureManagement\FeatureManager;
+use MediaWiki\Skins\Vector\FeatureManagement\Requirements\ABRequirement;
 use MediaWiki\Skins\Vector\FeatureManagement\Requirements\DynamicConfigRequirement;
 use MediaWiki\Skins\Vector\FeatureManagement\Requirements\LimitedWidthContentRequirement;
 use MediaWiki\Skins\Vector\FeatureManagement\Requirements\LoggedInRequirement;
@@ -71,10 +72,21 @@ return [
 
 		// MultiConfig checks each config in turn, allowing us to override the main config for specific keys.
 		$config = new MultiConfig( [
-			new HashConfig( [] ),
+			new HashConfig( [
+				Constants::REQUIREMENT_ZEBRA_AB_TEST => true,
+			] ),
 			$services->getMainConfig(),
 		] );
 
+		$featureManager->registerRequirement(
+			new ABRequirement(
+				$services->getMainConfig(),
+				$context->getUser(),
+				Constants::REQUIREMENT_ZEBRA_AB_TEST,
+				'skin-vector-zebra-experiment'
+			)
+		);
+
 		$featureManager->registerRequirement(
 			new OverridableConfigRequirement(
 				$config,
@@ -82,8 +94,7 @@ return [
 				$context->getRequest(),
 				$services->getCentralIdLookupFactory()->getNonLocalLookup(),
 				Constants::CONFIG_KEY_LANGUAGE_IN_HEADER,
-				$requirementName,
-				/* $overrideName = */ ''
+				$requirementName
 			)
 		);
 
@@ -282,7 +293,8 @@ return [
 				$context->getRequest(),
 				null,
 				Constants::CONFIG_ZEBRA_DESIGN,
-				Constants::REQUIREMENT_ZEBRA_DESIGN
+				Constants::REQUIREMENT_ZEBRA_DESIGN,
+				Constants::REQUIREMENT_ZEBRA_AB_TEST
 			)
 		);
 		$featureManager->registerFeature(
@@ -290,6 +302,7 @@ return [
 			[
 				Constants::REQUIREMENT_FULLY_INITIALISED,
 				Constants::REQUIREMENT_ZEBRA_DESIGN,
+				Constants::REQUIREMENT_ZEBRA_AB_TEST
 			]
 		);
 

skin.json

@@ -570,7 +570,7 @@
 		},
 		"VectorWebABTestEnrollment": {
 			"value": {
-				"name": "skin-vector-toc-experiment",
+				"name": "skin-vector-zebra-experiment",
 				"enabled": false,
 				"buckets": {
 					"unsampled": {