src/config/req.ts

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { notifications } from '@mantine/notifications';
import axios, { AxiosError, type AxiosResponse, HttpStatusCode } from 'axios';
import { stringify } from 'qs';

import {
  API_HEADER_KEY,
  API_PREFIX,
  SKIP_INTERCEPTOR_HEADER,
} from '@/config/constant';
import { globalStore } from '@/stores/global';

export const req = axios.create();

req.interceptors.request.use((conf) => {
  conf.paramsSerializer = (p) =>
    stringify(p, {
      arrayFormat: 'repeat',
    });
  conf.baseURL = API_PREFIX;
  conf.headers.set(API_HEADER_KEY, globalStore.settings.adminKey);
  return conf;
});

type APISIXRespErr = {
  error_msg?: string;
  message?: string;
};

/**
 * use request header `[SKIP_INTERCEPTOR_HEADER]: ['404', ...]` to skip interceptor for specific status code.
 */
const matchSkipInterceptor = (err: AxiosError) => {
  const interceptors = err.config?.headers?.[SKIP_INTERCEPTOR_HEADER] || [];
  const status = err.response?.status;
  return interceptors.some((v: string) => v === String(status));
};

req.interceptors.response.use(
  (res) => {
    // it's a apisix design
    // when list is empty, it will be a object
    // but we need a array
    if (
      res.data?.list &&
      !Array.isArray(res.data.list) &&
      Object.keys(res.data.list).length === 0
    ) {
      res.data.list = [];
    }
    return res;
  },
  (err) => {
    if (err.response) {
      if (matchSkipInterceptor(err)) return Promise.reject(err);
      const res = err.response as AxiosResponse<APISIXRespErr>;
      const d = res.data;
      notifications.show({
        id: d?.error_msg || d?.message,
        message: d?.error_msg || d?.message,
        color: 'red',
      });
      // Requires to enter admin key at 401
      if (res.status === HttpStatusCode.Unauthorized) {
        globalStore.settings.set('isOpen', true);
        return Promise.resolve({ data: {} });
      }
    }
    return Promise.reject(err);
  }
);