Upgrade extension Thanks to MW 1.43 | Pull all Fandom patches into Thanks 1.43

.github/workflows/php-pr-checks.yml

@@ -0,0 +1,78 @@
+name: PHPUnit / PHPCS / Phan
+on:
+  pull_request:
+    branches: '**'
+
+  push:
+    branches: [ REL1_43 ]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        php_version: ['8.0']
+        mw: ['REL1_43']
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php_version }}
+          # We don't run any coverage, so we should set this parameter to none
+          # as this will disable xdebug which slows all processes significantly
+          coverage: none
+          extensions: ast
+      - uses: actions/checkout@v3
+
+      - name: Checkout Mediawiki
+        uses: actions/checkout@v3
+        with:
+          repository: wikimedia/mediawiki
+          path: mediawiki
+          ref: ${{ matrix.mw }}
+
+      - name: Checkout Echo (dependency) extension
+        uses: actions/checkout@v3
+        with:
+          repository: wikimedia/mediawiki-extensions-Echo
+          path: mediawiki/extensions/Echo
+
+      - name: Checkout Flow (implicit dependency) extension
+        uses: actions/checkout@v3
+        with:
+          repository: wikimedia/mediawiki-extensions-Flow
+          path: mediawiki/extensions/Flow
+
+      - name: Checkout MobileFrontend (implicit dependency) extension
+        uses: actions/checkout@v3
+        with:
+          repository: wikimedia/mediawiki-extensions-MobileFrontend
+          path: mediawiki/extensions/MobileFrontend
+
+      - name: Checkout CheckUser (implicit dependency) extension
+        uses: actions/checkout@v3
+        with:
+          repository: wikimedia/mediawiki-extensions-CheckUser
+          path: mediawiki/extensions/CheckUser
+
+      - name: Checkout Thanks extension
+        uses: actions/checkout@v2
+        with:
+          path: mediawiki/extensions/Thanks
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-v3-${{ hashFiles('**/composer.lock') }}
+
+      - name: Install composer dependencies
+        if: steps.composer-cache.outputs.cache-hit != 'true'
+        working-directory: ./mediawiki/extensions/Thanks
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run PHPCS
+        working-directory: ./mediawiki/extensions/Thanks
+        run: composer phpcs

extension.json

