From 46246b5f194caafba4e3a72e9365acd8b35785de Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Sun, 22 May 2016 09:15:00 +0200 Subject: [PATCH] Extends the search feature by customizing the search field (name, podUrl...) --- server/controllers/api/v1/videos.js | 7 +- server/initializers/constants.js | 6 ++ server/middlewares/index.js | 2 + server/middlewares/reqValidators/videos.js | 4 +- server/middlewares/search.js | 15 ++++ server/models/videos.js | 11 ++- server/tests/api/singlePod.js | 99 ++++++++++++++++++++-- server/tests/api/utils.js | 25 ++++-- 8 files changed, 149 insertions(+), 20 deletions(-) create mode 100644 server/middlewares/search.js diff --git a/server/controllers/api/v1/videos.js b/server/controllers/api/v1/videos.js index f7aeea453..7f59dd232 100644 --- a/server/controllers/api/v1/videos.js +++ b/server/controllers/api/v1/videos.js @@ -17,6 +17,7 @@ const reqValidator = middlewares.reqValidators const reqValidatorPagination = reqValidator.pagination const reqValidatorSort = reqValidator.sort const reqValidatorVideos = reqValidator.videos +const search = middlewares.search const sort = middlewares.sort const utils = require('../../../helpers/utils') const Videos = require('../../../models/videos') // model @@ -69,12 +70,13 @@ router.delete('/:id', reqValidatorVideos.videosRemove, removeVideo ) -router.get('/search/:name', +router.get('/search/:value', reqValidatorVideos.videosSearch, reqValidatorPagination.pagination, reqValidatorSort.videosSort, sort.setVideosSort, pagination.setPagination, + search.setVideosSearch, searchVideos ) @@ -237,7 +239,8 @@ function removeVideo (req, res, next) { } function searchVideos (req, res, next) { - Videos.search(req.params.name, req.query.start, req.query.count, req.query.sort, function (err, videosList, totalVideos) { + Videos.search(req.params.value, req.query.field, req.query.start, req.query.count, req.query.sort, + function (err, videosList, totalVideos) { if (err) return next(err) res.json(getFormatedVideos(videosList, totalVideos)) diff --git a/server/initializers/constants.js b/server/initializers/constants.js index 4350bb892..c190ab506 100644 --- a/server/initializers/constants.js +++ b/server/initializers/constants.js @@ -26,6 +26,11 @@ const PODS_SCORE = { // Number of retries we make for the make retry requests (to friends...) let REQUEST_RETRIES = 10 +// Sortable columns per schema +const SEARCHABLE_COLUMNS = { + VIDEOS: [ 'name', 'magnetUri', 'podUrl', 'author' ] +} + // Sortable columns per schema const SORTABLE_COLUMNS = { VIDEOS: [ 'name', '-name', 'duration', '-duration', 'createdDate', '-createdDate' ] @@ -56,6 +61,7 @@ module.exports = { PAGINATION_COUNT_DEFAULT: PAGINATION_COUNT_DEFAULT, PODS_SCORE: PODS_SCORE, REQUEST_RETRIES: REQUEST_RETRIES, + SEARCHABLE_COLUMNS: SEARCHABLE_COLUMNS, SORTABLE_COLUMNS: SORTABLE_COLUMNS, THUMBNAILS_SIZE: THUMBNAILS_SIZE, THUMBNAILS_STATIC_PATH: THUMBNAILS_STATIC_PATH diff --git a/server/middlewares/index.js b/server/middlewares/index.js index 35858da2c..b30a7be56 100644 --- a/server/middlewares/index.js +++ b/server/middlewares/index.js @@ -3,6 +3,7 @@ const oauth2 = require('./oauth2') const pagination = require('./pagination') const reqValidatorsMiddleware = require('./reqValidators') +const search = require('./search') const sort = require('./sort') const secureMiddleware = require('./secure') @@ -10,6 +11,7 @@ const middlewares = { oauth2: oauth2, pagination: pagination, reqValidators: reqValidatorsMiddleware, + search: search, sort: sort, secure: secureMiddleware } diff --git a/server/middlewares/reqValidators/videos.js b/server/middlewares/reqValidators/videos.js index d4dec1a59..d444c9f0a 100644 --- a/server/middlewares/reqValidators/videos.js +++ b/server/middlewares/reqValidators/videos.js @@ -81,7 +81,9 @@ function videosRemove (req, res, next) { } function videosSearch (req, res, next) { - req.checkParams('name', 'Should have a name').notEmpty() + const searchableColumns = constants.SEARCHABLE_COLUMNS.VIDEOS + req.checkParams('value', 'Should have a name').notEmpty() + req.checkQuery('field', 'Should have correct searchable column').optional().isIn(searchableColumns) logger.debug('Checking videosSearch parameters', { parameters: req.params }) diff --git a/server/middlewares/search.js b/server/middlewares/search.js new file mode 100644 index 000000000..89302a564 --- /dev/null +++ b/server/middlewares/search.js @@ -0,0 +1,15 @@ +'use strict' + +const searchMiddleware = { + setVideosSearch: setVideosSearch +} + +function setVideosSearch (req, res, next) { + if (!req.query.field) req.query.field = 'name' + + return next() +} + +// --------------------------------------------------------------------------- + +module.exports = searchMiddleware diff --git a/server/models/videos.js b/server/models/videos.js index 9521e63e3..7bd41f7ee 100644 --- a/server/models/videos.js +++ b/server/models/videos.js @@ -124,8 +124,15 @@ function removeByIds (ids, callback) { VideosDB.remove({ _id: { $in: ids } }, callback) } -function search (name, start, count, sort, callback) { - const query = { name: new RegExp(name) } +function search (value, field, start, count, sort, callback) { + const query = {} + // Make an exact search with the magnet + if (field === 'magnetUri') { + query[field] = value + } else { + query[field] = new RegExp(value) + } + findWithCount(query, start, count, sort, callback) } diff --git a/server/tests/api/singlePod.js b/server/tests/api/singlePod.js index 884a83032..296dd0aa4 100644 --- a/server/tests/api/singlePod.js +++ b/server/tests/api/singlePod.js @@ -129,7 +129,7 @@ describe('Test a single pod', function () { }) }) - it('Should search the video', function (done) { + it('Should search the video by name by default', function (done) { utils.searchVideo(server.url, 'my', function (err, res) { if (err) throw err @@ -154,7 +154,32 @@ describe('Test a single pod', function () { }) }) - it('Should not find a search', function (done) { + it('Should search the video by podUrl', function (done) { + utils.searchVideo(server.url, '9001', 'podUrl', function (err, res) { + if (err) throw err + + expect(res.body.total).to.equal(1) + expect(res.body.data).to.be.an('array') + expect(res.body.data.length).to.equal(1) + + const video = res.body.data[0] + expect(video.name).to.equal('my super name') + expect(video.description).to.equal('my super description') + expect(video.podUrl).to.equal('localhost:9001') + expect(video.author).to.equal('root') + expect(video.isLocal).to.be.true + expect(utils.dateIsValid(video.createdDate)).to.be.true + + utils.testImage(server.url, 'video_short.webm', video.thumbnailPath, function (err, test) { + if (err) throw err + expect(test).to.equal(true) + + done() + }) + }) + }) + + it('Should not find a search by name by default', function (done) { utils.searchVideo(server.url, 'hello', function (err, res) { if (err) throw err @@ -166,6 +191,18 @@ describe('Test a single pod', function () { }) }) + it('Should not find a search by author', function (done) { + utils.searchVideo(server.url, 'hello', 'author', function (err, res) { + if (err) throw err + + expect(res.body.total).to.equal(0) + expect(res.body.data).to.be.an('array') + expect(res.body.data.length).to.equal(0) + + done() + }) + }) + it('Should remove the video', function (done) { utils.removeVideo(server.url, server.accessToken, videoId, function (err) { if (err) throw err @@ -288,7 +325,7 @@ describe('Test a single pod', function () { }) it('Should search the first video', function (done) { - utils.searchVideoWithPagination(server.url, 'webm', 0, 1, function (err, res) { + utils.searchVideoWithPagination(server.url, 'webm', 'name', 0, 1, function (err, res) { if (err) throw err const videos = res.body.data @@ -301,7 +338,7 @@ describe('Test a single pod', function () { }) it('Should search the last two videos', function (done) { - utils.searchVideoWithPagination(server.url, 'webm', 2, 2, function (err, res) { + utils.searchVideoWithPagination(server.url, 'webm', 'name', 2, 2, function (err, res) { if (err) throw err const videos = res.body.data @@ -314,8 +351,8 @@ describe('Test a single pod', function () { }) }) - it('Should search all the videos', function (done) { - utils.searchVideoWithPagination(server.url, 'webm', 0, 15, function (err, res) { + it('Should search all the webm videos', function (done) { + utils.searchVideoWithPagination(server.url, 'webm', 'name', 0, 15, function (err, res) { if (err) throw err const videos = res.body.data @@ -326,6 +363,56 @@ describe('Test a single pod', function () { }) }) + it('Should search all the root author videos', function (done) { + utils.searchVideoWithPagination(server.url, 'root', 'author', 0, 15, function (err, res) { + if (err) throw err + + const videos = res.body.data + expect(res.body.total).to.equal(6) + expect(videos.length).to.equal(6) + + done() + }) + }) + + it('Should search all the 9001 port videos', function (done) { + utils.searchVideoWithPagination(server.url, '9001', 'podUrl', 0, 15, function (err, res) { + if (err) throw err + + const videos = res.body.data + expect(res.body.total).to.equal(6) + expect(videos.length).to.equal(6) + + done() + }) + }) + + it('Should search all the localhost videos', function (done) { + utils.searchVideoWithPagination(server.url, 'localhost', 'podUrl', 0, 15, function (err, res) { + if (err) throw err + + const videos = res.body.data + expect(res.body.total).to.equal(6) + expect(videos.length).to.equal(6) + + done() + }) + }) + + it('Should search the good magnetUri video', function (done) { + const video = videosListBase[0] + utils.searchVideoWithPagination(server.url, encodeURIComponent(video.magnetUri), 'magnetUri', 0, 15, function (err, res) { + if (err) throw err + + const videos = res.body.data + expect(res.body.total).to.equal(1) + expect(videos.length).to.equal(1) + expect(videos[0].name).to.equal(video.name) + + done() + }) + }) + it('Should list and sort by name in descending order', function (done) { utils.getVideosListSort(server.url, '-name', function (err, res) { if (err) throw err diff --git a/server/tests/api/utils.js b/server/tests/api/utils.js index 218b46157..c6430c930 100644 --- a/server/tests/api/utils.js +++ b/server/tests/api/utils.js @@ -291,24 +291,31 @@ function runServer (number, callback) { }) } -function searchVideo (url, search, end) { - const path = '/api/v1/videos' +function searchVideo (url, search, field, end) { + if (!end) { + end = field + field = null + } - request(url) - .get(path + '/search/' + search) - .set('Accept', 'application/json') - .expect(200) - .expect('Content-Type', /json/) - .end(end) + const path = '/api/v1/videos' + const req = request(url) + .get(path + '/search/' + search) + .set('Accept', 'application/json') + + if (field) req.query({ field: field }) + req.expect(200) + .expect('Content-Type', /json/) + .end(end) } -function searchVideoWithPagination (url, search, start, count, end) { +function searchVideoWithPagination (url, search, field, start, count, end) { const path = '/api/v1/videos' request(url) .get(path + '/search/' + search) .query({ start: start }) .query({ count: count }) + .query({ field: field }) .set('Accept', 'application/json') .expect(200) .expect('Content-Type', /json/) -- 2.41.0