Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

2.6 KB
Raw Blame
import { logDefect, logExpected } from '../../utilities/Diagnostics';

import { ApiAuthError } from './ApiAuthError';
import { ApiRequestError } from './ApiRequestError';
import { ClientUpgradeRequiredError } from './ClientUpgradeRequiredError';
import { NetworkError } from './NetworkError';
import { PayloadTooLargeError } from './PayloadTooLargeError';
import { ServerUpdateRequiredError } from './ServerUpdateRequiredError';

/**
 * HTTP statuses that fall into expected failure categories and describe server behavior instead of client error.
 */
const EXPECTED_STATUS_CODES = new Set([401, 403, 404, 409, 413, 426, 429]);

/**
 * Whether an error is an abort: a timeout signal firing, the popup closing mid-request, or a caller cancelling.
 * @param error - the error to inspect
 */
function isAbort(error: unknown): boolean {
  return error instanceof Error && (error.name === 'AbortError' || error.name === 'TimeoutError');
}

/**
 * Whether a failure is one the environment can cause on its own.
 * @param error - the error to classify
 */
export function isExpectedFailure(error: unknown): boolean {
  // NetworkError also covers RequestTimeoutError, which extends it.
  if (error instanceof NetworkError || error instanceof ApiAuthError || error instanceof PayloadTooLargeError) {
    return true;
  }
  if (error instanceof ClientUpgradeRequiredError || error instanceof ServerUpdateRequiredError) {
    return true;
  }
  if (error instanceof ApiRequestError) {
    // A coded 400 is the server refusing on purpose (wrong password, username taken), not a malformed request.
    return error.statusCode >= 500 || EXPECTED_STATUS_CODES.has(error.statusCode) || (error.statusCode === 400 && error.apiErrorCode !== null);
  }
  return isAbort(error);
}

/**
 * Report a failure on the channel its classification calls for: {@link logExpected} for anything the
 * environment can cause, {@link logDefect} for the rest.
 * @param message - what failed, e.g. 'Vault sync failed'
 * @param error - the error to classify and report
 */
export function logFailure(message: string, error: unknown): void {
  if (isExpectedFailure(error)) {
    logExpected(message, error);
    return;
  }
  logDefect(message, error);
}

/**
 * Whether a failed request means the server is unreachable: no response at all, or a gateway in front of it reporting it down.
 * @param error - the error to classify
 */
export function isServerUnreachable(error: unknown): boolean {
  if (error instanceof NetworkError) {
    return true;
  }
  return error instanceof ApiRequestError && [502, 503, 504].includes(error.statusCode);
}