@@ -11,10 +11,7 @@
 	"license-name": "MIT",
 	"type": "other",
 	"requires": {
-		"MediaWiki": ">= 1.43",
-		"extensions": {
-			"Echo": "*"
-		}
+		"MediaWiki": ">= 1.43"
 	},
 	"DefaultUserOptions": {
 		"echo-subscriptions-web-edit-thank": true,
@@ -81,6 +78,10 @@
 			"dependencies": [
 				"mediawiki.cookie",
 				"mediawiki.api"
+			],
+			"targets": [
+				"desktop",
+				"mobile"
 			]
 		},
 		"ext.thanks.corethank": {
@@ -106,6 +107,10 @@
 				"mediawiki.api",
 				"jquery.confirmable",
 				"ext.thanks"
+			],
+			"targets": [
+				"desktop",
+				"mobile"
 			]
 		},
 		"ext.thanks.flowthank": {
@@ -161,6 +166,7 @@
 		"main": {
 			"class": "MediaWiki\\Extension\\Thanks\\Hooks",
 			"services": [
+				"Fandom\\FandomThanks\\ThanksCache",
 				"MainConfig",
 				"GenderCache",
 				"PermissionManager",

includes/Api/ApiCoreThank.php

@@ -3,14 +3,15 @@
 namespace MediaWiki\Extension\Thanks\Api;
 
 use DatabaseLogEntry;
+use Fandom\FandomThanks\ThanksCache;
 use LogEntry;
 use MediaWiki\Api\ApiBase;
 use MediaWiki\Api\ApiMain;
-use MediaWiki\Extension\Notifications\DiscussionParser;
-use MediaWiki\Extension\Notifications\Model\Event;
+use MediaWiki\Context\RequestContext;
 use MediaWiki\Extension\Thanks\Storage\Exceptions\InvalidLogType;
 use MediaWiki\Extension\Thanks\Storage\Exceptions\LogDeleted;
 use MediaWiki\Extension\Thanks\Storage\LogStore;
+use MediaWiki\MediaWikiServices;
 use MediaWiki\Permissions\PermissionManager;
 use MediaWiki\Revision\RevisionRecord;
 use MediaWiki\Revision\RevisionStore;
@@ -93,7 +94,6 @@ public function execute() {
 		}
 		if ( $type === 'rev' ) {
 			$revision = $this->getRevisionFromId( $id );
-			$excerpt = DiscussionParser::getEditExcerpt( $revision, $this->getLanguage() );
 			$title = $this->getTitleFromRevision( $revision );
 			$this->dieOnUserBlockedFromTitle( $user, $title );
 
@@ -115,7 +115,7 @@ public function execute() {
 				$user,
 				$type,
 				$id,
-				$excerpt,
+				'', // We don't need the excerpt for our notification, and it would come from Echo
 				$recipient,
 				$this->getSourceFromParams( $params ),
 				$title,
@@ -132,11 +132,13 @@ public function execute() {
 	 * @return bool
 	 */
 	protected function userAlreadySentThanks( User $user, $type, $id ) {
-		if ( $type === 'rev' ) {
-			// For b/c with old-style keys
-			$type = '';
-		}
-		return (bool)$user->getRequest()->getSessionData( "thanks-thanked-$type$id" );
+		/**
+		 * Fandom change - start - UGC-4533 - Cache thanks data in session in a better way
+		 * @author Mkostrzewski
+		 */
+		return MediaWikiServices::getInstance()->getService( ThanksCache::class )
+			->haveThanked( RequestContext::getMain(), $user->getActorId(), $id, $type );
+		// Fandom change - end
 	}
 
 	private function getRevisionFromId( $revId ) {
@@ -241,8 +243,8 @@ protected function sendThanks(
 			return;
 		}
 
-		// Create the notification via Echo extension
-		Event::create( [
+		// Create notification via hook
+		$this->getHookContainer()->run( 'ThankCreated', [
 			'type' => 'edit-thank',
 			'title' => $title,
 			'extra' => [
@@ -256,7 +258,13 @@ protected function sendThanks(
 		] );
 
 		// And mark the thank in session for a cheaper check to prevent duplicates (Phab:T48690).
-		$user->getRequest()->setSessionData( "thanks-thanked-$type$id", true );
+		/**
+		 * Fandom change - start - UGC-4533 - Cache thanks data in session in a better way
+		 * @author Mkostrzewski
+		 */
+		MediaWikiServices::getInstance()->getService( ThanksCache::class )
+			->appendUserThanks( $this->getContext(), $user->getActorId(), $uniqueId );
+		// Fandom change - end
 		// Set success message
 		$this->markResultSuccess( $recipient->getName() );
 		$this->logThanks( $user, $recipient, $uniqueId );

includes/Hooks.php

@@ -7,6 +7,8 @@
 use Article;
 use DatabaseLogEntry;
 use DifferenceEngine;
+use Fandom\FandomThanks\ThanksCache;
+use Fandom\FandomThanks\ThanksPermissions;
 use LogEventsList;
 use LogPage;
 use MediaWiki\Api\ApiModuleManager;
@@ -63,14 +65,15 @@ class Hooks implements
 	PageHistoryPager__doBatchLookupsHook,
 	ChangesListInitRowsHook
 {
-	private Config $config;
-	private GenderCache $genderCache;
-	private PermissionManager $permissionManager;
-	private RevisionLookup $revisionLookup;
-	private UserFactory $userFactory;
-	private UserOptionsManager $userOptionsManager;
+	protected Config $config;
+	protected GenderCache $genderCache;
+	protected PermissionManager $permissionManager;
+	protected RevisionLookup $revisionLookup;
+	protected UserFactory $userFactory;
+	protected UserOptionsManager $userOptionsManager;
 
 	public function __construct(
+		protected ThanksCache $thanksCache,
 		Config $config,
 		GenderCache $genderCache,
 		PermissionManager $permissionManager,
@@ -100,6 +103,11 @@ public function onHistoryTools(
 		$oldRevisionRecord,
 		$userIdentity
 	) {
+		// [UGC-4257] Don't show thank links if user doesn't have specific permission
+		if ( !ThanksPermissions::checkUserPermissionsForThanks( RequestContext::getMain()->getOutput() ) ) {
+			return;
+		}
+
 		$this->insertThankLink( $revisionRecord,
 			$links, $userIdentity );
 	}
@@ -118,6 +126,13 @@ public function onDiffTools(
 		$oldRevisionRecord,
 		$userIdentity
 	) {
+		$out = RequestContext::getMain()->getOutput();
+
+		// [UGC-4257] Don't show thank links if user doesn't have specific permission
+		if ( !ThanksPermissions::checkUserPermissionsForThanks( $out ) ) {
+			return;
+		}
+
 		// Don't allow thanking for a diff that includes multiple revisions
 		// This does a query that is too expensive for history rows (T284274)
 		$previous = $this->revisionLookup->getPreviousRevision( $revisionRecord );
@@ -245,16 +260,18 @@ protected function generateThankElement(
 		bool $isPrimaryButton = false
 	) {
 		$useCodex = RequestContext::getMain()->getSkin()->getSkinName() === 'minerva';
-		// Check if the user has already thanked for this revision or log entry.
-		// Session keys are backwards-compatible, and are also used in the ApiCoreThank class.
-		$sessionKey = ( $type === 'revision' ) ? $id : $type . $id;
 		$class = $useCodex ? 'cdx-button cdx-button--fake-button cdx-button--fake-button--enabled' : '';
 		if ( $isPrimaryButton && $useCodex ) {
 			$class .= ' cdx-button--weight-primary cdx-button--action-progressive';
 		}
-		if ( $sender->getRequest()->getSessionData( "thanks-thanked-$sessionKey" ) ) {
+		// Check if the user has already thanked for this revision or log entry.
+		/**
+		 * Fandom change - start - UGC-4533 - Cache thanks data in session in a better way
+		 * @author Mkostrzewski
+		 */
+		if ( $this->thanksCache->haveThanked( RequestContext::getMain(), $sender->getActorId(), $id, $type ) ) {
+			// Fandom change - end
 			$class .= ' mw-thanks-thanked';
-
 			return Html::element(
 				'span',
 				[ 'class' => $class ],

modules/ext.thanks.corethank.js

@@ -54,8 +54,14 @@
 		( new mw.Api() ).postWithToken( 'csrf', apiParams )
 			.then(
 				// Success
-				() => {
-					$thankElement.before( mw.message( 'thanks-thanked', mw.user, $thankLink.data( 'recipient-gender' ) ).escaped() );
+                () => {
+					// FANDOM change. Gave the "before" element a class, so we can style it.
+					$thankElement.before(
+						`<span class="mw-thanks-thank-confirmation">
+							${mw.message( 'thanks-thanked', mw.user, $thankLink.data( 'recipient-gender' ) ).escaped()}
+						</span>`
+					);
+					// FANDOM change end.
 					$thankElement.remove();
 					mw.thanks.thanked.push( $thankLink.attr( attrName ) );
 				},
@@ -133,5 +139,15 @@
 
 	mw.hook( 'wikipage.content' ).add( ( $content ) => {
 		addActionToLinks( $content );
+		reloadThankedState();
 	} );
+
+	// Add `wikipage.content` hook only to special pages that are dynamically reloading DOM
+	const specialPageName = mw.config.get( 'wgCanonicalSpecialPageName' );
+	if ( specialPageName === 'Recentchanges' || specialPageName === 'Watchlist' ) {
+		mw.hook( 'wikipage.content' ).add( function ( $content ) {
+			addActionToLinks( $content );
+			reloadThankedState();
+		} );
+	}
 }() );

modules/ext.thanks.thank.js

@@ -12,7 +12,12 @@
 			 * @return {string[]} Thanks IDs
 			 */
 			load: function ( cookieName ) {
-				const cookie = mw.cookie.get( cookieName || this.cookieName );
+				/**
+				 * Fandom change - start - UGC-4533 - Use localStorage instead of a cookie
+				 * @author Mkostrzewski
+				 */
+				const cookie = mw.storage.get( cookieName || this.cookieName );
+				// Fandom change - end
 				if ( cookie === null ) {
 					return [];
 				}
@@ -31,7 +36,12 @@
 				if ( saved.length > this.maxHistory ) { // prevent forever growing
 					saved = saved.slice( saved.length - this.maxHistory );
 				}
-				mw.cookie.set( cookieName || this.cookieName, escape( saved.join( ',' ) ) );
+				/**
+				 * Fandom change - start - UGC-4533 - Use localStorage instead of a cookie
+				 * @author Mkostrzewski
+				 */
+				mw.storage.set( cookieName || this.cookieName, escape( saved.join( ',' ) ) );
+				// Fandom change - end
 			},
 
 			/**