PaperTiger.Store.Requests (PaperTiger v1.2.0)

ETS-backed store for captured inbound API requests during tests.

The request spy supports end-to-end assertions on what was sent to PaperTiger, including method, path, parsed params, and selected headers.

Summary

Types

filter()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

clear()

Clears all requests from the store (all namespaces).

clear_namespace(namespace)

Clears all requests for a specific namespace.

count()

Counts total requests in current namespace.

delete(id)

Deletes a request from the store.

filter(filters)

Returns captured requests filtered by method/path and optional param match.

get(id)

Retrieves a request by ID.

insert(item)

Inserts a request into the store.

list(opts \\ %{})

Lists all requests with optional pagination.

list_all()

Returns all captured requests for the current namespace.

list_namespace(namespace)

Returns all items in a specific namespace.

prefix()

Returns the ID prefix for this resource.

record(conn)

Records an inbound request for later inspection.

start_link(opts \\ [])

Starts the request store GenServer.

table_name()

Returns the ETS table name for this store.

update(item)

Updates a request in the store.

Types

filter()

@type filter() :: [
  method: String.t() | atom() | nil,
  path: String.t() | nil,
  idempotency_key: String.t() | nil,
  params: map() | nil
]

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

clear()

@spec clear() :: :ok

Clears all requests from the store (all namespaces).

Serialized write - goes through GenServer.

Useful for test cleanup. Note: This clears ALL data, not just the current namespace. For namespace-specific cleanup, use clear_namespace/1.

clear_namespace(namespace)

@spec clear_namespace(pid() | :global | {pid() | :global, String.t()}) :: :ok

Clears all requests for a specific namespace.

Used by PaperTiger.Test to clean up after each test.

count()

@spec count() :: non_neg_integer()

Counts total requests in current namespace.

Direct ETS access - does not go through GenServer.

delete(id)

@spec delete(String.t()) :: :ok

Deletes a request from the store.

Serialized write - goes through GenServer. Data is scoped to the current test namespace.

filter(filters)

@spec filter(keyword()) :: [map()]

Returns captured requests filtered by method/path and optional param match.

get(id)

@spec get(String.t()) :: {:ok, map()} | {:error, :not_found}

Retrieves a request by ID.

Direct ETS access - does not go through GenServer. Data is scoped to the current test namespace.

insert(item)

@spec insert(map()) :: {:ok, map()}

Inserts a request into the store.

Serialized write - goes through GenServer to prevent race conditions. Data is scoped to the current test namespace.

list(opts \\ %{})

@spec list(keyword() | map()) :: PaperTiger.List.t()

Lists all requests with optional pagination.

Direct ETS access - does not go through GenServer. Data is scoped to the current test namespace.

Options

:limit - Number of items (default: 10, max: 100)
:starting_after - Cursor for pagination
:ending_before - Reverse cursor

list_all()

@spec list_all() :: [map()]

Returns all captured requests for the current namespace.

list_namespace(namespace)

@spec list_namespace(pid() | :global | {pid() | :global, String.t()}) :: [map()]

Returns all items in a specific namespace.

Useful for debugging test isolation.

prefix()

@spec prefix() :: String.t() | nil

Returns the ID prefix for this resource.

record(conn)

@spec record(Plug.Conn.t()) :: map()

Records an inbound request for later inspection.

start_link(opts \\ [])

@spec start_link(keyword()) :: GenServer.on_start()

Starts the request store GenServer.

table_name()

@spec table_name() :: atom()

Returns the ETS table name for this store.

update(item)

@spec update(map()) :: {:ok, map()}

Updates a request in the store.

Serialized write - goes through GenServer. Data is scoped to the current test namespace.