supabase/apps/studio/data/fetchers.ts

import * as Sentry from '@sentry/nextjs'
import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
import { getAccessToken, IS_PLATFORM } from 'common'
import createClient from 'openapi-fetch'

import type { paths } from './api'
import { ERROR_PATTERNS } from './error-patterns'
import { API_URL } from '@/lib/constants'
import { uuidv4 } from '@/lib/helpers'
import { ResponseError } from '@/types'
import { UnknownAPIResponseError } from '@/types/api-errors'
import { ErrorMetadata } from '@/types/base'

// generated from openapi-typescript

const DEFAULT_HEADERS = { Accept: 'application/json' }

export const fetchHandler: typeof fetch = async (input, init) => {
  try {
    return await fetch(input, init)
  } catch (err: any) {
    if (err instanceof TypeError && err.message === 'Failed to fetch') {
      console.error(err)
      throw new Error('Unable to reach the server. Please check your network or try again later.')
    }
    throw err
  }
}

export const client = createClient<paths>({
  fetch: fetchHandler,
  // [Joshen] Just FYI, the replace is temporary until we update env vars API_URL to remove /platform or /v1 - should just be the base URL
  baseUrl: API_URL?.replace('/platform', ''),
  referrerPolicy: 'no-referrer-when-downgrade',
  headers: DEFAULT_HEADERS,
  credentials: 'include',
  querySerializer: {
    array: {
      style: 'form',
      explode: false,
    },
  },
})

export function isValidConnString(connString?: string | null) {
  // If there is no `connectionString` on platform, pg-meta will necessarily fail to connect to the target database.
  // This only applies if IS_PLATFORM is true; otherwise (test/local-dev), pg-meta won't need this parameter
  // and will connect to the locally running DB_URL instead.
  return IS_PLATFORM ? Boolean(connString) : true
}

export async function constructHeaders(headersInit?: HeadersInit | undefined) {
  const requestId = uuidv4()
  const headers = new Headers(headersInit)

  headers.set('X-Request-Id', requestId)

  if (!headers.has('Authorization')) {
    const accessToken = await getAccessToken()
    if (accessToken) headers.set('Authorization', `Bearer ${accessToken}`)
  }

  return headers
}

/**
 * openapi-fetch only treats a response body as empty when `status === 204` or the
 * response carries a `Content-Length: 0` header; otherwise it calls `response.json()`,
 * which throws "Unexpected end of JSON input" on an empty body. HTTP/3 (and HEAD
 * requests) may omit `Content-Length: 0` on empty-body responses — e.g. a `201` with
 * no body — so a request that succeeds over HTTP/2 can fail over HTTP/3.
 *
 * Normalize empty-body success responses by setting `Content-Length: 0` so the parser
 * short-circuits regardless of transport. Non-empty responses are returned untouched.
 */
export async function normalizeEmptyBodyResponse(response: Response): Promise<Response> {
  if (response.status === 204 || response.headers.has('Content-Length')) {
    return response
  }

  const body = await response.clone().text()
  if (body.length > 0) {
    return response
  }

  const headers = new Headers(response.headers)
  headers.set('Content-Length', '0')
  return new Response(null, {
    status: response.status,
    statusText: response.statusText,
    headers,
  })
}

function pgMetaGuard(request: Request) {
  // Only check for /platform/pg-meta/ endpoints
  if (request.url.includes('/platform/pg-meta/')) {
    // If there is no valid `x-connection-encrypted`, pg-meta will necesseraly fail to connect to the target database
    // in such case, we save the hops and throw a 421 response instead
    if (!isValidConnString(request.headers.get('x-connection-encrypted'))) {
      const retryAfterHeader = request.headers.get('Retry-After')
      throw new ResponseError(
        'API Error: happened while trying to acquire connection to the database',
        400,
        request.headers.get('X-Request-Id') ?? undefined,
        retryAfterHeader ? parseInt(retryAfterHeader) : undefined
      )
    }
    if (!request.headers.get('x-pg-application-name')) {
      request.headers.set('x-pg-application-name', DEFAULT_PLATFORM_APPLICATION_NAME)
    }
  }
  return request
}

