yunohost-admin/app/src/api/handlers.ts

/**
 * API handlers.
 * @module api/handlers
 */

import errors, { APIError } from '@/api/errors'
import {
  STATUS_VARIANT,
  type APIRequest,
  type APIRequestAction,
} from '@/composables/useRequests'
import { toEntries } from '@/helpers/commons'
import type { Obj } from '@/types/commons'
import type { APIErrorData } from './api'

/**
 * Try to get response content as json and if it's not as text.
 *
 * @param response - A fetch `Response` object.
 * @returns Parsed response's json or response's text.
 */
export async function getResponseData(response: Response) {
  // FIXME the api should always return json as response
  const responseText = await response.text()
  try {
    return JSON.parse(responseText) as Obj
  } catch {
    return responseText
  }
}

/**
 * Opens a WebSocket connection to the server in case it sends messages.
 * Currently, the connection is closed by the server right after an API call so
 * we have to open it for every calls.
 * Messages are dispatch to the store so it can handle them.
 *
 * @param request - Request info data.
 * @returns Promise that resolve on websocket 'open' or 'error' event.
 */
export function openWebSocket(request: APIRequestAction): Promise<Event> {
  return new Promise((resolve) => {
    const ws = new WebSocket(
      `wss://${store.getters.host}/yunohost/api/messages`,
    )
    ws.onmessage = ({ data }) => {
      const messages: Record<'info' | 'success' | 'warning' | 'error', string> =
        JSON.parse(data)
      toEntries(messages).forEach(([status, text]) => {
        text = text.replaceAll('\n', '<br>')
        const progressBar = text.match(/^\[#*\+*\.*\] > /)?.[0]
        if (progressBar) {
          text = text.replace(progressBar, '')
          const progress: Obj<number> = { '#': 0, '+': 0, '.': 0 }
          for (const char of progressBar) {
            if (char in progress) progress[char] += 1
          }
          request.action.progress = Object.values(progress)
        }
        request.action.messages.push({
          text,
          variant: STATUS_VARIANT[status],
        })
        if (['error', 'warning'].includes(status)) {
          request.action[`${status as 'error' | 'warning'}s`]++
        }
      })
    }
    // ws.onclose = (e) => {}
    ws.onopen = resolve
    // Resolve also on error so the actual fetch may be called.
    ws.onerror = resolve
  })
}

/**
 * Handler for API errors.
 *
 * @param request - Request info data.
 * @param response - A consumed fetch `Response` object.
 * @param errorData - The response parsed json/text.
 * @returns an `APIError` or subclass with request and response data.
 */
export function getError(
  request: APIRequest,
  response: Response,
  errorData: string | APIErrorData,
) {
  let errorCode = (
    response.status in errors ? response.status : 'default'
  ) as keyof typeof errors
  if (typeof errorData === 'string') {
    // FIXME API: Patching errors that are plain text or html.
    errorData = { error: errorData }
  }
  if ('log_ref' in errorData) {
    // Define a special error so it won't get caught as a `APIBadRequestError`.
    errorCode = 'log'
  }

  // This error can be catched by a view otherwise it will be catched by the `onUnhandledAPIError` handler.
  return new errors[errorCode](request, response, errorData)
}

/**
 * If an APIError is not catched by a view it will be dispatched to the store so the
 * error can be displayed in the error modal.
 */
export function onUnhandledAPIError(error: APIError) {
  error.log()
  store.dispatch('HANDLE_ERROR', error)
}

/**
 * Global catching of unhandled promise's rejections.
 * Those errors (thrown or rejected from inside a promise) can't be catched by
 * `window.onerror`.
 */
export function registerGlobalErrorHandlers() {
  window.addEventListener('unhandledrejection', (e) => {
    const error = e.reason
    if (error instanceof APIError) {
      onUnhandledAPIError(error)
      // Seems like there's a bug in Firefox and the error logging in not prevented.
      e.preventDefault()
    }
  })

  // Keeping this in case it is needed.

  // Global catching of errors occuring inside vue components.
  // Vue.config.errorHandler = (err, vm, info) => {}

  // Global catching of regular js errors.
  // window.onerror = (message, source, lineno, colno, error) => {}
}