effect 4.0.0-beta.66 → 4.0.0-beta.68

package/src/unstable/persistence/RateLimiter.ts

@@ -1,4 +1,29 @@
 /**
+ * Persistent rate limiting for effects that need to coordinate token
+ * consumption through a shared `RateLimiterStore`.
+ *
+ * The module exposes a `RateLimiter` service that can consume tokens for
+ * string keys using either fixed-window counters or token-bucket state. It is
+ * useful for protecting external APIs, enforcing per-user or per-tenant quotas,
+ * throttling job workers, and coordinating limits across multiple fibers or
+ * processes when they share the Redis-backed store. The helpers can fail fast
+ * with `RateLimiterError`, return a delay to apply yourself, or wrap an effect
+ * so it waits before continuing.
+ *
+ * Rate-limit keys and Redis prefixes are part of the persistence namespace, so
+ * choose stable, collision-free values. The in-memory store is process-local
+ * and is only coordinated inside one runtime, while the Redis store uses Lua
+ * scripts for atomic updates under concurrent consumers. Time is measured with
+ * the Effect `Clock`, windows are clamped to at least one millisecond, and
+ * refill calculations use millisecond granularity.
+ *
+ * Fixed-window state is TTL-driven: rejected `fail` attempts do not extend the
+ * current TTL, and Redis fixed-window keys expire automatically. Token-bucket
+ * state keeps the remaining token count and last-refill time instead of using a
+ * TTL, so high-cardinality dynamic keys may need an external cleanup or bounded
+ * key strategy. With `onExceeded: "delay"`, overflow can be recorded so callers
+ * should actually sleep for the returned delay, or use the provided accessors.
+ *
  * @since 4.0.0
  */
 import * as Config from "../../Config.ts"
@@ -11,20 +36,27 @@ import * as Schema from "../../Schema.ts"
 import * as Redis from "./Redis.ts"
 
 /**
+ * Runtime type identifier for `RateLimiter` values.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category Type IDs
  */
 export const TypeId: TypeId = "~effect/persistence/RateLimiter"
 
 /**
+ * Type-level identifier used to brand `RateLimiter` values.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category Type IDs
  */
 export type TypeId = "~effect/persistence/RateLimiter"
 
 /**
+ * Service for consuming rate-limit tokens for a key using fixed-window or
+ * token-bucket algorithms.
+ *
+ * @category models
  * @since 4.0.0
- * @category Models
  */
 export interface RateLimiter {
   readonly [TypeId]: TypeId
@@ -40,14 +72,21 @@ export interface RateLimiter {
 }
 
 /**
- * @since 4.0.0
+ * Context service tag for the `RateLimiter` service.
+ *
  * @category Tags
+ * @since 4.0.0
  */
 export const RateLimiter: Context.Service<RateLimiter, RateLimiter> = Context.Service<RateLimiter>(TypeId)
 
 /**
+ * Creates a `RateLimiter` from the current `RateLimiterStore`.
+ *
+ * The limiter supports fixed-window and token-bucket algorithms and either
+ * fails or returns a delay when a limit is exceeded.
+ *
+ * @category constructors
  * @since 4.0.0
- * @category Constructors
  */
 export const make: Effect.Effect<
   RateLimiter,
@@ -182,8 +221,10 @@ export const make: Effect.Effect<
 })
 
 /**
+ * Provides `RateLimiter` using the current `RateLimiterStore`.
+ *
+ * @category layers
  * @since 4.0.0
- * @category Layers
  */
 export const layer: Layer.Layer<
   RateLimiter,
