Page MenuHomeWickedGov Phorge
Files F1426816

Search.js
No OneTemporary
Actions

Size
10 KB
Referenced Files
None
Subscribers
None

Search.js
View Options

'use strict';
const { action, assert, REST, utils, wiki } = require( 'api-testing' );
const superagent = require( 'superagent' );
const xml2js = require( 'xml2js' );
describe( 'Search', () => {
const client = new REST( 'rest.php/v1' );
const sharedTitleTerm = 'X' + utils.uniq(); // NOTE: must start with upper-case letter
const pageWithBothTerms = utils.title( `${ sharedTitleTerm }XXX` );
const pageWithOneTerm = utils.title( `${ sharedTitleTerm }YYY` );
const pageWithOwnTitle = utils.title( 'ZZZ' );
const searchTerm = utils.uniq();
const searchTerm2 = utils.uniq();
let alice;
let mindy;
before( async () => {
alice = await action.alice();
mindy = await action.mindy();
await alice.edit( pageWithBothTerms, { text: `${ searchTerm } ${ searchTerm2 }` } );
await alice.edit( pageWithOneTerm, { text: searchTerm2 } );
await alice.edit( pageWithOwnTitle, { text: pageWithOwnTitle } );
await wiki.runAllJobs();
} );
describe( 'GET /search/page?q={term}', () => {
it( 'should return empty array when search term has no title or text matches', async () => {
const nonExistentTerm = utils.uniq();
const { body, headers } = await client.get( `/search/page?q=${ nonExistentTerm }` );
const noResultsResponse = { pages: [] };
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.deepEqual( noResultsResponse, body );
} );
it( 'should return array of pages when there is only a text match', async () => {
const { body, headers } = await client.get( `/search/page?q=${ searchTerm }` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 1 );
const returnPage = body.pages[ 0 ];
assert.nestedProperty( returnPage, 'title' );
assert.nestedProperty( returnPage, 'id' );
assert.nestedProperty( returnPage, 'key' );
assert.nestedProperty( returnPage, 'excerpt' );
assert.nestedPropertyVal( returnPage, 'thumbnail', null );
assert.nestedPropertyVal( returnPage, 'description', null );
assert.nestedPropertyVal( returnPage, 'matched_title', null );
assert.include( returnPage.excerpt, `<span class="searchmatch">${ searchTerm }</span>` );
// full-text search should not have cache-control
if ( headers[ 'cache-control' ] ) {
assert.notMatch( headers[ 'cache-control' ], /\bpublic\b/ );
assert.notMatch( headers[ 'cache-control' ], /\bmax-age=0*[1-9]\b/ );
assert.notMatch( headers[ 'cache-control' ], /\bs-maxage=0*[1-9]\b/ );
}
} );
it( 'should return array of pages when there is only title match', async () => {
const { body, headers } = await client.get( `/search/page?q=${ pageWithBothTerms }` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 1 );
const returnPage = body.pages[ 0 ];
assert.nestedProperty( returnPage, 'title' );
assert.nestedProperty( returnPage, 'id' );
assert.nestedProperty( returnPage, 'key' );
assert.nestedPropertyVal( returnPage, 'excerpt', null );
assert.nestedPropertyVal( returnPage, 'thumbnail', null );
assert.nestedPropertyVal( returnPage, 'description', null );
assert.nestedPropertyVal( returnPage, 'matched_title', null );
} );
it( 'should return a single page when there is a title and text match on the same page', async () => {
const { body, headers } = await client.get( `/search/page?q=${ pageWithOwnTitle }` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 1 );
const returnPage = body.pages[ 0 ];
assert.nestedProperty( returnPage, 'title' );
assert.nestedProperty( returnPage, 'id' );
assert.nestedProperty( returnPage, 'key' );
assert.nestedPropertyVal( returnPage, 'title', pageWithOwnTitle );
assert.nestedPropertyVal( returnPage, 'thumbnail', null );
assert.nestedPropertyVal( returnPage, 'description', null );
assert.nestedPropertyVal( returnPage, 'matched_title', null );
} );
it( 'should return two pages when both pages match', async () => {
const { body, headers } = await client.get( `/search/page?q=${ searchTerm2 }` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 2 );
const returnedPages = [ body.pages[ 0 ].title, body.pages[ 1 ].title ];
const expectedPages = [ pageWithBothTerms, pageWithOneTerm ];
assert.equal( expectedPages.sort().join( '|' ), returnedPages.sort().join( '|' ) );
} );
it( 'should return only one page when two pages match but limit is 1', async () => {
const { body, headers } = await client.get( `/search/page?q=${ searchTerm2 }&limit=1` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 1 );
} );
it( 'should not return results when page with term has been deleted', async () => {
const pageToDelete = 'Delete Page';
const deleteTerm = `Delete_${ utils.uniq() }`;
const { title } = await alice.edit( pageToDelete, { text: deleteTerm } );
await mindy.action( 'delete', {
title,
summary: 'testing',
token: await mindy.token( 'csrf' )
}, 'POST' );
await wiki.runAllJobs();
const { body, headers } = await client.get( `/search/page?q=${ deleteTerm }` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 0 );
} );
it( 'should ignore duplicate redirect source and target if both pages are a match', async () => {
const redirectSource = utils.title( 'redirect_source_' );
const redirectTarget = utils.title( 'redirect_target_' );
const uniquePageText = utils.uniq();
await alice.edit( redirectSource,
{ text: `#REDIRECT [[ ${ redirectTarget } ]]. ${ uniquePageText }.` }
);
const { title: redirectTargetTitle } = await alice.edit( redirectTarget, { text: `${ uniquePageText }` } );
await wiki.runAllJobs();
const { body, headers } = await client.get( `/search/page?q=${ uniquePageText }` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 1 );
assert.nestedPropertyVal( body.pages[ 0 ], 'title', redirectTargetTitle );
} );
} );
describe( 'GET /search/title?q={term}', () => {
it( 'should return empty array when search term has no title matches', async () => {
const nonExistentTerm = utils.uniq();
const { body, headers } = await client.get( `/search/title?q=${ nonExistentTerm }` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 0 );
} );
it( 'should not return pages when there is only a text match', async () => {
const { body, headers } = await client.get( `/search/title?q=${ searchTerm }` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 0 );
} );
it( 'should return array of pages when there is a title match', async () => {
const { body, headers } = await client.get( `/search/title?q=${ pageWithBothTerms }` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 1 );
const returnPage = body.pages[ 0 ];
assert.nestedProperty( returnPage, 'title' );
assert.nestedProperty( returnPage, 'id' );
assert.nestedProperty( returnPage, 'key' );
assert.nestedProperty( returnPage, 'excerpt' );
assert.nestedPropertyVal( returnPage, 'thumbnail', null );
assert.nestedPropertyVal( returnPage, 'description', null );
assert.nestedPropertyVal( returnPage, 'matched_title', null );
// completion search should encourage caching
assert.nestedProperty( headers, 'cache-control' );
assert.match( headers[ 'cache-control' ], /\bpublic\b/ );
assert.match( headers[ 'cache-control' ], /\bmax-age=[1-9]\d*/ );
} );
it( 'should return two pages when both pages match', async () => {
const { body, headers } = await client.get( `/search/title?q=${ sharedTitleTerm }` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 2 );
const returnedPages = [ body.pages[ 0 ].title, body.pages[ 1 ].title ];
const expectedPages = [ pageWithBothTerms, pageWithOneTerm ];
assert.equal( expectedPages.sort().join( '|' ), returnedPages.sort().join( '|' ) );
} );
it( 'should return only one page when two pages match but limit is 1', async () => {
const { body, headers } = await client.get( `/search/title?q=${ sharedTitleTerm }&limit=1` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 1 );
} );
it( 'should not return deleted page', async () => {
const deleteTerm = utils.uniq();
const pageToDelete = utils.title( `${ deleteTerm }_test_` );
const { title } = await alice.edit( pageToDelete, { text: deleteTerm } );
await mindy.action( 'delete', {
title,
summary: 'testing',
token: await mindy.token( 'csrf' )
}, 'POST' );
await wiki.runAllJobs();
const { body, headers } = await client.get( `/search/title?q=${ deleteTerm }` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 0 );
} );
it( 'should include redirect for page if one exists', async () => {
const redirectSource = utils.title( 'redirect_source_' );
const redirectTarget = utils.title( 'redirect_target_' );
const { title: redirectSourceTitle } = await alice.edit( redirectSource,
{ text: `#REDIRECT [[ ${ redirectTarget } ]]` }
);
const { title: redirectTargetTitle } = await alice.edit( redirectTarget, { text: 'foo' } );
await wiki.runAllJobs();
const { body, headers } = await client.get( `/search/title?q=${ redirectSourceTitle }` );
assert.match( headers[ 'content-type' ], /^application\/json/ );
assert.lengthOf( body.pages, 1 );
assert.nestedPropertyVal( body.pages[ 0 ], 'title', redirectTargetTitle );
assert.nestedPropertyVal( body.pages[ 0 ], 'matched_title', redirectSourceTitle );
} );
} );
describe( 'GET /search', () => {
// enable XML parsing
function parseXML( res, cb ) {
res.text = '';
res.on( 'data', ( chunk ) => {
res.text += chunk;
} );
res.on( 'end', () => xml2js.parseString( res.text, cb ) );
}
superagent.parse[ 'application/xml' ] = parseXML;
superagent.parse[ 'application/opensearchdescription+xml' ] = parseXML;
it( 'should return an OpenSearch Description document', async () => {
const { body, headers } = await client.get( '/search' );
assert.match( headers[ 'content-type' ], /^application\/opensearchdescription\+xml/ );
assert.nestedProperty( body, 'OpenSearchDescription' );
// TODO: assert more about the structure
} );
it( 'should support plain XML output', async () => {
const { body, headers } = await client.get( '/search' )
.query( { ctype: 'application/xml' } );
assert.match( headers[ 'content-type' ], /^application\/xml/ );
assert.nestedProperty( body, 'OpenSearchDescription' );
} );
} );
} );

File Metadata

Mime Type
text/plain
Expires
Sat, May 16, 13:44 (1 d, 20 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
07/76/e71396db736e2e3ee89fc4fca557
Default Alt Text
Search.js (10 KB)

Event Timeline