Add anon edit warning link parameters

The message mock for the snapshot test has changed so that also the arguments are in the snapshot. Bug: T330550
wmde · Sep 14, 2023 · c038ed8 · c038ed8
1 parent d1d0044
commit c038ed8
Show file tree

Hide file tree

Showing 10 changed files with 105 additions and 4 deletions.
diff --git a/src/components/AnonymousEditWarning.vue b/src/components/AnonymousEditWarning.vue
@@ -3,10 +3,16 @@ import WarningMessage from '@/components/WarningMessage.vue';
 import { useConfig } from '@/plugins/ConfigPlugin/Config';
 import { useMessages } from '@/plugins/MessagesPlugin/Messages';
 import { computed } from 'vue';
+import { useAuthenticationLinker } from '@/plugins/AuthenticationLinkerPlugin/AuthenticationLinker';
 
+const authenticationLinker = useAuthenticationLinker();
 const messages = useMessages();
 const warning = computed(
-	() => messages.get( 'wikibase-anonymouseditwarning' ) );
+	() => messages.get(
+		'wikibase-anonymouseditwarning',
+		authenticationLinker.getLoginLink(),
+		authenticationLinker.getCreateAccountLink(),
+	) );
 const config = useConfig();
 
 </script>

diff --git a/src/init.ts b/src/init.ts
@@ -12,6 +12,7 @@ import { ComponentPublicInstance } from 'vue';
 import MediaWikiRouter from './plugins/WikiRouterPlugin/MediaWikiRouter';
 import MwApiLangCodeRetriever from './data-access/MwApiLangCodeRetriever';
 import LanguageItemSearcher from '@/data-access/LanguageItemSearcher';
+import MediaWikiAuthenticationLinker from '@/plugins/AuthenticationLinkerPlugin/MediaWikiAuthenticationLinker';
 
 interface InitConfig extends CreateAndMountConfig {
 	tags: string[];
@@ -39,6 +40,10 @@ export default function init( config: InitConfig, mw: MediaWiki ): ComponentPubl
 		mw.util.getUrl,
 		( mw.config.get( 'wgNamespaceIds' ) as Record<string, number> ).lexeme,
 	);
+	const authenticationLinker = new MediaWikiAuthenticationLinker(
+		mw.util.getUrl,
+		mw.config.get( 'wgPageName' ) as string,
+	);
 	const tracker = new MwTracker( mw.track );
 	const wikiRouter = new MediaWikiRouter( mw.util.getUrl );
 
@@ -49,6 +54,7 @@ export default function init( config: InitConfig, mw: MediaWiki ): ComponentPubl
 		messagesRepository,
 		lexemeCreator,
 		searchLinker,
+		authenticationLinker,
 		tracker,
 		wikiRouter,
 	};

diff --git a/src/main.ts b/src/main.ts
@@ -3,6 +3,7 @@ import LexemeCreator from '@/data-access/LexemeCreator';
 import { ItemSearchKey } from '@/plugins/ItemSearchPlugin/ItemSearch';
 import { Config, ConfigKey } from '@/plugins/ConfigPlugin/Config';
 import SearchLinker, { SearchLinkerKey } from '@/plugins/SearchLinkerPlugin/SearchLinker';
