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

import { createStubTitle } from '../stubs';
import { createModel } from '../../../src/preview/model';
import createMediaWikiApiGateway from '../../../src/gateway/mediawiki';

const DEFAULT_CONSTANTS = {
		THUMBNAIL_SIZE: 300,
		EXTRACT_LENGTH: 525
	},
	MEDIAWIKI_API_RESPONSE = {
		query: {
			pages: [
				{
					contentmodel: 'wikitext',
					extract: 'Richard Paul "Rick" Astley is an English singer, songwriter, musician, and radio personality. His 1987 song, "Never Gonna Give You Up" was a No. 1 hit single in 25 countries. By the time of his retirement in 1993, Astley had sold approximately 40 million records worldwide.\nAstley made a comeback in 2007, becoming an Internet phenomenon when his video "Never Gonna Give You Up" became integral to the meme known as "rickrolling". Astley was voted "Best Act Ever" by Internet users at the',
					lastrevid: 748725726,
					length: 32132,
					fullurl: 'https://en.wikipedia.org/wiki/Rick_Astley',
					editurl: 'https://en.wikipedia.org/w/index.php?title=Rick_Astley&action=edit',
					canonicalurl: 'https://en.wikipedia.org/wiki/Rick_Astley',
					ns: 0,
					pageid: 447541,
					pagelanguage: 'en',
					pagelanguagedir: 'ltr',
					pagelanguagehtmlcode: 'en',
					revisions: [ {
						timestamp: '2016-11-10T00:14:14Z'
					} ],
					thumbnail: {
						height: 300,
						source: 'https://upload.wikimedia.org/wikipedia/commons/thumb/6/6d/Rick_Astley_-_Pepsifest_2009.jpg/200px-Rick_Astley_-_Pepsifest_2009.jpg',
						width: 200
					},
					title: 'Rick Astley',
					touched: '2016-11-10T00:14:14Z'
				}
			]
		}
	},
	MEDIAWIKI_API_RESPONSE_PREVIEW_MODEL = createModel(
		'Rick Astley',
		'https://en.wikipedia.org/wiki/Rick_Astley',
		'en',
		'ltr',
		[ document.createTextNode( 'Richard Paul "Rick" Astley is an English singer, songwriter, musician, and radio personality. His 1987 song, "Never Gonna Give You Up" was a No. 1 hit single in 25 countries. By the time of his retirement in 1993, Astley had sold approximately 40 million records worldwide.\nAstley made a comeback in 2007, becoming an Internet phenomenon when his video "Never Gonna Give You Up" became integral to the meme known as "rickrolling". Astley was voted "Best Act Ever" by Internet users at the' ) ],
		undefined,
		{
			height: 300,
			source: 'https://upload.wikimedia.org/wikipedia/commons/thumb/6/6d/Rick_Astley_-_Pepsifest_2009.jpg/200px-Rick_Astley_-_Pepsifest_2009.jpg',
			width: 200
		},
		447541
	);

QUnit.module( 'ext.popups/gateway/mediawiki', {
	beforeEach() {
		mw.util = {
			escapeRegExp: this.sandbox.spy(
				( str ) => str.replace( /([\\{}()|.?*+\-^$[\]])/g, '\\$1' )
			)
		};
	},
	afterEach() {
		mw.util = null;
	}
} );

QUnit.test( 'MediaWiki API gateway is called with correct arguments', function ( assert ) {
	const config = $.extend( {}, DEFAULT_CONSTANTS, {
		acceptLanguage: 'pl'
	} );
	const spy = this.sandbox.spy(),
		api = {
			get: spy
		},
		gateway = createMediaWikiApiGateway( api, config ),
		expectedOptions = {
			action: 'query',
			prop: 'info|extracts|pageimages|revisions|info',
			formatversion: 2,
			redirects: true,
			exintro: true,
			exchars: 525,
			explaintext: true,
			piprop: 'thumbnail',
			pithumbsize: DEFAULT_CONSTANTS.THUMBNAIL_SIZE,
			pilicense: 'any',
			rvprop: 'timestamp',
			inprop: 'url',
			titles: 'Test Title',
			smaxage: 300,
			maxage: 300,
			uselang: 'content'
		},
		expectedHeaders = {
			headers: {
				'X-Analytics': 'preview=1',
				'Accept-Language': 'pl'
			}
		};

	gateway.fetch( 'Test Title' );

	assert.deepEqual( spy.getCall( 0 ).args[ 0 ], expectedOptions, 'options' );
	assert.deepEqual( spy.getCall( 0 ).args[ 1 ], expectedHeaders, 'headers' );
} );