// Middleware
client.use(
  {
    // Middleware to add authorization headers to the request
    async onRequest({ request }) {
      const headers = await constructHeaders()
      headers.forEach((value, key) => request.headers.set(key, value))
      return pgMetaGuard(request)
    },
  },
  {
    // Middleware to format errors
    async onResponse({ request, response }) {
      if (response.ok) {
        return normalizeEmptyBodyResponse(response)
      }

      // handle errors
      try {
        // attempt to parse the response body as JSON
        let body = await response.clone().json()

        // add code field to body
        body.code = response.status

        body.requestId = request.headers.get('X-Request-Id')

        const retryAfterHeader =
          response.headers.get('Retry-After') ?? response.headers.get('X-RateLimit-Reset')
        body.retryAfter = retryAfterHeader ? parseInt(retryAfterHeader) : undefined

        const requestUrl = new URL(request.url)
        body.requestPathname = requestUrl.pathname

        return new Response(JSON.stringify(body), {
          headers: response.headers,
          status: response.status,
          statusText: response.statusText,
        })
      } catch {
        // noop
      }

      return response
    },
  }
)

export const {
  GET: get,
  POST: post,
  PUT: put,
  PATCH: patch,
  DELETE: del,
  HEAD: head,
  TRACE: trace,
  OPTIONS: options,
} = client

type HandleErrorOptions = {
  alwaysCapture?: boolean
  sentryContext?: Parameters<typeof Sentry.captureException>[1]
}

export const handleError = (error: unknown, options: HandleErrorOptions = {}): never => {
  if (error && typeof error === 'object') {
    if (options.alwaysCapture) {
      Sentry.captureException(error, options.sentryContext)
    }
    const errorMessage =
      'msg' in error && typeof error.msg === 'string'
        ? error.msg
        : 'message' in error && typeof error.message === 'string'
          ? error.message
          : undefined

    const errorCode = 'code' in error && typeof error.code === 'number' ? error.code : undefined
    const requestId =
      'requestId' in error && typeof error.requestId === 'string' ? error.requestId : undefined
    const retryAfter =
      'retryAfter' in error && typeof error.retryAfter === 'number' ? error.retryAfter : undefined
    const requestPathname =
      'requestPathname' in error && typeof error.requestPathname === 'string'
        ? error.requestPathname
        : undefined
    const metadata =
      'metadata' in error && typeof error.metadata === 'object' && !!error.metadata
        ? (error.metadata as ErrorMetadata)
        : undefined
    const formattedError =
      'formattedError' in error && typeof error.formattedError === 'string'
        ? error.formattedError
        : undefined

    if (errorMessage) {
      const matched = ERROR_PATTERNS.find(({ pattern }) => pattern.test(errorMessage))
      throw matched
        ? new matched.ErrorClass(
            errorMessage,
            errorCode,
            requestId,
            retryAfter,
            requestPathname,
            metadata,
            formattedError
          )
        : new UnknownAPIResponseError(
            errorMessage,
            errorCode,
            requestId,
            retryAfter,
            requestPathname,
            metadata,
            formattedError
          )
    }
  }

  if (error !== null && typeof error === 'object' && 'stack' in error) {
    console.error(error.stack)
  }

  // the error doesn't have a message or msg property, so we can't throw it as an error. Log it via Sentry so that we can
  // add handling for it.
  Sentry.captureException(error, options.sentryContext)

  // throw a generic error if we don't know what the error is. The message is intentionally vague because it might show
  // up in the UI.
  throw new UnknownAPIResponseError(undefined)
}

// [Joshen] The methods below are brought over from lib/common/fetch because we still need them
// primarily for our own endpoints in the dashboard repo. So consolidating all the fetch methods into here.

async function handleFetchResponse<T>(response: Response): Promise<T | ResponseError> {
  const contentType = response.headers.get('Content-Type')
  if (contentType === 'application/octet-stream') return response as any
  try {
    const resTxt = await response.text()
    try {
      // try to parse response text as json
      return JSON.parse(resTxt)
    } catch (err) {
      // return as text plain
      return resTxt as any
    }
  } catch (e) {
    return handleError(response) as T | ResponseError
  }
}

