chore: add error handler

Author: kevinkim-ogp

packages/backend/src/apps/aisay/__tests__/common/interceptors.error-handlers.test.ts

@@ -0,0 +1,164 @@
+import '@/apps'
+
+import type { IGlobalVariable } from '@plumber/types'
+
+import {
+  AxiosError,
+  type AxiosPromise,
+  type AxiosResponse,
+  type InternalAxiosRequestConfig,
+} from 'axios'
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+
+import HttpError from '@/errors/http'
+import RetriableError, { DEFAULT_DELAY_MS } from '@/errors/retriable-error'
+import createHttpClient, { type IHttpClient } from '@/helpers/http-client'
+
+import aisayApp from '../..'
+
+function mockAxiosAdapterToThrowOnce(
+  status: AxiosResponse['status'],
+  headers?: AxiosResponse['headers'],
+): void {
+  mocks.axiosAdapter.mockImplementationOnce((config) => {
+    throw new AxiosError(
+      'Request failed',
+      AxiosError.ERR_BAD_RESPONSE,
+      config,
+      null,
+      {
+        status,
+        headers,
+        config,
+      } as unknown as AxiosResponse,
+    )
+  })
+}
+
+const mocks = vi.hoisted(() => ({
+  axiosAdapter: vi.fn(
+    async (config: InternalAxiosRequestConfig): AxiosPromise => ({
+      data: 'test-data',
+      status: 200,
+      statusText: 'OK',
+      headers: {},
+      config,
+    }),
+  ),
+  logWarning: vi.fn(),
+  logError: vi.fn(),
+}))
+
+vi.mock('axios', async (importOriginal) => {
+  const actualAxios = await importOriginal<typeof import('axios')>()
+  const mockCreate: typeof actualAxios.default.create = (createConfig) =>
+    actualAxios.default.create({
+      ...createConfig,
+      adapter: mocks.axiosAdapter,
+    })
+
+  return {
+    ...actualAxios,
+    default: {
+      ...actualAxios.default,
+      create: mockCreate,
+    },
+  }
+})
+
+vi.mock('@/helpers/logger', () => ({
+  default: {
+    warn: mocks.logWarning,
+    error: mocks.logError,
+  },
+}))
+
+describe('AISAY request error handlers', () => {
+  let http: IHttpClient
+
+  beforeEach(() => {
+    const $ = {
+      auth: {
+        data: {
+          clientId: 'some-client-key',
+          clientSecret: 'some-client-secret',
+        },
+      },
+    } as unknown as IGlobalVariable
+    http = createHttpClient({
+      $,
+      baseURL: 'http://localhost/mock-aisay-api',
+      beforeRequest: [],
+      requestErrorHandler: aisayApp.requestErrorHandler,
+    })
+  })
+
+  afterEach(() => {
+    vi.restoreAllMocks()
+  })
+
+  it('logs a warning and throws a RetriableError with default step delay on 503', async () => {
+    mockAxiosAdapterToThrowOnce(503)
+    await http
+      .get('/test-url')
+      .then(() => {
+        expect.unreachable()
+      })
+      .catch((error): void => {
+        expect(error).toBeInstanceOf(RetriableError)
+        expect(error.delayType).toEqual('step')
+        expect(error.delayInMs).toEqual(DEFAULT_DELAY_MS)
+      })
+    expect(mocks.logWarning).toHaveBeenCalledWith(
+      expect.stringContaining(`HTTP 503`),
+      expect.objectContaining({ event: `aisay-http-503` }),
+    )
+  })
+
+  it('logs a warning and throws a RetriableError with step delay set to retry-after, on receiving 503', async () => {
+    mockAxiosAdapterToThrowOnce(503, { 'retry-after': 234 })
+    await http
+      .get('/test-url')
+      .then(() => {
+        expect.unreachable()
+      })
+      .catch((error): void => {
+        expect(error).toBeInstanceOf(RetriableError)
+        expect(error.delayType).toEqual('step')
+        expect(error.delayInMs).toEqual(234000)
+      })
+    expect(mocks.logWarning).toHaveBeenCalledWith(
+      expect.stringContaining(`HTTP 503`),
+      expect.objectContaining({ event: `aisay-http-503` }),
+    )
+  })
+
+  it('logs a warning and still throws a RetriableError with default step delay on 503, if response has invalid retry-after', async () => {
+    mockAxiosAdapterToThrowOnce(503, { 'retry-after': 'corrupted' })
+    await http
+      .get('/test-url')
+      .then(() => {
+        expect.unreachable()
+      })
+      .catch((error): void => {
+        expect(error).toBeInstanceOf(RetriableError)
+        expect(error.delayType).toEqual('step')
+        expect(error.delayInMs).toEqual(DEFAULT_DELAY_MS)
+      })
+    expect(mocks.logWarning).toHaveBeenCalledWith(
+      expect.stringContaining('HTTP 503'),
+      expect.objectContaining({ event: 'aisay-http-503' }),
+    )
+  })
+
+  it('throws HTTP error on other non-successful codes', async () => {
+    mockAxiosAdapterToThrowOnce(501, { 'retry-after': 123 })
+    await expect(http.get('/test-url')).rejects.toThrow(HttpError)
+  })
+
+  it('does not throw error if response is success', async () => {
+    await expect(http.get('/test-url')).resolves.toEqual(
+      expect.objectContaining({ data: 'test-data', status: 200 }),
+    )
+  })
+})

packages/backend/src/apps/aisay/common/interceptors/request-error-handler.ts

@@ -0,0 +1,42 @@
+import { IApp } from '@plumber/types'
+
+import RetriableError from '@/errors/retriable-error'
+import logger from '@/helpers/logger'
+import { parseRetryAfterToMs } from '@/helpers/parse-retry-after-to-ms'
+
+type ThrowingHandler = (
+  ...args: Parameters<IApp['requestErrorHandler']>
+) => never
+
+// Retry failures
+const handle503: ThrowingHandler = function ($, error) {
+  const status = error.response.status
+  logger.warn('Received HTTP 503 from AISAY', {
+    event: 'aisay-http-503',
+    clientId: $.auth.data.clientId,
+    baseUrl: error.response.config.baseURL,
+    url: error.response.config.url,
+    flowId: $.flow?.id,
+    stepId: $.step?.id,
+    executionId: $.execution?.id,
+    retryAfterMs: error.response?.headers?.['retry-after'],
+  })
+
+  // AISAY will specify a Retry-After header when it returns 503.
+  const retryAfterMs =
+    parseRetryAfterToMs(error.response?.headers?.['retry-after']) ?? 'default'
+  throw new RetriableError({
+    error: `Encountered HTTP ${status} from AISAY`,
+    delayInMs: retryAfterMs,
+    delayType: 'step',
+  })
+}
+
+const errorHandler: IApp['requestErrorHandler'] = async function ($, error) {
+  switch (error.response.status) {
+    case 503:
+      return handle503($, error)
+  }
+}
+
+export default errorHandler

packages/backend/src/apps/aisay/index.ts

@@ -1,5 +1,6 @@
 import { IApp } from '@plumber/types'
 
+import requestErrorHandler from './common/interceptors/request-error-handler'
 import actions from './actions'
 import auth from './auth'
 import queue from './queue'
@@ -16,6 +17,7 @@ const app: IApp = {
   apiBaseUrl: '',
   primaryColor: '0059F7',
   actions,
+  requestErrorHandler,
   substepLabels: {
     connectionStepLabel: 'Connect your AISAY account',
     settingsStepLabel: 'Set up step',