effect 4.0.0-beta.6 → 4.0.0-beta.60

package/src/Equivalence.ts

@@ -18,7 +18,7 @@
  * - Using strict equality (`===`) → {@link strictEqual}
  * - Combining multiple equivalences (AND logic) → {@link combine}, {@link combineAll}
  * - Transforming input before comparison → {@link mapInput}
- * - Creating equivalences for structured types → {@link Struct}, {@link Tuple}, {@link Array}, {@link Record}
+ * - Creating equivalences for structured types → {@link Struct}, {@link Tuple}, {@link Array_}, {@link Record}
  *
  * ## Gotchas
  *
@@ -46,7 +46,7 @@
  * ## See also
  *
  * - {@link Equal} - For structural equality (can convert to Equivalence)
- * - {@link Array.dedupeWith} - Remove duplicates using an equivalence
+ * - {@link Array_.dedupeWith} - Remove duplicates using an equivalence
  * - {@link Chunk} - Collections that use equivalences for operations
  *
  * @since 2.0.0
@@ -779,7 +779,7 @@ export const mapInput: {
  * ) // true
  * ```
  *
- * See also: {@link Array}, {@link Struct}
+ * See also: {@link Array_}, {@link Struct}
  *
  * @category combinators
  * @since 4.0.0
@@ -801,56 +801,9 @@ export function Tuple<const Elements extends ReadonlyArray<Equivalence<any>>>(
 }
 
 /**
- * Creates an equivalence for arrays where all elements are compared using the same equivalence.
- *
- * When to use this:
- * - When comparing arrays with homogeneous element types
- * - When all elements should use the same equivalence logic
- * - When working with variable-length arrays (not fixed tuples)
- * - Prefer over `Tuple` when you have arrays of the same type
- *
- * Behavior:
- * - Does not mutate inputs
- * - Requires arrays to have the same length; different lengths are never equivalent
- * - Compares elements positionally (index 0 with index 0, etc.)
- * - Returns `true` only if all corresponding elements are equivalent
- * - Empty arrays are considered equivalent
- * - The result is also an equivalence (satisfies reflexive, symmetric, transitive properties)
- *
- * **Example** (Number array equivalence)
- *
- * ```ts
- * import { Equivalence } from "effect"
- *
- * const numberArrayEq = Equivalence.Array(Equivalence.strictEqual<number>())
- *
- * console.log(numberArrayEq([1, 2, 3], [1, 2, 3])) // true
- * console.log(numberArrayEq([1, 2, 3], [1, 2, 4])) // false
- * console.log(numberArrayEq([1, 2], [1, 2, 3])) // false (different length)
- * ```
- *
- * **Example** (Case-insensitive string array)
- *
- * ```ts
- * import { Equivalence } from "effect"
- *
- * const caseInsensitive = Equivalence.mapInput(
- *   Equivalence.strictEqual<string>(),
- *   (s: string) => s.toLowerCase()
- * )
- * const stringArrayEq = Equivalence.Array(caseInsensitive)
- *
- * console.log(stringArrayEq(["Hello", "World"], ["HELLO", "WORLD"])) // true
- * console.log(stringArrayEq(["Hello"], ["Hi"])) // false
- * console.log(stringArrayEq([], [])) // true (empty arrays)
- * ```
- *
- * See also: {@link Tuple}, {@link Record}
- *
- * @category combinators
  * @since 4.0.0
  */
-export function Array<A>(item: Equivalence<A>): Equivalence<ReadonlyArray<A>> {
+function Array_<A>(item: Equivalence<A>): Equivalence<ReadonlyArray<A>> {
   return make((self, that) => {
     if (self.length !== that.length) return false
 
@@ -861,6 +814,59 @@ export function Array<A>(item: Equivalence<A>): Equivalence<ReadonlyArray<A>> {
     return true
   })
 }
+export {
+  /**
+   * Creates an equivalence for arrays where all elements are compared using the same equivalence.
+   *
+   * When to use this:
+   * - When comparing arrays with homogeneous element types
+   * - When all elements should use the same equivalence logic
+   * - When working with variable-length arrays (not fixed tuples)
+   * - Prefer over `Tuple` when you have arrays of the same type
+   *
+   * Behavior:
+   * - Does not mutate inputs
+   * - Requires arrays to have the same length; different lengths are never equivalent
+   * - Compares elements positionally (index 0 with index 0, etc.)
+   * - Returns `true` only if all corresponding elements are equivalent
+   * - Empty arrays are considered equivalent
+   * - The result is also an equivalence (satisfies reflexive, symmetric, transitive properties)
+   *
+   * **Example** (Number array equivalence)
+   *
+   * ```ts
+   * import { Equivalence } from "effect"
+   *
+   * const numberArrayEq = Equivalence.Array(Equivalence.strictEqual<number>())
+   *
+   * console.log(numberArrayEq([1, 2, 3], [1, 2, 3])) // true
+   * console.log(numberArrayEq([1, 2, 3], [1, 2, 4])) // false
+   * console.log(numberArrayEq([1, 2], [1, 2, 3])) // false (different length)
+   * ```
+   *
+   * **Example** (Case-insensitive string array)
+   *
+   * ```ts
+   * import { Equivalence } from "effect"
+   *
+   * const caseInsensitive = Equivalence.mapInput(
+   *   Equivalence.strictEqual<string>(),
+   *   (s: string) => s.toLowerCase()
+   * )
+   * const stringArrayEq = Equivalence.Array(caseInsensitive)
+   *
+   * console.log(stringArrayEq(["Hello", "World"], ["HELLO", "WORLD"])) // true
+   * console.log(stringArrayEq(["Hello"], ["Hi"])) // false
+   * console.log(stringArrayEq([], [])) // true (empty arrays)
+   * ```
+   *
+   * See also: {@link Tuple}, {@link Record}
+   *
+   * @category combinators
+   * @since 4.0.0
+   */
+  Array_ as Array
+}
 
 /**
  * Creates an equivalence for objects by comparing their properties using provided equivalences.
@@ -992,7 +998,7 @@ export function Struct<R extends Record<string, Equivalence<any>>>(
  * console.log(numberRecordEq(scores1, scores3)) // false
  * ```
  *