@@ -194,6 +235,8 @@ export const layer: Layer.Layer<
 /**
  * Access a function that applies rate limiting to an effect.
  *
+ * **Example** (Applying rate limits to effects)
+ *
  * ```ts
  * import { Effect } from "effect"
  * import { RateLimiter } from "effect/unstable/persistence"
@@ -215,8 +258,8 @@ export const layer: Layer.Layer<
  * })
  * ```
  *
- * @since 4.0.0
  * @category Accessors
+ * @since 4.0.0
  */
 export const makeWithRateLimiter: Effect.Effect<
   ((options: {
@@ -241,6 +284,8 @@ export const makeWithRateLimiter: Effect.Effect<
 /**
  * Access a function that sleeps when the rate limit is exceeded.
  *
+ * **Example** (Sleeping until rate limit permits)
+ *
  * ```ts
  * import { Effect } from "effect"
  * import { RateLimiter } from "effect/unstable/persistence"
@@ -260,8 +305,8 @@ export const makeWithRateLimiter: Effect.Effect<
  * })
  * ```
  *
- * @since 4.0.0
  * @category Accessors
+ * @since 4.0.0
  */
 export const makeSleep: Effect.Effect<
   ((options: {
@@ -289,20 +334,28 @@ export const makeSleep: Effect.Effect<
 )
 
 /**
+ * Runtime type identifier for `RateLimiterError`.
+ *
+ * @category errors
  * @since 4.0.0
- * @category Errors
  */
 export const ErrorTypeId: ErrorTypeId = "~@effect/experimental/RateLimiter/RateLimiterError"
 
 /**
+ * Type-level identifier used to brand `RateLimiterError` values.
+ *
+ * @category errors
  * @since 4.0.0
- * @category Errors
  */
 export type ErrorTypeId = "~@effect/experimental/RateLimiter/RateLimiterError"
 
 /**
+ * Error reason for a rate-limit check that exceeded the configured limit.
+ *
+ * Includes the affected key, limit, remaining token count, and retry delay.
+ *
+ * @category errors
  * @since 4.0.0
- * @category Errors
  */
 export class RateLimitExceeded extends Schema.ErrorClass<RateLimitExceeded>(
   "effect/persistence/RateLimiter/RateLimitExceeded"
@@ -314,6 +367,8 @@ export class RateLimitExceeded extends Schema.ErrorClass<RateLimitExceeded>(
   remaining: Schema.Number
 }) {
   /**
+   * Public message used when the rate limiter rejects a request.
+   *
    * @since 4.0.0
    */
   override get message(): string {
@@ -322,8 +377,10 @@ export class RateLimitExceeded extends Schema.ErrorClass<RateLimitExceeded>(
 }
 
 /**
+ * Error reason for failures in the backing `RateLimiterStore`.
+ *
+ * @category errors
  * @since 4.0.0
- * @category Errors
  */
 export class RateLimitStoreError extends Schema.ErrorClass<RateLimitStoreError>(
   "effect/persistence/RateLimiter/RateLimitStoreError"
@@ -334,14 +391,18 @@ export class RateLimitStoreError extends Schema.ErrorClass<RateLimitStoreError>(
 }) {}
 
 /**
+ * Union of reasons carried by `RateLimiterError`.
+ *
+ * @category errors
  * @since 4.0.0
- * @category Errors
  */
 export type RateLimiterErrorReason = RateLimitExceeded | RateLimitStoreError
 
 /**
+ * Schema for all reasons that can be carried by `RateLimiterError`.
+ *
+ * @category errors
  * @since 4.0.0
- * @category Errors
  */
 export const RateLimiterErrorReason: Schema.Union<[
   typeof RateLimitExceeded,
@@ -349,8 +410,11 @@ export const RateLimiterErrorReason: Schema.Union<[
 ]> = Schema.Union([RateLimitExceeded, RateLimitStoreError])
 
 /**
+ * Error raised by rate limiter operations, wrapping a concrete failure
+ * `reason`.
+ *
+ * @category errors
  * @since 4.0.0
- * @category Errors
  */
 export class RateLimiterError extends Schema.ErrorClass<RateLimiterError>(ErrorTypeId)({
   _tag: Schema.tag("RateLimiterError"),
@@ -371,6 +435,8 @@ export class RateLimiterError extends Schema.ErrorClass<RateLimiterError>(ErrorT
   }
 
   /**
+   * Marks this value as a rate limiter error for runtime guards.
+   *
    * @since 4.0.0
    */
   readonly [ErrorTypeId]: ErrorTypeId = ErrorTypeId
@@ -381,8 +447,10 @@ export class RateLimiterError extends Schema.ErrorClass<RateLimiterError>(ErrorT
 }
 
 /**
+ * Metadata returned after consuming tokens from a rate limiter.
+ *
+ * @category models
  * @since 4.0.0
- * @category Models
  */
 export interface ConsumeResult {
   /**
@@ -410,8 +478,10 @@ export interface ConsumeResult {
 }
 
 /**
- * @since 4.0.0
+ * Low-level backing store for fixed-window counters and token-bucket state.
+ *
  * @category RateLimiterStore
+ * @since 4.0.0
  */
 export class RateLimiterStore extends Context.Service<
   RateLimiterStore,
@@ -454,8 +524,10 @@ export class RateLimiterStore extends Context.Service<
 >()("effect/persistence/RateLimiter/RateLimiterStore") {}
 
 /**
- * @since 4.0.0
+ * Provides a process-local in-memory `RateLimiterStore`.
+ *
  * @category RateLimiterStore
+ * @since 4.0.0
  */
 export const layerStoreMemory: Layer.Layer<
   RateLimiterStore
@@ -511,8 +583,11 @@ export const layerStoreMemory: Layer.Layer<
 })
 
 /**
- * @since 4.0.0
+ * Creates a Redis-backed `RateLimiterStore` using Lua scripts and the
+ * configured key prefix.
+ *
  * @category RateLimiterStore
+ * @since 4.0.0
  */
 export const makeStoreRedis = Effect.fnUntraced(function*(
   options?: {
@@ -646,8 +721,10 @@ return next
 ).withReturnType<number>()
 
 /**
+ * Provides a Redis-backed `RateLimiterStore` using `makeStoreRedis`.
+ *
+ * @category layers
  * @since 4.0.0
- * @category Layers
  */
 export const layerStoreRedis: (
   options?: { readonly prefix?: string | undefined }
@@ -658,8 +735,11 @@ export const layerStoreRedis: (
 > = flow(makeStoreRedis, Layer.effect(RateLimiterStore))
 
 /**
+ * Provides a Redis-backed `RateLimiterStore` from wrapped configuration
+ * options.
+ *
+ * @category layers
  * @since 4.0.0
- * @category Layers
  */
 export const layerStoreRedisConfig = (
   options: Config.Wrap<{ readonly prefix?: string | undefined }>

package/src/unstable/persistence/Redis.ts

@@ -1,4 +1,20 @@
 /**
+ * Low-level Redis integration for the persistence modules.
+ *
+ * This module defines the `Redis` service used by Redis-backed persistence,
+ * persisted queues, and rate limiter stores. It adapts an external Redis
+ * connection to Effect through `send` for raw commands and `eval` for typed
+ * Lua scripts that are loaded with `SCRIPT LOAD` and executed with `EVALSHA`.
+ *
+ * The service does not create or manage Redis connections; callers provide a
+ * command sender from their Redis client or pool. Higher-level stores layer on
+ * key prefixes and store ids, so choose stable prefixes to avoid collisions
+ * and remember that schema or primary-key changes can make previously persisted
+ * JSON values fail to decode. Finite TTLs in the persistence stores are applied
+ * with millisecond Redis expirations, while non-finite TTLs are stored without
+ * expiration. Script parameters are stringified before execution, and the
+ * script descriptor's key count controls how Redis splits `KEYS` from `ARGV`.
+ *
  * @since 4.0.0
  */
 import * as Cache from "../../Cache.ts"
@@ -10,8 +26,10 @@ import * as Hash from "../../Hash.ts"
 import * as Schema from "../../Schema.ts"
 
 /**
+ * Service for sending Redis commands and evaluating cached Lua scripts.
+ *
+ * @category services
  * @since 4.0.0
- * @category Service
  */
 export class Redis extends Context.Service<Redis, {
   readonly send: <A = unknown>(command: string, ...args: ReadonlyArray<string>) => Effect.Effect<A, RedisError>
@@ -25,8 +43,13 @@ export class Redis extends Context.Service<Redis, {
 }>()("effect/persistence/Redis") {}
 
 /**
+ * Creates a `Redis` service from a raw command sender.
+ *
+ * Lua scripts are loaded through `SCRIPT LOAD`, cached, and then invoked with
+ * `EVALSHA`.
+ *
+ * @category constructors
  * @since 4.0.0
- * @category Constructors
  */
 export const make = Effect.fnUntraced(function*(
   options: {
@@ -65,14 +88,18 @@ type ErrorTypeId = "~effect/persistence/Redis/RedisError"
 const ErrorTypeId: ErrorTypeId = "~effect/persistence/Redis/RedisError"
 
 /**
+ * Error raised by Redis command or script execution.
+ *
+ * @category errors
  * @since 4.0.0
- * @category Errors
  */
 export class RedisError extends Schema.ErrorClass<RedisError>(ErrorTypeId)({
   _tag: Schema.tag("RedisError"),
   cause: Schema.Defect
 }) {
   /**
+   * Marks this value as a Redis persistence error for runtime guards.
+   *
    * @since 4.0.0
    */
   readonly [ErrorTypeId]: ErrorTypeId = ErrorTypeId
@@ -82,8 +109,13 @@ type ScriptTypeId = "~effect/persistence/Redis/Script"
 const ScriptTypeId: ScriptTypeId = "~effect/persistence/Redis/Script"
 
 /**
- * @since 4.0.0
+ * Typed descriptor for a Redis Lua script.
+ *
+ * It defines the Lua source, parameter-to-argument mapping, Redis key count,
+ * and result type used by `Redis.eval`.
+ *
  * @category Scripting
+ * @since 4.0.0
  */
 export interface Script<
   Config extends {
@@ -125,8 +157,13 @@ const ScriptProto = {
 }
 
 /**
- * @since 4.0.0
+ * Constructs a typed Redis Lua script descriptor.
+ *
+ * The result type defaults to `void` and can be refined with
+ * `withReturnType`.
+ *
  * @category Scripting
+ * @since 4.0.0
  */
 export const script = <Params extends ReadonlyArray<any>>(
   f: (...params: Params) => ReadonlyArray<unknown>,

package/src/unstable/persistence/index.ts

@@ -5,36 +5,183 @@
 // @barrel: Auto-generated exports. Do not edit manually.
 
 /**
+ * Effectful key/value storage for persistence backends.
+ *
+ * This module defines the `KeyValueStore` service used by the persistence
+ * package when a simple string or binary store is enough. It is useful for
+ * lightweight durable state, browser storage, local file-backed data, SQL
+ * tables, test stores, and as the storage primitive underneath higher-level
+ * persistence APIs.
+ *
+ * Values are stored as strings or `Uint8Array`s, and `toSchemaStore` adds a
+ * schema-aware JSON layer for typed values. Schema changes can make existing
+ * JSON fail to decode, and `prefix` should be used to separate namespaces when
+ * several logical stores share the same backend. This service does not provide
+ * native TTL support; higher-level persistence layers encode expiration
+ * metadata in stored values when they need TTLs.
+ *
+ * Backend behavior is intentionally small but not identical: Web Storage is
+ * string-only, `makeStringOnly` stores binary values as base64, filesystem
+ * keys become encoded file names, SQL stores value type metadata in a table,
+ * and the memory layer is process-local. Choose keys, prefixes, table names,
+ * and value formats with those backend constraints in mind.
+ *
  * @since 4.0.0
  */
 export * as KeyValueStore from "./KeyValueStore.ts"
 
 /**
+ * Defines the request-side contract used by the persistence layer.
+ *
+ * A `Persistable` request is a `PrimaryKey` value that carries the success and
+ * error schemas needed to encode and decode the stored `Exit` for that request.
+ * Persisted request resolvers and `PersistedCache` use this metadata to restore
+ * previous lookup results from a backing store before running the lookup again.
+ *
+ * Use `Class` for cacheable or durable requests whose results can safely be
+ * reused across fibers, processes, or restarts. The request primary key is the
+ * entry id inside a persistence store, so it should be stable, collision-free,
+ * and usually include a request-specific prefix. The `storeId` is configured on
+ * `Persistence` or `PersistedCache`; it selects the backing store namespace and
+ * is separate from the request primary key.
+ *
+ * Success and error schemas are encoded with the JSON codec, so persisted
+ * values must be representable by those schemas and any required schema services
+ * must be available where the store reads or writes entries. Changing a schema,
+ * primary-key format, or store id can make existing persisted values fail to
+ * decode or stop being found, so treat those changes as persistence migrations.
+ *
  * @since 4.0.0
  */
 export * as Persistable from "./Persistable.ts"
 
 /**
+ * Persistent caching for `Persistable` request keys.
+ *
+ * A `PersistedCache` combines a scoped in-memory `Cache` with a named
+ * `Persistence` store. It is useful for expensive or idempotent lookups such as
+ * remote API calls, database reads, and request results that should be reused
+ * across fibers, process restarts, or multiple workers sharing the same backing
+ * store.
+ *
+ * The persistent `timeToLive` is evaluated for the stored `Exit`, so successes
+ * and failures can be cached with different lifetimes. The in-memory cache has
+ * its own `inMemoryTTL` and capacity, and `invalidate` removes both the
+ * persisted value and the in-memory entry. Persisted values are encoded with
+ * the key's success and error schemas and stored under the key's primary key, so
+ * schema changes, primary-key changes, or store-id collisions can make old
+ * entries fail to decode until they are invalidated or written under a new
+ * `storeId`.
+ *
  * @since 4.0.0
  */
 export * as PersistedCache from "./PersistedCache.ts"
 
 /**
+ * Schema-aware persisted queues for background work.
+ *
+ * A `PersistedQueue` stores JSON-encoded values in a named queue and lets
+ * workers `take` one value at a time inside a scoped processing window. It is
+ * useful for durable handoffs, background jobs, outbox-style integrations, and
+ * workloads where failed work should be retried across fibers, process
+ * restarts, or multiple workers sharing Redis or SQL.
+ *
+ * Delivery is at-least-once: a handler that fails, is interrupted, or loses its
+ * backing-store lock may see the same element again until `maxAttempts` is
+ * reached. Use stable custom ids when offering idempotent work, and choose ids
+ * that are collision-free for the backing store because stores can enforce
+ * uniqueness at the queue, prefix, or table level. Ordering is intentionally a
+ * store-level concern; retries, lock expiration, polling, and multiple workers
+ * can move entries behind newer work, so handlers should not rely on strict
+ * FIFO processing.
+ *
+ * Values are encoded and decoded with the supplied schema using the JSON codec,
+ * so schema services must be available when offering and taking values. Changing
+ * a queue name, schema, Redis prefix, SQL table, or id format is a persistence
+ * migration: old entries may decode differently, stop being visible, or collide
+ * with new entries. The memory store is process-local and volatile, while Redis
+ * and SQL stores use leases that should be tuned for the expected processing
+ * time.
+ *
  * @since 4.0.0
  */
 export * as PersistedQueue from "./PersistedQueue.ts"
 
 /**
+ * Durable storage for encoded `Persistable` request results.
+ *
+ * The `Persistence` service creates scoped stores that read and write
+ * schema-encoded `Exit` values keyed by each request's `PrimaryKey`. It is the
+ * lower-level persistence layer used by `PersistedCache` and similar request
+ * workflows to reuse expensive or idempotent lookup results across fibers,
+ * process restarts, and workers that share a backing store.
+ *
+ * Each store is selected by a `storeId`, while each entry id comes from the
+ * request's primary key. Keep both stable and collision-free: changing the
+ * `storeId`, the primary-key format, or the success/error schemas is a
+ * persistence migration, because old entries may stop being found or fail to
+ * decode. Values are encoded with the request's success and error schemas using
+ * the JSON codec, so any required schema services must be available at store
+ * read and write time, and the backing value must stay JSON-compatible.
+ *
+ * TTLs are computed from the stored `Exit` and request key. Infinite TTLs are
+ * stored without an expiration, finite TTLs become backing-store expirations,
+ * and zero or negative TTLs skip the write entirely. Backing layers provide
+ * process-local memory, `KeyValueStore`, Redis, and SQL implementations; store
+ * ids are used as prefixes, table names, or SQL partitions and should be
+ * chosen with the target backing store in mind.
+ *
  * @since 4.0.0
  */
 export * as Persistence from "./Persistence.ts"
 
 /**
+ * Persistent rate limiting for effects that need to coordinate token
+ * consumption through a shared `RateLimiterStore`.
+ *
+ * The module exposes a `RateLimiter` service that can consume tokens for
+ * string keys using either fixed-window counters or token-bucket state. It is
+ * useful for protecting external APIs, enforcing per-user or per-tenant quotas,
+ * throttling job workers, and coordinating limits across multiple fibers or
+ * processes when they share the Redis-backed store. The helpers can fail fast
+ * with `RateLimiterError`, return a delay to apply yourself, or wrap an effect
+ * so it waits before continuing.
+ *
+ * Rate-limit keys and Redis prefixes are part of the persistence namespace, so
+ * choose stable, collision-free values. The in-memory store is process-local
+ * and is only coordinated inside one runtime, while the Redis store uses Lua
+ * scripts for atomic updates under concurrent consumers. Time is measured with
+ * the Effect `Clock`, windows are clamped to at least one millisecond, and
+ * refill calculations use millisecond granularity.
+ *
+ * Fixed-window state is TTL-driven: rejected `fail` attempts do not extend the
+ * current TTL, and Redis fixed-window keys expire automatically. Token-bucket
+ * state keeps the remaining token count and last-refill time instead of using a
+ * TTL, so high-cardinality dynamic keys may need an external cleanup or bounded
+ * key strategy. With `onExceeded: "delay"`, overflow can be recorded so callers
+ * should actually sleep for the returned delay, or use the provided accessors.
+ *
  * @since 4.0.0
  */
 export * as RateLimiter from "./RateLimiter.ts"
 
 /**
+ * Low-level Redis integration for the persistence modules.
+ *
+ * This module defines the `Redis` service used by Redis-backed persistence,
+ * persisted queues, and rate limiter stores. It adapts an external Redis
+ * connection to Effect through `send` for raw commands and `eval` for typed
+ * Lua scripts that are loaded with `SCRIPT LOAD` and executed with `EVALSHA`.
+ *
+ * The service does not create or manage Redis connections; callers provide a
+ * command sender from their Redis client or pool. Higher-level stores layer on
+ * key prefixes and store ids, so choose stable prefixes to avoid collisions
+ * and remember that schema or primary-key changes can make previously persisted
+ * JSON values fail to decode. Finite TTLs in the persistence stores are applied
+ * with millisecond Redis expirations, while non-finite TTLs are stored without
+ * expiration. Script parameters are stringified before execution, and the
+ * script descriptor's key count controls how Redis splits `KEYS` from `ARGV`.
+ *
  * @since 4.0.0
  */
 export * as Redis from "./Redis.ts"