PaperTiger.Store.Events (PaperTiger v1.0.2)

ETS-backed storage for Event resources.

Uses the shared store pattern via use PaperTiger.Store which provides:

GenServer wraps ETS table
Reads go directly to ETS (concurrent, fast)
Writes go through GenServer (serialized, safe)

Architecture

ETS Table: :paper_tiger_events (public, read_concurrency: true)
GenServer: Serializes writes, handles initialization
Shared Implementation: All CRUD operations via PaperTiger.Store

Examples

# Direct read (no GenServer bottleneck)
{:ok, event} = PaperTiger.Store.Events.get("evt_123")

# Serialized write
event = %{id: "evt_123", type: "payment_intent.succeeded", ...}
{:ok, event} = PaperTiger.Store.Events.insert(event)

# Query helpers (direct ETS access)
events = PaperTiger.Store.Events.find_by_type("payment_intent.succeeded")

Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

clear()

Clears all events from the store (all namespaces).

clear_namespace(namespace)

Clears all events for a specific namespace.

count()

Counts total events in current namespace.

delete(id)

Deletes a event from the store.

find_by_type(type)

Finds events by type.

get(id)

Retrieves a event by ID.

insert(item)

Inserts a event into the store.

list(opts \\ %{})

Lists all events with optional pagination.

list_namespace(namespace)

Returns all items in a specific namespace.

prefix()

Returns the ID prefix for this resource.

start_link(opts \\ [])

Starts the event store GenServer.

table_name()

Returns the ETS table name for this store.

update(item)

Updates a event in the store.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

clear()

@spec clear() :: :ok

Clears all events 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) :: :ok

Clears all events for a specific namespace.

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

count()

@spec count() :: non_neg_integer()

Counts total events in current namespace.

Direct ETS access - does not go through GenServer.

delete(id)

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

Deletes a event from the store.

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

find_by_type(type)

@spec find_by_type(String.t()) :: [map()]

Finds events by type.

Direct ETS access - does not go through GenServer.

get(id)

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

Retrieves a event 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 event 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 events 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_namespace(namespace)

@spec list_namespace(pid() | :global) :: [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.

start_link(opts \\ [])

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

Starts the event 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 event in the store.

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