All files / kernel-errors/src/errors PeerRestartedError.ts

100% Statements 6/6
100% Branches 0/0
100% Functions 2/2
100% Lines 6/6

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64                                                        6x         6x           174x                                     4x 4x     174x  
import {
  assert,
  literal,
  never,
  object,
  optional,
} from '@metamask/superstruct';
 
import { BaseError } from '../BaseError.ts';
import { marshaledErrorSchema, ErrorCode } from '../constants.ts';
import type { ErrorOptionsWithStack, MarshaledOcapError } from '../types.ts';
 
/**
 * Sentinel error thrown by `sendRemoteMessage` when the outbound handshake
 * detects the peer has restarted. The peer is reachable but its incarnation
 * changed; the freshly dialed channel is closed without registration to
 * keep stale payloads off the wire. Recipients use this to abort retransmit
 * and reject pending traffic generated against the now-dead session.
 */
export class PeerRestartedError extends BaseError {
  /**
   * Creates a new PeerRestartedError.
   *
   * @param options - Additional error options including cause and stack.
   * @param options.cause - The underlying error that caused the peer restart.
   * @param options.stack - The stack trace of the error.
   */
  constructor(options?: ErrorOptionsWithStack) {
    super(
      ErrorCode.PeerRestartedError,
      'Remote peer restarted: message not sent to avoid stale delivery',
      { ...options },
    );
    harden(this);
  }
 
  /**
   * A superstruct struct for validating marshaled {@link PeerRestartedError} instances.
   */
  public static struct = object({
    ...marshaledErrorSchema,
    code: literal(ErrorCode.PeerRestartedError),
    data: optional(never()),
  });
 
  /**
   * Unmarshals a {@link MarshaledError} into a {@link PeerRestartedError}.
   *
   * @param marshaledError - The marshaled error to unmarshal.
   * @param unmarshalErrorOptions - The function to unmarshal the error options.
   * @returns The unmarshaled error.
   */
  public static unmarshal(
    marshaledError: MarshaledOcapError,
    unmarshalErrorOptions: (
      marshaledError: MarshaledOcapError,
    ) => ErrorOptionsWithStack,
  ): PeerRestartedError {
    assert(marshaledError, this.struct);
    return new PeerRestartedError(unmarshalErrorOptions(marshaledError));
  }
}
harden(PeerRestartedError);