- * See also: {@link Struct}, {@link Array}
+ * See also: {@link Struct}, {@link Array_}
  *
  * @category combinators
  * @since 4.0.0
@@ -1060,3 +1066,59 @@ export function makeReducer<A>() {
     combineAll
   )
 }
+
+/**
+ * An `Equivalence` instance for `Date` objects.
+ *
+ * Dates are compared by their time value (milliseconds since the Unix epoch),
+ * using {@link Date.prototype.getTime}.
+ *
+ * When to use this:
+ * - When comparing `Date` objects by their exact point in time
+ * - When you need value-based equality instead of reference equality
+ * - When working with collections that contain `Date` values
+ *
+ * Behavior:
+ * - Does not mutate inputs
+ * - Two dates are equivalent if `self.getTime() === that.getTime()`
+ * - Internally uses {@link Number} equivalence
+ * - Different `Date` instances representing the same time are considered equivalent
+ *
+ * **Example**
+ *
+ * ```ts
+ * import { Equivalence } from "effect"
+ *
+ * const d1 = new Date("2020-01-01T00:00:00.000Z")
+ * const d2 = new Date("2020-01-01T00:00:00.000Z")
+ * const d3 = new Date("2021-01-01T00:00:00.000Z")
+ * const invalidDate1 = new Date("foo")
+ * const invalidDate2 = new Date("bar")
+ *
+ * console.log(Equivalence.Date(d1, d2)) // true
+ * console.log(Equivalence.Date(d1, d3)) // false
+ * console.log(Equivalence.Date(invalidDate1, invalidDate2)) // true
+ * console.log(Equivalence.Date(invalidDate1, d1)) // false
+ * ```
+ *
+ * **Example** (Reference vs value equality)
+ *
+ * ```ts
+ * import { Equivalence } from "effect"
+ *
+ * const d1 = new Date(0)
+ * const d2 = new Date(0)
+ *
+ * console.log(d1 === d2) // false (different references)
+ * console.log(Equivalence.Date(d1, d2)) // true (same time value)
+ * ```
+ *
+ * See also: {@link Number}, {@link mapInput}, {@link strictEqual}
+ *
+ * @category instances
+ * @since 4.0.0
+ */
+export const Date: Equivalence<Date> = mapInput(
+  Number,
+  (d: Date) => d.getTime()
+)

