interesting
/
PeerTube
mirror of https://github.com/Chocobozzz/PeerTube.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add filter hooks tests

This commit is contained in:
Chocobozzz 2019-07-22 11:14:58 +02:00 committed by Chocobozzz
parent 89cd127560
commit 6691c52280
10 changed files with 260 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
server/controllers/api/videos/comment.ts
View File

@ -110,7 +110,7 @@ async function listVideoThreadComments (req: express.Request, res: express.Respo
const apiOptions = await Hooks.wrapObject({
videoId: video.id,
threadId: res.locals.videoCommentThread.id,
user: user
user
}, 'filter:api.video-thread-comments.list.params')
resultList = await Hooks.wrapPromiseFun(

2
server/controllers/api/videos/import.ts
View File

@ -245,7 +245,7 @@ function insertIntoDB (parameters: {
if (thumbnailModel) await videoCreated.addAndSaveThumbnail(thumbnailModel, t)
if (previewModel) await videoCreated.addAndSaveThumbnail(previewModel, t)
await autoBlacklistVideoIfNeeded(video, user, t)
await autoBlacklistVideoIfNeeded({ video, user, isRemote: false, isNew: true, transaction: t })
// Set tags to the video
if (tags) {

36
server/controllers/api/videos/index.ts
View File

@ -268,7 +268,13 @@ async function addVideo (req: express.Request, res: express.Response) {
}, { transaction: t })
}
const videoWasAutoBlacklisted = await autoBlacklistVideoIfNeeded(video, res.locals.oauth.token.User, t)
const videoWasAutoBlacklisted = await autoBlacklistVideoIfNeeded({
video,
user: res.locals.oauth.token.User,
isRemote: false,
isNew: true,
transaction: t
})
if (!videoWasAutoBlacklisted) await federateVideoIfNeeded(video, true, t)
auditLogger.create(getAuditIdFromRes(res), new VideoAuditView(videoCreated.toFormattedDetailsJSON()))
@ -336,16 +342,16 @@ async function updateVideo (req: express.Request, res: express.Response) {
const sequelizeOptions = { transaction: t }
const oldVideoChannel = videoInstance.VideoChannel
if (videoInfoToUpdate.name !== undefined) videoInstance.set('name', videoInfoToUpdate.name)
if (videoInfoToUpdate.category !== undefined) videoInstance.set('category', videoInfoToUpdate.category)
if (videoInfoToUpdate.licence !== undefined) videoInstance.set('licence', videoInfoToUpdate.licence)
if (videoInfoToUpdate.language !== undefined) videoInstance.set('language', videoInfoToUpdate.language)
if (videoInfoToUpdate.nsfw !== undefined) videoInstance.set('nsfw', videoInfoToUpdate.nsfw)
if (videoInfoToUpdate.waitTranscoding !== undefined) videoInstance.set('waitTranscoding', videoInfoToUpdate.waitTranscoding)
if (videoInfoToUpdate.support !== undefined) videoInstance.set('support', videoInfoToUpdate.support)
if (videoInfoToUpdate.description !== undefined) videoInstance.set('description', videoInfoToUpdate.description)
if (videoInfoToUpdate.commentsEnabled !== undefined) videoInstance.set('commentsEnabled', videoInfoToUpdate.commentsEnabled)
if (videoInfoToUpdate.downloadEnabled !== undefined) videoInstance.set('downloadEnabled', videoInfoToUpdate.downloadEnabled)
if (videoInfoToUpdate.name !== undefined) videoInstance.name = videoInfoToUpdate.name
if (videoInfoToUpdate.category !== undefined) videoInstance.category = videoInfoToUpdate.category
if (videoInfoToUpdate.licence !== undefined) videoInstance.licence = videoInfoToUpdate.licence
if (videoInfoToUpdate.language !== undefined) videoInstance.language = videoInfoToUpdate.language
if (videoInfoToUpdate.nsfw !== undefined) videoInstance.nsfw = videoInfoToUpdate.nsfw
if (videoInfoToUpdate.waitTranscoding !== undefined) videoInstance.waitTranscoding = videoInfoToUpdate.waitTranscoding
if (videoInfoToUpdate.support !== undefined) videoInstance.support = videoInfoToUpdate.support
if (videoInfoToUpdate.description !== undefined) videoInstance.description = videoInfoToUpdate.description
if (videoInfoToUpdate.commentsEnabled !== undefined) videoInstance.commentsEnabled = videoInfoToUpdate.commentsEnabled
if (videoInfoToUpdate.downloadEnabled !== undefined) videoInstance.downloadEnabled = videoInfoToUpdate.downloadEnabled
if (videoInfoToUpdate.originallyPublishedAt !== undefined && videoInfoToUpdate.originallyPublishedAt !== null) {
videoInstance.originallyPublishedAt = new Date(videoInfoToUpdate.originallyPublishedAt)
@ -398,6 +404,14 @@ async function updateVideo (req: express.Request, res: express.Response) {
await ScheduleVideoUpdateModel.deleteByVideoId(videoInstanceUpdated.id, t)
}
await autoBlacklistVideoIfNeeded({
video: videoInstanceUpdated,
user: res.locals.oauth.token.User,
isRemote: false,
isNew: false,
transaction: t
})
const isNewVideo = wasPrivateVideo && videoInstanceUpdated.privacy !== VideoPrivacy.PRIVATE
// Don't send update if the video was unfederated

4
server/lib/activitypub/process/process-create.ts
View File

@ -48,9 +48,9 @@ export {
async function processCreateVideo (activity: ActivityCreate) {
const videoToCreateData = activity.object as VideoTorrentObject
const { video, created } = await getOrCreateVideoAndAccountAndChannel({ videoObject: videoToCreateData })
const { video, created, autoBlacklisted } = await getOrCreateVideoAndAccountAndChannel({ videoObject: videoToCreateData })
if (created) Notifier.Instance.notifyOnNewVideo(video)
if (created && !autoBlacklisted) Notifier.Instance.notifyOnNewVideo(video)
return video
}

28
server/lib/activitypub/videos.ts
View File

@ -224,11 +224,11 @@ async function getOrCreateVideoAndAccountAndChannel (options: {
if (!fetchedVideo) throw new Error('Cannot fetch remote video with url: ' + videoUrl)
const channelActor = await getOrCreateVideoChannelFromVideoObject(fetchedVideo)
const video = await retryTransactionWrapper(createVideo, fetchedVideo, channelActor, syncParam.thumbnail)
const { autoBlacklisted, videoCreated } = await retryTransactionWrapper(createVideo, fetchedVideo, channelActor, syncParam.thumbnail)
await syncVideoExternalAttributes(video, fetchedVideo, syncParam)
await syncVideoExternalAttributes(videoCreated, fetchedVideo, syncParam)
return { video, created: true }
return { video: videoCreated, created: true, autoBlacklisted }
}
async function updateVideoFromAP (options: {
@ -354,7 +354,13 @@ async function updateVideoFromAP (options: {
}
})
const autoBlacklisted = await autoBlacklistVideoIfNeeded(video, undefined, undefined)
const autoBlacklisted = await autoBlacklistVideoIfNeeded({
video,
user: undefined,
isRemote: true,
isNew: false,
transaction: undefined
})
if (autoBlacklisted) Notifier.Instance.notifyOnVideoAutoBlacklist(video)
else if (!wasPrivateVideo || wasUnlistedVideo) Notifier.Instance.notifyOnNewVideo(video) // Notify our users?
@ -467,7 +473,7 @@ async function createVideo (videoObject: VideoTorrentObject, channelActor: Actor
thumbnailModel = await promiseThumbnail
}
const videoCreated: VideoModel = await sequelizeTypescript.transaction(async t => {
const { autoBlacklisted, videoCreated } = await sequelizeTypescript.transaction(async t => {
const sequelizeOptions = { transaction: t }
const videoCreated = await video.save(sequelizeOptions)
@ -506,9 +512,17 @@ async function createVideo (videoObject: VideoTorrentObject, channelActor: Actor
})
await Promise.all(videoCaptionsPromises)
const autoBlacklisted = await autoBlacklistVideoIfNeeded({
video,
user: undefined,
isRemote: true,
isNew: true,
transaction: t
})
logger.info('Remote video with uuid %s inserted.', videoObject.uuid)
return videoCreated
return { autoBlacklisted, videoCreated }
})
if (waitThumbnail === false) {
@ -519,7 +533,7 @@ async function createVideo (videoObject: VideoTorrentObject, channelActor: Actor
})
}
return videoCreated
return { autoBlacklisted, videoCreated }
}
async function videoActivityObjectToDBAttributes (

33
server/lib/video-blacklist.ts
View File

@ -8,10 +8,17 @@ import { logger } from '../helpers/logger'
import { UserAdminFlag } from '../../shared/models/users/user-flag.model'
import { Hooks } from './plugins/hooks'
async function autoBlacklistVideoIfNeeded (video: VideoModel, user?: UserModel, transaction?: Transaction) {
async function autoBlacklistVideoIfNeeded (parameters: {
video: VideoModel,
user?: UserModel,
isRemote: boolean,
isNew: boolean,
transaction?: Transaction
}) {
const { video, user, isRemote, isNew, transaction } = parameters
const doAutoBlacklist = await Hooks.wrapPromiseFun(
autoBlacklistNeeded,
{ video, user },
{ video, user, isRemote, isNew },
'filter:video.auto-blacklist.result'
)
@ -23,17 +30,33 @@ async function autoBlacklistVideoIfNeeded (video: VideoModel, user?: UserModel,
reason: 'Auto-blacklisted. Moderator review required.',
type: VideoBlacklistType.AUTO_BEFORE_PUBLISHED
}
await VideoBlacklistModel.create(videoBlacklistToCreate, { transaction })
const [ videoBlacklist ] = await VideoBlacklistModel.findOrCreate({
where: {
videoId: video.id
},
defaults: videoBlacklistToCreate,
transaction
})
video.VideoBlacklist = videoBlacklist
logger.info('Video %s auto-blacklisted.', video.uuid)
return true
}
async function autoBlacklistNeeded (parameters: { video: VideoModel, user?: UserModel }) {
const { user } = parameters
async function autoBlacklistNeeded (parameters: {
video: VideoModel,
isRemote: boolean,
isNew: boolean,
user?: UserModel
}) {
const { user, video, isRemote, isNew } = parameters
// Already blacklisted
if (video.VideoBlacklist) return false
if (!CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED || !user) return false
if (isRemote || isNew) return false
if (user.hasRight(UserRight.MANAGE_VIDEO_BLACKLIST) || user.hasAdminFlag(UserAdminFlag.BY_PASS_VIDEO_AUTO_BLACKLIST)) return false

10
server/middlewares/validators/videos/video-comments.ts
View File

@ -210,13 +210,15 @@ async function isVideoCommentAccepted (req: express.Request, res: express.Respon
if (isReply) {
const acceptReplyParameters = Object.assign(acceptParameters, { parentComment: res.locals.videoComment })
acceptedResult = await Hooks.wrapObject(
isLocalVideoCommentReplyAccepted(acceptReplyParameters),
acceptedResult = await Hooks.wrapFun(
isLocalVideoCommentReplyAccepted,
acceptReplyParameters,
'filter:api.video-comment-reply.create.accept.result'
)
} else {
acceptedResult = await Hooks.wrapObject(
isLocalVideoThreadAccepted(acceptParameters),
acceptedResult = await Hooks.wrapFun(
isLocalVideoThreadAccepted,
acceptParameters,
'filter:api.video-thread.create.accept.result'
)
}

57
server/tests/fixtures/peertube-plugin-test/main.js vendored
View File

@ -26,7 +26,7 @@ async function register ({ registerHook, registerSetting, settingsManager, stora
registerHook({
target: 'filter:api.videos.list.result',
handler: obj => ({ data: obj.data, total: obj.total + 1 })
handler: obj => addToTotal(obj)
})
registerHook({
@ -41,12 +41,51 @@ async function register ({ registerHook, registerSetting, settingsManager, stora
registerHook({
target: 'filter:api.video.upload.accept.result',
handler: ({ accepted }, { videoBody }) => {
if (accepted !== false) return { accepted: true }
if (!accepted) return { accepted: false }
if (videoBody.name.indexOf('bad word') !== -1) return { accepted: false, errorMessage: 'bad word '}
return { accepted: true }
}
})
registerHook({
target: 'filter:api.video-thread.create.accept.result',
handler: ({ accepted }, { commentBody }) => checkCommentBadWord(accepted, commentBody)
})
registerHook({
target: 'filter:api.video-comment-reply.create.accept.result',
handler: ({ accepted }, { commentBody }) => checkCommentBadWord(accepted, commentBody)
})
registerHook({
target: 'filter:api.video-threads.list.params',
handler: obj => addToCount(obj)
})
registerHook({
target: 'filter:api.video-threads.list.result',
handler: obj => addToTotal(obj)
})
registerHook({
target: 'filter:api.video-thread-comments.list.result',
handler: obj => {
obj.data.forEach(c => c.text += ' <3')
return obj
}
})
registerHook({
target: 'filter:video.auto-blacklist.result',
handler: (blacklisted, { video }) => {
if (blacklisted) return true
if (video.name.includes('please blacklist me')) return true
return false
}
})
}
async function unregister () {
@ -63,3 +102,17 @@ module.exports = {
function addToCount (obj) {
return Object.assign({}, obj, { count: obj.count + 1 })
}
function addToTotal (result) {
return {
data: result.data,
total: result.total + 1
}
}
function checkCommentBadWord (accepted, commentBody) {
if (!accepted) return { accepted: false }
if (commentBody.text.indexOf('bad word') !== -1) return { accepted: false, errorMessage: 'bad word '}
return { accepted: true }
}

123
server/tests/plugins/filter-hooks.ts
View File

@ -11,15 +11,28 @@ import {
} from '../../../shared/extra-utils/server/servers'
import {
addVideoCommentReply,
addVideoCommentThread, deleteVideoComment,
getPluginTestPath, getVideosList,
installPlugin, removeVideo,
addVideoCommentThread,
deleteVideoComment,
getPluginTestPath,
getVideosList,
installPlugin,
removeVideo,
setAccessTokensToServers,
updateVideo,
uploadVideo,
viewVideo,
getVideosListPagination, getVideo
getVideosListPagination,
getVideo,
getVideoCommentThreads,
getVideoThreadComments,
getVideoWithToken,
setDefaultVideoChannel,
waitJobs,
doubleFollow
} from '../../../shared/extra-utils'
import { VideoCommentThreadTree } from '../../../shared/models/videos/video-comment.model'
import { VideoDetails } from '../../../shared/models/videos'
import { getYoutubeVideoUrl, importVideo } from '../../../shared/extra-utils/videos/video-imports'
const expect = chai.expect
@ -33,6 +46,8 @@ describe('Test plugin filter hooks', function () {
servers = await flushAndRunMultipleServers(2)
await setAccessTokensToServers(servers)
await setDefaultVideoChannel(servers)
await doubleFollow(servers[0], servers[1])
await installPlugin({
url: servers[0].url,
@ -54,7 +69,7 @@ describe('Test plugin filter hooks', function () {
videoUUID = res.body.data[0].uuid
})
it('Should run filter:api.videos.list.params hook', async function () {
it('Should run filter:api.videos.list.params', async function () {
const res = await getVideosListPagination(servers[0].url, 0, 2)
// 2 plugins do +1 to the count parameter
@ -74,6 +89,104 @@ describe('Test plugin filter hooks', function () {
expect(res.body.name).to.contain('<3')
})
it('Should run filter:api.video.upload.accept.result', async function () {
await uploadVideo(servers[0].url, servers[0].accessToken, { name: 'video with bad word' }, 403)
})
it('Should run filter:api.video-thread.create.accept.result', async function () {
await addVideoCommentThread(servers[0].url, servers[0].accessToken, videoUUID, 'comment with bad word', 403)
})
it('Should run filter:api.video-comment-reply.create.accept.result', async function () {
const res = await addVideoCommentThread(servers[0].url, servers[0].accessToken, videoUUID, 'thread')
threadId = res.body.comment.id
await addVideoCommentReply(servers[0].url, servers[0].accessToken, videoUUID, threadId, 'comment with bad word', 403)
await addVideoCommentReply(servers[0].url, servers[0].accessToken, videoUUID, threadId, 'comment with good word', 200)
})
it('Should run filter:api.video-threads.list.params', async function () {
const res = await getVideoCommentThreads(servers[0].url, videoUUID, 0, 0)
// our plugin do +1 to the count parameter
expect(res.body.data).to.have.lengthOf(1)
})
it('Should run filter:api.video-threads.list.result', async function () {
const res = await getVideoCommentThreads(servers[0].url, videoUUID, 0, 0)
// Plugin do +1 to the total result
expect(res.body.total).to.equal(2)
})
it('Should run filter:api.video-thread-comments.list.params')
it('Should run filter:api.video-thread-comments.list.result', async function () {
const res = await getVideoThreadComments(servers[0].url, videoUUID, threadId)
const thread = res.body as VideoCommentThreadTree
expect(thread.comment.text.endsWith(' <3')).to.be.true
})
describe('Should run filter:video.auto-blacklist.result', function () {
async function checkIsBlacklisted (oldRes: any, value: boolean) {
const videoId = oldRes.body.video.uuid
const res = await getVideoWithToken(servers[0].url, servers[0].accessToken, videoId)
const video: VideoDetails = res.body
expect(video.blacklisted).to.equal(value)
}
it('Should blacklist on upload', async function () {
const res = await uploadVideo(servers[ 0 ].url, servers[ 0 ].accessToken, { name: 'video please blacklist me' })
await checkIsBlacklisted(res, true)
})
it('Should blacklist on import', async function () {
const attributes = {
name: 'video please blacklist me',
targetUrl: getYoutubeVideoUrl(),
channelId: servers[0].videoChannel.id
}
const res = await importVideo(servers[0].url, servers[0].accessToken, attributes)
await checkIsBlacklisted(res, true)
})
it('Should blacklist on update', async function () {
const res = await uploadVideo(servers[ 0 ].url, servers[ 0 ].accessToken, { name: 'video' })
const videoId = res.body.video.uuid
await checkIsBlacklisted(res, false)
await updateVideo(servers[ 0 ].url, servers[ 0 ].accessToken, videoId, { name: 'please blacklist me' })
await checkIsBlacklisted(res, true)
})
it('Should blacklist on remote upload', async function () {
this.timeout(45000)
const res = await uploadVideo(servers[ 1 ].url, servers[ 1 ].accessToken, { name: 'remote please blacklist me' })
await waitJobs(servers)
await checkIsBlacklisted(res, true)
})
it('Should blacklist on remote update', async function () {
this.timeout(45000)
const res = await uploadVideo(servers[ 1 ].url, servers[ 1 ].accessToken, { name: 'video' })
await waitJobs(servers)
const videoId = res.body.video.uuid
await checkIsBlacklisted(res, false)
await updateVideo(servers[1].url, servers[1].accessToken, videoId, { name: 'please blacklist me' })
await waitJobs(servers)
await checkIsBlacklisted(res, true)
})
})
after(async function () {
await cleanupTests(servers)
})

6
shared/models/plugins/server-hook.model.ts
View File

@ -7,12 +7,12 @@ export type ServerFilterHookName =
'filter:api.video-thread.create.accept.result' |
'filter:api.video-comment-reply.create.accept.result' |
'filter:api.video-thread-comments.list.params' |
'filter:api.video-thread-comments.list.result' |
'filter:api.video-threads.list.params' |
'filter:api.video-threads.list.result' |
'filter:api.video-thread-comments.list.params' |
'filter:api.video-thread-comments.list.result' |
'filter:video.auto-blacklist.result'
export type ServerActionHookName =