gitlab-org--gitlab-foss/doc/development/fe_guide/axios.md

Axios

We use axios to communicate with the server in Vue applications and most new code.

In order to guarantee all defaults are set you should not use axios directly, you should import axios from axios_utils.

CSRF token

All our request require a CSRF token. To guarantee this token is set, we are importing axios, setting the token, and exporting axios .

This exported module should be used instead of directly using axios to ensure the token is set.

Usage

  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 on tests

To help us mock the responses we need we use axios-mock-adapter

  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.reset();
  });

Mock poll requests on tests with axios

Because polling function requires an header object, we need to always include an object as the third argument:

  mock.onGet('/users').reply(200, { foo: 'bar' }, {});