debian-mirror-gitlab/doc/development/fe_guide/axios.md

77 lines
2.2 KiB
Markdown
Raw Normal View History

2018-03-17 18:26:18 +05:30
# Axios
2019-10-12 21:52:04 +05:30
2020-05-24 23:13:21 +05:30
We use [axios](https://github.com/axios/axios) to communicate with the server in Vue applications and most new code.
2018-03-17 18:26:18 +05:30
In order to guarantee all defaults are set you *should not use `axios` directly*, you should import `axios` from `axios_utils`.
## CSRF token
2019-10-12 21:52:04 +05:30
2018-03-17 18:26:18 +05:30
All our request require a CSRF token.
2020-05-24 23:13:21 +05:30
To guarantee this token is set, we are importing [axios](https://github.com/axios/axios), setting the token, and exporting `axios` .
2018-03-17 18:26:18 +05:30
This exported module should be used instead of directly using `axios` to ensure the token is set.
## Usage
2019-10-12 21:52:04 +05:30
2018-03-17 18:26:18 +05:30
```javascript
import axios from './lib/utils/axios_utils';
axios.get(url)
.then((response) => {
// `data` is the response that was provided by the server
const data = response.data;
// `headers` the headers that the server responded with
// All header names are lower cased
const paginationData = response.headers;
})
.catch(() => {
//handle the error
});
```
## Mock axios response in tests
2020-05-24 23:13:21 +05:30
To help us mock the responses we are using [axios-mock-adapter](https://github.com/ctimmerm/axios-mock-adapter).
2018-03-17 18:26:18 +05:30
2020-05-24 23:13:21 +05:30
Advantages over [`spyOn()`](https://jasmine.github.io/api/edge/global.html#spyOn):
2018-03-17 18:26:18 +05:30
- no need to create response objects
- does not allow call through (which we want to avoid)
2019-12-04 20:38:33 +05:30
- simple API to test error cases
2018-03-17 18:26:18 +05:30
- provides `replyOnce()` to allow for different responses
2020-05-24 23:13:21 +05:30
We have also decided against using [axios interceptors](https://github.com/axios/axios#interceptors) because they are not suitable for mocking.
2018-03-17 18:26:18 +05:30
### Example
```javascript
import axios from '~/lib/utils/axios_utils';
import MockAdapter from 'axios-mock-adapter';
let mock;
beforeEach(() => {
// This sets the mock adapter on the default instance
mock = new MockAdapter(axios);
// Mock any GET request to /users
// arguments for reply are (status, data, headers)
mock.onGet('/users').reply(200, {
users: [
{ id: 1, name: 'John Smith' }
]
});
});
afterEach(() => {
mock.restore();
});
```
### Mock poll requests in tests with axios
Because polling function requires a header object, we need to always include an object as the third argument:
```javascript
mock.onGet('/users').reply(200, { foo: 'bar' }, {});
```