async function handleFetchHeadResponse<T>(
  response: Response,
  headers: string[]
): Promise<T | ResponseError> {
  try {
    const res = {} as any
    headers.forEach((header: string) => {
      res[header] = response.headers.get(header)
    })
    return res
  } catch (e) {
    return handleError(response) as T | ResponseError
  }
}

async function handleFetchError(response: unknown): Promise<ResponseError> {
  let resJson: any = {}

  if (response instanceof Error) {
    resJson = response
  }

  if (response instanceof Response) {
    resJson = await response.json()
  }

  const status = response instanceof Response ? response.status : undefined

  const message =
    resJson.message ??
    resJson.msg ??
    resJson.error ??
    `An error has occurred: ${status ?? 'Unknown error'}`
  const retryAfterHeader =
    response instanceof Response
      ? (response.headers.get('Retry-After') ?? response.headers.get('X-RateLimit-Reset'))
      : null
  const retryAfter = retryAfterHeader ? parseInt(retryAfterHeader) : undefined

  let error = new ResponseError(message, status, undefined, retryAfter)

  // @ts-expect-error - [Alaister] many of our local api routes check `if (response.error)`.
  // This is a fix to keep those checks working without breaking changes.
  // In future we should check for `if (response instanceof ResponseError)` instead.
  error.error = error

  return error
}

/**
 * To be used only for dashboard API endpoints. Use `fetch` directly if calling a non dashboard API endpoint
 */
export async function fetchGet<T = any>(
  url: string,
  options?: { [prop: string]: any }
): Promise<T | ResponseError> {
  try {
    const { headers: otherHeaders, abortSignal, ...otherOptions } = options ?? {}
    const headers = await constructHeaders({
      'Content-Type': 'application/json',
      ...DEFAULT_HEADERS,
      ...otherHeaders,
    })
    const response = await fetch(url, {
      headers,
      method: 'GET',
      referrerPolicy: 'no-referrer-when-downgrade',
      ...otherOptions,
      signal: abortSignal,
    })
    if (!response.ok) return handleFetchError(response)
    return handleFetchResponse(response)
  } catch (error) {
    return handleFetchError(error)
  }
}

/**
 * To be used only for dashboard API endpoints. Use `fetch` directly if calling a non dashboard API endpoint
 *
 * Exception for `bucket-object-download-mutation` as openapi-fetch doesn't support octet-stream responses
 */
export async function fetchPost<T = any>(
  url: string,
  data: { [prop: string]: any },
  options?: { [prop: string]: any }
): Promise<T | ResponseError> {
  try {
    const { headers: otherHeaders, abortSignal, ...otherOptions } = options ?? {}
    const headers = await constructHeaders({
      'Content-Type': 'application/json',
      ...DEFAULT_HEADERS,
      ...otherHeaders,
    })
    const response = await fetch(url, {
      headers,
      method: 'POST',
      body: JSON.stringify(data),
      referrerPolicy: 'no-referrer-when-downgrade',
      ...otherOptions,
      signal: abortSignal,
    })
    if (!response.ok) return handleFetchError(response)
    return handleFetchResponse(response)
  } catch (error) {
    return handleFetchError(error)
  }
}

/**
 * To be used only for dashboard API endpoints. Use `fetch` directly if calling a non dashboard API endpoint
 */
export async function fetchHeadWithTimeout<T = any>(
  url: string,
  headersToRetrieve: string[],
  options?: { [prop: string]: any }
): Promise<T | ResponseError> {
  try {
    const timeout = options?.timeout ?? 60000

    const { headers: otherHeaders, abortSignal, ...otherOptions } = options ?? {}
    const headers = await constructHeaders({
      'Content-Type': 'application/json',
      ...DEFAULT_HEADERS,
      ...otherHeaders,
    })

    const response = await fetch(url, {
      method: 'HEAD',
      referrerPolicy: 'no-referrer-when-downgrade',
      headers,
      ...otherOptions,
      signal: AbortSignal.timeout(timeout),
    })

    if (!response.ok) return handleFetchError(response)
    return handleFetchHeadResponse(response, headersToRetrieve)
  } catch (error) {
    return handleFetchError(error)
  }
}