mediawiki-extensions-Popups/tests/node-qunit/title.test.js

import { fromElement, getTitle, isValid } from '../../src/title';

QUnit.module( 'title#getTitle', {
	beforeEach() {
		this.config = new Map();
		this.config.set( 'wgArticlePath', '/wiki/$1' );

		this.location = global.location = { hostname: 'en.wikipedia.org' };

		mw.util = {
			escapeRegExp: this.sandbox.spy( ( str ) => {
				return str.replace( /([\\{}()|.?*+\-^$[\]])/g, '\\$1' );
			} )
		};

		mw.Uri = this.sandbox.stub().throws( 'UNIMPLEMENTED' );
	},
	afterEach() {
		global.location = null;
		mw.util = null;
		mw.Uri = null;
	}
} );

QUnit.test( 'it should return the title of a url with a title query param', function ( assert ) {
	const href = '/w/index.php?title=Foo';
	mw.Uri.withArgs( href ).returns( {
		host: this.location.hostname,
		query: {
			title: 'Foo'
		}
	} );

	assert.strictEqual(
		getTitle( href, this.config ),
		'Foo',
		'The query title is returned.'
	);
} );

QUnit.test( 'it should return the title of a pretty url if it conforms wgArticlePath', function ( assert ) {
	const href = '/wiki/Foo';
	mw.Uri.withArgs( href ).returns( {
		host: this.location.hostname,
		path: href,
		query: {}
	} );

	assert.strictEqual(
		getTitle( href, this.config ),
		'Foo',
		'The ASCII title is returned.'
	);
} );

QUnit.test( 'it should return the title of a pretty url properly decoded', function ( assert ) {
	const href = '/wiki/%E6%B8%AC%E8%A9%A6';
	mw.Uri.withArgs( href ).returns( {
		host: this.location.hostname,
		path: href,
		query: {}
	} );

	assert.strictEqual(
		getTitle( href, this.config ),
		'測試',
		'The UTF-8 title is returned.'
	);
} );

QUnit.test( 'it should accept urls with fragments', function ( assert ) {
	let href = '/wiki/Example_1#footnote_1';
	mw.Uri.withArgs( href ).returns( {
		host: this.location.hostname,
		path: href,
		query: {},
		fragment: 'footnote_1'
	} );

	assert.strictEqual(
		getTitle( href, this.config ),
		'Example_1#footnote_1',
		'It accepts pretty urls with fragments.'
	);

	href = '/w/index.php?title=Example_2#footnote_2';
	mw.Uri.withArgs( href ).returns( {
		host: this.location.hostname,
		query: { title: 'Example_2' },
		fragment: 'footnote_2'
	} );

	assert.strictEqual(
		getTitle( href, this.config ),
		'Example_2#footnote_2',
		'It accepts title parameter urls with fragments.'
	);
} );

QUnit.test( 'it should skip pretty urls with invalid % encoded characters', function ( assert ) {
	const href = '/wiki/100%';
	mw.Uri.withArgs( href ).returns( {
		host: this.location.hostname,
		path: href,
		query: {}
	} );

	assert.strictEqual( getTitle( href, this.config ), undefined );
} );

QUnit.test( 'it should skip urls that mw.Uri cannot parse', function ( assert ) {
	const href = 'javascript:void(0);'; // eslint-disable-line no-script-url
	mw.Uri.withArgs( href ).throws(
		new Error( 'Cannot parse' )
	);

	assert.strictEqual(
		getTitle( href, this.config ),
		undefined,
		'No title is returned.'
	);
} );

QUnit.test( 'it should skip urls that are external', function ( assert ) {
	const href = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ';
	mw.Uri.withArgs( href ).returns( {
		host: 'www.youtube.com',
		path: '/watch',
		query: { v: 'dQw4w9WgXcQ' }
	} );

	assert.strictEqual(
		getTitle( href, this.config ),
		undefined,
		'No title is returned.'
	);
} );

QUnit.test( 'it should skip urls not on article path without one title query param', function ( assert ) {
	// No params
	let href = '/Foo';
	mw.Uri.withArgs( href ).returns( {
		host: this.location.hostname,
		path: '/Foo',
		query: {}
	} );

	assert.strictEqual(
		getTitle( href, this.config ),
		undefined,
		'No title is returned.'
	);

	// Multiple query params
	href = '/Foo?a=1&title=Foo';
	mw.Uri.withArgs( href ).returns( {
		host: this.location.hostname,
		path: '/Foo',
		query: { a: 1, title: 'Foo' }
	} );

	assert.strictEqual(
		getTitle( href, this.config ),
		undefined,
		'No title is returned.'
	);
} );

