@sanity/export/src/util/friendlyError.ts

Export Sanity documents and assets

interface ErrorWithResponse {
  response: {
    body: NodeJS.ReadableStream
    headers: Record<string, string>
    statusCode?: number
  }
}

interface ErrorBody {
  error?: string
  message?: string
}

function isRecord(thing: unknown): thing is Record<string, unknown> {
  return typeof thing === 'object' && thing !== null && !Array.isArray(thing)
}

function isErrorWithResponse(err: unknown): err is ErrorWithResponse {
  if (!isRecord(err)) {
    return false
  }

  if (!('response' in err) || !isRecord(err.response)) {
    return false
  }

  const response = err.response
  return (
    'body' in response &&
    isRecord(response.body) &&
    'pipe' in response.body &&
    'headers' in response &&
    isRecord(response.headers)
  )
}

async function readBody(req: NodeJS.ReadableStream): Promise<Buffer> {
  const chunks: Buffer[] = []
  for await (const chunk of req) {
    chunks.push(typeof chunk === 'string' ? Buffer.from(chunk) : Buffer.from(chunk as Uint8Array))
  }
  return Buffer.concat(chunks)
}

async function readBodyJson(req: NodeJS.ReadableStream): Promise<unknown> {
  return JSON.parse((await readBody(req)).toString('utf8'))
}

export async function tryThrowFriendlyError(err: unknown): Promise<null> {
  if (!isErrorWithResponse(err)) {
    return null
  }

  const contentType = err.response.headers['content-type']
  if (typeof contentType !== 'string' || !contentType.includes('application/json')) {
    return null
  }

  const body = await readBodyJson(err.response.body)

  if (!isRecord(body)) {
    return null
  }

  const typedBody = body as ErrorBody
  const status =
    typeof err.response.statusCode === 'number' ? `HTTP ${err.response.statusCode}` : undefined
  const error = typeof typedBody.error === 'string' ? typedBody.error : undefined
  const message = typeof typedBody.message === 'string' ? typedBody.message : undefined
  if (!error && !message) {
    return null
  }

  throw new Error(['Export', status, error, message].filter(Boolean).join(': '))
}