QUnit.test( 'MediaWiki API gateway is correctly extracting the page data from the response ', function ( assert ) {
	const api = {
			get: this.sandbox.stub()
		},
		gateway = createMediaWikiApiGateway( api, DEFAULT_CONSTANTS ),
		errorCases = [
			{},
			{
				query: {}
			},
			{
				query: {
					pages: []
				}
			}
		],
		successCases = [
			[
				{
					query: {
						pages: [ { someData: 'Yes' } ]
					}
				},
				{
					someData: 'Yes'
				}
			]
		];

	errorCases.forEach( ( data, i ) => {
		assert.throws(
			() => { gateway.extractPageFromResponse( data ); },
			`Case ${i}: the gateway throws an error.`
		);
	} );

	successCases.forEach( ( data, i ) => {
		assert.deepEqual(
			gateway.extractPageFromResponse( data[ 0 ] ),
			data[ 1 ],
			`Case ${i}: the gateway extracts the response.`
		);
	} );
} );

QUnit.test( 'MediaWiki API gateway is correctly converting the page data to a model', ( assert ) => {
	const gateway = createMediaWikiApiGateway(),
		page = gateway.extractPageFromResponse( MEDIAWIKI_API_RESPONSE );

	assert.deepEqual(
		gateway.convertPageToModel( gateway.formatPlainTextExtract( page ) ),
		MEDIAWIKI_API_RESPONSE_PREVIEW_MODEL,
		'The gateway converts the page preview response.'
	);
} );

QUnit.test( 'MediaWiki API gateway handles API failure', function ( assert ) {
	const api = {
			get: this.sandbox.stub()
				.returns( $.Deferred().reject( { status: 400 } ).promise() )
		},
		gateway = createMediaWikiApiGateway( api, DEFAULT_CONSTANTS );

	return gateway.fetchPreviewForTitle( createStubTitle( 1, 'Test Title' ) ).catch( () => {
		assert.ok( true, 'The gateway threw an error.' );
	} );
} );

QUnit.test( 'MediaWiki API gateway returns the correct data', function ( assert ) {
	const api = {
			get: this.sandbox.stub().returns(
				$.Deferred().resolve( MEDIAWIKI_API_RESPONSE ).promise()
			)
		},
		gateway = createMediaWikiApiGateway( api, DEFAULT_CONSTANTS );

	return gateway.fetchPreviewForTitle( createStubTitle( 1, 'Test Title' ) ).then( ( result ) => {
		assert.deepEqual(
			result,
			MEDIAWIKI_API_RESPONSE_PREVIEW_MODEL,
			'The gateway converts the page preview response.'
		);
	} );
} );

QUnit.test( 'MediaWiki API gateway handles missing pages', function ( assert ) {
	const response = {
			query: {
				pages: [ {
					canonicalurl: 'http://dev.wiki.local.wmftest.net:8080/wiki/Missing_page',
					contentmodel: 'wikitext',
					editurl: 'http://dev.wiki.local.wmftest.net:8080/w/index.php?title=Missing_page&action=edit',
					fullurl: 'http://dev.wiki.local.wmftest.net:8080/wiki/Missing_page',
					missing: true,
					ns: 0,
					pagelanguage: 'en',
					pagelanguagedir: 'ltr',
					pagelanguagehtmlcode: 'en',
					title: 'Missing page'
				} ]
			}
		},
		model = createModel(
			'Missing page',
			'http://dev.wiki.local.wmftest.net:8080/wiki/Missing_page',
			'en',
			'ltr',
			undefined,
			undefined,
			undefined
		),
		api = {
			get: this.sandbox.stub().returns(
				$.Deferred().resolve( response ).promise()
			)
		},
		gateway = createMediaWikiApiGateway( api, DEFAULT_CONSTANTS );

	return gateway.fetchPreviewForTitle( createStubTitle( 1, 'Test Title' ) ).then( ( result ) => {
		assert.deepEqual(
			result,
			model,
			'The gateway converts the page preview response.'
		);
	} );
} );

QUnit.test( 'MediaWiki API gateway is abortable', function ( assert ) {
	const
		deferred = $.Deferred(),
		api = {
			get: this.sandbox.stub().returns(
				deferred.promise( { abort() { deferred.reject( 'http' ); } } )
			)
		},
		gateway = createMediaWikiApiGateway( api, DEFAULT_CONSTANTS );

	const xhr = gateway.fetchPreviewForTitle( createStubTitle( 1, 'Test Title' ) );

	const chain = xhr.then( () => {
		assert.ok( false, 'It never calls a thenable after rejection' );
	} ).catch( ( data ) => {
		assert.strictEqual( data, 'http' );
	} );

	xhr.abort();

	return chain;
} );