@growi/sdk-typescript 1.0.0 → 1.1.0

package/src/utils/axios-default-instance.test.ts

@@ -0,0 +1,108 @@
+import type { AxiosInstance } from 'axios';
+/**
+ * Tests for axios-default-instance.ts
+ *
+ * This file manages the default Axios instance for GROWI SDK,
+ * providing functionality to configure base URL and authentication headers.
+ */
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { AXIOS_DEFAULT } from './axios-default-instance.js';
+
+describe('AXIOS_DEFAULT', () => {
+  beforeEach(() => {
+    // Reset the instance before each test
+    AXIOS_DEFAULT.instance.defaults.baseURL = 'http://localhost';
+    AXIOS_DEFAULT.instance.defaults.headers.common.Authorization = undefined;
+  });
+
+  describe('setBaseURL', () => {
+    it('should update base URL when setting a valid URL', () => {
+      // Arrange
+      const newBaseURL = 'https://api.example.com';
+
+      // Act
+      AXIOS_DEFAULT.setBaseURL(newBaseURL);
+
+      // Assert
+      expect(AXIOS_DEFAULT.instance.defaults.baseURL).toBe(newBaseURL);
+    });
+
+    it('should set base URL to empty string when empty string is provided', () => {
+      // Arrange
+      const emptyURL = '';
+
+      // Act
+      AXIOS_DEFAULT.setBaseURL(emptyURL);
+
+      // Assert
+      expect(AXIOS_DEFAULT.instance.defaults.baseURL).toBe(emptyURL);
+    });
+
+    it('should use the last value when called multiple times', () => {
+      // Arrange
+      const firstURL = 'https://first.example.com';
+      const secondURL = 'https://second.example.com';
+
+      // Act
+      AXIOS_DEFAULT.setBaseURL(firstURL);
+      AXIOS_DEFAULT.setBaseURL(secondURL);
+
+      // Assert
+      expect(AXIOS_DEFAULT.instance.defaults.baseURL).toBe(secondURL);
+    });
+  });
+
+  describe('setAuthorizationHeader', () => {
+    it('should set authorization header in Bearer token format when valid token is provided', () => {
+      // Arrange
+      const token = 'test-token-123';
+      const expectedHeader = `Bearer ${token}`;
+
+      // Act
+      AXIOS_DEFAULT.setAuthorizationHeader(token);
+
+      // Assert
+      expect(AXIOS_DEFAULT.instance.defaults.headers.common.Authorization).toBe(expectedHeader);
+    });
+
+    it('should set Bearer header with empty string when empty token is provided', () => {
+      // Arrange
+      const emptyToken = '';
+      const expectedHeader = 'Bearer ';
+
+      // Act
+      AXIOS_DEFAULT.setAuthorizationHeader(emptyToken);
+
+      // Assert
+      expect(AXIOS_DEFAULT.instance.defaults.headers.common.Authorization).toBe(expectedHeader);
+    });
+
+    it('should use the last token when called multiple times', () => {
+      // Arrange
+      const firstToken = 'first-token';
+      const secondToken = 'second-token';
+      const expectedHeader = `Bearer ${secondToken}`;
+
+      // Act
+      AXIOS_DEFAULT.setAuthorizationHeader(firstToken);
+      AXIOS_DEFAULT.setAuthorizationHeader(secondToken);
+
+      // Assert
+      expect(AXIOS_DEFAULT.instance.defaults.headers.common.Authorization).toBe(expectedHeader);
+    });
+  });
+
+  describe('instance', () => {
+    it('should have default base URL set to localhost', () => {
+      // Assert
+      expect(AXIOS_DEFAULT.instance.defaults.baseURL).toBe('http://localhost');
+    });
+
+    it('should have Axios instance properly created', () => {
+      // Assert
+      expect(AXIOS_DEFAULT.instance).toBeDefined();
+      expect(typeof AXIOS_DEFAULT.instance).toBe('function');
+      expect(AXIOS_DEFAULT.instance.defaults).toBeDefined();
+    });
+  });
+});

package/src/utils/v1/axios-instance.test.ts

