rename blacklist to block/blocklist, merge block and auto-block views

[github/Chocobozzz/PeerTube.git] / shared / extra-utils / users / user-notifications.ts

diff --git a/shared/extra-utils/users/user-notifications.ts b/shared/extra-utils/users/user-notifications.ts
index 495ff80d9b61c450a6f02534a566a4f49ab0c012..6f85bd450c8787b5001c00f4219a69c5b650555a 100644 (file)
--- a/shared/extra-utils/users/user-notifications.ts
+++ b/shared/extra-utils/users/user-notifications.ts
@@ -1,4 +1,4 @@
-/* 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'
@@ -54,6 +54,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'
 
@@ -77,7 +78,7 @@ type CheckerBaseParams = {
   server: ServerInfo
   emails: object[]
   socketNotifications: UserNotification[]
-  token: string,
+  token: string
   check?: { web: boolean, mail: boolean }
 }
 
@@ -109,10 +110,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 is 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 is should not be present. ' + obj).to.be.undefined
     }
   }
 
@@ -124,9 +125,9 @@ async function checkNotification (
                       .find(e => emailNotificationFinder(e))
 
     if (checkType === 'presence') {
-      expect(email, 'The email is absent. ' + inspect(base.emails)).to.not.be.undefined
+      expect(email, 'The email is absent when is should be present. ' + inspect(base.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 +172,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 +195,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 +226,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 +251,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 +280,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 +291,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 +320,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 +385,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
 
@@ -380,12 +414,13 @@ async function checkNewCommentOnMyVideo (base: CheckerBaseParams, uuid: string,
     }
   }
 
-  const commentUrl = `http://localhost:9001/videos/watch/${uuid};threadId=${threadId}`
-  function emailFinder (email: object) {
-    return email[ 'text' ].indexOf(commentUrl) !== -1
+  const commentUrl = `http://localhost:${base.server.port}/videos/watch/${uuid};threadId=${threadId}`
+
+  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
@@ -411,24 +446,24 @@ async function checkNewVideoAbuseForModerators (base: CheckerBaseParams, videoUU
     }
   }
 
-  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) {
-  const notificationType = UserNotificationType.VIDEO_AUTO_BLACKLIST_FOR_MODERATORS
+  const notificationType = UserNotificationType.VIDEO_AUTO_BLOCK_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.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 +471,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 (
@@ -451,8 +486,8 @@ async function checkNewBlacklistOnMyVideo (
   blacklistType: 'blacklist' | 'unblacklist'
 ) {
   const notificationType = blacklistType === 'blacklist'
-    ? UserNotificationType.BLACKLIST_ON_MY_VIDEO
-    : UserNotificationType.UNBLACKLIST_ON_MY_VIDEO
+    ? UserNotificationType.BLOCK_ON_MY_VIDEO
+    : UserNotificationType.UNBLOCK_ON_MY_VIDEO
 
   function notificationChecker (notification: UserNotification) {
     expect(notification).to.not.be.undefined
@@ -463,12 +498,12 @@ 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')
 }
 
 // ---------------------------------------------------------------------------
@@ -480,6 +515,7 @@ export {
   markAsReadAllNotifications,
   checkMyVideoImportIsFinished,
   checkUserRegistered,
+  checkAutoInstanceFollowing,
   checkVideoIsPublished,
   checkNewVideoFromSubscription,
   checkNewActorFollow,