]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - shared/extra-utils/users/user-notifications.ts
Add migrations
[github/Chocobozzz/PeerTube.git] / shared / extra-utils / users / user-notifications.ts
index f7de542bfe731b87c9ce94bc493cab7ea2e0a161..4a5bc30fe05b14318c66d64c4df3745f1259ef2b 100644 (file)
@@ -1,10 +1,15 @@
-/* tslint:disable:no-unused-expression */
+/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
 
-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'
+import { UserNotification, UserNotificationSetting, UserNotificationSettingValue, UserNotificationType } from '../../models/users'
+import { MockSmtpServer } from '../miscs/email'
+import { makeGetRequest, makePostBodyRequest, makePutBodyRequest } from '../requests/requests'
+import { doubleFollow } from '../server/follows'
+import { flushAndRunMultipleServers, ServerInfo } from '../server/servers'
+import { getUserNotificationSocket } from '../socket/socket-io'
+import { setAccessTokensToServers, userLogin } from './login'
+import { createUser, getMyUserInformation } from './users'
 
 function updateMyNotificationSettings (url: string, token: string, settings: UserNotificationSetting, statusCodeExpected = 204) {
   const path = '/api/v1/users/me/notification-settings'
@@ -54,6 +59,7 @@ function markAsReadNotifications (url: string, token: string, ids: number[], sta
     statusCodeExpected
   })
 }
+
 function markAsReadAllNotifications (url: string, token: string, statusCodeExpected = 204) {
   const path = '/api/v1/users/me/notifications/read-all'
 
@@ -75,9 +81,9 @@ async function getLastNotification (serverUrl: string, accessToken: string) {
 
 type CheckerBaseParams = {
   server: ServerInfo
-  emails: object[]
+  emails: any[]
   socketNotifications: UserNotification[]
-  token: string,
+  token: string
   check?: { web: boolean, mail: boolean }
 }
 
@@ -109,10 +115,10 @@ async function checkNotification (
 
     if (checkType === 'presence') {
       const obj = inspect(base.socketNotifications, { depth: 5 })
-      expect(socketNotification, 'The socket notification is absent. ' + obj).to.not.be.undefined
+      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. ' + obj).to.be.undefined
+      expect(socketNotification, 'The socket notification is present when it should not be present. ' + obj).to.be.undefined
     }
   }
 
@@ -124,9 +130,10 @@ async function checkNotification (
                       .find(e => emailNotificationFinder(e))
 
     if (checkType === 'presence') {
-      expect(email, 'The email is absent. ' + inspect(base.emails)).to.not.be.undefined
+      const emails = base.emails.map(e => e.text)
+      expect(email, 'The email is absent when is should be present. ' + inspect(emails)).to.not.be.undefined
     } else {
-      expect(email, 'The email is present. ' + inspect(email)).to.be.undefined
+      expect(email, 'The email is present when is should not be present. ' + inspect(email)).to.be.undefined
     }
   }
 }
@@ -171,12 +178,12 @@ async function checkNewVideoFromSubscription (base: CheckerBaseParams, videoName
     }
   }
 
-  function emailFinder (email: object) {
-    const text = email[ 'text' ]
+  function emailNotificationFinder (email: object) {
+    const text = email['text']
     return text.indexOf(videoUUID) !== -1 && text.indexOf('Your subscription') !== -1
   }
 
-  await checkNotification(base, notificationChecker, emailFinder, type)
+  await checkNotification(base, notificationChecker, emailNotificationFinder, type)
 }
 
 async function checkVideoIsPublished (base: CheckerBaseParams, videoName: string, videoUUID: string, type: CheckerType) {
@@ -194,12 +201,12 @@ async function checkVideoIsPublished (base: CheckerBaseParams, videoName: string
     }
   }
 
-  function emailFinder (email: object) {
-    const text: string = email[ 'text' ]
+  function emailNotificationFinder (email: object) {
+    const text: string = email['text']
     return text.includes(videoUUID) && text.includes('Your video')
   }
 
-  await checkNotification(base, notificationChecker, emailFinder, type)
+  await checkNotification(base, notificationChecker, emailNotificationFinder, type)
 }
 
 async function checkMyVideoImportIsFinished (
@@ -225,14 +232,14 @@ async function checkMyVideoImportIsFinished (
     }
   }
 
-  function emailFinder (email: object) {
-    const text: string = email[ 'text' ]
+  function emailNotificationFinder (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)
+  await checkNotification(base, notificationChecker, emailNotificationFinder, type)
 }
 
 async function checkUserRegistered (base: CheckerBaseParams, username: string, type: CheckerType) {
@@ -250,13 +257,13 @@ async function checkUserRegistered (base: CheckerBaseParams, username: string, t
     }
   }
 
