mirror of https://github.com/Chocobozzz/PeerTube
530 lines
17 KiB
TypeScript
530 lines
17 KiB
TypeScript
/* tslint:disable:no-unused-expression */
|
|
|
|
import { makeGetRequest, makePostBodyRequest, makePutBodyRequest } from '../requests/requests'
|
|
import { UserNotification, UserNotificationSetting, UserNotificationType } from '../../models/users'
|
|
import { ServerInfo } from '..'
|
|
import { expect } from 'chai'
|
|
import { inspect } from 'util'
|
|
|
|
function updateMyNotificationSettings (url: string, token: string, settings: UserNotificationSetting, statusCodeExpected = 204) {
|
|
const path = '/api/v1/users/me/notification-settings'
|
|
|
|
return makePutBodyRequest({
|
|
url,
|
|
path,
|
|
token,
|
|
fields: settings,
|
|
statusCodeExpected
|
|
})
|
|
}
|
|
|
|
async function getUserNotifications (
|
|
url: string,
|
|
token: string,
|
|
start: number,
|
|
count: number,
|
|
unread?: boolean,
|
|
sort = '-createdAt',
|
|
statusCodeExpected = 200
|
|
) {
|
|
const path = '/api/v1/users/me/notifications'
|
|
|
|
return makeGetRequest({
|
|
url,
|
|
path,
|
|
token,
|
|
query: {
|
|
start,
|
|
count,
|
|
sort,
|
|
unread
|
|
},
|
|
statusCodeExpected
|
|
})
|
|
}
|
|
|
|
function markAsReadNotifications (url: string, token: string, ids: number[], statusCodeExpected = 204) {
|
|
const path = '/api/v1/users/me/notifications/read'
|
|
|
|
return makePostBodyRequest({
|
|
url,
|
|
path,
|
|
token,
|
|
fields: { ids },
|
|
statusCodeExpected
|
|
})
|
|
}
|
|
function markAsReadAllNotifications (url: string, token: string, statusCodeExpected = 204) {
|
|
const path = '/api/v1/users/me/notifications/read-all'
|
|
|
|
return makePostBodyRequest({
|
|
url,
|
|
path,
|
|
token,
|
|
statusCodeExpected
|
|
})
|
|
}
|
|
|
|
async function getLastNotification (serverUrl: string, accessToken: string) {
|
|
const res = await getUserNotifications(serverUrl, accessToken, 0, 1, undefined, '-createdAt')
|
|
|
|
if (res.body.total === 0) return undefined
|
|
|
|
return res.body.data[0] as UserNotification
|
|
}
|
|
|
|
type CheckerBaseParams = {
|
|
server: ServerInfo
|
|
emails: object[]
|
|
socketNotifications: UserNotification[]
|
|
token: string,
|
|
check?: { web: boolean, mail: boolean }
|
|
}
|
|
|
|
type CheckerType = 'presence' | 'absence'
|
|
|
|
async function checkNotification (
|
|
base: CheckerBaseParams,
|
|
notificationChecker: (notification: UserNotification, type: CheckerType) => void,
|
|
emailNotificationFinder: (email: object) => boolean,
|
|
checkType: CheckerType
|
|
) {
|
|
const check = base.check || { web: true, mail: true }
|
|
|
|
if (check.web) {
|
|
const notification = await getLastNotification(base.server.url, base.token)
|
|
|
|
if (notification || checkType !== 'absence') {
|
|
notificationChecker(notification, checkType)
|
|
}
|
|
|
|
const socketNotification = base.socketNotifications.find(n => {
|
|
try {
|
|
notificationChecker(n, 'presence')
|
|
return true
|
|
} catch {
|
|
return false
|
|
}
|
|
})
|
|
|
|
if (checkType === 'presence') {
|
|
const obj = inspect(base.socketNotifications, { depth: 5 })
|
|
expect(socketNotification, 'The socket notification is absent. ' + obj).to.not.be.undefined
|
|
} else {
|
|
const obj = inspect(socketNotification, { depth: 5 })
|
|
expect(socketNotification, 'The socket notification is present. ' + obj).to.be.undefined
|
|
}
|
|
}
|
|
|
|
if (check.mail) {
|
|
// Last email
|
|
const email = base.emails
|
|
.slice()
|
|
.reverse()
|
|
.find(e => emailNotificationFinder(e))
|
|
|
|
if (checkType === 'presence') {
|
|
expect(email, 'The email is absent. ' + inspect(base.emails)).to.not.be.undefined
|
|
} else {
|
|
expect(email, 'The email is present. ' + inspect(email)).to.be.undefined
|
|
}
|
|
}
|
|
}
|
|
|
|
function checkVideo (video: any, videoName?: string, videoUUID?: string) {
|
|
expect(video.name).to.be.a('string')
|
|
expect(video.name).to.not.be.empty
|
|
if (videoName) expect(video.name).to.equal(videoName)
|
|
|
|
expect(video.uuid).to.be.a('string')
|
|
expect(video.uuid).to.not.be.empty
|
|
if (videoUUID) expect(video.uuid).to.equal(videoUUID)
|
|
|
|
expect(video.id).to.be.a('number')
|
|
}
|
|
|
|
function checkActor (actor: any) {
|
|
expect(actor.displayName).to.be.a('string')
|
|
expect(actor.displayName).to.not.be.empty
|
|
expect(actor.host).to.not.be.undefined
|
|
}
|
|
|
|
function checkComment (comment: any, commentId: number, threadId: number) {
|
|
expect(comment.id).to.equal(commentId)
|
|
expect(comment.threadId).to.equal(threadId)
|
|
}
|
|
|
|
async function checkNewVideoFromSubscription (base: CheckerBaseParams, videoName: string, videoUUID: string, type: CheckerType) {
|
|
const notificationType = UserNotificationType.NEW_VIDEO_FROM_SUBSCRIPTION
|
|
|
|
function notificationChecker (notification: UserNotification, type: CheckerType) {
|
|
if (type === 'presence') {
|
|
expect(notification).to.not.be.undefined
|
|
expect(notification.type).to.equal(notificationType)
|
|
|
|
checkVideo(notification.video, videoName, videoUUID)
|
|
checkActor(notification.video.channel)
|
|
} else {
|
|
expect(notification).to.satisfy((n: UserNotification) => {
|
|
return n === undefined || n.type !== UserNotificationType.NEW_VIDEO_FROM_SUBSCRIPTION || n.video.name !== videoName
|
|
})
|
|
}
|
|
}
|
|
|
|
function emailFinder (email: object) {
|
|
const text = email[ 'text' ]
|
|
return text.indexOf(videoUUID) !== -1 && text.indexOf('Your subscription') !== -1
|
|
}
|
|
|
|
await checkNotification(base, notificationChecker, emailFinder, type)
|
|
}
|
|
|
|
async function checkVideoIsPublished (base: CheckerBaseParams, videoName: string, videoUUID: string, type: CheckerType) {
|
|
const notificationType = UserNotificationType.MY_VIDEO_PUBLISHED
|
|
|
|
function notificationChecker (notification: UserNotification, type: CheckerType) {
|
|
if (type === 'presence') {
|
|
expect(notification).to.not.be.undefined
|
|
expect(notification.type).to.equal(notificationType)
|
|
|
|
checkVideo(notification.video, videoName, videoUUID)
|
|
checkActor(notification.video.channel)
|
|
} else {
|
|
expect(notification.video).to.satisfy(v => v === undefined || v.name !== videoName)
|
|
}
|
|
}
|
|
|
|
function emailFinder (email: object) {
|
|
const text: string = email[ 'text' ]
|
|
return text.includes(videoUUID) && text.includes('Your video')
|
|
}
|
|
|
|
await checkNotification(base, notificationChecker, emailFinder, type)
|
|
}
|
|
|
|
async function checkMyVideoImportIsFinished (
|
|
base: CheckerBaseParams,
|
|
videoName: string,
|
|
videoUUID: string,
|
|
url: string,
|
|
success: boolean,
|
|
type: CheckerType
|
|
) {
|
|
const notificationType = success ? UserNotificationType.MY_VIDEO_IMPORT_SUCCESS : UserNotificationType.MY_VIDEO_IMPORT_ERROR
|
|
|
|
function notificationChecker (notification: UserNotification, type: CheckerType) {
|
|
if (type === 'presence') {
|
|
expect(notification).to.not.be.undefined
|
|
expect(notification.type).to.equal(notificationType)
|
|
|
|
expect(notification.videoImport.targetUrl).to.equal(url)
|
|
|
|
if (success) checkVideo(notification.videoImport.video, videoName, videoUUID)
|
|
} else {
|
|
expect(notification.videoImport).to.satisfy(i => i === undefined || i.targetUrl !== url)
|
|
}
|
|
}
|
|
|
|
function emailFinder (email: object) {
|
|
const text: string = email[ 'text' ]
|
|
const toFind = success ? ' finished' : ' error'
|
|
|
|
return text.includes(url) && text.includes(toFind)
|
|
}
|
|
|
|
await checkNotification(base, notificationChecker, emailFinder, type)
|
|
}
|
|
|
|
async function checkUserRegistered (base: CheckerBaseParams, username: string, type: CheckerType) {
|
|
const notificationType = UserNotificationType.NEW_USER_REGISTRATION
|
|
|
|
function notificationChecker (notification: UserNotification, type: CheckerType) {
|
|
if (type === 'presence') {
|
|
expect(notification).to.not.be.undefined
|
|
expect(notification.type).to.equal(notificationType)
|
|
|
|
checkActor(notification.account)
|
|
expect(notification.account.name).to.equal(username)
|
|
} else {
|
|
expect(notification).to.satisfy(n => n.type !== notificationType || n.account.name !== username)
|
|
}
|
|
}
|
|
|
|
function emailFinder (email: object) {
|
|
const text: string = email[ 'text' ]
|
|
|
|
return text.includes(' registered ') && text.includes(username)
|
|
}
|
|
|
|
await checkNotification(base, notificationChecker, emailFinder, type)
|
|
}
|
|
|
|
async function checkNewActorFollow (
|
|
base: CheckerBaseParams,
|
|
followType: 'channel' | 'account',
|
|
followerName: string,
|
|
followerDisplayName: string,
|
|
followingDisplayName: string,
|
|
type: CheckerType
|
|
) {
|
|
const notificationType = UserNotificationType.NEW_FOLLOW
|
|
|
|
function notificationChecker (notification: UserNotification, type: CheckerType) {
|
|
if (type === 'presence') {
|
|
expect(notification).to.not.be.undefined
|
|
expect(notification.type).to.equal(notificationType)
|
|
|
|
checkActor(notification.actorFollow.follower)
|
|
expect(notification.actorFollow.follower.displayName).to.equal(followerDisplayName)
|
|
expect(notification.actorFollow.follower.name).to.equal(followerName)
|
|
expect(notification.actorFollow.follower.host).to.not.be.undefined
|
|
|
|
const following = notification.actorFollow.following
|
|
expect(following.displayName).to.equal(followingDisplayName)
|
|
expect(following.type).to.equal(followType)
|
|
} else {
|
|
expect(notification).to.satisfy(n => {
|
|
return n.type !== notificationType ||
|
|
(n.actorFollow.follower.name !== followerName && n.actorFollow.following !== followingDisplayName)
|
|
})
|
|
}
|
|
}
|
|
|
|
function emailFinder (email: object) {
|
|
const text: string = email[ 'text' ]
|
|
|
|
return text.includes('Your ' + followType) && text.includes(followingDisplayName) && text.includes(followerDisplayName)
|
|
}
|
|
|
|
await checkNotification(base, notificationChecker, emailFinder, type)
|
|
}
|
|
|
|
async function checkNewInstanceFollower (base: CheckerBaseParams, followerHost: string, type: CheckerType) {
|
|
const notificationType = UserNotificationType.NEW_INSTANCE_FOLLOWER
|
|
|
|
function notificationChecker (notification: UserNotification, type: CheckerType) {
|
|
if (type === 'presence') {
|
|
expect(notification).to.not.be.undefined
|
|
expect(notification.type).to.equal(notificationType)
|
|
|
|
checkActor(notification.actorFollow.follower)
|
|
expect(notification.actorFollow.follower.name).to.equal('peertube')
|
|
expect(notification.actorFollow.follower.host).to.equal(followerHost)
|
|
|
|
expect(notification.actorFollow.following.name).to.equal('peertube')
|
|
} else {
|
|
expect(notification).to.satisfy(n => {
|
|
return n.type !== notificationType || n.actorFollow.follower.host !== followerHost
|
|
})
|
|
}
|
|
}
|
|
|
|
function emailFinder (email: object) {
|
|
const text: string = email[ 'text' ]
|
|
|
|
return text.includes('instance has a new follower') && text.includes(followerHost)
|
|
}
|
|
|
|
await checkNotification(base, notificationChecker, emailFinder, type)
|
|
}
|
|
|
|
async function checkAutoInstanceFollowing (base: CheckerBaseParams, followerHost: string, followingHost: string, type: CheckerType) {
|
|
const notificationType = UserNotificationType.AUTO_INSTANCE_FOLLOWING
|
|
|
|
function notificationChecker (notification: UserNotification, type: CheckerType) {
|
|
if (type === 'presence') {
|
|
expect(notification).to.not.be.undefined
|
|
expect(notification.type).to.equal(notificationType)
|
|
|
|
const following = notification.actorFollow.following
|
|
checkActor(following)
|
|
expect(following.name).to.equal('peertube')
|
|
expect(following.host).to.equal(followingHost)
|
|
|
|
expect(notification.actorFollow.follower.name).to.equal('peertube')
|
|
expect(notification.actorFollow.follower.host).to.equal(followerHost)
|
|
} else {
|
|
expect(notification).to.satisfy(n => {
|
|
return n.type !== notificationType || n.actorFollow.following.host !== followingHost
|
|
})
|
|
}
|
|
}
|
|
|
|
function emailFinder (email: object) {
|
|
const text: string = email[ 'text' ]
|
|
|
|
return text.includes(' automatically followed a new instance') && text.includes(followingHost)
|
|
}
|
|
|
|
await checkNotification(base, notificationChecker, emailFinder, type)
|
|
}
|
|
|
|
async function checkCommentMention (
|
|
base: CheckerBaseParams,
|
|
uuid: string,
|
|
commentId: number,
|
|
threadId: number,
|
|
byAccountDisplayName: string,
|
|
type: CheckerType
|
|
) {
|
|
const notificationType = UserNotificationType.COMMENT_MENTION
|
|
|
|
function notificationChecker (notification: UserNotification, type: CheckerType) {
|
|
if (type === 'presence') {
|
|
expect(notification).to.not.be.undefined
|
|
expect(notification.type).to.equal(notificationType)
|
|
|
|
checkComment(notification.comment, commentId, threadId)
|
|
checkActor(notification.comment.account)
|
|
expect(notification.comment.account.displayName).to.equal(byAccountDisplayName)
|
|
|
|
checkVideo(notification.comment.video, undefined, uuid)
|
|
} else {
|
|
expect(notification).to.satisfy(n => n.type !== notificationType || n.comment.id !== commentId)
|
|
}
|
|
}
|
|
|
|
function emailFinder (email: object) {
|
|
const text: string = email[ 'text' ]
|
|
|
|
return text.includes(' mentioned ') && text.includes(uuid) && text.includes(byAccountDisplayName)
|
|
}
|
|
|
|
await checkNotification(base, notificationChecker, emailFinder, type)
|
|
}
|
|
|
|
let lastEmailCount = 0
|
|
async function checkNewCommentOnMyVideo (base: CheckerBaseParams, uuid: string, commentId: number, threadId: number, type: CheckerType) {
|
|
const notificationType = UserNotificationType.NEW_COMMENT_ON_MY_VIDEO
|
|
|
|
function notificationChecker (notification: UserNotification, type: CheckerType) {
|
|
if (type === 'presence') {
|
|
expect(notification).to.not.be.undefined
|
|
expect(notification.type).to.equal(notificationType)
|
|
|
|
checkComment(notification.comment, commentId, threadId)
|
|
checkActor(notification.comment.account)
|
|
checkVideo(notification.comment.video, undefined, uuid)
|
|
} else {
|
|
expect(notification).to.satisfy((n: UserNotification) => {
|
|
return n === undefined || n.comment === undefined || n.comment.id !== commentId
|
|
})
|
|
}
|
|
}
|
|
|
|
const commentUrl = `http://localhost:${base.server.port}/videos/watch/${uuid};threadId=${threadId}`
|
|
function emailFinder (email: object) {
|
|
return email[ 'text' ].indexOf(commentUrl) !== -1
|
|
}
|
|
|
|
await checkNotification(base, notificationChecker, emailFinder, type)
|
|
|
|
if (type === 'presence') {
|
|
// We cannot detect email duplicates, so check we received another email
|
|
expect(base.emails).to.have.length.above(lastEmailCount)
|
|
lastEmailCount = base.emails.length
|
|
}
|
|
}
|
|
|
|
async function checkNewVideoAbuseForModerators (base: CheckerBaseParams, videoUUID: string, videoName: string, type: CheckerType) {
|
|
const notificationType = UserNotificationType.NEW_VIDEO_ABUSE_FOR_MODERATORS
|
|
|
|
function notificationChecker (notification: UserNotification, type: CheckerType) {
|
|
if (type === 'presence') {
|
|
expect(notification).to.not.be.undefined
|
|
expect(notification.type).to.equal(notificationType)
|
|
|
|
expect(notification.videoAbuse.id).to.be.a('number')
|
|
checkVideo(notification.videoAbuse.video, videoName, videoUUID)
|
|
} else {
|
|
expect(notification).to.satisfy((n: UserNotification) => {
|
|
return n === undefined || n.videoAbuse === undefined || n.videoAbuse.video.uuid !== videoUUID
|
|
})
|
|
}
|
|
}
|
|
|
|
function emailFinder (email: object) {
|
|
const text = email[ 'text' ]
|
|
return text.indexOf(videoUUID) !== -1 && text.indexOf('abuse') !== -1
|
|
}
|
|
|
|
await checkNotification(base, notificationChecker, emailFinder, type)
|
|
}
|
|
|
|
async function checkVideoAutoBlacklistForModerators (base: CheckerBaseParams, videoUUID: string, videoName: string, type: CheckerType) {
|
|
const notificationType = UserNotificationType.VIDEO_AUTO_BLACKLIST_FOR_MODERATORS
|
|
|
|
function notificationChecker (notification: UserNotification, type: CheckerType) {
|
|
if (type === 'presence') {
|
|
expect(notification).to.not.be.undefined
|
|
expect(notification.type).to.equal(notificationType)
|
|
|
|
expect(notification.videoBlacklist.video.id).to.be.a('number')
|
|
checkVideo(notification.videoBlacklist.video, videoName, videoUUID)
|
|
} else {
|
|
expect(notification).to.satisfy((n: UserNotification) => {
|
|
return n === undefined || n.video === undefined || n.video.uuid !== videoUUID
|
|
})
|
|
}
|
|
}
|
|
|
|
function emailFinder (email: object) {
|
|
const text = email[ 'text' ]
|
|
return text.indexOf(videoUUID) !== -1 && email[ 'text' ].indexOf('video-auto-blacklist/list') !== -1
|
|
}
|
|
|
|
await checkNotification(base, notificationChecker, emailFinder, type)
|
|
}
|
|
|
|
async function checkNewBlacklistOnMyVideo (
|
|
base: CheckerBaseParams,
|
|
videoUUID: string,
|
|
videoName: string,
|
|
blacklistType: 'blacklist' | 'unblacklist'
|
|
) {
|
|
const notificationType = blacklistType === 'blacklist'
|
|
? UserNotificationType.BLACKLIST_ON_MY_VIDEO
|
|
: UserNotificationType.UNBLACKLIST_ON_MY_VIDEO
|
|
|
|
function notificationChecker (notification: UserNotification) {
|
|
expect(notification).to.not.be.undefined
|
|
expect(notification.type).to.equal(notificationType)
|
|
|
|
const video = blacklistType === 'blacklist' ? notification.videoBlacklist.video : notification.video
|
|
|
|
checkVideo(video, videoName, videoUUID)
|
|
}
|
|
|
|
function emailFinder (email: object) {
|
|
const text = email[ 'text' ]
|
|
return text.indexOf(videoUUID) !== -1 && text.indexOf(' ' + blacklistType) !== -1
|
|
}
|
|
|
|
await checkNotification(base, notificationChecker, emailFinder, 'presence')
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
export {
|
|
CheckerBaseParams,
|
|
CheckerType,
|
|
checkNotification,
|
|
markAsReadAllNotifications,
|
|
checkMyVideoImportIsFinished,
|
|
checkUserRegistered,
|
|
checkAutoInstanceFollowing,
|
|
checkVideoIsPublished,
|
|
checkNewVideoFromSubscription,
|
|
checkNewActorFollow,
|
|
checkNewCommentOnMyVideo,
|
|
checkNewBlacklistOnMyVideo,
|
|
checkCommentMention,
|
|
updateMyNotificationSettings,
|
|
checkNewVideoAbuseForModerators,
|
|
checkVideoAutoBlacklistForModerators,
|
|
getUserNotifications,
|
|
markAsReadNotifications,
|
|
getLastNotification,
|
|
checkNewInstanceFollower
|
|
}
|