@@ -0,0 +1,250 @@
+import type { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+import Axios from 'axios';
+/**
+ * Tests for v1/axios-instance.ts
+ *
+ * This file provides custom Axios instance creation functionality for GROWI API v1,
+ * including automatic base URL configuration, cancellation capability, and request configuration merging.
+ */
+import { type MockedFunction, afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { AXIOS_DEFAULT } from '../axios-default-instance.js';
+import { customInstance } from './axios-instance.js';
+
+// Mock Axios
+vi.mock('axios');
+vi.mock('../axios-default-instance.js');
+
+const mockedAxios = vi.mocked(Axios);
+const mockedAXIOS_DEFAULT = vi.mocked(AXIOS_DEFAULT);
+
+// Type for the promise returned by customInstance with cancel functionality
+type CancellablePromise<T> = Promise<T> & {
+  cancel: () => void;
+};
+
+describe('v1 customInstance', () => {
+  let mockCancelTokenSource: {
+    token: string;
+    cancel: MockedFunction<() => void>;
+  };
+  let mockAxiosInstance: MockedFunction<(config: AxiosRequestConfig) => Promise<AxiosResponse<unknown>>>;
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+
+    // Mock for CancelTokenSource
+    mockCancelTokenSource = {
+      token: 'mock-cancel-token',
+      cancel: vi.fn(),
+    };
+
+    // Mock for Axios.CancelToken.source
+    mockedAxios.CancelToken = {
+      source: vi.fn().mockReturnValue(mockCancelTokenSource),
+    } as unknown as typeof Axios.CancelToken;
+
+    // Mock for Axios instance
+    mockAxiosInstance = vi.fn().mockResolvedValue({
+      data: { result: 'success' },
+      status: 200,
+      statusText: 'OK',
+      headers: {},
+      config: {},
+    } as AxiosResponse<{ result: string }>);
+
+    // Mock for AXIOS_DEFAULT
+    mockedAXIOS_DEFAULT.instance = mockAxiosInstance as unknown as typeof AXIOS_DEFAULT.instance;
+    Object.defineProperty(mockedAXIOS_DEFAULT.instance, 'defaults', {
+      value: {
+        baseURL: 'http://localhost',
+        headers: {
+          common: {},
+          delete: {},
+          get: {},
+          head: {},
+          post: {},
+          put: {},
+          patch: {},
+        },
+      },
+      writable: true,
+      configurable: true,
+    });
+  });
+
+  afterEach(() => {
+    vi.resetAllMocks();
+  });
+
+  describe('Base URL configuration', () => {
+    it('should append _api suffix to default base URL', async () => {
+      // Arrange
+      const config: AxiosRequestConfig = { method: 'GET', url: '/test' };
+
+      // Act
+      await customInstance(config);
+
+      // Assert
+      expect(mockAxiosInstance).toHaveBeenCalledWith(
+        expect.objectContaining({
+          baseURL: 'http://localhost/_api',
+          cancelToken: 'mock-cancel-token',
+        }),
+      );
+    });
+
+    it('should prioritize baseURL specified in options', async () => {
+      // Arrange
+      const config: AxiosRequestConfig = { method: 'GET', url: '/test' };
+      const options: AxiosRequestConfig = { baseURL: 'https://custom.example.com' };
+
+      // Act
+      await customInstance(config, options);
+
+      // Assert
+      expect(mockAxiosInstance).toHaveBeenCalledWith(
+        expect.objectContaining({
+          baseURL: 'https://custom.example.com/_api',
+        }),
+      );
+    });
+
+    it('should use baseURL specified in config when provided', async () => {
+      // Arrange
+      const config: AxiosRequestConfig = {
+        method: 'GET',
+        url: '/test',
+        baseURL: 'https://config.example.com',
+      };
+
+      // Act
+      await customInstance(config);
+
+      // Assert
+      expect(mockAxiosInstance).toHaveBeenCalledWith(
+        expect.objectContaining({
+          baseURL: 'https://config.example.com/_api',
+        }),
+      );
+    });
+  });
+
+  describe('Configuration merging', () => {
+    it('should correctly merge config and options', async () => {
+      // Arrange
+      const config: AxiosRequestConfig = {
+        method: 'POST',
+        url: '/test',
+        data: { name: 'test' },
+      };
+      const options: AxiosRequestConfig = {
+        headers: { 'Custom-Header': 'value' },
+        timeout: 5000,
+      };
+
+      // Act
+      await customInstance(config, options);
+
+      // Assert
+      expect(mockAxiosInstance).toHaveBeenCalledWith(
+        expect.objectContaining({
+          method: 'POST',
+          url: '/test',
+          data: { name: 'test' },
+          headers: { 'Custom-Header': 'value' },
+          timeout: 5000,
+          baseURL: 'http://localhost/_api',
+          cancelToken: 'mock-cancel-token',
+        }),
+      );
+    });
+
+    it('should override config values with options values', async () => {
+      // Arrange
+      const config: AxiosRequestConfig = {
+        method: 'GET',
+        timeout: 1000,
+      };
+      const options: AxiosRequestConfig = {
+        timeout: 3000,
+      };
+
+      // Act
+      await customInstance(config, options);
+
+      // Assert
+      expect(mockAxiosInstance).toHaveBeenCalledWith(
+        expect.objectContaining({
+          timeout: 3000,
+        }),
+      );
+    });
+  });
+
+  describe('Response processing', () => {
+    it('should return the data property from response', async () => {
+      // Arrange
+      const expectedData = { users: [{ id: 1, name: 'John' }] };
+      mockAxiosInstance.mockResolvedValue({
+        data: expectedData,
+        status: 200,
+        statusText: 'OK',
+        headers: {},
+        config: {},
+      } as AxiosResponse<{ users: Array<{ id: number; name: string }> }>);
+
+      const config: AxiosRequestConfig = { method: 'GET', url: '/users' };
+
+      // Act
+      const result = await customInstance(config);
+
+      // Assert
+      expect(result).toEqual(expectedData);
+    });
+  });
+
+  describe('Cancellation functionality', () => {
+    it('should add cancel function to returned Promise', async () => {
+      // Arrange
+      const config: AxiosRequestConfig = { method: 'GET', url: '/test' };
+
+      // Act
+      const promise = customInstance(config) as CancellablePromise<unknown>;
+
+      // Assert
+      expect(promise).toHaveProperty('cancel');
+      expect(typeof promise.cancel).toBe('function');
+
+      // cleanup
+      await promise;
+    });
+
+    it('should call CancelTokenSource cancel when cancel function is invoked', async () => {
+      // Arrange
+      const config: AxiosRequestConfig = { method: 'GET', url: '/test' };
+
+      // Act
+      const promise = customInstance(config) as CancellablePromise<unknown>;
+      promise.cancel();
+
+      // Assert
+      expect(mockCancelTokenSource.cancel).toHaveBeenCalledWith('Query cancelled');
+
+      // cleanup
+      await promise;
+    });
+  });
+
+  describe('Error handling', () => {
+    it('should reject Promise when Axios error occurs', async () => {
+      // Arrange
+      const error = new Error('Network error');
+      mockAxiosInstance.mockRejectedValue(error);
+
+      const config: AxiosRequestConfig = { method: 'GET', url: '/test' };
+
+      // Act & Assert
+      await expect(customInstance(config)).rejects.toThrow('Network error');
+    });
+  });
+});