path: root/www/wiki/tests/qunit/suites/resources/mediawiki.rcfilters/UriProcessor.test.js

/* eslint-disable camelcase */
/* eslint no-underscore-dangle: "off" */
( function ( mw, $ ) {
	var mockFilterStructure = [ {
			name: 'group1',
			title: 'Group 1',
			type: 'send_unselected_if_any',
			filters: [
				{ name: 'filter1', cssClass: 'filter1class', default: true },
				{ name: 'filter2', cssClass: 'filter2class' }
			]
		}, {
			name: 'group2',
			title: 'Group 2',
			type: 'send_unselected_if_any',
			filters: [
				{ name: 'filter3', cssClass: 'filter3class' },
				{ name: 'filter4', cssClass: 'filter4class', default: true }
			]
		}, {
			name: 'group3',
			title: 'Group 3',
			type: 'string_options',
			filters: [
				{ name: 'filter5', cssClass: 'filter5class' },
				{ name: 'filter6' } // Not supporting highlights
			]
		}, {
			name: 'group4',
			title: 'Group 4',
			type: 'boolean',
			sticky: true,
			filters: [
				{ name: 'stickyFilter7', cssClass: 'filter7class' },
				{ name: 'stickyFilter8', cssClass: 'filter8class' }
			]
		} ],
		minimalDefaultParams = {
			filter1: '1',
			filter4: '1'
		};

	QUnit.module( 'mediawiki.rcfilters - UriProcessor' );

	QUnit.test( 'getVersion', function ( assert ) {
		var uriProcessor = new mw.rcfilters.UriProcessor( new mw.rcfilters.dm.FiltersViewModel() );

		assert.ok(
			uriProcessor.getVersion( { param1: 'foo', urlversion: '2' } ),
			2,
			'Retrieving the version from the URI query'
		);

		assert.ok(
			uriProcessor.getVersion( { param1: 'foo' } ),
			1,
			'Getting version 1 if no version is specified'
		);
	} );

	QUnit.test( 'getUpdatedUri', function ( assert ) {
		var uriProcessor,
			filtersModel = new mw.rcfilters.dm.FiltersViewModel(),
			makeUri = function ( queryParams ) {
				var uri = new mw.Uri( 'http://server/wiki/Special:RC' );
				uri.query = queryParams;
				return uri;
			};

		filtersModel.initializeFilters( mockFilterStructure );
		uriProcessor = new mw.rcfilters.UriProcessor( filtersModel );

		assert.deepEqual(
			( uriProcessor.getUpdatedUri( makeUri( {} ) ) ).query,
			{ urlversion: '2' },
			'Empty model state with empty uri state, assumes the given uri is already normalized, and adds urlversion=2'
		);

		assert.deepEqual(
			( uriProcessor.getUpdatedUri( makeUri( { foo: 'bar' } ) ) ).query,
			{ urlversion: '2', foo: 'bar' },
			'Empty model state with unrecognized params retains unrecognized params'
		);

		// Update the model
		filtersModel.toggleFiltersSelected( {
			group1__filter1: true, // Param: filter2: '1'
			group3__filter5: true // Param: group3: 'filter5'
		} );

		assert.deepEqual(
			( uriProcessor.getUpdatedUri( makeUri( {} ) ) ).query,
			{ urlversion: '2', filter2: '1', group3: 'filter5' },
			'Model state is reflected in the updated URI'
		);

		assert.deepEqual(
			( uriProcessor.getUpdatedUri( makeUri( { foo: 'bar' } ) ) ).query,
			{ urlversion: '2', filter2: '1', group3: 'filter5', foo: 'bar' },
			'Model state is reflected in the updated URI with existing uri params'
		);
	} );

	QUnit.test( 'updateModelBasedOnQuery', function ( assert ) {
		var uriProcessor,
			filtersModel = new mw.rcfilters.dm.FiltersViewModel();

		filtersModel.initializeFilters( mockFilterStructure );
		uriProcessor = new mw.rcfilters.UriProcessor( filtersModel );

		uriProcessor.updateModelBasedOnQuery( {} );
		assert.deepEqual(
			filtersModel.getCurrentParameterState(),
			minimalDefaultParams,
			'Version 1: Empty url query sets model to defaults'
		);

		uriProcessor.updateModelBasedOnQuery( { urlversion: '2' } );
		assert.deepEqual(
			filtersModel.getCurrentParameterState(),
			{},
			'Version 2: Empty url query sets model to all-false'
		);

		uriProcessor.updateModelBasedOnQuery( { filter1: '1', urlversion: '2' } );
		assert.deepEqual(
			filtersModel.getCurrentParameterState(),
			$.extend( true, {}, { filter1: '1' } ),
			'Parameters in Uri query set parameter value in the model'
		);
	} );

	QUnit.test( 'isNewState', function ( assert ) {
		var uriProcessor,
			filtersModel = new mw.rcfilters.dm.FiltersViewModel(),
			cases = [
				{
					states: {
						curr: {},
						new: {}
					},
					result: false,
					message: 'Empty objects are not new state.'
				},
				{
					states: {
						curr: { filter1: '1' },
						new: { filter1: '0' }
					},
					result: true,
					message: 'Nulified parameter is a new state'
				},
				{
					states: {
						curr: { filter1: '1' },
						new: { filter1: '1', filter2: '1' }
					},
					result: true,
					message: 'Added parameters are a new state'
				},
				{
					states: {
						curr: { filter1: '1' },
						new: { filter1: '1', filter2: '0' }
					},
					result: false,
					message: 'Added null parameters are not a new state (normalizing equals old state)'
				},
				{
					states: {
						curr: { filter1: '1' },
						new: { filter1: '1', foo: 'bar' }
					},
					result: true,
					message: 'Added unrecognized parameters are a new state'
				},
				{
					states: {
						curr: { filter1: '1', foo: 'bar' },
						new: { filter1: '1', foo: 'baz' }
					},
					result: true,
					message: 'Changed unrecognized parameters are a new state'
				}
			];

		filtersModel.initializeFilters( mockFilterStructure );
		uriProcessor = new mw.rcfilters.UriProcessor( filtersModel );

		cases.forEach( function ( testCase ) {
			assert.equal(
				uriProcessor.isNewState( testCase.states.curr, testCase.states.new ),
				testCase.result,
				testCase.message
			);
		} );
	} );

	QUnit.test( 'doesQueryContainRecognizedParams', function ( assert ) {
		var uriProcessor,
			filtersModel = new mw.rcfilters.dm.FiltersViewModel(),
			cases = [
				{
					query: {},
					result: false,
					message: 'Empty query is not valid for load.'
				},
				{
					query: { highlight: '1' },
					result: false,
					message: 'Highlight state alone is not valid for load'
				},
				{
					query: { urlversion: '2' },
					result: true,
					message: 'urlversion=2 state alone is valid for load as an empty state'
				},
				{
					query: { filter1: '1', foo: 'bar' },
					result: true,
					message: 'Existence of recognized parameters makes the query valid for load'
				},
				{
					query: { foo: 'bar', debug: true },
					result: false,
					message: 'Only unrecognized parameters makes the query invalid for load'
				}
			];

		filtersModel.initializeFilters( mockFilterStructure );
		uriProcessor = new mw.rcfilters.UriProcessor( filtersModel );

		cases.forEach( function ( testCase ) {
			assert.equal(
				uriProcessor.doesQueryContainRecognizedParams( testCase.query ),
				testCase.result,
				testCase.message
			);
		} );
	} );

	QUnit.test( '_getNormalizedQueryParams', function ( assert ) {
		var uriProcessor,
			filtersModel = new mw.rcfilters.dm.FiltersViewModel(),
			cases = [
				{
					query: {},
					result: $.extend( true, { urlversion: '2' }, minimalDefaultParams ),
					message: 'Empty query returns defaults (urlversion 1).'
				},
				{
					query: { urlversion: '2' },
					result: { urlversion: '2' },
					message: 'Empty query returns empty (urlversion 2)'
				},
				{
					query: { filter1: '0' },
					result: { urlversion: '2', filter4: '1' },
					message: 'urlversion 1 returns query that overrides defaults'
				},
				{
					query: { filter3: '1' },
					result: { urlversion: '2', filter1: '1', filter4: '1', filter3: '1' },
					message: 'urlversion 1 with an extra param value returns query that is joined with defaults'
				}
			];

		filtersModel.initializeFilters( mockFilterStructure );
		uriProcessor = new mw.rcfilters.UriProcessor( filtersModel );

		cases.forEach( function ( testCase ) {
			assert.deepEqual(
				uriProcessor._getNormalizedQueryParams( testCase.query ),
				testCase.result,
				testCase.message
			);
		} );
	} );

	QUnit.test( '_normalizeTargetInUri', function ( assert ) {
		var cases = [
			{
				input: 'http://host/wiki/Special:RecentChangesLinked/Moai',
				output: 'http://host/wiki/Special:RecentChangesLinked?target=Moai',
				message: 'Target as subpage in path'
			},
			{
				input: 'http://host/wiki/Special:RecentChangesLinked/Château',
				output: 'http://host/wiki/Special:RecentChangesLinked?target=Château',
				message: 'Target as subpage in path with special characters'
			},
			{
				input: 'http://host/wiki/Special:RecentChangesLinked/Moai/Sub1',
				output: 'http://host/wiki/Special:RecentChangesLinked?target=Moai/Sub1',
				message: 'Target as subpage also has a subpage'
			},
			{
				input: 'http://host/wiki/Special:RecentChangesLinked/Category:Foo',
				output: 'http://host/wiki/Special:RecentChangesLinked?target=Category:Foo',
				message: 'Target as subpage in path (with namespace)'
			},
			{
				input: 'http://host/wiki/Special:RecentChangesLinked/Category:Foo/Bar',
				output: 'http://host/wiki/Special:RecentChangesLinked?target=Category:Foo/Bar',
				message: 'Target as subpage in path also has a subpage (with namespace)'
			},
			{
				input: 'http://host/w/index.php?title=Special:RecentChangesLinked/Moai',
				output: 'http://host/w/index.php?title=Special:RecentChangesLinked&target=Moai',
				message: 'Target as subpage in title param'
			},
			{
				input: 'http://host/w/index.php?title=Special:RecentChangesLinked/Moai/Sub1',
				output: 'http://host/w/index.php?title=Special:RecentChangesLinked&target=Moai/Sub1',
				message: 'Target as subpage in title param also has a subpage'
			},
			{
				input: 'http://host/w/index.php?title=Special:RecentChangesLinked/Category:Foo/Bar',
				output: 'http://host/w/index.php?title=Special:RecentChangesLinked&target=Category:Foo/Bar',
				message: 'Target as subpage in title param also has a subpage (with namespace)'
			},
			{
				input: 'http://host/wiki/Special:Watchlist',
				output: 'http://host/wiki/Special:Watchlist',
				message: 'No target specified'
			},
			{
				normalizeTarget: false,
				input: 'http://host/wiki/Special:RecentChanges/Foo',
				output: 'http://host/wiki/Special:RecentChanges/Foo',
				message: 'Do not normalize if "normalizeTarget" is false.'
			}
		];

		cases.forEach( function ( testCase ) {
			var uriProcessor = new mw.rcfilters.UriProcessor(
				null,
				{
					normalizeTarget: testCase.normalizeTarget === undefined ?
						true : testCase.normalizeTarget
				}
			);

			assert.equal(
				uriProcessor._normalizeTargetInUri(
					new mw.Uri( testCase.input )
				).toString(),
				new mw.Uri( testCase.output ).toString(),
				testCase.message
			);
		} );
	} );

}( mediaWiki, jQuery ) );