Effect VCR

This package records Effect HTTP requests into cassette files. Tests can replay the same requests later.

Install

pnpm add -D @useairfoil/effect-vcr @effect/platform-node@^4 effect@^4

Usage

Use VcrHttpClient.layer(...) around the live Effect HTTP client and FileSystemCassetteStore.layer(...) for cassette files.

import { NodeServices } from "@effect/platform-node";
import { FileSystemCassetteStore, VcrHttpClient } from "@useairfoil/effect-vcr";
import { Layer } from "effect";
import { FetchHttpClient } from "effect/http";

const store = FileSystemCassetteStore.layer().pipe(Layer.provide(NodeServices.layer));

const VcrLive = VcrHttpClient.layer({
  vcrName: "provider-api",
  mode: "auto",
}).pipe(Layer.provide(Layer.mergeAll(FetchHttpClient.layer, NodeServices.layer, store)));

Auto mode replays a cassette if it is present. It records one if it is missing. On CI, a missing cassette fails. ACK_DISABLE_VCR=* skips VCR and uses live HTTP.

Requests match on method, URL with its query params, headers, and body. Authorization headers are ignored while matching and removed before a cassette is written. Add other secrets to redact. Query params listed in redact.requestQueryParams are removed from the cassette and ignored while matching, which also helps when a param comes from local config.

Requests can record at the same time. Cassette writes take turns, so no entry is lost.

Configuration

| Variable | Required | Default | | ----------------- | -------- | ------- | | CI | no | false | | ACK_DISABLE_VCR | no | empty |