protocol/testing/toxics

Public barrel for Toxiproxy toxic profiles and control helpers.

protocol/testing/toxics

packages/protocol/src/testing/toxics

Purpose

Public barrel for Toxiproxy toxic profiles and control helpers.

Public surface

allToxicTags

Variable

export const allToxicTags = [
  "latency",
  "bandwidth",
  "slicer",
  "reset_peer",
  "timeout",
  "slow_close",
] as const

All six toxic tags, enumerated for coverage assertions in Tier D.

defaultToxicProfile

Variable

export const defaultToxicProfile:

Provides the default toxic profile runtime value.

makeToxiproxyClient

Function

export function makeToxiproxyClient(
  config: ToxiproxyConfig,
): Effect.Effect<ToxiproxyClient, ToxicControlError>

Creates toxiproxy client.

Returns: The created toxiproxy client.

ToxicControlError

Class

export class ToxicControlError extends Data.TaggedError(
  "TestingToxicControlError",
)<{
  readonly op: "create-proxy" | "delete-proxy" | "add-toxic" | "remove-toxic";
  readonly status: number;
  readonly body: string;
}> {}

Toxiproxy HTTP API returned a non-2xx, or the control endpoint is down.

ToxicHandle

Interface

export interface ToxicHandle {
  readonly name: string;
  readonly profile: ToxicProfile;
}

A live toxic attachment. Scoped: acquiring adds the toxic to the proxy, releasing the scope removes it. Tier D properties acquire a ToxicHandle inside Effect.scoped so a crashed property still cleans up.

ToxicProfile

TypeAlias

export type ToxicProfile =
  | {
      readonly _tag: "latency";
      /** Added latency in milliseconds, per-packet. */
      readonly latencyMs: number;
      /** Random jitter in ms, uniform [0, jitterMs). */
      readonly jitterMs: number;
    }

Represents toxic profile values.

ToxicTag

TypeAlias

export type ToxicTag = (typeof allToxicTags)[number];

Represents toxic tag values.

ToxiproxyClient

Interface

export interface ToxiproxyClient {
  /** Create a scoped proxy; teardown on release. */
  readonly proxy: (opts: {
    readonly name: string;
    readonly upstream: string;
  }) => Effect.Effect<ToxiproxyProxy, ToxicControlError, Scope.Scope>;
  /** Probe: control plane reachable. */
  readonly ping: Effect.Effect<void, ToxicControlError>;
}

Describes toxiproxy client.

ToxiproxyConfig

Interface

export interface ToxiproxyConfig {
  /** Control-plane URL, e.g. `http://localhost:8474`. */
  readonly apiUrl: string;
  readonly network?: ToxiproxyNetworkConfig;
}

Describes toxiproxy config.

ToxiproxyNetworkConfig

Interface

export interface ToxiproxyNetworkConfig {
  /** Hostname Toxiproxy should use when dialing the real server upstream. */
  readonly upstreamHost?: string;
  /** Address Toxiproxy should bind inside its own process/container. */
  readonly listenHost?: string;
  /** Hostname conformance clients should use when dialing a Toxiproxy listener. */
  readonly connectHost?: string;
  /** Fixed listener port range for Docker bridge mode. Omit for `:0`. */
  readonly listenPortRange?: ToxiproxyListenPortRange;
}

Describes toxiproxy network config.

ToxiproxyProxy

Interface

export interface ToxiproxyProxy {
  /** Upstream (real server) address the proxy forwards to. */
  readonly upstream: string;
  /** Client-facing URL (`ws://127.0.0.1:<ephemeralPort>`). */
  readonly listenUrl: string;
  /** Attach a toxic inside a Scope; removed on release. */
  readonly withToxic: (
    profile: ToxicProfile,
  ) => Effect.Effect<ToxicHandle, ToxicControlError, Scope.Scope>;
}

A live proxy that sits between TestClient and the real server (or between real client and TestServer). Acquiring the scope allocates an ephemeral port and registers the proxy; releasing deletes it.

Files

• client.ts
• defaults.ts
• errors.ts
• profile.ts