effect 4.0.1 → 4.0.2

package/src/TxQueue.ts

@@ -8,6 +8,7 @@
  * full bounded queue. This makes the queue useful for coordinating producers
  * and consumers alongside other transactional state changes.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import type * as Arr from "./Array.ts"
@@ -44,6 +45,7 @@ import type * as Types from "./Types.ts"
  * state._tag // => "Open"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -67,6 +69,7 @@ const TypeId = "~effect/TxQueue"
 /**
  * Namespace containing type definitions for TxEnqueue variance annotations.
  *
+ * @stability stable
  * @since 4.0.0
  */
 export declare namespace TxEnqueue {
@@ -85,6 +88,7 @@ export declare namespace TxEnqueue {
 /**
  * Namespace containing type definitions for TxDequeue variance annotations.
  *
+ * @stability stable
  * @since 4.0.0
  */
 export declare namespace TxDequeue {
@@ -103,6 +107,7 @@ export declare namespace TxDequeue {
 /**
  * Namespace containing type definitions for TxQueue variance annotations.
  *
+ * @stability stable
  * @since 4.0.0
  */
 export declare namespace TxQueue {
@@ -123,6 +128,7 @@ export declare namespace TxQueue {
  * This interface contains the core properties needed for queue state inspection
  * operations like size, capacity, and completion status.
  *
+ * @stability unstable
  * @category models
  * @since 4.0.0
  */
@@ -167,6 +173,7 @@ export interface TxQueueState extends Inspectable {
  * await Effect.runPromise(program) // => true
  * ```
  *
+ * @stability unstable
  * @category models
  * @since 4.0.0
  */
@@ -202,6 +209,7 @@ export interface TxEnqueue<in A, in E = never> extends TxQueueState {
  * await Effect.runPromise(program) // => [42, "processing failed", "processing failed"]
  * ```
  *
+ * @stability unstable
  * @category models
  * @since 4.0.0
  */
@@ -238,6 +246,7 @@ export interface TxDequeue<out A, out E = never> extends TxQueueState {
  * await Effect.runPromise(program) // => [true, 42, "queue failed"]
  * ```
  *
+ * @stability unstable
  * @category models
  * @since 4.0.0
  */
@@ -257,6 +266,7 @@ export interface TxQueue<in out A, in out E = never> extends TxEnqueue<A, E>, Tx
  * TxQueue.isTxEnqueue(someValue) // => false
  * ```
  *
+ * @stability unstable
  * @category guards
  * @since 4.0.0
  */
@@ -274,6 +284,7 @@ export const isTxEnqueue = <A = unknown, E = unknown>(u: unknown): u is TxEnqueu
  * TxQueue.isTxDequeue(someValue) // => false
  * ```
  *
+ * @stability unstable
  * @category guards
  * @since 4.0.0
  */
@@ -291,6 +302,7 @@ export const isTxDequeue = <A = unknown, E = unknown>(u: unknown): u is TxDequeu
  * TxQueue.isTxQueue(someValue) // => false
  * ```
  *
+ * @stability unstable
  * @category guards
  * @since 4.0.0
  */
@@ -352,6 +364,7 @@ const TxQueueProto = {
  * await Effect.runPromise(program) // => 1
  * ```
  *
+ * @stability unstable
  * @category constructors
  * @since 2.0.0
  */
@@ -399,6 +412,7 @@ export const bounded = <A = never, E = never>(
  * await Effect.runPromise(program) // => 2
  * ```
  *
+ * @stability unstable
  * @category constructors
  * @since 2.0.0
  */
@@ -442,6 +456,7 @@ export const unbounded = <A = never, E = never>(): Effect.Effect<TxQueue<A, E>>
  * await Effect.runPromise(program) // => false
  * ```
  *
+ * @stability unstable
  * @category constructors
  * @since 2.0.0
  */
@@ -489,6 +504,7 @@ export const dropping = <A = never, E = never>(
  * await Effect.runPromise(program) // => 2
  * ```
  *
+ * @stability unstable
  * @category constructors
  * @since 2.0.0
  */
@@ -533,6 +549,7 @@ export const sliding = <A = never, E = never>(
  * await Effect.runPromise(program) // => true
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 2.0.0
  */
@@ -563,6 +580,7 @@ export const offer: {
    * await Effect.runPromise(program) // => true
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 2.0.0
    */
@@ -593,6 +611,7 @@ export const offer: {
    * await Effect.runPromise(program) // => true
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 2.0.0
    */
@@ -659,6 +678,7 @@ export const offer: {
  * await Effect.runPromise(program) // => []
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 2.0.0
  */
@@ -686,6 +706,7 @@ export const offerAll: {
    * await Effect.runPromise(program) // => []
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 2.0.0
    */
@@ -713,6 +734,7 @@ export const offerAll: {
    * await Effect.runPromise(program) // => []
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 2.0.0
    */
@@ -766,6 +788,7 @@ export const offerAll: {
  * await Effect.runPromise(program) // => [42, Exit.fail("queue error")]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 2.0.0
  */
@@ -822,6 +845,7 @@ export const take = <A, E>(self: TxDequeue<A, E>): Effect.Effect<A, E> =>
  * await Effect.runPromise(program) // => [Option.none(), Option.some(42)]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 2.0.0
  */
@@ -881,6 +905,7 @@ export const poll = <A, E>(self: TxDequeue<A, E>): Effect.Effect<Option.Option<A
  * await Effect.runPromise(errorExample) // => Exit.fail("processing error")
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 2.0.0
  */
@@ -939,6 +964,7 @@ export const takeAll = <A, E>(self: TxDequeue<A, E>): Effect.Effect<Arr.NonEmpty
  * await Effect.runPromise(program) // => [[1, 2, 3, 4], [5, 6, 7, 8, 9]]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 2.0.0
  */
@@ -970,6 +996,7 @@ export const takeN: {
    * await Effect.runPromise(program) // => [[1, 2, 3, 4], [5, 6, 7, 8, 9]]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 2.0.0
    */
@@ -1001,6 +1028,7 @@ export const takeN: {
    * await Effect.runPromise(program) // => [[1, 2, 3, 4], [5, 6, 7, 8, 9]]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 2.0.0
    */
@@ -1094,6 +1122,7 @@ export const takeN: {
  * await Effect.runPromise(program) // => [[1, 2, 3, 4, 5], [6, 7, 8]]
  * ```
  *
+ * @stability unstable
  * @category taking
  * @since 2.0.0
  */
@@ -1129,6 +1158,7 @@ export const takeBetween: {
    * await Effect.runPromise(program) // => [[1, 2, 3, 4, 5], [6, 7, 8]]
    * ```
    *
+   * @stability unstable
    * @category taking
    * @since 2.0.0
    */
@@ -1164,6 +1194,7 @@ export const takeBetween: {
    * await Effect.runPromise(program) // => [[1, 2, 3, 4, 5], [6, 7, 8]]
    * ```
    *
+   * @stability unstable
    * @category taking
    * @since 2.0.0
    */
@@ -1261,6 +1292,7 @@ export const takeBetween: {
  * await Effect.runPromise(errorExample) // => Exit.fail("queue failed")
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 2.0.0
  */
@@ -1298,6 +1330,7 @@ export const peek = <A, E>(self: TxDequeue<A, E>): Effect.Effect<A, E> =>
  * await Effect.runPromise(program) // => 3
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 2.0.0
  */
@@ -1324,6 +1357,7 @@ export const size = (self: TxQueueState): Effect.Effect<number> => TxChunk.size(
  * await Effect.runPromise(program) // => [true, false]
  * ```
  *
+ * @stability unstable
  * @category predicates
  * @since 2.0.0
  */
@@ -1350,6 +1384,7 @@ export const isEmpty = (self: TxQueueState): Effect.Effect<boolean> => TxChunk.i
  * await Effect.runPromise(program) // => [false, true]
  * ```
  *
+ * @stability unstable
  * @category predicates
  * @since 4.0.0
  */
@@ -1376,6 +1411,7 @@ export const isNonEmpty = (self: TxQueueState): Effect.Effect<boolean> => TxChun
  * await Effect.runPromise(program) // => [false, true]
  * ```
  *
+ * @stability unstable
  * @category predicates
  * @since 2.0.0
  */
@@ -1407,6 +1443,7 @@ export const isFull = (self: TxQueueState): Effect.Effect<boolean> =>
  * await Effect.runPromise(program) // => true
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -1435,6 +1472,7 @@ export const interrupt = <A, E>(self: TxEnqueue<A, E>): Effect.Effect<boolean> =
  * await Effect.runPromise(program) // => true
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -1461,6 +1499,7 @@ export const fail: {
    * await Effect.runPromise(program) // => true
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1487,6 +1526,7 @@ export const fail: {
    * await Effect.runPromise(program) // => true
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1533,6 +1573,7 @@ export const fail: {
  * await Effect.runPromise(program) // => [Cause.interrupt(), true]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -1561,6 +1602,7 @@ export const failCause: {
    * await Effect.runPromise(program) // => [Cause.interrupt(), true]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1589,6 +1631,7 @@ export const failCause: {
    * await Effect.runPromise(program) // => [Cause.interrupt(), true]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1643,6 +1686,7 @@ export const failCause: {
  * await Effect.runPromise(program) // => [true, Exit.fail(Cause.Done()), Exit.fail(Cause.Done())]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -1676,6 +1720,7 @@ export const end = <A, E>(self: TxEnqueue<A, E | Cause.Done>): Effect.Effect<boo
  * await Effect.runPromise(program) // => [5, [1, 2, 3, 4, 5], 0]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -1726,6 +1771,7 @@ export const clear = <A, E>(self: TxEnqueue<A, E>): Effect.Effect<Array<A>, Excl
  * await Effect.runPromise(program) // => [5, 0, true]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 2.0.0
  */
@@ -1756,6 +1802,7 @@ export const shutdown = <A, E>(self: TxEnqueue<A, E>): Effect.Effect<boolean> =>
  * await Effect.runPromise(program) // => [true, false]
  * ```
  *
+ * @stability unstable
  * @category predicates
  * @since 4.0.0
  */
@@ -1784,6 +1831,7 @@ export const isOpen = (self: TxQueueState): Effect.Effect<boolean> =>
  * await Effect.runPromise(program) // => [false, true]
  * ```
  *
+ * @stability unstable
  * @category predicates
  * @since 4.0.0
  */
@@ -1811,6 +1859,7 @@ export const isClosing = (self: TxQueueState): Effect.Effect<boolean> =>
  * await Effect.runPromise(program) // => [false, true]
  * ```
  *
+ * @stability unstable
  * @category predicates
  * @since 4.0.0
  */
@@ -1838,6 +1887,7 @@ export const isDone = (self: TxQueueState): Effect.Effect<boolean> =>
  * await Effect.runPromise(program) // => [false, true]
  * ```
  *
+ * @stability unstable
  * @category predicates
  * @since 2.0.0
  */
@@ -1864,6 +1914,7 @@ export const isShutdown = (self: TxQueueState): Effect.Effect<boolean> => isDone
  * await Effect.runPromise(program) // => "Queue completed successfully"
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */

package/src/TxReentrantLock.ts

@@ -8,9 +8,11 @@
  * until the lock becomes available. This module includes manual, scoped, and
  * wrapper-style operations for read and write locking.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import * as Effect from "./Effect.ts"
+import { dual } from "./Function.ts"
 import * as HashMap from "./HashMap.ts"
 import type { Inspectable } from "./Inspectable.ts"
 import { NodeInspectSymbol, toJson } from "./Inspectable.ts"
@@ -61,6 +63,7 @@ const emptyState: LockState = {
  * await Effect.runPromise(program) // => ["reading", "writing"]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -105,6 +108,7 @@ const TxReentrantLockProto: Omit<TxReentrantLock, typeof TypeId | "stateRef"> =
  * await Effect.runPromise(program) // => false
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -141,6 +145,7 @@ export const make = (): Effect.Effect<TxReentrantLock> =>
  * await Effect.runPromise(program) // => 1
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -197,6 +202,7 @@ export const acquireRead = (self: TxReentrantLock): Effect.Effect<number> =>
  * await Effect.runPromise(program) // => 1
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -293,6 +299,7 @@ const releaseReadFor = (self: TxReentrantLock, fiberId: number): Effect.Effect<n
  *
  * Returns the remaining number of read locks held by this fiber.
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -353,6 +360,7 @@ const releaseWriteFor = (self: TxReentrantLock, fiberId: number): Effect.Effect<
  *
  * Returns the remaining number of write locks held by this fiber.
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -385,6 +393,7 @@ export const releaseWrite = (self: TxReentrantLock): Effect.Effect<number> =>
  * await Effect.runPromise(program) // => [1, 0]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -392,7 +401,8 @@ export const readLock = (self: TxReentrantLock): Effect.Effect<number, never, Sc
   Effect.withFiber((fiber) =>
     Effect.acquireRelease(
       acquireRead(self),
-      () => releaseReadFor(self, fiber.id)
+      () => releaseReadFor(self, fiber.id),
+      { interruptible: true }
     )
   )
 
@@ -422,6 +432,7 @@ export const readLock = (self: TxReentrantLock): Effect.Effect<number, never, Sc
  * await Effect.runPromise(program) // => [1, 0]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -429,10 +440,25 @@ export const writeLock = (self: TxReentrantLock): Effect.Effect<number, never, S
   Effect.withFiber((fiber) =>
     Effect.acquireRelease(
       acquireWrite(self),
-      () => releaseWriteFor(self, fiber.id)
+      () => releaseWriteFor(self, fiber.id),
+      { interruptible: true }
     )
   )
 
+/**
+ * Runs `effect` between `acquire` and `release`. Acquisition and `effect`
+ * inherit the caller's interruptibility, while the handoff from a successful
+ * acquisition to the release finalizer stays protected.
+ */
+const withAcquired = <A, E, R>(
+  acquire: Effect.Effect<number>,
+  effect: Effect.Effect<A, E, R>,
+  release: Effect.Effect<number>
+): Effect.Effect<A, E, R> =>
+  Effect.uninterruptibleMask((restore) =>
+    Effect.flatMap(restore(acquire), () => Effect.ensuring(restore(effect), release))
+  )
+
 /**
  * Runs the provided effect while holding a read lock. The lock is automatically
  * released after the effect completes, fails, or is interrupted.
@@ -453,6 +479,7 @@ export const writeLock = (self: TxReentrantLock): Effect.Effect<number, never, S
  * await Effect.runPromise(program) // => "read data"
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -477,6 +504,7 @@ export const withReadLock: {
    * await Effect.runPromise(program) // => "read data"
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -501,27 +529,16 @@ export const withReadLock: {
    * await Effect.runPromise(program) // => "read data"
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
   <A, E, R>(self: TxReentrantLock, effect: Effect.Effect<A, E, R>): Effect.Effect<A, E, R>
-} = ((...args: Array<any>) => {
-  if (args.length === 1) {
-    const [effect] = args
-    return (self: TxReentrantLock) =>
-      Effect.acquireUseRelease(
-        acquireRead(self),
-        () => effect,
-        () => releaseRead(self)
-      )
-  }
-  const [self, effect] = args
-  return Effect.acquireUseRelease(
-    acquireRead(self),
-    () => effect,
-    () => releaseRead(self)
-  )
-}) as any
+} = dual(
+  2,
+  <A, E, R>(self: TxReentrantLock, effect: Effect.Effect<A, E, R>): Effect.Effect<A, E, R> =>
+    withAcquired(acquireRead(self), effect, releaseRead(self))
+)
 
 /**
  * Runs the provided effect while holding a write lock. The lock is automatically
@@ -543,6 +560,7 @@ export const withReadLock: {
  * await Effect.runPromise(program) // => "wrote data"
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -567,6 +585,7 @@ export const withWriteLock: {
    * await Effect.runPromise(program) // => "wrote data"
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -591,27 +610,16 @@ export const withWriteLock: {
    * await Effect.runPromise(program) // => "wrote data"
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
   <A, E, R>(self: TxReentrantLock, effect: Effect.Effect<A, E, R>): Effect.Effect<A, E, R>
-} = ((...args: Array<any>) => {
-  if (args.length === 1) {
-    const [effect] = args
-    return (self: TxReentrantLock) =>
-      Effect.acquireUseRelease(
-        acquireWrite(self),
-        () => effect,
-        () => releaseWrite(self)
-      )
-  }
-  const [self, effect] = args
-  return Effect.acquireUseRelease(
-    acquireWrite(self),
-    () => effect,
-    () => releaseWrite(self)
-  )
-}) as any
+} = dual(
+  2,
+  <A, E, R>(self: TxReentrantLock, effect: Effect.Effect<A, E, R>): Effect.Effect<A, E, R> =>
+    withAcquired(acquireWrite(self), effect, releaseWrite(self))
+)
 
 /**
  * Runs an effect while holding a write lock.
@@ -637,6 +645,7 @@ export const withWriteLock: {
  * await Effect.runPromise(program) // => "exclusive operation"
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -665,6 +674,7 @@ export const withLock: {
    * await Effect.runPromise(program) // => "exclusive operation"
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -693,6 +703,7 @@ export const withLock: {
    * await Effect.runPromise(program) // => "exclusive operation"
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -722,6 +733,7 @@ export const withLock: {
  * await Effect.runPromise(program) // => 1
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -751,6 +763,7 @@ export const readLocks = (self: TxReentrantLock): Effect.Effect<number> =>
  * await Effect.runPromise(program) // => 0
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -776,6 +789,7 @@ export const writeLocks = (self: TxReentrantLock): Effect.Effect<number> =>
  * await Effect.runPromise(program) // => false
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -801,6 +815,7 @@ export const locked = (self: TxReentrantLock): Effect.Effect<boolean> =>
  * await Effect.runPromise(program) // => false
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -826,6 +841,7 @@ export const readLocked = (self: TxReentrantLock): Effect.Effect<boolean> =>
  * await Effect.runPromise(program) // => false
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -852,6 +868,7 @@ export const writeLocked = (self: TxReentrantLock): Effect.Effect<boolean> =>
  * TxReentrantLock.isTxReentrantLock(someValue) // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */