]>
Commit | Line | Data |
---|---|---|
736c64ca | 1 | import autocannon, { printResult } from 'autocannon' |
10874276 | 2 | import { program } from 'commander' |
4abbeff5 | 3 | import { writeJson } from 'fs-extra' |
12edc149 | 4 | import { Video, VideoPrivacy } from '@shared/models' |
6afc0d37 | 5 | import { createMultipleServers, doubleFollow, killallServers, PeerTubeServer, setAccessTokensToServers } from '@shared/server-commands' |
4abbeff5 | 6 | |
6afc0d37 C |
7 | let servers: PeerTubeServer[] |
8 | // First server | |
254d3579 | 9 | let server: PeerTubeServer |
4abbeff5 C |
10 | let video: Video |
11 | let threadId: number | |
12 | ||
10874276 C |
13 | program |
14 | .option('-o, --outfile [outfile]', 'Outfile') | |
15 | .option('--grep [string]', 'Filter tests you want to execute') | |
16 | .description('Run API REST benchmark') | |
17 | .parse(process.argv) | |
18 | ||
19 | const options = program.opts() | |
20 | ||
21 | const outfile = options.outfile | |
4abbeff5 C |
22 | |
23 | run() | |
24 | .catch(err => console.error(err)) | |
25 | .finally(() => { | |
6afc0d37 | 26 | if (servers) return killallServers(servers) |
4abbeff5 C |
27 | }) |
28 | ||
29 | function buildAuthorizationHeader () { | |
30 | return { | |
31 | Authorization: 'Bearer ' + server.accessToken | |
32 | } | |
33 | } | |
34 | ||
0ce8d34e C |
35 | function buildAPHeader () { |
36 | return { | |
37 | Accept: 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"' | |
38 | } | |
39 | } | |
40 | ||
6afc0d37 C |
41 | function buildJSONHeader () { |
42 | return { | |
43 | 'Content-Type': 'application/json' | |
44 | } | |
45 | } | |
46 | ||
4abbeff5 C |
47 | async function run () { |
48 | console.log('Preparing server...') | |
49 | ||
50 | await prepare() | |
51 | ||
52 | const tests = [ | |
0ce8d34e C |
53 | { |
54 | title: 'AP - account peertube', | |
55 | path: '/accounts/peertube', | |
56 | headers: buildAPHeader(), | |
47099aba | 57 | expecter: (body, status) => { |
68a4b1e5 | 58 | return status === 200 && body.startsWith('{"@context":') |
0ce8d34e C |
59 | } |
60 | }, | |
61 | { | |
62 | title: 'AP - video', | |
63 | path: '/videos/watch/' + video.uuid, | |
64 | headers: buildAPHeader(), | |
47099aba | 65 | expecter: (body, status) => { |
68a4b1e5 | 66 | return status === 200 && body.startsWith('{"@context":') |
0ce8d34e C |
67 | } |
68 | }, | |
69 | { | |
70 | title: 'Misc - webfinger peertube', | |
71 | path: '/.well-known/webfinger?resource=acct:peertube@' + server.host, | |
47099aba C |
72 | expecter: (body, status) => { |
73 | return status === 200 && body.startsWith('{"subject":') | |
0ce8d34e C |
74 | } |
75 | }, | |
4abbeff5 C |
76 | { |
77 | title: 'API - unread notifications', | |
78 | path: '/api/v1/users/me/notifications?start=0&count=0&unread=true', | |
79 | headers: buildAuthorizationHeader(), | |
47099aba C |
80 | expecter: (_body, status) => { |
81 | return status === 200 | |
4abbeff5 C |
82 | } |
83 | }, | |
84 | { | |
85 | title: 'API - me', | |
86 | path: '/api/v1/users/me', | |
87 | headers: buildAuthorizationHeader(), | |
47099aba C |
88 | expecter: (body, status) => { |
89 | return status === 200 && body.startsWith('{"id":') | |
4abbeff5 C |
90 | } |
91 | }, | |
92 | { | |
93 | title: 'API - videos list', | |
94 | path: '/api/v1/videos', | |
47099aba C |
95 | expecter: (body, status) => { |
96 | return status === 200 && body.startsWith('{"total":10') | |
4abbeff5 C |
97 | } |
98 | }, | |
99 | { | |
100 | title: 'API - video get', | |
101 | path: '/api/v1/videos/' + video.uuid, | |
47099aba C |
102 | expecter: (body, status) => { |
103 | return status === 200 && body.startsWith('{"id":') | |
4abbeff5 C |
104 | } |
105 | }, | |
106 | { | |
107 | title: 'API - video captions', | |
108 | path: '/api/v1/videos/' + video.uuid + '/captions', | |
47099aba C |
109 | expecter: (body, status) => { |
110 | return status === 200 && body.startsWith('{"total":4') | |
4abbeff5 C |
111 | } |
112 | }, | |
113 | { | |
114 | title: 'API - video threads', | |
115 | path: '/api/v1/videos/' + video.uuid + '/comment-threads', | |
47099aba C |
116 | expecter: (body, status) => { |
117 | return status === 200 && body.startsWith('{"total":10') | |
4abbeff5 C |
118 | } |
119 | }, | |
120 | { | |
121 | title: 'API - video replies', | |
122 | path: '/api/v1/videos/' + video.uuid + '/comment-threads/' + threadId, | |
47099aba C |
123 | expecter: (body, status) => { |
124 | return status === 200 && body.startsWith('{"comment":{') | |
4abbeff5 C |
125 | } |
126 | }, | |
127 | { | |
128 | title: 'HTML - video watch', | |
129 | path: '/videos/watch/' + video.uuid, | |
47099aba C |
130 | expecter: (body, status) => { |
131 | return status === 200 && body.includes('<title>my super') | |
4abbeff5 C |
132 | } |
133 | }, | |
0ce8d34e C |
134 | { |
135 | title: 'HTML - video embed', | |
136 | path: '/videos/embed/' + video.uuid, | |
47099aba C |
137 | expecter: (body, status) => { |
138 | return status === 200 && body.includes('embed') | |
0ce8d34e C |
139 | } |
140 | }, | |
4abbeff5 C |
141 | { |
142 | title: 'HTML - homepage', | |
143 | path: '/', | |
47099aba C |
144 | expecter: (_body, status) => { |
145 | return status === 200 | |
4abbeff5 C |
146 | } |
147 | }, | |
148 | { | |
149 | title: 'API - config', | |
150 | path: '/api/v1/config', | |
47099aba | 151 | expecter: (body, status) => { |
cf0c8ee5 | 152 | return status === 200 && body.startsWith('{"client":') |
4abbeff5 | 153 | } |
6afc0d37 C |
154 | }, |
155 | { | |
b2111066 | 156 | title: 'API - views with token', |
6afc0d37 C |
157 | method: 'PUT', |
158 | headers: { | |
159 | ...buildAuthorizationHeader(), | |
160 | ...buildJSONHeader() | |
161 | }, | |
162 | body: JSON.stringify({ currentTime: 2 }), | |
b2111066 | 163 | path: '/api/v1/videos/' + video.uuid + '/views', |
6afc0d37 C |
164 | expecter: (body, status) => { |
165 | return status === 204 | |
166 | } | |
167 | }, | |
168 | { | |
b2111066 | 169 | title: 'API - views without token', |
6afc0d37 | 170 | method: 'POST', |
b2111066 C |
171 | headers: buildJSONHeader(), |
172 | body: JSON.stringify({ currentTime: 2 }), | |
6afc0d37 C |
173 | path: '/api/v1/videos/' + video.uuid + '/views', |
174 | expecter: (body, status) => { | |
175 | return status === 204 | |
176 | } | |
4abbeff5 | 177 | } |
10874276 C |
178 | ].filter(t => { |
179 | if (!options.grep) return true | |
180 | ||
181 | return t.title.includes(options.grep) | |
182 | }) | |
4abbeff5 C |
183 | |
184 | const finalResult: any[] = [] | |
185 | ||
186 | for (const test of tests) { | |
187 | console.log('Running against %s.', test.path) | |
188 | const testResult = await runBenchmark(test) | |
189 | ||
190 | Object.assign(testResult, { title: test.title, path: test.path }) | |
191 | finalResult.push(testResult) | |
192 | ||
736c64ca | 193 | console.log(printResult(testResult)) |
4abbeff5 C |
194 | } |
195 | ||
196 | if (outfile) await writeJson(outfile, finalResult) | |
197 | } | |
198 | ||
199 | function runBenchmark (options: { | |
200 | path: string | |
6afc0d37 C |
201 | method?: string |
202 | body?: string | |
4abbeff5 C |
203 | headers?: { [ id: string ]: string } |
204 | expecter: Function | |
205 | }) { | |
4e5e072c | 206 | const { method = 'GET', path, body, expecter, headers } = options |
4abbeff5 C |
207 | |
208 | return new Promise((res, rej) => { | |
47099aba | 209 | autocannon({ |
4abbeff5 | 210 | url: server.url + path, |
ba2684ce | 211 | method, |
6afc0d37 | 212 | body, |
4abbeff5 C |
213 | connections: 20, |
214 | headers, | |
215 | pipelining: 1, | |
47099aba C |
216 | duration: 10, |
217 | requests: [ | |
218 | { | |
219 | onResponse: (status, body) => { | |
220 | if (expecter(body, status) !== true) { | |
221 | console.error('Expected result failed.', { body, status }) | |
222 | throw new Error('Invalid expectation') | |
223 | } | |
224 | } | |
225 | } | |
226 | ] | |
4abbeff5 C |
227 | }, (err, result) => { |
228 | if (err) return rej(err) | |
229 | ||
230 | return res(result) | |
231 | }) | |
4abbeff5 C |
232 | }) |
233 | } | |
234 | ||
235 | async function prepare () { | |
6afc0d37 | 236 | servers = await createMultipleServers(3, { |
4abbeff5 C |
237 | rates_limit: { |
238 | api: { | |
239 | max: 5_000_000 | |
240 | } | |
241 | } | |
242 | }) | |
6afc0d37 C |
243 | server = servers[0] |
244 | ||
245 | await setAccessTokensToServers(servers) | |
246 | await doubleFollow(servers[0], servers[1]) | |
247 | await doubleFollow(servers[0], servers[2]) | |
4abbeff5 | 248 | |
d23dd9fb | 249 | const attributes = { |
4abbeff5 C |
250 | name: 'my super video', |
251 | category: 2, | |
252 | nsfw: true, | |
253 | licence: 6, | |
254 | language: 'fr', | |
255 | privacy: VideoPrivacy.PUBLIC, | |
256 | support: 'please give me a coffee', | |
cc45cc9a | 257 | description: 'my super description\n'.repeat(10) + ' * list1\n * list 2\n * list 3', |
4abbeff5 C |
258 | tags: [ 'tag1', 'tag2', 'tag3' ] |
259 | } | |
260 | ||
261 | for (let i = 0; i < 10; i++) { | |
89d241a7 | 262 | await server.videos.upload({ attributes: { ...attributes, name: 'my super video ' + i } }) |
4abbeff5 C |
263 | } |
264 | ||
89d241a7 | 265 | const { data } = await server.videos.list() |
d23dd9fb | 266 | video = data.find(v => v.name === 'my super video 1') |
4abbeff5 C |
267 | |
268 | for (let i = 0; i < 10; i++) { | |
269 | const text = 'my super first comment' | |
89d241a7 | 270 | const created = await server.comments.createThread({ videoId: video.id, text }) |
12edc149 | 271 | threadId = created.id |
4abbeff5 C |
272 | |
273 | const text1 = 'my super answer to thread 1' | |
89d241a7 | 274 | const child = await server.comments.addReply({ videoId: video.id, toCommentId: threadId, text: text1 }) |
4abbeff5 C |
275 | |
276 | const text2 = 'my super answer to answer of thread 1' | |
89d241a7 | 277 | await server.comments.addReply({ videoId: video.id, toCommentId: child.id, text: text2 }) |
4abbeff5 C |
278 | |
279 | const text3 = 'my second answer to thread 1' | |
89d241a7 | 280 | await server.comments.addReply({ videoId: video.id, toCommentId: threadId, text: text3 }) |
4abbeff5 C |
281 | } |
282 | ||
283 | for (const caption of [ 'ar', 'fr', 'en', 'zh' ]) { | |
c63830f1 | 284 | await server.captions.add({ |
4abbeff5 C |
285 | language: caption, |
286 | videoId: video.id, | |
287 | fixture: 'subtitle-good2.vtt' | |
288 | }) | |
289 | } | |
4abbeff5 | 290 | } |