@clayroach/effect 3.19.14-source-capture.8 → 3.19.14-source-trace.1

package/src/FiberRef.ts

@@ -0,0 +1,444 @@
+/**
+ * @since 2.0.0
+ */
+import type * as Cause from "./Cause.js"
+import type * as Chunk from "./Chunk.js"
+import type * as Context from "./Context.js"
+import type * as Differ from "./Differ.js"
+import type * as Effect from "./Effect.js"
+import type { LazyArg } from "./Function.js"
+import type * as HashMap from "./HashMap.js"
+import type * as HashSet from "./HashSet.js"
+import * as core from "./internal/core.js"
+import * as fiberRuntime from "./internal/fiberRuntime.js"
+import * as query from "./internal/query.js"
+import type * as List from "./List.js"
+import type * as Logger from "./Logger.js"
+import type * as LogLevel from "./LogLevel.js"
+import type * as LogSpan from "./LogSpan.js"
+import type * as MetricLabel from "./MetricLabel.js"
+import type * as Option from "./Option.js"
+import type * as Request from "./Request.js"
+import type * as RuntimeFlags from "./RuntimeFlags.js"
+import * as Scheduler from "./Scheduler.js"
+import type * as Scope from "./Scope.js"
+import type * as SourceLocation from "./SourceLocation.js"
+import type * as Supervisor from "./Supervisor.js"
+import type * as Tracer from "./Tracer.js"
+import type * as Types from "./Types.js"
+import type * as Unify from "./Unify.js"
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const FiberRefTypeId: unique symbol = core.FiberRefTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type FiberRefTypeId = typeof FiberRefTypeId
+
+/**
+ * @since 2.0.0
+ * @category model
+ */
+export interface FiberRef<in out A> extends Effect.Effect<A>, Variance<A> {
+  /** @internal */
+  readonly initial: A
+  /** @internal */
+  diff(oldValue: A, newValue: A): unknown
+  /** @internal */
+  combine(first: unknown, second: unknown): unknown
+  /** @internal */
+  patch(patch: unknown): (oldValue: A) => A
+  /** @internal */
+  readonly fork: unknown
+  /** @internal */
+  join(oldValue: A, newValue: A): A
+  readonly [Unify.typeSymbol]?: unknown
+  readonly [Unify.unifySymbol]?: FiberRefUnify<this>
+  readonly [Unify.ignoreSymbol]?: FiberRefUnifyIgnore
+}
+
+/**
+ * @category models
+ * @since 3.8.0
+ */
+export interface FiberRefUnify<A extends { [Unify.typeSymbol]?: any }> extends Effect.EffectUnify<A> {
+  FiberRef?: () => Extract<A[Unify.typeSymbol], FiberRef<any>>
+}
+
+/**
+ * @category models
+ * @since 3.8.0
+ */
+export interface FiberRefUnifyIgnore extends Effect.EffectUnifyIgnore {
+  Effect?: true
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Variance<in out A> {
+  readonly [FiberRefTypeId]: {
+    readonly _A: Types.Invariant<A>
+  }
+}
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const make: <A>(
+  initial: A,
+  options?: {
+    readonly fork?: ((a: A) => A) | undefined
+    readonly join?: ((left: A, right: A) => A) | undefined
+  }
+) => Effect.Effect<FiberRef<A>, never, Scope.Scope> = fiberRuntime.fiberRefMake
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const makeWith: <Value>(ref: LazyArg<FiberRef<Value>>) => Effect.Effect<FiberRef<Value>, never, Scope.Scope> =
+  fiberRuntime.fiberRefMakeWith
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const makeContext: <A>(
+  initial: Context.Context<A>
+) => Effect.Effect<FiberRef<Context.Context<A>>, never, Scope.Scope> = fiberRuntime.fiberRefMakeContext
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const makeRuntimeFlags: (
+  initial: RuntimeFlags.RuntimeFlags
+) => Effect.Effect<FiberRef<RuntimeFlags.RuntimeFlags>, never, Scope.Scope> = fiberRuntime.fiberRefMakeRuntimeFlags
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const unsafeMake: <Value>(
+  initial: Value,
+  options?: {
+    readonly fork?: ((a: Value) => Value) | undefined
+    readonly join?: ((left: Value, right: Value) => Value) | undefined
+  }
+) => FiberRef<Value> = core.fiberRefUnsafeMake
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const unsafeMakeHashSet: <A>(initial: HashSet.HashSet<A>) => FiberRef<HashSet.HashSet<A>> =
+  core.fiberRefUnsafeMakeHashSet
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const unsafeMakeContext: <A>(initial: Context.Context<A>) => FiberRef<Context.Context<A>> =
+  core.fiberRefUnsafeMakeContext
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const unsafeMakeSupervisor: (initial: Supervisor.Supervisor<any>) => FiberRef<Supervisor.Supervisor<any>> =
+  fiberRuntime.fiberRefUnsafeMakeSupervisor
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const unsafeMakePatch: <Value, Patch>(
+  initial: Value,
+  options: {
+    readonly differ: Differ.Differ<Value, Patch>
+    readonly fork: Patch
+    readonly join?: ((oldV: Value, newV: Value) => Value) | undefined
+  }
+) => FiberRef<Value> = core.fiberRefUnsafeMakePatch
+
+/**
+ * @since 2.0.0
+ * @category getters
+ */
+export const get: <A>(self: FiberRef<A>) => Effect.Effect<A> = core.fiberRefGet
+
+/**
+ * @since 2.0.0
+ * @category utils
+ */
+export const getAndSet: {
+  <A>(value: A): (self: FiberRef<A>) => Effect.Effect<A>
+  <A>(self: FiberRef<A>, value: A): Effect.Effect<A>
+} = core.fiberRefGetAndSet
+
+/**
+ * @since 2.0.0
+ * @category utils
+ */
+export const getAndUpdate: {
+  <A>(f: (a: A) => A): (self: FiberRef<A>) => Effect.Effect<A>
+  <A>(self: FiberRef<A>, f: (a: A) => A): Effect.Effect<A>
+} = core.fiberRefGetAndUpdate
+
+/**
+ * @since 2.0.0
+ * @category utils
+ */
+export const getAndUpdateSome: {
+  <A>(pf: (a: A) => Option.Option<A>): (self: FiberRef<A>) => Effect.Effect<A>
+  <A>(self: FiberRef<A>, pf: (a: A) => Option.Option<A>): Effect.Effect<A>
+} = core.fiberRefGetAndUpdateSome
+
+/**
+ * @since 2.0.0
+ * @category utils
+ */
+export const getWith: {
+  <A, B, E, R>(f: (a: A) => Effect.Effect<B, E, R>): (self: FiberRef<A>) => Effect.Effect<B, E, R>
+  <A, B, E, R>(self: FiberRef<A>, f: (a: A) => Effect.Effect<B, E, R>): Effect.Effect<B, E, R>
+} = core.fiberRefGetWith
+
+/**
+ * @since 2.0.0
+ * @category utils
+ */
+export const set: {
+  <A>(value: A): (self: FiberRef<A>) => Effect.Effect<void>
+  <A>(self: FiberRef<A>, value: A): Effect.Effect<void>
+} = core.fiberRefSet
+
+const _delete: <A>(self: FiberRef<A>) => Effect.Effect<void> = core.fiberRefDelete
+
+export {
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
+  _delete as delete
+}
+
+/**
+ * @since 2.0.0
+ * @category utils
+ */
+export const reset: <A>(self: FiberRef<A>) => Effect.Effect<void> = core.fiberRefReset
+
+/**
+ * @since 2.0.0
+ * @category utils
+ */
+export const modify: {
+  <A, B>(f: (a: A) => readonly [B, A]): (self: FiberRef<A>) => Effect.Effect<B>
+  <A, B>(self: FiberRef<A>, f: (a: A) => readonly [B, A]): Effect.Effect<B>
+} = core.fiberRefModify
+
+/**
+ * @since 2.0.0
+ * @category utils
+ */
+export const modifySome: <A, B>(
+  self: FiberRef<A>,
+  def: B,
+  f: (a: A) => Option.Option<readonly [B, A]>
+) => Effect.Effect<B> = core.fiberRefModifySome
+
+/**
+ * @since 2.0.0
+ * @category utils
+ */
+export const update: {
+  <A>(f: (a: A) => A): (self: FiberRef<A>) => Effect.Effect<void>
+  <A>(self: FiberRef<A>, f: (a: A) => A): Effect.Effect<void>
+} = core.fiberRefUpdate
+
+/**
+ * @since 2.0.0
+ * @category utils
+ */
+export const updateSome: {
+  <A>(pf: (a: A) => Option.Option<A>): (self: FiberRef<A>) => Effect.Effect<void>
+  <A>(self: FiberRef<A>, pf: (a: A) => Option.Option<A>): Effect.Effect<void>
+} = core.fiberRefUpdateSome
+
+/**
+ * @since 2.0.0
+ * @category utils
+ */
+export const updateAndGet: {
+  <A>(f: (a: A) => A): (self: FiberRef<A>) => Effect.Effect<A>
+  <A>(self: FiberRef<A>, f: (a: A) => A): Effect.Effect<A>
+} = core.fiberRefUpdateAndGet
+
+/**
+ * @since 2.0.0
+ * @category utils
+ */
+export const updateSomeAndGet: {
+  <A>(pf: (a: A) => Option.Option<A>): (self: FiberRef<A>) => Effect.Effect<A>
+  <A>(self: FiberRef<A>, pf: (a: A) => Option.Option<A>): Effect.Effect<A>
+} = core.fiberRefUpdateSomeAndGet
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentConcurrency: FiberRef<number | "unbounded"> = core.currentConcurrency
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentRequestBatchingEnabled: FiberRef<boolean> = core.currentRequestBatching
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentRequestCache: FiberRef<Request.Cache> = query.currentCache as any
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentRequestCacheEnabled: FiberRef<boolean> = query.currentCacheEnabled
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentContext: FiberRef<Context.Context<never>> = core.currentContext
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentSchedulingPriority: FiberRef<number> = core.currentSchedulingPriority
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentMaxOpsBeforeYield: FiberRef<number> = core.currentMaxOpsBeforeYield
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const unhandledErrorLogLevel: FiberRef<Option.Option<LogLevel.LogLevel>> = core.currentUnhandledErrorLogLevel
+
+/**
+ * @since 3.17.0
+ * @category fiberRefs
+ */
+export const versionMismatchErrorLogLevel: FiberRef<Option.Option<LogLevel.LogLevel>> =
+  core.currentVersionMismatchErrorLogLevel
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentLogAnnotations: FiberRef<HashMap.HashMap<string, unknown>> = core.currentLogAnnotations
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentLoggers: FiberRef<HashSet.HashSet<Logger.Logger<unknown, any>>> = fiberRuntime.currentLoggers
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentLogLevel: FiberRef<LogLevel.LogLevel> = core.currentLogLevel
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentMinimumLogLevel: FiberRef<LogLevel.LogLevel> = fiberRuntime.currentMinimumLogLevel
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentLogSpan: FiberRef<List.List<LogSpan.LogSpan>> = core.currentLogSpan
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentRuntimeFlags: FiberRef<RuntimeFlags.RuntimeFlags> = fiberRuntime.currentRuntimeFlags
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentScheduler: FiberRef<Scheduler.Scheduler> = Scheduler.currentScheduler
+
+/**
+ * The current source location trace, used for build-time instrumentation.
+ *
+ * This FiberRef contains the source location of the currently executing effect
+ * step within an `Effect.gen` block. It is automatically set by the
+ * `@effect/unplugin` build-time transformer.
+ *
+ * @since 3.20.0
+ * @category fiberRefs
+ */
+export const currentSourceTrace: FiberRef<SourceLocation.SourceLocation | undefined> = core.currentSourceTrace
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentSupervisor: FiberRef<Supervisor.Supervisor<any>> = fiberRuntime.currentSupervisor
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentMetricLabels: FiberRef<ReadonlyArray<MetricLabel.MetricLabel>> = core.currentMetricLabels
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentTracerEnabled: FiberRef<boolean> = core.currentTracerEnabled
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentTracerTimingEnabled: FiberRef<boolean> = core.currentTracerTimingEnabled
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentTracerSpanAnnotations: FiberRef<HashMap.HashMap<string, unknown>> =
+  core.currentTracerSpanAnnotations
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const currentTracerSpanLinks: FiberRef<Chunk.Chunk<Tracer.SpanLink>> = core.currentTracerSpanLinks
+
+/**
+ * @since 2.0.0
+ * @category fiberRefs
+ */
+export const interruptedCause: FiberRef<Cause.Cause<never>> = core.currentInterruptedCause

package/src/FiberRefs.ts

@@ -0,0 +1,204 @@
+/**
+ * @since 2.0.0
+ */
+import type * as Arr from "./Array.js"
+import type * as Effect from "./Effect.js"
+import type * as FiberId from "./FiberId.js"
+import type * as FiberRef from "./FiberRef.js"
+import type * as HashSet from "./HashSet.js"
+import * as internal from "./internal/fiberRefs.js"
+import type * as Option from "./Option.js"
+import type { Pipeable } from "./Pipeable.js"
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const FiberRefsSym: unique symbol = internal.FiberRefsSym
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type FiberRefsSym = typeof FiberRefsSym
+
+/**
+ * `FiberRefs` is a data type that represents a collection of `FiberRef` values.
+ *
+ * This allows safely propagating `FiberRef` values across fiber boundaries, for
+ * example between an asynchronous producer and consumer.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+export interface FiberRefs extends Pipeable {
+  readonly [FiberRefsSym]: FiberRefsSym
+  readonly locals: Map<FiberRef.FiberRef<any>, Arr.NonEmptyReadonlyArray<readonly [FiberId.Single, any]>>
+}
+
+const delete_: {
+  <A>(fiberRef: FiberRef.FiberRef<A>): (self: FiberRefs) => FiberRefs
+  <A>(self: FiberRefs, fiberRef: FiberRef.FiberRef<A>): FiberRefs
+} = internal.delete_
+
+export {
+  /**
+   * Deletes the specified `FiberRef` from the `FibterRefs`.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
+  delete_ as delete
+}
+
+/**
+ * Returns a set of each `FiberRef` in this collection.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+export const fiberRefs: (self: FiberRefs) => HashSet.HashSet<FiberRef.FiberRef<any>> = internal.fiberRefs
+
+/**
+ * Forks this collection of fiber refs as the specified child fiber id. This
+ * will potentially modify the value of the fiber refs, as determined by the
+ * individual fiber refs that make up the collection.
+ *
+ * @since 2.0.0
+ * @category utils
+ */
+export const forkAs: {
+  (childId: FiberId.Single): (self: FiberRefs) => FiberRefs
+  (self: FiberRefs, childId: FiberId.Single): FiberRefs
+} = internal.forkAs
+
+/**
+ * Gets the value of the specified `FiberRef` in this collection of `FiberRef`
+ * values if it exists or `None` otherwise.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+export const get: {
+  <A>(fiberRef: FiberRef.FiberRef<A>): (self: FiberRefs) => Option.Option<A>
+  <A>(self: FiberRefs, fiberRef: FiberRef.FiberRef<A>): Option.Option<A>
+} = internal.get
+
+/**
+ * Gets the value of the specified `FiberRef` in this collection of `FiberRef`
+ * values if it exists or the `initial` value of the `FiberRef` otherwise.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+export const getOrDefault: {
+  <A>(fiberRef: FiberRef.FiberRef<A>): (self: FiberRefs) => A
+  <A>(self: FiberRefs, fiberRef: FiberRef.FiberRef<A>): A
+} = internal.getOrDefault
+
+/**
+ * Joins this collection of fiber refs to the specified collection, as the
+ * specified fiber id. This will perform diffing and merging to ensure
+ * preservation of maximum information from both child and parent refs.
+ *
+ * @since 2.0.0
+ * @category utils
+ */
+export const joinAs: {
+  (fiberId: FiberId.Single, that: FiberRefs): (self: FiberRefs) => FiberRefs
+  (self: FiberRefs, fiberId: FiberId.Single, that: FiberRefs): FiberRefs
+} = internal.joinAs
+
+/**
+ * Set each ref to either its value or its default.
+ *
+ * @since 2.0.0
+ * @category utils
+ */
+export const setAll: (self: FiberRefs) => Effect.Effect<void> = internal.setAll
+
+/**
+ * Updates the value of the specified `FiberRef` using the provided `FiberId`
+ *
+ * @since 2.0.0
+ * @category utils
+ */
+export const updateAs: {
+  <A>(
+    options: {
+      readonly fiberId: FiberId.Single
+      readonly fiberRef: FiberRef.FiberRef<A>
+      readonly value: A
+    }
+  ): (self: FiberRefs) => FiberRefs
+  <A>(
+    self: FiberRefs,
+    options: {
+      readonly fiberId: FiberId.Single
+      readonly fiberRef: FiberRef.FiberRef<A>
+      readonly value: A
+    }
+  ): FiberRefs
+} = internal.updateAs
+
+/**
+ * Updates the values of the specified `FiberRef` & value pairs using the provided `FiberId`
+ *
+ * @since 2.0.0
+ * @category utils
+ */
+export const updateManyAs: {
+  (
+    options: {
+      readonly forkAs?: FiberId.Single | undefined
+      readonly entries: readonly [
+        readonly [
+          FiberRef.FiberRef<any>,
+          readonly [readonly [FiberId.Single, any], ...Array<readonly [FiberId.Single, any]>]
+        ],
+        ...Array<
+          readonly [
+            FiberRef.FiberRef<any>,
+            readonly [readonly [FiberId.Single, any], ...Array<readonly [FiberId.Single, any]>]
+          ]
+        >
+      ]
+    }
+  ): (self: FiberRefs) => FiberRefs
+  (
+    self: FiberRefs,
+    options: {
+      readonly forkAs?: FiberId.Single | undefined
+      readonly entries: readonly [
+        readonly [
+          FiberRef.FiberRef<any>,
+          readonly [readonly [FiberId.Single, any], ...Array<readonly [FiberId.Single, any]>]
+        ],
+        ...Array<
+          readonly [
+            FiberRef.FiberRef<any>,
+            readonly [readonly [FiberId.Single, any], ...Array<readonly [FiberId.Single, any]>]
+          ]
+        >
+      ]
+    }
+  ): FiberRefs
+} = internal.updateManyAs
+
+/**
+ * Note: it will not copy the provided Map, make sure to provide a fresh one.
+ *
+ * @since 2.0.0
+ * @category unsafe
+ */
+export const unsafeMake: (
+  fiberRefLocals: Map<FiberRef.FiberRef<any>, Arr.NonEmptyReadonlyArray<readonly [FiberId.Single, any]>>
+) => FiberRefs = internal.unsafeMake
+
+/**
+ * The empty collection of `FiberRef` values.
+ *
+ * @category constructors
+ * @since 2.0.0
+ */
+export const empty: () => FiberRefs = internal.empty