2 QUnit
.module( 'mediawiki.api', QUnit
.newMwEnvironment( {
4 this.server
= this.sandbox
.useFakeServer();
5 this.server
.respondImmediately
= true;
9 function sequence( responses
) {
11 return function ( request
) {
12 var response
= responses
[ i
];
15 request
.respond
.apply( request
, response
);
20 function sequenceBodies( status
, headers
, bodies
) {
21 jQuery
.each( bodies
, function ( i
, body
) {
22 bodies
[ i
] = [ status
, headers
, body
];
24 return sequence( bodies
);
27 QUnit
.test( 'get()', function ( assert
) {
28 var api
= new mw
.Api();
30 this.server
.respond( [ 200, { 'Content-Type': 'application/json' }, '[]' ] );
32 return api
.get( {} ).then( function ( data
) {
33 assert
.deepEqual( data
, [], 'If request succeeds without errors, resolve deferred' );
37 QUnit
.test( 'post()', function ( assert
) {
38 var api
= new mw
.Api();
40 this.server
.respond( [ 200, { 'Content-Type': 'application/json' }, '[]' ] );
42 return api
.post( {} ).then( function ( data
) {
43 assert
.deepEqual( data
, [], 'Simple POST request' );
47 QUnit
.test( 'API error', function ( assert
) {
48 var api
= new mw
.Api();
50 this.server
.respond( [ 200, { 'Content-Type': 'application/json' },
51 '{ "error": { "code": "unknown_action" } }'
54 api
.get( { action
: 'doesntexist' } )
55 .fail( function ( errorCode
) {
56 assert
.equal( errorCode
, 'unknown_action', 'API error should reject the deferred' );
58 .always( assert
.async() );
61 QUnit
.test( 'FormData support', function ( assert
) {
62 var api
= new mw
.Api();
64 this.server
.respond( function ( request
) {
65 if ( window
.FormData
) {
66 assert
.ok( !request
.url
.match( /action=/ ), 'Request has no query string' );
67 assert
.ok( request
.requestBody
instanceof FormData
, 'Request uses FormData body' );
69 assert
.ok( !request
.url
.match( /action=test/ ), 'Request has no query string' );
70 assert
.equal( request
.requestBody
, 'action=test&format=json', 'Request uses query string body' );
72 request
.respond( 200, { 'Content-Type': 'application/json' }, '[]' );
75 return api
.post( { action
: 'test' }, { contentType
: 'multipart/form-data' } );
78 QUnit
.test( 'Converting arrays to pipe-separated', function ( assert
) {
79 var api
= new mw
.Api();
81 this.server
.respond( function ( request
) {
82 assert
.ok( request
.url
.match( /test=foo%7Cbar%7Cbaz/ ), 'Pipe-separated value was submitted' );
83 request
.respond( 200, { 'Content-Type': 'application/json' }, '[]' );
86 return api
.get( { test
: [ 'foo', 'bar', 'baz' ] } );
89 QUnit
.test( 'Omitting false booleans', function ( assert
) {
90 var api
= new mw
.Api();
92 this.server
.respond( function ( request
) {
93 assert
.ok( !request
.url
.match( /foo/ ), 'foo query parameter is not present' );
94 assert
.ok( request
.url
.match( /bar=true/ ), 'bar query parameter is present with value true' );
95 request
.respond( 200, { 'Content-Type': 'application/json' }, '[]' );
98 return api
.get( { foo
: false, bar
: true } );
101 QUnit
.test( 'getToken() - cached', function ( assert
) {
102 var api
= new mw
.Api(),
105 // Get editToken for local wiki, this should not make
106 // a request as it should be retrieved from mw.user.tokens.
107 return api
.getToken( 'edit' )
108 .then( function ( token
) {
109 assert
.ok( token
.length
, 'Got a token' );
110 }, function ( err
) {
111 assert
.equal( '', err
, 'API error' );
114 assert
.equal( test
.server
.requests
.length
, 0, 'Requests made' );
118 QUnit
.test( 'getToken() - uncached', function ( assert
) {
119 var api
= new mw
.Api(),
120 firstDone
= assert
.async(),
121 secondDone
= assert
.async();
123 this.server
.respondWith( /type=testuncached/, [ 200, { 'Content-Type': 'application/json' },
124 '{ "query": { "tokens": { "testuncachedtoken": "good" } } }'
127 // Get a token of a type that isn't prepopulated by user.tokens.
128 // Could use "block" or "delete" here, but those could in theory
129 // be added to user.tokens, use a fake one instead.
130 api
.getToken( 'testuncached' )
131 .done( function ( token
) {
132 assert
.equal( token
, 'good', 'The token' );
134 .fail( function ( err
) {
135 assert
.equal( err
, '', 'API error' );
137 .always( firstDone
);
139 api
.getToken( 'testuncached' )
140 .done( function ( token
) {
141 assert
.equal( token
, 'good', 'The cached token' );
143 .fail( function ( err
) {
144 assert
.equal( err
, '', 'API error' );
146 .always( secondDone
);
148 assert
.equal( this.server
.requests
.length
, 1, 'Requests made' );
151 QUnit
.test( 'getToken() - error', function ( assert
) {
152 var api
= new mw
.Api();
154 this.server
.respondWith( /type=testerror/, sequenceBodies( 200, { 'Content-Type': 'application/json' },
156 '{ "error": { "code": "bite-me", "info": "Smite me, O Mighty Smiter" } }',
157 '{ "query": { "tokens": { "testerrortoken": "good" } } }'
161 // Don't cache error (bug 65268)
162 return api
.getToken( 'testerror' )
163 .then( null, function ( err
) {
164 assert
.equal( err
, 'bite-me', 'Expected error' );
166 return api
.getToken( 'testerror' );
168 .then( function ( token
) {
169 assert
.equal( token
, 'good', 'The token' );
173 QUnit
.test( 'getToken() - deprecated', function ( assert
) {
174 // Cache API endpoint from default to avoid cachehit in mw.user.tokens
175 var api
= new mw
.Api( { ajax
: { url
: '/postWithToken/api.php' } } ),
178 this.server
.respondWith( /type=csrf/, [ 200, { 'Content-Type': 'application/json' },
179 '{ "query": { "tokens": { "csrftoken": "csrfgood" } } }'
182 // Get a token of a type that is in the legacy map.
183 return api
.getToken( 'email' )
184 .done( function ( token
) {
185 assert
.equal( token
, 'csrfgood', 'Token' );
187 .fail( function ( err
) {
188 assert
.equal( err
, '', 'API error' );
190 .always( function () {
191 assert
.equal( test
.server
.requests
.length
, 1, 'Requests made' );
195 QUnit
.test( 'badToken()', function ( assert
) {
196 var api
= new mw
.Api(),
199 this.server
.respondWith( /type=testbad/, sequenceBodies( 200, { 'Content-Type': 'application/json' },
201 '{ "query": { "tokens": { "testbadtoken": "bad" } } }',
202 '{ "query": { "tokens": { "testbadtoken": "good" } } }'
206 return api
.getToken( 'testbad' )
208 api
.badToken( 'testbad' );
209 return api
.getToken( 'testbad' );
211 .then( function ( token
) {
212 assert
.equal( token
, 'good', 'The token' );
213 assert
.equal( test
.server
.requests
.length
, 2, 'Requests made' );
218 QUnit
.test( 'badToken( legacy )', function ( assert
) {
219 var api
= new mw
.Api( { ajax
: { url
: '/badTokenLegacy/api.php' } } ),
222 this.server
.respondWith( /type=csrf/, sequenceBodies( 200, { 'Content-Type': 'application/json' },
224 '{ "query": { "tokens": { "csrftoken": "badlegacy" } } }',
225 '{ "query": { "tokens": { "csrftoken": "goodlegacy" } } }'
229 return api
.getToken( 'options' )
231 api
.badToken( 'options' );
232 return api
.getToken( 'options' );
234 .then( function ( token
) {
235 assert
.equal( token
, 'goodlegacy', 'The token' );
236 assert
.equal( test
.server
.requests
.length
, 2, 'Request made' );
241 QUnit
.test( 'postWithToken( tokenType, params )', function ( assert
) {
242 var api
= new mw
.Api( { ajax
: { url
: '/postWithToken/api.php' } } );
244 this.server
.respondWith( 'GET', /type=testpost/, [ 200, { 'Content-Type': 'application/json' },
245 '{ "query": { "tokens": { "testposttoken": "good" } } }'
247 this.server
.respondWith( 'POST', /api/, function ( request
) {
248 if ( request
.requestBody
.match( /token=good/ ) ) {
249 request
.respond( 200, { 'Content-Type': 'application/json' },
250 '{ "example": { "foo": "quux" } }'
255 return api
.postWithToken( 'testpost', { action
: 'example', key
: 'foo' } )
256 .then( function ( data
) {
257 assert
.deepEqual( data
, { example
: { foo
: 'quux' } } );
261 QUnit
.test( 'postWithToken( tokenType, params with assert )', function ( assert
) {
262 var api
= new mw
.Api( { ajax
: { url
: '/postWithToken/api.php' } } ),
265 this.server
.respondWith( /assert=user/, [ 200, { 'Content-Type': 'application/json' },
266 '{ "error": { "code": "assertuserfailed", "info": "Assertion failed" } }'
269 return api
.postWithToken( 'testassertpost', { action
: 'example', key
: 'foo', assert
: 'user' } )
270 // Cast error to success and vice versa
271 .then( function ( ) {
272 return $.Deferred().reject( 'Unexpected success' );
273 }, function ( errorCode
) {
274 assert
.equal( errorCode
, 'assertuserfailed', 'getToken fails assert' );
275 return $.Deferred().resolve();
278 assert
.equal( test
.server
.requests
.length
, 1, 'Requests made' );
282 QUnit
.test( 'postWithToken( tokenType, params, ajaxOptions )', function ( assert
) {
283 var api
= new mw
.Api(),
286 this.server
.respond( [ 200, { 'Content-Type': 'application/json' }, '{ "example": "quux" }' ] );
288 return api
.postWithToken( 'edit',
289 { action
: 'example' },
297 assert
.equal( test
.server
.requests
[ 0 ].requestHeaders
[ 'X-Foo' ], 'Bar', 'Header sent' );
299 return api
.postWithToken( 'edit',
300 { action
: 'example' },
302 assert
.ok( false, 'This parameter cannot be a callback' );
306 .then( function ( data
) {
307 assert
.equal( data
.example
, 'quux' );
309 assert
.equal( test
.server
.requests
.length
, 2, 'Request made' );
313 QUnit
.test( 'postWithToken() - badtoken', function ( assert
) {
314 var api
= new mw
.Api();
316 this.server
.respondWith( /type=testbadtoken/, sequenceBodies( 200, { 'Content-Type': 'application/json' },
318 '{ "query": { "tokens": { "testbadtokentoken": "bad" } } }',
319 '{ "query": { "tokens": { "testbadtokentoken": "good" } } }'
322 this.server
.respondWith( 'POST', /api/, function ( request
) {
323 if ( request
.requestBody
.match( /token=bad/ ) ) {
324 request
.respond( 200, { 'Content-Type': 'application/json' },
325 '{ "error": { "code": "badtoken" } }'
328 if ( request
.requestBody
.match( /token=good/ ) ) {
329 request
.respond( 200, { 'Content-Type': 'application/json' },
330 '{ "example": { "foo": "quux" } }'
335 // - Request: new token -> bad
336 // - Request: action=example -> badtoken error
337 // - Request: new token -> good
338 // - Request: action=example -> success
339 return api
.postWithToken( 'testbadtoken', { action
: 'example', key
: 'foo' } )
340 .then( function ( data
) {
341 assert
.deepEqual( data
, { example
: { foo
: 'quux' } } );
345 QUnit
.test( 'postWithToken() - badtoken-cached', function ( assert
) {
349 this.server
.respondWith( /type=testonce/, sequenceBodies( 200, { 'Content-Type': 'application/json' },
351 '{ "query": { "tokens": { "testoncetoken": "good-A" } } }',
352 '{ "query": { "tokens": { "testoncetoken": "good-B" } } }'
355 sequenceA
= sequenceBodies( 200, { 'Content-Type': 'application/json' },
357 '{ "example": { "value": "A" } }',
358 '{ "error": { "code": "badtoken" } }'
361 this.server
.respondWith( 'POST', /api/, function ( request
) {
362 if ( request
.requestBody
.match( /token=good-A/ ) ) {
363 sequenceA( request
);
364 } else if ( request
.requestBody
.match( /token=good-B/ ) ) {
365 request
.respond( 200, { 'Content-Type': 'application/json' },
366 '{ "example": { "value": "B" } }'
371 // - Request: new token -> A
372 // - Request: action=example
373 return api
.postWithToken( 'testonce', { action
: 'example', key
: 'foo' } )
374 .then( function ( data
) {
375 assert
.deepEqual( data
, { example
: { value
: 'A' } } );
377 // - Request: action=example w/ token A -> badtoken error
378 // - Request: new token -> B
379 // - Request: action=example w/ token B -> success
380 return api
.postWithToken( 'testonce', { action
: 'example', key
: 'bar' } );
382 .then( function ( data
) {
383 assert
.deepEqual( data
, { example
: { value
: 'B' } } );
387 QUnit
.module( 'mediawiki.api (2)', {
390 requests
= this.requests
= [];
391 this.api
= new mw
.Api();
392 this.sandbox
.stub( jQuery
, 'ajax', function () {
393 var request
= $.extend( {
394 abort
: self
.sandbox
.spy()
396 requests
.push( request
);
402 QUnit
.test( '#abort', 3, function ( assert
) {
410 assert
.ok( this.requests
.length
=== 2, 'Check both requests triggered' );
411 $.each( this.requests
, function ( i
, request
) {
412 assert
.ok( request
.abort
.calledOnce
, 'abort request number ' + i
);
415 }( mediaWiki
, jQuery
) );