+import AuthenticationLinker, { AuthenticationLinkerKey } from '@/plugins/AuthenticationLinkerPlugin/AuthenticationLinker';
 import Tracker from '@/data-access/tracking/Tracker';
 import {
 	HANDLE_INIT_PARAMS,
@@ -35,6 +36,7 @@ export interface Services {
 	langCodeRetriever: LangCodeRetriever;
 	lexemeCreator: LexemeCreator;
 	searchLinker: SearchLinker;
+	authenticationLinker: AuthenticationLinker;
 	tracker: Tracker;
 	wikiRouter: WikiRouter;
 }
@@ -59,6 +61,7 @@ export default function createAndMount(
 	app.provide( ItemSearchKey, services.itemSearcher );
 	app.provide( LanguageItemSearchKey, services.languageItemSearcher );
 	app.provide( SearchLinkerKey, services.searchLinker );
+	app.provide( AuthenticationLinkerKey, services.authenticationLinker );
 	app.provide( WikiRouterKey, services.wikiRouter );
 	app.provide(
 		LanguageCodesProviderKey,

diff --git a/src/plugins/AuthenticationLinkerPlugin/AuthenticationLinker.ts b/src/plugins/AuthenticationLinkerPlugin/AuthenticationLinker.ts
@@ -0,0 +1,21 @@
+import { inject, InjectionKey } from 'vue';
+
+export default interface AuthenticationLinker {
+	/**
+	 * Return a URL for logging in
+	 */
+	getLoginLink(): string;
+
+	/**
+	 * Return a URL for creating a new account
+	 */
+	getCreateAccountLink(): string;
+}
+
+export const AuthenticationLinkerKey: InjectionKey<AuthenticationLinker> = Symbol( 'AuthenticationLinker' );
+
+export function useAuthenticationLinker(): AuthenticationLinker {
+	return inject( AuthenticationLinkerKey, () => {
+		throw new Error( 'No AuthenticationLinker provided!' );
+	}, true );
+}
diff --git a/src/plugins/AuthenticationLinkerPlugin/MediaWikiAuthenticationLinker.ts b/src/plugins/AuthenticationLinkerPlugin/MediaWikiAuthenticationLinker.ts
@@ -0,0 +1,19 @@
+import { MwUtilGetUrl } from '@/@types/mediawiki';
+import AuthenticationLinker from '@/plugins/AuthenticationLinkerPlugin/AuthenticationLinker';
+
+export default class MediaWikiAuthenticationLinker implements AuthenticationLinker {
+
+	public constructor(
+		private readonly getUrl: MwUtilGetUrl,
+		private readonly currentPage: string,
+	) {}
+
+	public getCreateAccountLink(): string {
+		return this.getUrl( 'Special:CreateAccount', { returnto: this.currentPage } );
+	}
+
+	public getLoginLink(): string {
+		return this.getUrl( 'Special:UserLogin', { returnto: this.currentPage } );
+	}
+
+}
diff --git a/tests/integration/App.test.ts b/tests/integration/App.test.ts
@@ -15,6 +15,7 @@ import DevItemSearcher from '@/data-access/DevItemSearcher';
 import DevMessagesRepository from '@/plugins/MessagesPlugin/DevMessagesRepository';
 import MediaWikiSearchLinker from '@/plugins/SearchLinkerPlugin/MediaWikiSearchLinker';
 import { LanguageItemSearchKey } from '@/plugins/ItemSearchPlugin/LanguageItemSearch';
+import { AuthenticationLinkerKey } from '@/plugins/AuthenticationLinkerPlugin/AuthenticationLinker';
 
 describe( 'App.vue', () => {
 
@@ -64,6 +65,7 @@ describe( 'App.vue', () => {
 						mwUtilGetUrl,
 						lexemeNS,
 					),
+					[ AuthenticationLinkerKey as symbol ]: null,
 					[ WikiRouterKey as symbol ]: null,
 					[ MessagesKey as symbol ]: new Messages( new DevMessagesRepository() ),
 					[ ItemSearchKey as symbol ]: new DevItemSearcher(),

diff --git a/tests/unit/components/AnonymousEditWarning.test.ts b/tests/unit/components/AnonymousEditWarning.test.ts
@@ -2,37 +2,52 @@ import AnonymousEditWarning from '@/components/AnonymousEditWarning.vue';
 import { ConfigKey } from '@/plugins/ConfigPlugin/Config';
 import { MessagesKey } from '@/plugins/MessagesPlugin/Messages';
 import { mount } from '@vue/test-utils';
+import { AuthenticationLinkerKey } from '@/plugins/AuthenticationLinkerPlugin/AuthenticationLinker';
 
 describe( 'AnonymousEditWarning', () => {
 
 	it( 'does nothing if not anonymous', () => {
 		const messages = { get: jest.fn() };
+		const authenticationLinker = {
+			getLoginLink: jest.fn(),
+			getCreateAccountLink: jest.fn(),
+		};
 		const warning = mount( AnonymousEditWarning, {
 			global: {
 				provide: {
 					[ ConfigKey as symbol ]: { isAnonymous: false },
 					[ MessagesKey as symbol ]: messages,
+					[ AuthenticationLinkerKey as symbol ]: authenticationLinker,
 				},
 			},
 		} );
 
 		expect( warning.isVisible() ).toBe( false );
 		expect( messages.get ).not.toHaveBeenCalled();
+		expect( authenticationLinker.getLoginLink ).not.toHaveBeenCalled();
+		expect( authenticationLinker.getCreateAccountLink ).not.toHaveBeenCalled();
 	} );
 
 	it( 'matches snapshot if anonymous', () => {
-		const messages = { get: jest.fn().mockImplementation( ( key ) => key ) };
+		const messages = { get: jest.fn().mockImplementation( ( ...params ) =>
+			`(${params.join( ', ' )})`,
+		) };
+		const authenticationLinker = {
+			getLoginLink: jest.fn().mockReturnValue( 'loginLink' ),
+			getCreateAccountLink: jest.fn().mockReturnValue( 'createAccountLink' ),
+		};
 		const warning = mount( AnonymousEditWarning, {
 			global: {
 				provide: {
 					[ ConfigKey as symbol ]: { isAnonymous: true },
 					[ MessagesKey as symbol ]: messages,
+					[ AuthenticationLinkerKey as symbol ]: authenticationLinker,
 				},
 			},
 		} );
 
 		expect( warning.html() ).toMatchSnapshot();
-		expect( messages.get ).toHaveBeenCalledWith( 'wikibase-anonymouseditwarning' );
+		expect( messages.get ).toHaveBeenCalledWith( 'wikibase-anonymouseditwarning', 'loginLink', 'createAccountLink' );
 	} );
 
 } );
diff --git a/tests/unit/components/__snapshots__/AnonymousEditWarning.test.ts.snap b/tests/unit/components/__snapshots__/AnonymousEditWarning.test.ts.snap
@@ -1,3 +1,3 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`AnonymousEditWarning matches snapshot if anonymous 1`] = `"<div class="wikit wikit-Message wikit-Message--warning wbl-snl-anonymous-edit-warning"><span class="wikit-Message__content"><span class="wikit wikit-Icon wikit-Icon--large wikit-Icon--warning wikit-Message__icon"><svg class="wikit-Icon__svg" xmlns="http://www.w3.org/2000/svg" fill="none" aria-hidden="true" focusable="false" viewBox="0 0 16 16"><path fill="currentColor" d="M9.163 1.68234C9.06078 1.4381 8.89901 1.22746 8.69449 1.07231C8.48997 0.917151 8.25017 0.823144 7.99999 0.800049C7.75116 0.82453 7.51294 0.919178 7.30987 1.07425C7.10679 1.22933 6.94619 1.43922 6.84459 1.68234L0.672272 13.0631C0.0337565 14.2368 0.558251 15.2 1.82768 15.2H14.1723C15.4417 15.2 15.9662 14.2368 15.3277 13.0631L9.163 1.68234ZM8.76013 12.7717H7.23986V11.1528H8.76013V12.7717ZM8.76013 9.53394H7.23986V4.67728H8.76013V9.53394Z"></path></svg></span><span><!-- eslint-disable-next-line vue/no-v-html --><span>wikibase-anonymouseditwarning</span></span></span></div>"`;
+exports[`AnonymousEditWarning matches snapshot if anonymous 1`] = `"<div class="wikit wikit-Message wikit-Message--warning wbl-snl-anonymous-edit-warning"><span class="wikit-Message__content"><span class="wikit wikit-Icon wikit-Icon--large wikit-Icon--warning wikit-Message__icon"><svg class="wikit-Icon__svg" xmlns="http://www.w3.org/2000/svg" fill="none" aria-hidden="true" focusable="false" viewBox="0 0 16 16"><path fill="currentColor" d="M9.163 1.68234C9.06078 1.4381 8.89901 1.22746 8.69449 1.07231C8.48997 0.917151 8.25017 0.823144 7.99999 0.800049C7.75116 0.82453 7.51294 0.919178 7.30987 1.07425C7.10679 1.22933 6.94619 1.43922 6.84459 1.68234L0.672272 13.0631C0.0337565 14.2368 0.558251 15.2 1.82768 15.2H14.1723C15.4417 15.2 15.9662 14.2368 15.3277 13.0631L9.163 1.68234ZM8.76013 12.7717H7.23986V11.1528H8.76013V12.7717ZM8.76013 9.53394H7.23986V4.67728H8.76013V9.53394Z"></path></svg></span><span><!-- eslint-disable-next-line vue/no-v-html --><span>(wikibase-anonymouseditwarning, loginLink, createAccountLink)</span></span></span></div>"`;
diff --git a/tests/unit/main.test.ts b/tests/unit/main.test.ts
@@ -39,6 +39,10 @@ describe( 'createAndMount', () => {
 			searchLinker: {
 				getSearchUrlForLexeme: jest.fn().mockReturnValue( 'https://example.com' ),
 			},
+			authenticationLinker: {
+				getLoginLink: jest.fn(),
+				getCreateAccountLink: jest.fn(),
+			},
 			tracker: unusedTracker,
 			wikiRouter: unusedWikiRouter,
 			langCodeRetriever: unusedLangCodeRetriever,

diff --git a/tests/unit/plugins/MediaWikiAuthenticationLinker.test.ts b/tests/unit/plugins/MediaWikiAuthenticationLinker.test.ts
@@ -0,0 +1,25 @@
+import MediaWikiAuthenticationLinker from '@/plugins/AuthenticationLinkerPlugin/MediaWikiAuthenticationLinker';
+
+describe( 'MediaWikiAuthenticationLinker', () => {
+	it( 'delegates to mw.util.getUrl for getting the login url', () => {
+		const url = '/w/index.php?title=Special:UserLogin&returnto=Special%3ANewLexeme';
+		const getUrlMock = jest.fn().mockReturnValue( url );
+		const authenticationLinker = new MediaWikiAuthenticationLinker( getUrlMock, 'Special:NewLexeme' );
+
+		expect( authenticationLinker.getLoginLink() ).toBe( url );
+		expect( getUrlMock ).toHaveBeenCalledWith( 'Special:UserLogin', {
+			returnto: 'Special:NewLexeme',
+		} );
+	} );
+
+	it( 'delegates to mw.util.getUrl for getting the create account url', () => {
+		const url = '/w/index.php?title=Special:CreateAccount&returnto=Special%3ANewLexeme';
+		const getUrlMock = jest.fn().mockReturnValue( url );
+		const authenticationLinker = new MediaWikiAuthenticationLinker( getUrlMock, 'Special:NewLexeme' );
+
+		expect( authenticationLinker.getCreateAccountLink() ).toBe( url );
+		expect( getUrlMock ).toHaveBeenCalledWith( 'Special:CreateAccount', {
+			returnto: 'Special:NewLexeme',
+		} );
+	} );
+} );