package/src/ErrorReporter.ts

@@ -0,0 +1,458 @@
+/**
+ * Pluggable error reporting for Effect programs.
+ *
+ * Reporting is triggered by `Effect.withErrorReporting`,
+ * `ErrorReporter.report`, or built-in reporting boundaries in the HTTP and
+ * RPC server modules.
+ *
+ * Each reporter receives a structured callback with the failing `Cause`, a
+ * pretty-printed `Error`, severity, and any extra attributes attached to the
+ * original error — making it straightforward to forward failures to Sentry,
+ * Datadog, or a custom logging backend.
+ *
+ * Use the annotation symbols (`ignore`, `severity`, `attributes`) on your
+ * error classes to control reporting behavior per-error.
+ *
+ * @example
+ * ```ts
+ * import { Data, Effect, ErrorReporter } from "effect"
+ *
+ * // A reporter that logs to the console
+ * const consoleReporter = ErrorReporter.make(({ error, severity }) => {
+ *   console.error(`[${severity}]`, error.message)
+ * })
+ *
+ * // An error that should be ignored by reporters
+ * class NotFoundError extends Data.TaggedError("NotFoundError")<{}> {
+ *   readonly [ErrorReporter.ignore] = true
+ * }
+ *
+ * // An error with custom severity and attributes
+ * class RateLimitError extends Data.TaggedError("RateLimitError")<{
+ *   readonly retryAfter: number
+ * }> {
+ *   readonly [ErrorReporter.severity] = "Warn" as const
+ *   readonly [ErrorReporter.attributes] = {
+ *     retryAfter: this.retryAfter
+ *   }
+ * }
+ *
+ * // Opt in to error reporting with Effect.withErrorReporting
+ * const program = Effect.gen(function*() {
+ *   return yield* new RateLimitError({ retryAfter: 60 })
+ * }).pipe(
+ *   Effect.withErrorReporting,
+ *   Effect.provide(ErrorReporter.layer([consoleReporter]))
+ * )
+ * ```
+ *
+ * @since 4.0.0
+ */
+import type * as Cause from "./Cause.ts"
+import type * as Context from "./Context.ts"
+import * as Effect from "./Effect.ts"
+import type * as Fiber from "./Fiber.ts"
+import * as effect from "./internal/effect.ts"
+import * as references from "./internal/references.ts"
+import * as Layer from "./Layer.ts"
+import * as LogLevel from "./LogLevel.ts"
+import type { Severity } from "./LogLevel.ts"
+import type { ReadonlyRecord } from "./Record.ts"
+import type * as Scope from "./Scope.ts"
+
+/**
+ * @since 4.0.0
+ * @category Type Identifiers
+ */
+export type TypeId = "~effect/ErrorReporter"
+
+/**
+ * @since 4.0.0
+ * @category Type Identifiers
+ */
+export const TypeId: TypeId = "~effect/ErrorReporter"
+
+/**
+ * An `ErrorReporter` receives reported failures and forwards them to an
+ * external system (logging service, error tracker, etc.).
+ *
+ * Reporting is triggered by `Effect.withErrorReporting`,
+ * `ErrorReporter.report`, or built-in boundaries in the HTTP and RPC server
+ * modules. Use {@link make} to create a reporter — it handles deduplication
+ * and per-error annotation extraction automatically.
+ *
+ * @since 4.0.0
+ * @category Models
+ */
+export interface ErrorReporter {
+  readonly [TypeId]: TypeId
+  report(options: {
+    readonly cause: Cause.Cause<unknown>
+    readonly fiber: Fiber.Fiber<unknown, unknown>
+    readonly timestamp: bigint
+  }): void
+}
+
+/**
+ * Creates an `ErrorReporter` from a callback.
+ *
+ * The returned reporter automatically deduplicates causes and individual
+ * errors (the same object is never reported twice), skips interruptions,
+ * and resolves the `ignore`, `severity`, and `attributes` annotations on
+ * each error before invoking your callback.
+ *
+ * @example
+ * ```ts
+ * import { ErrorReporter } from "effect"
+ *
+ * // Forward every failure to the console
+ * const consoleReporter = ErrorReporter.make(
+ *   ({ error, severity, attributes }) => {
+ *     console.error(`[${severity}]`, error.message, attributes)
+ *   }
+ * )
+ * ```
+ *
+ * @since 4.0.0
+ * @category Constructors
+ */
+export const make = (
+  report: (options: {
+    readonly cause: Cause.Cause<unknown>
+    readonly error: Error
+    readonly attributes: ReadonlyRecord<string, unknown>
+    readonly severity: Severity
+    readonly fiber: Fiber.Fiber<unknown, unknown>
+    readonly timestamp: bigint
+  }) => void
+): ErrorReporter => {
+  const reported = new WeakSet<Cause.Cause<unknown> | object>()
+  return {
+    [TypeId]: TypeId,
+    report(options) {
+      if (reported.has(options.cause)) return
+      reported.add(options.cause)
+      for (let i = 0; i < options.cause.reasons.length; i++) {
+        const reason = options.cause.reasons[i]
+        if (reason._tag === "Interrupt") continue
+        const original = reason._tag === "Fail" ? reason.error : reason.defect
+        const isObject = typeof original === "object" && original !== null
+        if (isObject) {
+          if (reported.has(original)) continue
+          reported.add(original)
+        }
+        if (isIgnored(original)) continue
+        const pretty = effect.causePrettyError(original as any, reason.annotations)
+        report({
+          ...options,
+          error: pretty,
+          severity: isObject ? getSeverity(original) : "Info",
+          attributes: isObject ? getAttributes(original) : emptyAttributes
+        })
+      }
+    }
+  }
+}
+
+/**
+ * A `Context.Reference` holding the set of active `ErrorReporter`s for the
+ * current fiber. Defaults to an empty set (no reporting).
+ *
+ * Prefer {@link layer} to configure reporters via the `Layer` API. Use this
+ * reference directly only when you need low-level control (e.g. reading the
+ * current reporters or swapping them inside a `FiberRef`).
+ *
+ * @since 4.0.0
+ * @category References
+ */
+export const CurrentErrorReporters: Context.Reference<ReadonlySet<ErrorReporter>> = references.CurrentErrorReporters
+
+/**
+ * Creates a `Layer` that registers one or more `ErrorReporter`s.
+ *
+ * Reporters can be plain `ErrorReporter` values or effectful
+ * `Effect<ErrorReporter>` values that are resolved when the layer is built.
+ *
+ * By default the provided reporters **replace** any previously registered
+ * reporters. Set `mergeWithExisting: true` to add them alongside existing
+ * ones.
+ *
+ * @example
+ * ```ts
+ * import { Effect, ErrorReporter } from "effect"
+ *
+ * const consoleReporter = ErrorReporter.make(({ error, severity }) => {
+ *   console.error(`[${severity}]`, error.message)
+ * })
+ *
+ * const metricsReporter = ErrorReporter.make(({ severity }) => {
+ *   // increment an error counter by severity
+ * })
+ *
+ * // Replace all existing reporters
+ * const ReporterLive = ErrorReporter.layer([
+ *   consoleReporter,
+ *   metricsReporter
+ * ])
+ *
+ * // Add to existing reporters instead of replacing
+ * const ReporterMerged = ErrorReporter.layer(
+ *   [metricsReporter],
+ *   { mergeWithExisting: true }
+ * )
+ *
+ * const program = Effect.fail("boom").pipe(
+ *   Effect.withErrorReporting,
+ *   Effect.provide(ReporterLive)
+ * )
+ * ```
+ *
+ * @since 4.0.0
+ * @category Layers
+ */
+export const layer = <
+  const Reporters extends ReadonlyArray<ErrorReporter | Effect.Effect<ErrorReporter, any, any>>
+>(
+  reporters: Reporters,
+  options?: { readonly mergeWithExisting?: boolean | undefined } | undefined
+): Layer.Layer<
+  never,
+  Reporters extends readonly [] ? never : Effect.Error<Reporters[number]>,
+  Exclude<
+    Reporters extends readonly [] ? never : Effect.Services<Reporters[number]>,
+    Scope.Scope
+  >
+> =>
+  Layer.effect(
+    CurrentErrorReporters,
+    Effect.withFiber(Effect.fnUntraced(function*(fiber) {
+      const currentReporters = new Set(
+        options?.mergeWithExisting === true ? fiber.getRef(references.CurrentErrorReporters) : []
+      )
+      for (const reporter of reporters) {
+        currentReporters.add(Effect.isEffect(reporter) ? yield* reporter : reporter)
+      }
+      return currentReporters
+    }))
+  )
+
+/**
+ * Manually report a `Cause` to all registered `ErrorReporter`s on the
+ * current fiber.
+ *
+ * This is useful when you want to report an error for observability without
+ * actually failing the fiber.
+ *
+ * @example
+ * ```ts
+ * import { Cause, Effect, ErrorReporter } from "effect"
+ *
+ * // Log the cause for monitoring, then continue with a fallback
+ * const program = Effect.gen(function*() {
+ *   const cause = Cause.fail("something went wrong")
+ *   yield* ErrorReporter.report(cause)
+ *   return "fallback value"
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category Reporting
+ */
+export const report = <E>(cause: Cause.Cause<E>): Effect.Effect<void> =>
+  Effect.withFiber((fiber) => {
+    effect.reportCauseUnsafe(fiber, cause)
+    return Effect.void
+  })
+
+/**
+ * Interface that errors can implement to control reporting behavior.
+ *
+ * All three annotation properties are optional:
+ * - `[ErrorReporter.ignore]` — when `true`, the error is never reported
+ * - `[ErrorReporter.severity]` — overrides the default `"Error"` severity
+ * - `[ErrorReporter.attributes]` — extra key/value pairs forwarded to reporters
+ *
+ * The global `Error` interface is augmented with `Reportable`, so these
+ * properties are available on all `Error` instances.
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export interface Reportable {
+  readonly [ignore]?: boolean
+  readonly [severity]?: Severity
+  readonly [attributes]?: ReadonlyRecord<string, unknown>
+}
+
+declare global {
+  interface Error extends Reportable {}
+}
+
+/**
+ * Symbol key used to mark an error as unreportable.
+ *
+ * Set this property to `true` on any error class to prevent it from being
+ * forwarded to reporters. Useful for expected errors such as HTTP 404s.
+ *
+ * @example
+ * ```ts
+ * import { Data, ErrorReporter } from "effect"
+ *
+ * class NotFoundError extends Data.TaggedError("NotFoundError")<{}> {
+ *   readonly [ErrorReporter.ignore] = true
+ * }
+ * ```
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export type ignore = "~effect/ErrorReporter/ignore"
+
+/**
+ * Symbol key used to mark an error as unreportable.
+ *
+ * Set this property to `true` on any error class to prevent it from being
+ * forwarded to reporters. Useful for expected errors such as HTTP 404s.
+ *
+ * @example
+ * ```ts
+ * import { Data, ErrorReporter } from "effect"
+ *
+ * class NotFoundError extends Data.TaggedError("NotFoundError")<{}> {
+ *   readonly [ErrorReporter.ignore] = true
+ * }
+ * ```
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export const ignore: ignore = "~effect/ErrorReporter/ignore"
+
+/**
+ * Returns `true` if the given value has the `ErrorReporter.ignore` annotation
+ * set to `true`.
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export const isIgnored = (u: unknown): boolean =>
+  typeof u === "object" && u !== null && ignore in u && u[ignore] === true
+
+/**
+ * Symbol key used to override the severity level of an error.
+ *
+ * When set, the reporter callback receives this value as `severity` instead
+ * of the default `"Error"`. Accepted values are the `LogLevel.Severity`
+ * literals: `"Trace"`, `"Debug"`, `"Info"`, `"Warn"`, `"Error"`, `"Fatal"`.
+ *
+ * @example
+ * ```ts
+ * import { Data, ErrorReporter } from "effect"
+ *
+ * class DeprecationWarning extends Data.TaggedError("DeprecationWarning")<{}> {
+ *   readonly [ErrorReporter.severity] = "Warn" as const
+ * }
+ * ```
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export type severity = "~effect/ErrorReporter/severity"
+
+/**
+ * Symbol key used to override the severity level of an error.
+ *
+ * When set, the reporter callback receives this value as `severity` instead
+ * of the default `"Error"`. Accepted values are the `LogLevel.Severity`
+ * literals: `"Trace"`, `"Debug"`, `"Info"`, `"Warn"`, `"Error"`, `"Fatal"`.
+ *
+ * @example
+ * ```ts
+ * import { Data, ErrorReporter } from "effect"
+ *
+ * class DeprecationWarning extends Data.TaggedError("DeprecationWarning")<{}> {
+ *   readonly [ErrorReporter.severity] = "Warn" as const
+ * }
+ * ```
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export const severity: severity = "~effect/ErrorReporter/severity"
+
+/**
+ * Reads the `ErrorReporter.severity` annotation from an error object,
+ * falling back to `"Error"` when unset or invalid.
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export const getSeverity = (error: object): Severity => {
+  if (severity in error && LogLevel.values.includes(error[severity] as Severity)) {
+    return error[severity] as Severity
+  }
+  return "Info"
+}
+
+/**
+ * Symbol key used to attach extra key/value metadata to an error report.
+ *
+ * Reporters receive these attributes alongside the error, making it easy to
+ * include contextual information such as user IDs, request IDs, or any
+ * domain-specific data useful for debugging.
+ *
+ * @example
+ * ```ts
+ * import { Data, ErrorReporter } from "effect"
+ *
+ * class PaymentError extends Data.TaggedError("PaymentError")<{
+ *   readonly orderId: string
+ * }> {
+ *   readonly [ErrorReporter.attributes] = {
+ *     orderId: this.orderId
+ *   }
+ * }
+ * ```
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export type attributes = "~effect/ErrorReporter/attributes"
+
+/**
+ * Symbol key used to attach extra key/value metadata to an error report.
+ *
+ * Reporters receive these attributes alongside the error, making it easy to
+ * include contextual information such as user IDs, request IDs, or any
+ * domain-specific data useful for debugging.
+ *
+ * @example
+ * ```ts
+ * import { Data, ErrorReporter } from "effect"
+ *
+ * class PaymentError extends Data.TaggedError("PaymentError")<{
+ *   readonly orderId: string
+ * }> {
+ *   readonly [ErrorReporter.attributes] = {
+ *     orderId: this.orderId
+ *   }
+ * }
+ * ```
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export const attributes: attributes = "~effect/ErrorReporter/attributes"
+
+/**
+ * Reads the `ErrorReporter.attributes` annotation from an error object,
+ * returning an empty record when unset.
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export const getAttributes = (error: object): ReadonlyRecord<string, unknown> => {
+  return attributes in error ? error[attributes] as any : emptyAttributes
+}
+
+const emptyAttributes: ReadonlyRecord<string, unknown> = {}