From 3b0bd70aa05ab82fa30fe67ed4899d44652c703a Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Tue, 9 Jun 2020 16:39:45 +0200 Subject: Add search target check params --- server/helpers/custom-validators/search.ts | 19 ++++++- server/middlewares/validators/search.ts | 4 ++ server/tests/api/check-params/search.ts | 79 +++++++++++++++++++++++++++++- 3 files changed, 98 insertions(+), 4 deletions(-) (limited to 'server') diff --git a/server/helpers/custom-validators/search.ts b/server/helpers/custom-validators/search.ts index bb17134c3..429fcafcf 100644 --- a/server/helpers/custom-validators/search.ts +++ b/server/helpers/custom-validators/search.ts @@ -1,5 +1,7 @@ import validator from 'validator' -import { isArray } from './misc' +import { SearchTargetType } from '@shared/models/search/search-target-query.model' +import { isArray, exists } from './misc' +import { CONFIG } from '@server/initializers/config' function isNumberArray (value: any) { return isArray(value) && value.every(v => validator.isInt('' + v)) @@ -13,10 +15,23 @@ function isNSFWQueryValid (value: any) { return value === 'true' || value === 'false' || value === 'both' } +function isSearchTargetValid (value: SearchTargetType) { + if (!exists(value)) return true + + const searchIndexConfig = CONFIG.SEARCH.SEARCH_INDEX + + if (value === 'local' && (!searchIndexConfig.ENABLED || !searchIndexConfig.DISABLE_LOCAL_SEARCH)) return true + + if (value === 'search-index' && searchIndexConfig.ENABLED) return true + + return false +} + // --------------------------------------------------------------------------- export { isNumberArray, isStringArray, - isNSFWQueryValid + isNSFWQueryValid, + isSearchTargetValid } diff --git a/server/middlewares/validators/search.ts b/server/middlewares/validators/search.ts index 5a3c83f2c..b4faa8894 100644 --- a/server/middlewares/validators/search.ts +++ b/server/middlewares/validators/search.ts @@ -3,6 +3,7 @@ import { areValidationErrors } from './utils' import { logger } from '../../helpers/logger' import { query } from 'express-validator' import { isDateValid } from '../../helpers/custom-validators/misc' +import { isSearchTargetValid } from '@server/helpers/custom-validators/search' const videosSearchValidator = [ query('search').optional().not().isEmpty().withMessage('Should have a valid search'), @@ -16,6 +17,8 @@ const videosSearchValidator = [ query('durationMin').optional().isInt().withMessage('Should have a valid min duration'), query('durationMax').optional().isInt().withMessage('Should have a valid max duration'), + query('searchTarget').optional().custom(isSearchTargetValid).withMessage('Should have a valid search target'), + (req: express.Request, res: express.Response, next: express.NextFunction) => { logger.debug('Checking videos search query', { parameters: req.query }) @@ -27,6 +30,7 @@ const videosSearchValidator = [ const videoChannelsSearchValidator = [ query('search').not().isEmpty().withMessage('Should have a valid search'), + query('searchTarget').optional().custom(isSearchTargetValid).withMessage('Should have a valid search target'), (req: express.Request, res: express.Response, next: express.NextFunction) => { logger.debug('Checking video channels search query', { parameters: req.query }) diff --git a/server/tests/api/check-params/search.ts b/server/tests/api/check-params/search.ts index f8d0cd4ec..1a8a7235e 100644 --- a/server/tests/api/check-params/search.ts +++ b/server/tests/api/check-params/search.ts @@ -1,14 +1,32 @@ /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */ import 'mocha' - -import { cleanupTests, flushAndRunServer, immutableAssign, makeGetRequest, ServerInfo } from '../../../../shared/extra-utils' +import { + cleanupTests, + flushAndRunServer, + immutableAssign, + makeGetRequest, + ServerInfo, + updateCustomSubConfig, + setAccessTokensToServers +} from '../../../../shared/extra-utils' import { checkBadCountPagination, checkBadSortPagination, checkBadStartPagination } from '../../../../shared/extra-utils/requests/check-api-params' +function updateSearchIndex (server: ServerInfo, enabled: boolean, disableLocalSearch = false) { + return updateCustomSubConfig(server.url, server.accessToken, { + search: { + searchIndex: { + enabled, + disableLocalSearch + } + } + }) +} + describe('Test videos API validator', function () { let server: ServerInfo @@ -18,6 +36,7 @@ describe('Test videos API validator', function () { this.timeout(30000) server = await flushAndRunServer(1) + await setAccessTokensToServers([ server ]) }) describe('When searching videos', function () { @@ -144,6 +163,62 @@ describe('Test videos API validator', function () { }) }) + describe('Search target', function () { + + it('Should fail/succeed depending on the search target', async function () { + this.timeout(10000) + + const query = { search: 'coucou' } + const paths = [ + '/api/v1/search/video-channels/', + '/api/v1/search/videos/' + ] + + for (const path of paths) { + { + const customQuery = immutableAssign(query, { searchTarget: 'hello' }) + await makeGetRequest({ url: server.url, path, query: customQuery, statusCodeExpected: 400 }) + } + + { + const customQuery = immutableAssign(query, { searchTarget: undefined }) + await makeGetRequest({ url: server.url, path, query: customQuery, statusCodeExpected: 200 }) + } + + { + const customQuery = immutableAssign(query, { searchTarget: 'local' }) + await makeGetRequest({ url: server.url, path, query: customQuery, statusCodeExpected: 200 }) + } + + { + const customQuery = immutableAssign(query, { searchTarget: 'search-index' }) + await makeGetRequest({ url: server.url, path, query: customQuery, statusCodeExpected: 400 }) + } + + await updateSearchIndex(server, true, true) + + { + const customQuery = immutableAssign(query, { searchTarget: 'local' }) + await makeGetRequest({ url: server.url, path, query: customQuery, statusCodeExpected: 400 }) + } + + { + const customQuery = immutableAssign(query, { searchTarget: 'search-index' }) + await makeGetRequest({ url: server.url, path, query: customQuery, statusCodeExpected: 200 }) + } + + await updateSearchIndex(server, true, false) + + { + const customQuery = immutableAssign(query, { searchTarget: 'local' }) + await makeGetRequest({ url: server.url, path, query: customQuery, statusCodeExpected: 200 }) + } + + await updateSearchIndex(server, false, false) + } + }) + }) + after(async function () { await cleanupTests([ server ]) }) -- cgit v1.2.3