aboutsummaryrefslogtreecommitdiffhomepage
path: root/server/tests/api/check-params/views.ts
blob: 84d31c5094b8f9cb8269cc78d48c3d43fcc64651 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */

import { HttpStatusCode, VideoPrivacy } from '@shared/models'
import {
  cleanupTests,
  createMultipleServers,
  doubleFollow,
  PeerTubeServer,
  setAccessTokensToServers,
  setDefaultVideoChannel
} from '@shared/server-commands'

describe('Test videos views', function () {
  let servers: PeerTubeServer[]
  let liveVideoId: string
  let videoId: string
  let remoteVideoId: string
  let userAccessToken: string

  before(async function () {
    this.timeout(120000)

    servers = await createMultipleServers(2)
    await setAccessTokensToServers(servers)
    await setDefaultVideoChannel(servers)

    await servers[0].config.enableLive({ allowReplay: false, transcoding: false });

    ({ uuid: videoId } = await servers[0].videos.quickUpload({ name: 'video' }));
    ({ uuid: remoteVideoId } = await servers[1].videos.quickUpload({ name: 'video' }));
    ({ uuid: liveVideoId } = await servers[0].live.create({
      fields: {
        name: 'live',
        privacy: VideoPrivacy.PUBLIC,
        channelId: servers[0].store.channel.id
      }
    }))

    userAccessToken = await servers[0].users.generateUserAndToken('user')

    await doubleFollow(servers[0], servers[1])
  })

  describe('When viewing a video', async function () {

    // TODO: implement it when we'll remove backward compatibility in REST API
    it('Should fail without current time')

    it('Should fail with an invalid current time', async function () {
      await servers[0].views.view({ id: videoId, currentTime: -1, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
      await servers[0].views.view({ id: videoId, currentTime: 10, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
    })

    it('Should succeed with correct parameters', async function () {
      await servers[0].views.view({ id: videoId, currentTime: 1 })
    })
  })

  describe('When getting overall stats', function () {

    it('Should fail with a remote video', async function () {
      await servers[0].videoStats.getOverallStats({ videoId: remoteVideoId, expectedStatus: HttpStatusCode.FORBIDDEN_403 })
    })

    it('Should fail without token', async function () {
      await servers[0].videoStats.getOverallStats({ videoId, token: null, expectedStatus: HttpStatusCode.UNAUTHORIZED_401 })
    })

    it('Should fail with another token', async function () {
      await servers[0].videoStats.getOverallStats({
        videoId,
        token: userAccessToken,
        expectedStatus: HttpStatusCode.FORBIDDEN_403
      })
    })

    it('Should fail with an invalid start date', async function () {
      await servers[0].videoStats.getOverallStats({
        videoId,
        startDate: 'fake' as any,
        endDate: new Date().toISOString(),
        expectedStatus: HttpStatusCode.BAD_REQUEST_400
      })
    })

    it('Should fail with an invalid end date', async function () {
      await servers[0].videoStats.getOverallStats({
        videoId,
        startDate: new Date().toISOString(),
        endDate: 'fake' as any,
        expectedStatus: HttpStatusCode.BAD_REQUEST_400
      })
    })

    it('Should succeed with the correct parameters', async function () {
      await servers[0].videoStats.getOverallStats({
        videoId,
        startDate: new Date().toISOString(),
        endDate: new Date().toISOString()
      })
    })
  })

  describe('When getting timeserie stats', function () {

    it('Should fail with a remote video', async function () {
      await servers[0].videoStats.getTimeserieStats({
        videoId: remoteVideoId,
        metric: 'viewers',
        expectedStatus: HttpStatusCode.FORBIDDEN_403
      })
    })

    it('Should fail without token', async function () {
      await servers[0].videoStats.getTimeserieStats({
        videoId,
        token: null,
        metric: 'viewers',
        expectedStatus: HttpStatusCode.UNAUTHORIZED_401
      })
    })

    it('Should fail with another token', async function () {
      await servers[0].videoStats.getTimeserieStats({
        videoId,
        token: userAccessToken,
        metric: 'viewers',
        expectedStatus: HttpStatusCode.FORBIDDEN_403
      })
    })

    it('Should fail with an invalid metric', async function () {
      await servers[0].videoStats.getTimeserieStats({ videoId, metric: 'hello' as any, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
    })

    it('Should fail with an invalid start date', async function () {
      await servers[0].videoStats.getTimeserieStats({
        videoId,
        metric: 'viewers',
        startDate: 'fake' as any,
        endDate: new Date(),
        expectedStatus: HttpStatusCode.BAD_REQUEST_400
      })
    })

    it('Should fail with an invalid end date', async function () {
      await servers[0].videoStats.getTimeserieStats({
        videoId,
        metric: 'viewers',
        startDate: new Date(),
        endDate: 'fake' as any,
        expectedStatus: HttpStatusCode.BAD_REQUEST_400
      })
    })

    it('Should fail if start date is specified but not end date', async function () {
      await servers[0].videoStats.getTimeserieStats({
        videoId,
        metric: 'viewers',
        startDate: new Date(),
        expectedStatus: HttpStatusCode.BAD_REQUEST_400
      })
    })

    it('Should fail if end date is specified but not start date', async function () {
      await servers[0].videoStats.getTimeserieStats({
        videoId,
        metric: 'viewers',
        endDate: new Date(),
        expectedStatus: HttpStatusCode.BAD_REQUEST_400
      })
    })

    it('Should fail with a too big interval', async function () {
      await servers[0].videoStats.getTimeserieStats({
        videoId,
        metric: 'viewers',
        startDate: new Date('2000-04-07T08:31:57.126Z'),
        endDate: new Date(),
        expectedStatus: HttpStatusCode.BAD_REQUEST_400
      })
    })

    it('Should succeed with the correct parameters', async function () {
      await servers[0].videoStats.getTimeserieStats({ videoId, metric: 'viewers' })
    })
  })

  describe('When getting retention stats', function () {

    it('Should fail with a remote video', async function () {
      await servers[0].videoStats.getRetentionStats({
        videoId: remoteVideoId,
        expectedStatus: HttpStatusCode.FORBIDDEN_403
      })
    })

    it('Should fail without token', async function () {
      await servers[0].videoStats.getRetentionStats({
        videoId,
        token: null,
        expectedStatus: HttpStatusCode.UNAUTHORIZED_401
      })
    })

    it('Should fail with another token', async function () {
      await servers[0].videoStats.getRetentionStats({
        videoId,
        token: userAccessToken,
        expectedStatus: HttpStatusCode.FORBIDDEN_403
      })
    })

    it('Should fail on live video', async function () {
      await servers[0].videoStats.getRetentionStats({ videoId: liveVideoId, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
    })

    it('Should succeed with the correct parameters', async function () {
      await servers[0].videoStats.getRetentionStats({ videoId })
    })
  })

  after(async function () {
    await cleanupTests(servers)
  })
})