Use dedicated hooks for account/channel videos

This commit is contained in:
Chocobozzz 2020-12-08 10:30:33 +01:00 committed by Chocobozzz
parent 1bfc07e4cc
commit 38267c0c8a
5 changed files with 74 additions and 8 deletions

View File

@ -176,12 +176,12 @@ async function listAccountVideos (req: express.Request, res: express.Response) {
accountId: account.id, accountId: account.id,
user: res.locals.oauth ? res.locals.oauth.token.User : undefined, user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
countVideos countVideos
}, 'filter:api.videos.list.params') }, 'filter:api.accounts.videos.list.params')
const resultList = await Hooks.wrapPromiseFun( const resultList = await Hooks.wrapPromiseFun(
VideoModel.listForApi, VideoModel.listForApi,
apiOptions, apiOptions,
'filter:api.videos.list.result' 'filter:api.accounts.videos.list.result'
) )
return res.json(getFormattedObjects(resultList.data, resultList.total)) return res.json(getFormattedObjects(resultList.data, resultList.total))

View File

@ -1,4 +1,5 @@
import * as express from 'express' import * as express from 'express'
import { Hooks } from '@server/lib/plugins/hooks'
import { getServerActor } from '@server/models/application/application' import { getServerActor } from '@server/models/application/application'
import { MChannelAccountDefault } from '@server/types/models' import { MChannelAccountDefault } from '@server/types/models'
import { VideoChannelCreate, VideoChannelUpdate } from '../../../shared' import { VideoChannelCreate, VideoChannelUpdate } from '../../../shared'
@ -266,7 +267,7 @@ async function listVideoChannelVideos (req: express.Request, res: express.Respon
const followerActorId = isUserAbleToSearchRemoteURI(res) ? null : undefined const followerActorId = isUserAbleToSearchRemoteURI(res) ? null : undefined
const countVideos = getCountVideos(req) const countVideos = getCountVideos(req)
const resultList = await VideoModel.listForApi({ const apiOptions = await Hooks.wrapObject({
followerActorId, followerActorId,
start: req.query.start, start: req.query.start,
count: req.query.count, count: req.query.count,
@ -283,7 +284,13 @@ async function listVideoChannelVideos (req: express.Request, res: express.Respon
videoChannelId: videoChannelInstance.id, videoChannelId: videoChannelInstance.id,
user: res.locals.oauth ? res.locals.oauth.token.User : undefined, user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
countVideos countVideos
}) }, 'filter:api.video-channels.videos.list.params')
const resultList = await Hooks.wrapPromiseFun(
VideoModel.listForApi,
apiOptions,
'filter:api.video-channels.videos.list.result'
)
return res.json(getFormattedObjects(resultList.data, resultList.total)) return res.json(getFormattedObjects(resultList.data, resultList.total))
} }

View File

@ -39,6 +39,26 @@ async function register ({ registerHook, registerSetting, settingsManager, stora
handler: obj => addToTotal(obj) handler: obj => addToTotal(obj)
}) })
registerHook({
target: 'filter:api.accounts.videos.list.params',
handler: obj => addToCount(obj)
})
registerHook({
target: 'filter:api.accounts.videos.list.result',
handler: obj => addToTotal(obj, 2)
})
registerHook({
target: 'filter:api.video-channels.videos.list.params',
handler: obj => addToCount(obj, 3)
})
registerHook({
target: 'filter:api.video-channels.videos.list.result',
handler: obj => addToTotal(obj, 3)
})
registerHook({ registerHook({
target: 'filter:api.video.get.result', target: 'filter:api.video.get.result',
handler: video => { handler: video => {
@ -167,14 +187,14 @@ module.exports = {
// ############################################################################ // ############################################################################
function addToCount (obj) { function addToCount (obj, amount = 1) {
return Object.assign({}, obj, { count: obj.count + 1 }) return Object.assign({}, obj, { count: obj.count + amount })
} }
function addToTotal (result) { function addToTotal (result, amount = 1) {
return { return {
data: result.data, data: result.data,
total: result.total + 1 total: result.total + amount
} }
} }

View File

@ -8,9 +8,11 @@ import {
addVideoCommentThread, addVideoCommentThread,
createLive, createLive,
doubleFollow, doubleFollow,
getAccountVideos,
getConfig, getConfig,
getPluginTestPath, getPluginTestPath,
getVideo, getVideo,
getVideoChannelVideos,
getVideoCommentThreads, getVideoCommentThreads,
getVideosList, getVideosList,
getVideosListPagination, getVideosListPagination,
@ -90,6 +92,34 @@ describe('Test plugin filter hooks', function () {
expect(res.body.total).to.equal(11) expect(res.body.total).to.equal(11)
}) })
it('Should run filter:api.accounts.videos.list.params', async function () {
const res = await getAccountVideos(servers[0].url, servers[0].accessToken, 'root', 0, 2)
// 1 plugin do +1 to the count parameter
expect(res.body.data).to.have.lengthOf(3)
})
it('Should run filter:api.accounts.videos.list.result', async function () {
const res = await getAccountVideos(servers[0].url, servers[0].accessToken, 'root', 0, 2)
// Plugin do +2 to the total result
expect(res.body.total).to.equal(12)
})
it('Should run filter:api.video-channels.videos.list.params', async function () {
const res = await getVideoChannelVideos(servers[0].url, servers[0].accessToken, 'root_channel', 0, 2)
// 1 plugin do +3 to the count parameter
expect(res.body.data).to.have.lengthOf(5)
})
it('Should run filter:api.video-channels.videos.list.result', async function () {
const res = await getAccountVideos(servers[0].url, servers[0].accessToken, 'root_channel', 0, 2)
// Plugin do +3 to the total result
expect(res.body.total).to.equal(13)
})
it('Should run filter:api.video.get.result', async function () { it('Should run filter:api.video.get.result', async function () {
const res = await getVideo(servers[0].url, videoUUID) const res = await getVideo(servers[0].url, videoUUID)

View File

@ -5,6 +5,15 @@ export const serverFilterHookObject = {
// (used by the trending page, recently-added page, local page etc) // (used by the trending page, recently-added page, local page etc)
'filter:api.videos.list.params': true, 'filter:api.videos.list.params': true,
'filter:api.videos.list.result': true, 'filter:api.videos.list.result': true,
// Filter params/result used to list account videos for the REST API
'filter:api.accounts.videos.list.params': true,
'filter:api.accounts.videos.list.result': true,
// Filter params/result used to list account videos for the REST API
'filter:api.video-channels.videos.list.params': true,
'filter:api.video-channels.videos.list.result': true,
// Filter the result of the get function // Filter the result of the get function
// Used to get detailed video information (video watch page for example) // Used to get detailed video information (video watch page for example)
'filter:api.video.get.result': true, 'filter:api.video.get.result': true,