aboutsummaryrefslogtreecommitdiff
path: root/packages/web-util/src/utils/axios.ts
blob: c3831400919ca8e40c68cb6b6db5d858f68a7b93 (plain)
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
/*
 This file is part of GNU Taler
 (C) 2021 Taler Systems S.A.

 GNU Taler is free software; you can redistribute it and/or modify it under the
 terms of the GNU General Public License as published by the Free Software
 Foundation; either version 3, or (at your option) any later version.

 GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

 You should have received a copy of the GNU General Public License along with
 GNU Taler; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */

import axios, { AxiosPromise, AxiosRequestConfig } from "axios";

/**
 *
 * @author Sebastian Javier Marchano (sebasjm)
 */

//FIXME: remove this, since it is not used anymore
/**
 * @deprecated
 */
export let removeAxiosCancelToken = false;

export let axiosHandler = function doAxiosRequest(
  config: AxiosRequestConfig,
): AxiosPromise<any> {
  return axios(config);
};

const listOfHandlersToUseOnce = new Array<AxiosHandler>();

/**
 * Set this backend library to testing mode.
 * Instead of calling the axios library the @handler will be called
 *
 * @param handler callback that will mock axios
 */
export function setAxiosRequestAsTestingEnvironment(
  handler: AxiosHandler,
): void {
  removeAxiosCancelToken = true;
  axiosHandler = function defaultTestingHandler(config) {
    const currentHanlder = listOfHandlersToUseOnce.shift();
    if (!currentHanlder) {
      return handler(config);
    }

    return currentHanlder(config);
  };
}

type AxiosHandler = (config: AxiosRequestConfig) => AxiosPromise<any>;
type AxiosArguments = { args: AxiosRequestConfig | undefined };

/**
 * Replace Axios handler with a mock.
 * Throw if is called more than once
 *
 * @param handler mock function
 * @returns savedArgs
 */
export function mockAxiosOnce(handler: AxiosHandler): {
  args: AxiosRequestConfig | undefined;
} {
  const savedArgs: AxiosArguments = { args: undefined };
  listOfHandlersToUseOnce.push(
    (config: AxiosRequestConfig): AxiosPromise<any> => {
      savedArgs.args = config;
      return handler(config);
    },
  );
  return savedArgs;
}