Skip to content

The open alternative to Salesforce, designed for AI.

2.5 KB
Raw Blame
import { isArray, isString } from '@sniptt/guards';
import { isPlainObject } from 'twenty-shared/utils';

import { CliError } from '@/output/cli-error';
import { EXIT_CODE } from '@/output/constants/exit-code.constant';
import { getAuthenticationHint } from '@/target/get-authentication-hint';
import { type ResolvedTarget } from '@/target/types/resolved-target.type';
import { extractMetadataValidation } from '@/transport/graphql/extract-metadata-validation';
import { pickSafeResponseHeaders } from '@/transport/pick-safe-response-headers';

const toPublicGraphqlError = (error: unknown) => {
  const entry: Record<string, unknown> = isPlainObject(error) ? error : {};

  return {
    message: isString(entry.message) ? entry.message : 'Unknown GraphQL error',
    path: isArray(entry.path) ? entry.path : null,
    code:
      isPlainObject(entry.extensions) && isString(entry.extensions.code)
        ? entry.extensions.code
        : null,
    ...(isPlainObject(entry.extensions) && isString(entry.extensions.subCode)
      ? { subCode: entry.extensions.subCode }
      : {}),
  };
};

const summarizeMessages = (errors: { message: string }[]) =>
  errors.length === 1
    ? errors[0].message
    : `${errors[0].message} (and ${errors.length - 1} more errors)`;

export const createGraphqlError = ({
  errors,
  data,
  status,
  headers,
  target,
}: {
  errors: unknown[];
  data: unknown;
  status: number;
  headers: Headers;
  target: ResolvedTarget;
}) => {
  const publicErrors = errors.map(toPublicGraphqlError);
  const errorCodes = publicErrors.map((error) => error.code);
  const validation = extractMetadataValidation(errors);
  const details = {
    status,
    headers: pickSafeResponseHeaders(headers),
    errors: publicErrors,
    data: data ?? null,
    ...(validation.errors.length > 0
      ? { validationErrors: validation.errors }
      : {}),
  };

  if (status === 401 || errorCodes.includes('UNAUTHENTICATED')) {
    return new CliError({
      code: 'AUTH_REQUIRED',
      exitCode: EXIT_CODE.AUTHENTICATION,
      message: `${target.apiUrl} rejected the credentials.`,
      hint: getAuthenticationHint(target),
      details,
    });
  }

  if (status === 403 || errorCodes.includes('FORBIDDEN')) {
    return new CliError({
      code: 'PERMISSION_DENIED',
      exitCode: EXIT_CODE.AUTHENTICATION,
      message: summarizeMessages(publicErrors),
      details,
    });
  }

  return new CliError({
    code: 'GRAPHQL_ERROR',
    message: validation.summary ?? summarizeMessages(publicErrors),
    details,
  });
};