QUnit.module( 'title#isValid', {
	beforeEach() {
		mw.Title = {
			newFromText: this.sandbox.stub().throws( 'UNIMPLEMENTED' )
		};
	},
	afterEach() {
		mw.Title = null;
	}
} );

QUnit.test( 'it should return null if the title is empty', ( assert ) => {
	assert.strictEqual( isValid( '', [] ), null, 'Doesn\'t accept empty titles' );
} );

QUnit.test( 'it should return null if the title can\'t be parsed properly', ( assert ) => {
	mw.Title.newFromText.withArgs( 'title' ).returns( null );
	assert.strictEqual(
		isValid( 'title', [] ),
		null,
		'Doesn\'t accept unparseable titles'
	);
	assert.strictEqual(
		mw.Title.newFromText.callCount, 1,
		'mw.Title.newFromText called for parsing the title' );
} );

QUnit.test( 'it should return null if the title is not from a content namespace', ( assert ) => {
	mw.Title.newFromText.withArgs( 'title' ).returns( {
		namespace: 1
	} );
	assert.strictEqual(
		isValid( 'title', [ 5 ] ),
		null,
		'Only content namespace titles are accepted'
	);
} );

QUnit.test( 'it should return the title object if the title is from a content namespace', ( assert ) => {
	const mwTitle = {
		namespace: 3
	};
	mw.Title.newFromText.withArgs( 'title' ).returns( mwTitle );
	assert.strictEqual(
		isValid( 'title', [ 1, 3, 5 ] ),
		mwTitle,
		'A content namespace title is accepted'
	);
} );

QUnit.module( 'title#fromElement', {
	beforeEach() {
		global.location = {
			host: 'own.host',
			pathname: '/w/index.php',
			search: '?oldid=1&extra=1'
		};
		mw.Title = {
			newFromText: this.sandbox.stub().throws( 'UNIMPLEMENTED' )
		};
	},
	afterEach() {
		global.location = null;
		mw.Title = null;
	}
} );

QUnit.test( 'it should accept anchor links that point to the own page', function ( assert ) {
	const el = document.createElement( 'a' );
	el.href = 'http://own.host/w/index.php?oldid=1&extra=1#example';

	const config = new Map();
	config.set( 'wgPageName', 'Talk:Page' );

	const mwTitle = {
		namespace: 1,
		title: 'Page',
		fragment: 'example'
	};
	mw.Title.newFromText.withArgs( 'Talk:Page#example' ).returns( mwTitle );

	assert.propEqual( fromElement( el, config ), mwTitle );
} );

QUnit.test( 'it should ignore anchor links that are not identical', function ( assert ) {
	const el = document.createElement( 'a' );
	el.href = 'http://own.host/w/index.php?oldid=1#example';

	const config = new Map();
	config.set( 'wgPageName', 'Talk:Page' );

	assert.strictEqual( fromElement( el, config ), null );
} );

QUnit.test( 'it should pass through anchor links with non-ASCII characters', function ( assert ) {
	const el = document.createElement( 'a' );
	el.href = 'http://own.host/w/index.php?oldid=1&extra=1#Fläche';

	const config = new Map();
	config.set( 'wgPageName', 'Talk:Page' );

	const mwTitle = {
		namespace: 1,
		title: 'Page',
		fragment: 'Fläche'
	};
	mw.Title.newFromText.withArgs( 'Talk:Page#Fläche' ).returns( mwTitle );

	assert.propEqual( fromElement( el, config ), mwTitle );
} );

QUnit.test( 'it should decode anchor links with encoded characters', function ( assert ) {
	const el = document.createElement( 'a' );
	el.href = 'http://own.host/w/index.php?oldid=1&extra=1#Fl%C3%A4che';

	const config = new Map();
	config.set( 'wgPageName', 'Talk:Page' );

	const mwTitle = {
		namespace: 1,
		title: 'Page',
		fragment: 'Fläche'
	};
	mw.Title.newFromText.withArgs( 'Talk:Page#Fläche' ).returns( mwTitle );

	assert.propEqual( fromElement( el, config ), mwTitle );
} );

QUnit.test( 'it should fail gracefully on anchor links with broken encoding', function ( assert ) {
	const el = document.createElement( 'a' );
	el.href = 'http://own.host/w/index.php?oldid=1&extra=1#malformed%A';

	const config = new Map();
	config.set( 'wgPageName', 'Talk:Page' );

	assert.propEqual( fromElement( el, config ), null );
} );