-  function emailFinder (email: object) {
-    const text: string = email[ 'text' ]
+  function emailNotificationFinder (email: object) {
+    const text: string = email['text']
 
-    return text.includes(' registered ') && text.includes(username)
+    return text.includes(' registered.') && text.includes(username)
   }
 
-  await checkNotification(base, notificationChecker, emailFinder, type)
+  await checkNotification(base, notificationChecker, emailNotificationFinder, type)
 }
 
 async function checkNewActorFollow (
@@ -279,8 +286,9 @@ async function checkNewActorFollow (
       expect(notification.actorFollow.follower.name).to.equal(followerName)
       expect(notification.actorFollow.follower.host).to.not.be.undefined
 
-      expect(notification.actorFollow.following.displayName).to.equal(followingDisplayName)
-      expect(notification.actorFollow.following.type).to.equal(followType)
+      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 ||
@@ -289,13 +297,13 @@ async function checkNewActorFollow (
     }
   }
 
-  function emailFinder (email: object) {
-    const text: string = email[ 'text' ]
+  function emailNotificationFinder (email: object) {
+    const text: string = email['text']
 
-    return text.includes('Your ' + followType) && text.includes(followingDisplayName) && text.includes(followerDisplayName)
+    return text.includes(followType) && text.includes(followingDisplayName) && text.includes(followerDisplayName)
   }
 
-  await checkNotification(base, notificationChecker, emailFinder, type)
+  await checkNotification(base, notificationChecker, emailNotificationFinder, type)
 }
 
 async function checkNewInstanceFollower (base: CheckerBaseParams, followerHost: string, type: CheckerType) {
@@ -318,13 +326,44 @@ async function checkNewInstanceFollower (base: CheckerBaseParams, followerHost:
     }
   }
 
-  function emailFinder (email: object) {
-    const text: string = email[ 'text' ]
+  function emailNotificationFinder (email: object) {
+    const text: string = email['text']
 
     return text.includes('instance has a new follower') && text.includes(followerHost)
   }
 
-  await checkNotification(base, notificationChecker, emailFinder, type)
+  await checkNotification(base, notificationChecker, emailNotificationFinder, 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 emailNotificationFinder (email: object) {
+    const text: string = email['text']
+
+    return text.includes(' automatically followed a new instance') && text.includes(followingHost)
+  }
+
+  await checkNotification(base, notificationChecker, emailNotificationFinder, type)
 }
 
 async function checkCommentMention (
@@ -352,16 +391,17 @@ async function checkCommentMention (
     }
   }
 
-  function emailFinder (email: object) {
-    const text: string = email[ 'text' ]
+  function emailNotificationFinder (email: object) {
+    const text: string = email['text']
 
     return text.includes(' mentioned ') && text.includes(uuid) && text.includes(byAccountDisplayName)
   }
 
-  await checkNotification(base, notificationChecker, emailFinder, type)
+  await checkNotification(base, notificationChecker, emailNotificationFinder, 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
 
@@ -381,11 +421,12 @@ async function checkNewCommentOnMyVideo (base: CheckerBaseParams, uuid: string,
   }
 
   const commentUrl = `http://localhost:${base.server.port}/videos/watch/${uuid};threadId=${threadId}`
-  function emailFinder (email: object) {
-    return email[ 'text' ].indexOf(commentUrl) !== -1
+
+  function emailNotificationFinder (email: object) {
+    return email['text'].indexOf(commentUrl) !== -1
   }
 
-  await checkNotification(base, notificationChecker, emailFinder, type)
+  await checkNotification(base, notificationChecker, emailNotificationFinder, type)
 
   if (type === 'presence') {
     // We cannot detect email duplicates, so check we received another email
@@ -402,21 +443,21 @@ async function checkNewVideoAbuseForModerators (base: CheckerBaseParams, videoUU
       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)
+      expect(notification.abuse.id).to.be.a('number')
+      checkVideo(notification.abuse.video, videoName, videoUUID)
     } else {
       expect(notification).to.satisfy((n: UserNotification) => {
-        return n === undefined || n.videoAbuse === undefined || n.videoAbuse.video.uuid !== videoUUID
+        return n === undefined || n.abuse === undefined || n.abuse.video.uuid !== videoUUID
       })
     }
   }
 
-  function emailFinder (email: object) {
-    const text = email[ 'text' ]
+  function emailNotificationFinder (email: object) {
+    const text = email['text']
     return text.indexOf(videoUUID) !== -1 && text.indexOf('abuse') !== -1
   }
 
-  await checkNotification(base, notificationChecker, emailFinder, type)
+  await checkNotification(base, notificationChecker, emailNotificationFinder, type)
 }
 
 async function checkVideoAutoBlacklistForModerators (base: CheckerBaseParams, videoUUID: string, videoName: string, type: CheckerType) {
@@ -427,8 +468,8 @@ async function checkVideoAutoBlacklistForModerators (base: CheckerBaseParams, vi
       expect(notification).to.not.be.undefined
       expect(notification.type).to.equal(notificationType)
 
-      expect(notification.video.id).to.be.a('number')
-      checkVideo(notification.video, videoName, videoUUID)
+      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
@@ -436,12 +477,12 @@ async function checkVideoAutoBlacklistForModerators (base: CheckerBaseParams, vi
     }
   }
 
-  function emailFinder (email: object) {
-    const text = email[ 'text' ]
-    return text.indexOf(videoUUID) !== -1 && email[ 'text' ].indexOf('video-auto-blacklist/list') !== -1
+  function emailNotificationFinder (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)
+  await checkNotification(base, notificationChecker, emailNotificationFinder, type)
 }
 
 async function checkNewBlacklistOnMyVideo (
@@ -463,12 +504,99 @@ async function checkNewBlacklistOnMyVideo (
     checkVideo(video, videoName, videoUUID)
   }
 
-  function emailFinder (email: object) {
-    const text = email[ 'text' ]
+  function emailNotificationFinder (email: object) {
+    const text = email['text']
     return text.indexOf(videoUUID) !== -1 && text.indexOf(' ' + blacklistType) !== -1
   }
 
-  await checkNotification(base, notificationChecker, emailFinder, 'presence')
+  await checkNotification(base, notificationChecker, emailNotificationFinder, 'presence')
+}
+
+function getAllNotificationsSettings () {
+  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,
+    autoInstanceFollowing: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL
+  } as UserNotificationSetting
+}
+
+async function prepareNotificationsTest (serversCount = 3) {
+  const userNotifications: UserNotification[] = []
+  const adminNotifications: UserNotification[] = []
+  const adminNotificationsServer2: UserNotification[] = []
+  const emails: object[] = []
+
+  const port = await MockSmtpServer.Instance.collectEmails(emails)
+
+  const overrideConfig = {
+    smtp: {
+      hostname: 'localhost',
+      port
+    }
+  }
+  const servers = await flushAndRunMultipleServers(serversCount, overrideConfig)
+
+  await setAccessTokensToServers(servers)
+
+  if (serversCount > 1) {
+    await doubleFollow(servers[0], servers[1])
+  }
+
+  const user = {
+    username: 'user_1',
+    password: 'super password'
+  }
+  await createUser({
+    url: servers[0].url,
+    accessToken: servers[0].accessToken,
+    username: user.username,
+    password: user.password,
+    videoQuota: 10 * 1000 * 1000
+  })
+  const userAccessToken = await userLogin(servers[0], user)
+
+  await updateMyNotificationSettings(servers[0].url, userAccessToken, getAllNotificationsSettings())
+  await updateMyNotificationSettings(servers[0].url, servers[0].accessToken, getAllNotificationsSettings())
+
+  if (serversCount > 1) {
+    await updateMyNotificationSettings(servers[1].url, servers[1].accessToken, getAllNotificationsSettings())
+  }
+
+  {
+    const socket = getUserNotificationSocket(servers[0].url, userAccessToken)
+    socket.on('new-notification', n => userNotifications.push(n))
+  }
+  {
+    const socket = getUserNotificationSocket(servers[0].url, servers[0].accessToken)
+    socket.on('new-notification', n => adminNotifications.push(n))
+  }
+
+  if (serversCount > 1) {
+    const socket = getUserNotificationSocket(servers[1].url, servers[1].accessToken)
+    socket.on('new-notification', n => adminNotificationsServer2.push(n))
+  }
+
+  const resChannel = await getMyUserInformation(servers[0].url, servers[0].accessToken)
+  const channelId = resChannel.body.videoChannels[0].id
+
+  return {
+    userNotifications,
+    adminNotifications,
+    adminNotificationsServer2,
+    userAccessToken,
+    emails,
+    servers,
+    channelId
+  }
 }
 
 // ---------------------------------------------------------------------------
@@ -476,10 +604,12 @@ async function checkNewBlacklistOnMyVideo (
 export {
   CheckerBaseParams,
   CheckerType,
+  getAllNotificationsSettings,
   checkNotification,
   markAsReadAllNotifications,
   checkMyVideoImportIsFinished,
   checkUserRegistered,
+  checkAutoInstanceFollowing,
   checkVideoIsPublished,
   checkNewVideoFromSubscription,
   checkNewActorFollow,
@@ -492,5 +622,6 @@ export {
   getUserNotifications,
   markAsReadNotifications,
   getLastNotification,
-  checkNewInstanceFollower
+  checkNewInstanceFollower,
+  prepareNotificationsTest
 }