PeerTube/server/tests/api/check-params/user-notifications.ts

296 lines
8.3 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 'mocha'
2020-11-19 08:58:34 +01:00
import { io } from 'socket.io-client'
2018-12-26 10:36:24 +01:00
import {
2019-04-24 15:10:37 +02:00
cleanupTests,
flushAndRunServer,
2018-12-26 10:36:24 +01:00
immutableAssign,
makeGetRequest,
makePostBodyRequest,
makePutBodyRequest,
ServerInfo,
setAccessTokensToServers,
wait
} from '../../../../shared/extra-utils'
2018-12-26 10:36:24 +01:00
import {
checkBadCountPagination,
checkBadSortPagination,
checkBadStartPagination
} from '../../../../shared/extra-utils/requests/check-api-params'
2018-12-26 10:36:24 +01:00
import { UserNotificationSetting, UserNotificationSettingValue } from '../../../../shared/models/users'
import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
2018-12-26 10:36:24 +01:00
describe('Test user notifications API validators', function () {
let server: ServerInfo
// ---------------------------------------------------------------
before(async function () {
this.timeout(30000)
2019-04-24 10:53:40 +02:00
server = await flushAndRunServer(1)
2018-12-26 10:36:24 +01:00
await setAccessTokensToServers([ server ])
})
describe('When listing my notifications', function () {
const path = '/api/v1/users/me/notifications'
it('Should fail with a bad start pagination', async function () {
await checkBadStartPagination(server.url, path, server.accessToken)
})
it('Should fail with a bad count pagination', async function () {
await checkBadCountPagination(server.url, path, server.accessToken)
})
it('Should fail with an incorrect sort', async function () {
await checkBadSortPagination(server.url, path, server.accessToken)
})
it('Should fail with an incorrect unread parameter', async function () {
await makeGetRequest({
url: server.url,
path,
query: {
unread: 'toto'
},
token: server.accessToken,
statusCodeExpected: HttpStatusCode.OK_200
})
})
2018-12-26 10:36:24 +01:00
it('Should fail with a non authenticated user', async function () {
await makeGetRequest({
url: server.url,
path,
statusCodeExpected: HttpStatusCode.UNAUTHORIZED_401
2018-12-26 10:36:24 +01:00
})
})
it('Should succeed with the correct parameters', async function () {
await makeGetRequest({
url: server.url,
path,
token: server.accessToken,
statusCodeExpected: HttpStatusCode.OK_200
2018-12-26 10:36:24 +01:00
})
})
})
describe('When marking as read my notifications', function () {
const path = '/api/v1/users/me/notifications/read'
it('Should fail with wrong ids parameters', async function () {
await makePostBodyRequest({
url: server.url,
path,
fields: {
ids: [ 'hello' ]
},
token: server.accessToken,
statusCodeExpected: HttpStatusCode.BAD_REQUEST_400
2018-12-26 10:36:24 +01:00
})
2019-01-08 11:26:41 +01:00
await makePostBodyRequest({
url: server.url,
path,
fields: {
ids: [ ]
},
token: server.accessToken,
statusCodeExpected: HttpStatusCode.BAD_REQUEST_400
2019-01-08 11:26:41 +01:00
})
2018-12-26 10:36:24 +01:00
await makePostBodyRequest({
url: server.url,
path,
fields: {
ids: 5
},
token: server.accessToken,
statusCodeExpected: HttpStatusCode.BAD_REQUEST_400
2018-12-26 10:36:24 +01:00
})
})
it('Should fail with a non authenticated user', async function () {
await makePostBodyRequest({
url: server.url,
path,
fields: {
ids: [ 5 ]
},
statusCodeExpected: HttpStatusCode.UNAUTHORIZED_401
2018-12-26 10:36:24 +01:00
})
})
it('Should succeed with the correct parameters', async function () {
await makePostBodyRequest({
url: server.url,
path,
fields: {
ids: [ 5 ]
},
token: server.accessToken,
statusCodeExpected: HttpStatusCode.NO_CONTENT_204
2018-12-26 10:36:24 +01:00
})
})
})
2019-01-08 11:26:41 +01:00
describe('When marking as read my notifications', function () {
const path = '/api/v1/users/me/notifications/read-all'
it('Should fail with a non authenticated user', async function () {
await makePostBodyRequest({
url: server.url,
path,
statusCodeExpected: HttpStatusCode.UNAUTHORIZED_401
2019-01-08 11:26:41 +01:00
})
})
it('Should succeed with the correct parameters', async function () {
await makePostBodyRequest({
url: server.url,
path,
token: server.accessToken,
statusCodeExpected: HttpStatusCode.NO_CONTENT_204
2019-01-08 11:26:41 +01:00
})
})
})
2018-12-26 10:36:24 +01:00
describe('When updating my notification settings', function () {
const path = '/api/v1/users/me/notification-settings'
const correctFields: UserNotificationSetting = {
2019-01-08 11:26:41 +01:00
newVideoFromSubscription: UserNotificationSettingValue.WEB,
newCommentOnMyVideo: UserNotificationSettingValue.WEB,
2020-07-07 14:34:16 +02:00
abuseAsModerator: UserNotificationSettingValue.WEB,
videoAutoBlacklistAsModerator: UserNotificationSettingValue.WEB,
2019-01-08 11:26:41 +01:00
blacklistOnMyVideo: UserNotificationSettingValue.WEB,
myVideoImportFinished: UserNotificationSettingValue.WEB,
myVideoPublished: UserNotificationSettingValue.WEB,
commentMention: UserNotificationSettingValue.WEB,
newFollow: UserNotificationSettingValue.WEB,
newUserRegistration: UserNotificationSettingValue.WEB,
newInstanceFollower: UserNotificationSettingValue.WEB,
autoInstanceFollowing: UserNotificationSettingValue.WEB,
abuseNewMessage: UserNotificationSettingValue.WEB,
abuseStateChange: UserNotificationSettingValue.WEB
2018-12-26 10:36:24 +01:00
}
it('Should fail with missing fields', async function () {
await makePutBodyRequest({
url: server.url,
path,
token: server.accessToken,
2019-01-08 11:26:41 +01:00
fields: { newVideoFromSubscription: UserNotificationSettingValue.WEB },
statusCodeExpected: HttpStatusCode.BAD_REQUEST_400
2018-12-26 10:36:24 +01:00
})
})
it('Should fail with incorrect field values', async function () {
{
const fields = immutableAssign(correctFields, { newCommentOnMyVideo: 15 })
await makePutBodyRequest({
url: server.url,
path,
token: server.accessToken,
fields,
statusCodeExpected: HttpStatusCode.BAD_REQUEST_400
2018-12-26 10:36:24 +01:00
})
}
{
const fields = immutableAssign(correctFields, { newCommentOnMyVideo: 'toto' })
await makePutBodyRequest({
url: server.url,
path,
fields,
token: server.accessToken,
statusCodeExpected: HttpStatusCode.BAD_REQUEST_400
2018-12-26 10:36:24 +01:00
})
}
})
it('Should fail with a non authenticated user', async function () {
await makePutBodyRequest({
url: server.url,
path,
fields: correctFields,
statusCodeExpected: HttpStatusCode.UNAUTHORIZED_401
2018-12-26 10:36:24 +01:00
})
})
it('Should succeed with the correct parameters', async function () {
await makePutBodyRequest({
url: server.url,
path,
token: server.accessToken,
fields: correctFields,
statusCodeExpected: HttpStatusCode.NO_CONTENT_204
2018-12-26 10:36:24 +01:00
})
})
})
describe('When connecting to my notification socket', function () {
2020-11-19 08:58:34 +01:00
2018-12-26 10:36:24 +01:00
it('Should fail with no token', function (next) {
2019-04-24 15:10:37 +02:00
const socket = io(`http://localhost:${server.port}/user-notifications`, { reconnection: false })
2018-12-26 10:36:24 +01:00
2020-11-19 08:58:34 +01:00
socket.once('connect_error', function () {
2018-12-26 10:36:24 +01:00
socket.disconnect()
next()
})
socket.on('connect', () => {
socket.disconnect()
next(new Error('Connected with a missing token.'))
})
})
it('Should fail with an invalid token', function (next) {
2019-04-24 15:10:37 +02:00
const socket = io(`http://localhost:${server.port}/user-notifications`, {
2018-12-26 10:36:24 +01:00
query: { accessToken: 'bad_access_token' },
reconnection: false
})
2020-11-19 08:58:34 +01:00
socket.once('connect_error', function () {
2018-12-26 10:36:24 +01:00
socket.disconnect()
next()
})
socket.on('connect', () => {
socket.disconnect()
next(new Error('Connected with an invalid token.'))
})
})
it('Should success with the correct token', function (next) {
2019-04-24 15:10:37 +02:00
const socket = io(`http://localhost:${server.port}/user-notifications`, {
2018-12-26 10:36:24 +01:00
query: { accessToken: server.accessToken },
reconnection: false
})
2020-11-05 10:27:02 +01:00
function errorListener (err) {
2018-12-26 10:36:24 +01:00
next(new Error('Error in connection: ' + err))
2020-11-05 10:27:02 +01:00
}
2020-11-19 08:58:34 +01:00
socket.on('connect_error', errorListener)
2018-12-26 10:36:24 +01:00
2020-11-19 08:58:34 +01:00
socket.once('connect', async () => {
2018-12-26 10:36:24 +01:00
socket.disconnect()
await wait(500)
next()
})
})
})
2019-04-24 15:10:37 +02:00
after(async function () {
await cleanupTests([ server ])
2018-12-26 10:36:24 +01:00
})
})