PeerTube/server/tests/shared/notifications.ts

890 lines
31 KiB
TypeScript
Raw Normal View History

2020-01-31 16:56:52 +01:00
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
2018-12-26 10:36:24 +01:00
import { expect } from 'chai'
import { inspect } from 'util'
import {
AbuseState,
PluginType,
UserNotification,
UserNotificationSetting,
UserNotificationSettingValue,
UserNotificationType
} from '@shared/models'
import {
2023-01-19 09:28:29 +01:00
ConfigCommand,
createMultipleServers,
doubleFollow,
PeerTubeServer,
setAccessTokensToServers,
setDefaultAccountAvatar,
2022-05-03 11:38:07 +02:00
setDefaultChannelAvatar,
setDefaultVideoChannel
} from '@shared/server-commands'
import { MockSmtpServer } from './mock-servers'
2018-12-26 10:36:24 +01:00
type CheckerBaseParams = {
server: PeerTubeServer
emails: any[]
socketNotifications: UserNotification[]
token: string
check?: { web: boolean, mail: boolean }
}
type CheckerType = 'presence' | 'absence'
2021-07-09 16:23:01 +02:00
function getAllNotificationsSettings (): UserNotificationSetting {
return {
newVideoFromSubscription: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
newCommentOnMyVideo: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
abuseAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
videoAutoBlacklistAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
blacklistOnMyVideo: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
myVideoImportFinished: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
myVideoPublished: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
commentMention: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
newFollow: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
newUserRegistration: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
newInstanceFollower: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
abuseNewMessage: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
abuseStateChange: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
autoInstanceFollowing: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
newPeerTubeVersion: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
2022-03-22 16:58:49 +01:00
myVideoStudioEditionFinished: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
2021-07-09 16:23:01 +02:00
newPluginVersion: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL
}
2018-12-26 10:36:24 +01:00
}
async function checkNewVideoFromSubscription (options: CheckerBaseParams & {
videoName: string
shortUUID: string
checkType: CheckerType
}) {
const { videoName, shortUUID } = options
2018-12-26 10:36:24 +01:00
const notificationType = UserNotificationType.NEW_VIDEO_FROM_SUBSCRIPTION
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
2018-12-26 10:36:24 +01:00
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
checkVideo(notification.video, videoName, shortUUID)
checkActor(notification.video.channel)
2018-12-26 10:36:24 +01:00
} else {
expect(notification).to.satisfy((n: UserNotification) => {
return n === undefined || n.type !== UserNotificationType.NEW_VIDEO_FROM_SUBSCRIPTION || n.video.name !== videoName
})
2018-12-26 10:36:24 +01:00
}
}
function emailNotificationFinder (email: object) {
2020-01-31 16:56:52 +01:00
const text = email['text']
return text.indexOf(shortUUID) !== -1 && text.indexOf('Your subscription') !== -1
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
}
async function checkVideoIsPublished (options: CheckerBaseParams & {
videoName: string
shortUUID: string
checkType: CheckerType
}) {
const { videoName, shortUUID } = options
const notificationType = UserNotificationType.MY_VIDEO_PUBLISHED
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
checkVideo(notification.video, videoName, shortUUID)
checkActor(notification.video.channel)
} else {
expect(notification.video).to.satisfy(v => v === undefined || v.name !== videoName)
}
2018-12-26 10:36:24 +01:00
}
function emailNotificationFinder (email: object) {
2020-01-31 16:56:52 +01:00
const text: string = email['text']
return text.includes(shortUUID) && text.includes('Your video')
2018-12-26 10:36:24 +01:00
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
}
2022-03-22 16:58:49 +01:00
async function checkVideoStudioEditionIsFinished (options: CheckerBaseParams & {
videoName: string
shortUUID: string
checkType: CheckerType
}) {
const { videoName, shortUUID } = options
2022-03-22 16:58:49 +01:00
const notificationType = UserNotificationType.MY_VIDEO_STUDIO_EDITION_FINISHED
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
checkVideo(notification.video, videoName, shortUUID)
checkActor(notification.video.channel)
} else {
expect(notification.video).to.satisfy(v => v === undefined || v.name !== videoName)
}
}
function emailNotificationFinder (email: object) {
const text: string = email['text']
return text.includes(shortUUID) && text.includes('Edition of your video')
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
}
async function checkMyVideoImportIsFinished (options: CheckerBaseParams & {
videoName: string
shortUUID: string
url: string
success: boolean
checkType: CheckerType
}) {
const { videoName, shortUUID, url, success } = options
const notificationType = success ? UserNotificationType.MY_VIDEO_IMPORT_SUCCESS : UserNotificationType.MY_VIDEO_IMPORT_ERROR
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === '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, shortUUID)
} else {
expect(notification.videoImport).to.satisfy(i => i === undefined || i.targetUrl !== url)
}
}
function emailNotificationFinder (email: object) {
2020-01-31 16:56:52 +01:00
const text: string = email['text']
const toFind = success ? ' finished' : ' error'
return text.includes(url) && text.includes(toFind)
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
2018-12-26 10:36:24 +01:00
}
2023-01-19 09:28:29 +01:00
// ---------------------------------------------------------------------------
async function checkUserRegistered (options: CheckerBaseParams & {
username: string
checkType: CheckerType
}) {
const { username } = options
const notificationType = UserNotificationType.NEW_USER_REGISTRATION
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
2022-05-25 09:10:20 +02:00
checkActor(notification.account, { withAvatar: false })
expect(notification.account.name).to.equal(username)
} else {
expect(notification).to.satisfy(n => n.type !== notificationType || n.account.name !== username)
}
}
function emailNotificationFinder (email: object) {
2020-01-31 16:56:52 +01:00
const text: string = email['text']
return text.includes(' registered.') && text.includes(username)
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
}
2023-01-19 09:28:29 +01:00
async function checkRegistrationRequest (options: CheckerBaseParams & {
username: string
registrationReason: string
checkType: CheckerType
}) {
const { username, registrationReason } = options
const notificationType = UserNotificationType.NEW_USER_REGISTRATION_REQUEST
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
expect(notification.registration.username).to.equal(username)
} else {
expect(notification).to.satisfy(n => n.type !== notificationType || n.registration.username !== username)
}
}
function emailNotificationFinder (email: object) {
const text: string = email['text']
return text.includes(' wants to register ') && text.includes(username) && text.includes(registrationReason)
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
}
// ---------------------------------------------------------------------------
async function checkNewActorFollow (options: CheckerBaseParams & {
followType: 'channel' | 'account'
followerName: string
followerDisplayName: string
followingDisplayName: string
checkType: CheckerType
}) {
const { followType, followerName, followerDisplayName, followingDisplayName } = options
const notificationType = UserNotificationType.NEW_FOLLOW
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === '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)
2019-01-21 15:58:07 +01:00
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 emailNotificationFinder (email: object) {
2020-01-31 16:56:52 +01:00
const text: string = email['text']
return text.includes(followType) && text.includes(followingDisplayName) && text.includes(followerDisplayName)
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
}
async function checkNewInstanceFollower (options: CheckerBaseParams & {
followerHost: string
checkType: CheckerType
}) {
const { followerHost } = options
const notificationType = UserNotificationType.NEW_INSTANCE_FOLLOWER
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
2022-05-25 09:10:20 +02:00
checkActor(notification.actorFollow.follower, { withAvatar: false })
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 emailNotificationFinder (email: object) {
2020-01-31 16:56:52 +01:00
const text: string = email['text']
return text.includes('instance has a new follower') && text.includes(followerHost)
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
}
async function checkAutoInstanceFollowing (options: CheckerBaseParams & {
followerHost: string
followingHost: string
checkType: CheckerType
}) {
const { followerHost, followingHost } = options
const notificationType = UserNotificationType.AUTO_INSTANCE_FOLLOWING
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
const following = notification.actorFollow.following
2022-05-25 09:10:20 +02:00
checkActor(following, { withAvatar: false })
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 emailNotificationFinder (email: object) {
2020-01-31 16:56:52 +01:00
const text: string = email['text']
return text.includes(' automatically followed a new instance') && text.includes(followingHost)
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
}
async function checkCommentMention (options: CheckerBaseParams & {
shortUUID: string
commentId: number
threadId: number
byAccountDisplayName: string
checkType: CheckerType
}) {
const { shortUUID, commentId, threadId, byAccountDisplayName } = options
const notificationType = UserNotificationType.COMMENT_MENTION
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === '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, shortUUID)
} else {
expect(notification).to.satisfy(n => n.type !== notificationType || n.comment.id !== commentId)
}
}
function emailNotificationFinder (email: object) {
2020-01-31 16:56:52 +01:00
const text: string = email['text']
return text.includes(' mentioned ') && text.includes(shortUUID) && text.includes(byAccountDisplayName)
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
}
2018-12-26 10:36:24 +01:00
let lastEmailCount = 0
2020-01-31 16:56:52 +01:00
async function checkNewCommentOnMyVideo (options: CheckerBaseParams & {
shortUUID: string
commentId: number
threadId: number
checkType: CheckerType
}) {
const { server, shortUUID, commentId, threadId, checkType, emails } = options
2018-12-26 10:36:24 +01:00
const notificationType = UserNotificationType.NEW_COMMENT_ON_MY_VIDEO
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
2018-12-26 10:36:24 +01:00
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, shortUUID)
2018-12-26 10:36:24 +01:00
} else {
expect(notification).to.satisfy((n: UserNotification) => {
return n === undefined || n.comment === undefined || n.comment.id !== commentId
})
}
}
2022-12-09 11:14:47 +01:00
const commentUrl = `${server.url}/w/${shortUUID};threadId=${threadId}`
2020-01-31 16:56:52 +01:00
function emailNotificationFinder (email: object) {
2020-01-31 16:56:52 +01:00
return email['text'].indexOf(commentUrl) !== -1
2018-12-26 10:36:24 +01:00
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
2018-12-26 10:36:24 +01:00
if (checkType === 'presence') {
2018-12-26 10:36:24 +01:00
// We cannot detect email duplicates, so check we received another email
expect(emails).to.have.length.above(lastEmailCount)
lastEmailCount = emails.length
2018-12-26 10:36:24 +01:00
}
}
async function checkNewVideoAbuseForModerators (options: CheckerBaseParams & {
shortUUID: string
videoName: string
checkType: CheckerType
}) {
const { shortUUID, videoName } = options
2020-07-08 15:51:46 +02:00
const notificationType = UserNotificationType.NEW_ABUSE_FOR_MODERATORS
2018-12-26 10:36:24 +01:00
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
2018-12-26 10:36:24 +01:00
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
2020-07-01 16:05:30 +02:00
expect(notification.abuse.id).to.be.a('number')
checkVideo(notification.abuse.video, videoName, shortUUID)
2018-12-26 10:36:24 +01:00
} else {
expect(notification).to.satisfy((n: UserNotification) => {
return n === undefined || n.abuse === undefined || n.abuse.video.shortUUID !== shortUUID
2018-12-26 10:36:24 +01:00
})
}
}
function emailNotificationFinder (email: object) {
2020-01-31 16:56:52 +01:00
const text = email['text']
return text.indexOf(shortUUID) !== -1 && text.indexOf('abuse') !== -1
2018-12-26 10:36:24 +01:00
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
2018-12-26 10:36:24 +01:00
}
async function checkNewAbuseMessage (options: CheckerBaseParams & {
abuseId: number
message: string
toEmail: string
checkType: CheckerType
}) {
const { abuseId, message, toEmail } = options
const notificationType = UserNotificationType.ABUSE_NEW_MESSAGE
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
expect(notification.abuse.id).to.equal(abuseId)
} else {
expect(notification).to.satisfy((n: UserNotification) => {
return n === undefined || n.type !== notificationType || n.abuse === undefined || n.abuse.id !== abuseId
})
}
}
function emailNotificationFinder (email: object) {
const text = email['text']
const to = email['to'].filter(t => t.address === toEmail)
return text.indexOf(message) !== -1 && to.length !== 0
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
}
async function checkAbuseStateChange (options: CheckerBaseParams & {
abuseId: number
state: AbuseState
checkType: CheckerType
}) {
const { abuseId, state } = options
const notificationType = UserNotificationType.ABUSE_STATE_CHANGE
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
expect(notification.abuse.id).to.equal(abuseId)
expect(notification.abuse.state).to.equal(state)
} else {
expect(notification).to.satisfy((n: UserNotification) => {
return n === undefined || n.abuse === undefined || n.abuse.id !== abuseId
})
}
}
function emailNotificationFinder (email: object) {
const text = email['text']
const contains = state === AbuseState.ACCEPTED
? ' accepted'
: ' rejected'
return text.indexOf(contains) !== -1
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
}
async function checkNewCommentAbuseForModerators (options: CheckerBaseParams & {
shortUUID: string
videoName: string
checkType: CheckerType
}) {
const { shortUUID, videoName } = options
2020-07-08 15:51:46 +02:00
const notificationType = UserNotificationType.NEW_ABUSE_FOR_MODERATORS
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
2020-07-08 15:51:46 +02:00
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
expect(notification.abuse.id).to.be.a('number')
checkVideo(notification.abuse.comment.video, videoName, shortUUID)
2020-07-08 15:51:46 +02:00
} else {
expect(notification).to.satisfy((n: UserNotification) => {
return n === undefined || n.abuse === undefined || n.abuse.comment.video.shortUUID !== shortUUID
2020-07-08 15:51:46 +02:00
})
}
}
function emailNotificationFinder (email: object) {
const text = email['text']
return text.indexOf(shortUUID) !== -1 && text.indexOf('abuse') !== -1
2020-07-08 15:51:46 +02:00
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
2020-07-08 15:51:46 +02:00
}
async function checkNewAccountAbuseForModerators (options: CheckerBaseParams & {
displayName: string
checkType: CheckerType
}) {
const { displayName } = options
2020-07-08 15:51:46 +02:00
const notificationType = UserNotificationType.NEW_ABUSE_FOR_MODERATORS
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
2020-07-08 15:51:46 +02:00
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
expect(notification.abuse.id).to.be.a('number')
expect(notification.abuse.account.displayName).to.equal(displayName)
} else {
expect(notification).to.satisfy((n: UserNotification) => {
return n === undefined || n.abuse === undefined || n.abuse.account.displayName !== displayName
})
}
}
function emailNotificationFinder (email: object) {
const text = email['text']
return text.indexOf(displayName) !== -1 && text.indexOf('abuse') !== -1
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
2020-07-08 15:51:46 +02:00
}
async function checkVideoAutoBlacklistForModerators (options: CheckerBaseParams & {
shortUUID: string
videoName: string
checkType: CheckerType
}) {
const { shortUUID, videoName } = options
const notificationType = UserNotificationType.VIDEO_AUTO_BLACKLIST_FOR_MODERATORS
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === '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, shortUUID)
} else {
expect(notification).to.satisfy((n: UserNotification) => {
return n === undefined || n.video === undefined || n.video.shortUUID !== shortUUID
})
}
}
function emailNotificationFinder (email: object) {
2020-01-31 16:56:52 +01:00
const text = email['text']
return text.indexOf(shortUUID) !== -1 && email['text'].indexOf('video-auto-blacklist/list') !== -1
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
}
async function checkNewBlacklistOnMyVideo (options: CheckerBaseParams & {
shortUUID: string
videoName: string
2018-12-26 10:36:24 +01:00
blacklistType: 'blacklist' | 'unblacklist'
}) {
const { videoName, shortUUID, blacklistType } = options
2018-12-26 10:36:24 +01:00
const notificationType = blacklistType === 'blacklist'
? UserNotificationType.BLACKLIST_ON_MY_VIDEO
: UserNotificationType.UNBLACKLIST_ON_MY_VIDEO
function notificationChecker (notification: UserNotification) {
2018-12-26 10:36:24 +01:00
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
const video = blacklistType === 'blacklist' ? notification.videoBlacklist.video : notification.video
checkVideo(video, videoName, shortUUID)
2018-12-26 10:36:24 +01:00
}
function emailNotificationFinder (email: object) {
2020-01-31 16:56:52 +01:00
const text = email['text']
const blacklistText = blacklistType === 'blacklist'
? 'blacklisted'
: 'unblacklisted'
return text.includes(shortUUID) && text.includes(blacklistText)
2018-12-26 10:36:24 +01:00
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder, checkType: 'presence' })
2018-12-26 10:36:24 +01:00
}
async function checkNewPeerTubeVersion (options: CheckerBaseParams & {
latestVersion: string
checkType: CheckerType
}) {
const { latestVersion } = options
2021-03-11 16:54:52 +01:00
const notificationType = UserNotificationType.NEW_PEERTUBE_VERSION
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
2021-03-11 16:54:52 +01:00
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
expect(notification.peertube).to.exist
expect(notification.peertube.latestVersion).to.equal(latestVersion)
} else {
expect(notification).to.satisfy((n: UserNotification) => {
return n === undefined || n.peertube === undefined || n.peertube.latestVersion !== latestVersion
})
}
}
function emailNotificationFinder (email: object) {
const text = email['text']
return text.includes(latestVersion)
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
2021-03-11 16:54:52 +01:00
}
async function checkNewPluginVersion (options: CheckerBaseParams & {
pluginType: PluginType
pluginName: string
checkType: CheckerType
}) {
const { pluginName, pluginType } = options
2021-03-11 16:54:52 +01:00
const notificationType = UserNotificationType.NEW_PLUGIN_VERSION
function notificationChecker (notification: UserNotification, checkType: CheckerType) {
if (checkType === 'presence') {
2021-03-11 16:54:52 +01:00
expect(notification).to.not.be.undefined
expect(notification.type).to.equal(notificationType)
expect(notification.plugin.name).to.equal(pluginName)
expect(notification.plugin.type).to.equal(pluginType)
} else {
expect(notification).to.satisfy((n: UserNotification) => {
return n === undefined || n.plugin === undefined || n.plugin.name !== pluginName
})
}
}
function emailNotificationFinder (email: object) {
const text = email['text']
return text.includes(pluginName)
}
await checkNotification({ ...options, notificationChecker, emailNotificationFinder })
2021-03-11 16:54:52 +01:00
}
async function prepareNotificationsTest (serversCount = 3, overrideConfigArg: any = {}) {
2020-06-16 15:52:05 +02:00
const userNotifications: UserNotification[] = []
const adminNotifications: UserNotification[] = []
const adminNotificationsServer2: UserNotification[] = []
const emails: object[] = []
const port = await MockSmtpServer.Instance.collectEmails(emails)
const overrideConfig = {
2023-01-19 09:28:29 +01:00
...ConfigCommand.getEmailOverrideConfig(port),
2020-07-08 15:51:46 +02:00
signup: {
limit: 20
2020-06-16 15:52:05 +02:00
}
}
2021-07-16 09:47:51 +02:00
const servers = await createMultipleServers(serversCount, Object.assign(overrideConfig, overrideConfigArg))
2020-06-16 15:52:05 +02:00
await setAccessTokensToServers(servers)
2022-05-03 11:38:07 +02:00
await setDefaultVideoChannel(servers)
await setDefaultChannelAvatar(servers)
await setDefaultAccountAvatar(servers)
2020-06-16 16:36:02 +02:00
2022-05-03 11:38:07 +02:00
if (servers[1]) {
await servers[1].config.enableStudio()
await servers[1].config.enableLive({ allowReplay: true, transcoding: false })
}
2020-06-16 16:36:02 +02:00
if (serversCount > 1) {
await doubleFollow(servers[0], servers[1])
}
2020-06-16 15:52:05 +02:00
2021-07-13 14:23:01 +02:00
const user = { username: 'user_1', password: 'super password' }
2021-07-16 09:04:35 +02:00
await servers[0].users.create({ ...user, videoQuota: 10 * 1000 * 1000 })
const userAccessToken = await servers[0].login.getAccessToken(user)
2020-06-16 15:52:05 +02:00
2021-07-16 09:04:35 +02:00
await servers[0].notifications.updateMySettings({ token: userAccessToken, settings: getAllNotificationsSettings() })
2022-05-25 09:10:20 +02:00
await servers[0].users.updateMyAvatar({ token: userAccessToken, fixture: 'avatar.png' })
await servers[0].channels.updateImage({ channelName: 'user_1_channel', token: userAccessToken, fixture: 'avatar.png', type: 'avatar' })
2021-07-16 09:04:35 +02:00
await servers[0].notifications.updateMySettings({ settings: getAllNotificationsSettings() })
2020-06-16 15:52:05 +02:00
if (serversCount > 1) {
2021-07-16 09:04:35 +02:00
await servers[1].notifications.updateMySettings({ settings: getAllNotificationsSettings() })
2020-06-16 15:52:05 +02:00
}
{
2021-07-16 09:04:35 +02:00
const socket = servers[0].socketIO.getUserNotificationSocket({ token: userAccessToken })
2020-06-16 15:52:05 +02:00
socket.on('new-notification', n => userNotifications.push(n))
}
{
2021-07-16 09:04:35 +02:00
const socket = servers[0].socketIO.getUserNotificationSocket()
2020-06-16 15:52:05 +02:00
socket.on('new-notification', n => adminNotifications.push(n))
}
if (serversCount > 1) {
2021-07-16 09:04:35 +02:00
const socket = servers[1].socketIO.getUserNotificationSocket()
2020-06-16 15:52:05 +02:00
socket.on('new-notification', n => adminNotificationsServer2.push(n))
}
2021-07-16 09:04:35 +02:00
const { videoChannels } = await servers[0].users.getMyInfo()
2021-07-13 14:23:01 +02:00
const channelId = videoChannels[0].id
2020-06-16 15:52:05 +02:00
return {
userNotifications,
adminNotifications,
adminNotificationsServer2,
userAccessToken,
emails,
servers,
2023-01-19 09:28:29 +01:00
channelId,
baseOverrideConfig: overrideConfig
2020-06-16 15:52:05 +02:00
}
}
2018-12-26 10:36:24 +01:00
// ---------------------------------------------------------------------------
export {
2021-07-09 16:23:01 +02:00
getAllNotificationsSettings,
2018-12-26 10:36:24 +01:00
CheckerBaseParams,
CheckerType,
checkMyVideoImportIsFinished,
checkUserRegistered,
checkAutoInstanceFollowing,
checkVideoIsPublished,
2018-12-26 10:36:24 +01:00
checkNewVideoFromSubscription,
checkNewActorFollow,
2018-12-26 10:36:24 +01:00
checkNewCommentOnMyVideo,
checkNewBlacklistOnMyVideo,
checkCommentMention,
2018-12-26 10:36:24 +01:00
checkNewVideoAbuseForModerators,
checkVideoAutoBlacklistForModerators,
checkNewAbuseMessage,
checkAbuseStateChange,
2020-06-16 15:52:05 +02:00
checkNewInstanceFollower,
2020-07-08 15:51:46 +02:00
prepareNotificationsTest,
checkNewCommentAbuseForModerators,
2021-03-11 16:54:52 +01:00
checkNewAccountAbuseForModerators,
checkNewPeerTubeVersion,
checkNewPluginVersion,
2023-01-19 09:28:29 +01:00
checkVideoStudioEditionIsFinished,
checkRegistrationRequest
2018-12-26 10:36:24 +01:00
}
// ---------------------------------------------------------------------------
async function checkNotification (options: CheckerBaseParams & {
notificationChecker: (notification: UserNotification, checkType: CheckerType) => void
emailNotificationFinder: (email: object) => boolean
checkType: CheckerType
}) {
const { server, token, checkType, notificationChecker, emailNotificationFinder, socketNotifications, emails } = options
const check = options.check || { web: true, mail: true }
if (check.web) {
2022-07-13 11:58:01 +02:00
const notification = await server.notifications.getLatest({ token })
if (notification || checkType !== 'absence') {
notificationChecker(notification, checkType)
}
const socketNotification = socketNotifications.find(n => {
try {
notificationChecker(n, 'presence')
return true
} catch {
return false
}
})
if (checkType === 'presence') {
const obj = inspect(socketNotifications, { depth: 5 })
expect(socketNotification, 'The socket notification is absent when it should be present. ' + obj).to.not.be.undefined
} else {
const obj = inspect(socketNotification, { depth: 5 })
expect(socketNotification, 'The socket notification is present when it should not be present. ' + obj).to.be.undefined
}
}
if (check.mail) {
// Last email
const email = emails
.slice()
.reverse()
.find(e => emailNotificationFinder(e))
if (checkType === 'presence') {
const texts = emails.map(e => e.text)
expect(email, 'The email is absent when is should be present. ' + inspect(texts)).to.not.be.undefined
} else {
expect(email, 'The email is present when is should not be present. ' + inspect(email)).to.be.undefined
}
}
}
function checkVideo (video: any, videoName?: string, shortUUID?: string) {
if (videoName) {
expect(video.name).to.be.a('string')
expect(video.name).to.not.be.empty
expect(video.name).to.equal(videoName)
}
if (shortUUID) {
expect(video.shortUUID).to.be.a('string')
expect(video.shortUUID).to.not.be.empty
expect(video.shortUUID).to.equal(shortUUID)
}
expect(video.id).to.be.a('number')
}
2022-05-25 09:10:20 +02:00
function checkActor (actor: any, options: { withAvatar?: boolean } = {}) {
const { withAvatar = true } = options
expect(actor.displayName).to.be.a('string')
expect(actor.displayName).to.not.be.empty
expect(actor.host).to.not.be.undefined
2022-05-25 09:10:20 +02:00
if (withAvatar) {
expect(actor.avatars).to.be.an('array')
expect(actor.avatars).to.have.lengthOf(2)
expect(actor.avatars[0].path).to.exist.and.not.empty
}
}
function checkComment (comment: any, commentId: number, threadId: number) {
expect(comment.id).to.equal(commentId)
expect(comment.threadId).to.equal(threadId)
}