effect 4.0.1 → 4.0.2

package/src/Queue.ts

@@ -6,6 +6,7 @@
  * or unbounded, and bounded queues can suspend, drop, or slide values when
  * producers are faster than consumers.
  *
+ * @stability stable
  * @since 3.8.0
  */
 import * as Arr from "./Array.ts"
@@ -40,6 +41,7 @@ const DequeueTypeId = "~effect/Queue/Dequeue"
  * @see {@link isEnqueue} for checking values that only need write access
  * @see {@link isDequeue} for checking values that only need read access
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -64,6 +66,7 @@ export const isQueue = <A = unknown, E = unknown>(
  * @see {@link isDequeue} for checking for the read side of a queue
  * @see {@link asEnqueue} for narrowing an existing `Queue` to its write-only interface
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -84,6 +87,7 @@ export const isEnqueue = <A = unknown, E = unknown>(
  * @see {@link isEnqueue} for checking for the write side of a queue
  * @see {@link asDequeue} for narrowing an existing `Queue` to its read-only interface
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -107,6 +111,7 @@ export const isDequeue = <A = unknown, E = unknown>(
  * @see {@link asDequeue} for exposing only the read side of a `Queue`
  * @see {@link Enqueue} for the write-only queue handle returned by this conversion
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -128,6 +133,7 @@ export const asEnqueue = <A, E>(self: Queue<A, E>): Enqueue<A, E> => self
  * @see {@link asEnqueue} for narrowing a queue to its producer side
  * @see {@link Dequeue} for the consumer-side queue handle returned by this function
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -162,6 +168,7 @@ export const asDequeue: <A, E>(self: Queue<A, E>) => Dequeue<A, E> = identity
  * await Effect.runPromise(program) // => ["hello", "world", "!"]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -179,6 +186,7 @@ export interface Enqueue<in A, in E = never> extends Inspectable {
  * Companion namespace containing type-level metadata for the `Enqueue`
  * write-only queue interface.
  *
+ * @stability stable
  * @since 2.0.0
  */
 export declare namespace Enqueue {
@@ -230,6 +238,7 @@ export declare namespace Enqueue {
  * await Effect.runPromise(program) // => "a"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -247,6 +256,7 @@ export interface Dequeue<out A, out E = never> extends Inspectable {
  * Companion namespace containing type-level metadata for the `Dequeue`
  * read-only queue interface.
  *
+ * @stability stable
  * @since 2.0.0
  */
 export declare namespace Dequeue {
@@ -298,6 +308,7 @@ export declare namespace Dequeue {
  * await Effect.runPromise(program) // => ["hello", "world", "!"]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -309,6 +320,7 @@ export interface Queue<in out A, in out E = never> extends Enqueue<A, E>, Dequeu
  * Companion namespace containing type-level metadata and low-level state types
  * for `Queue`.
  *
+ * @stability stable
  * @since 2.0.0
  */
 export declare namespace Queue {
@@ -461,6 +473,7 @@ const QueueProto = {
  * await Effect.runPromise(program) // => { messages: [1, 2, 3, 4, 5], done: Cause.Done(), failed: true }
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -513,6 +526,7 @@ export const make = <A, E = never>(
  * await Effect.runPromise(program) // => 2
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -550,6 +564,7 @@ export const bounded = <A, E = never>(capacity: number): Effect<Queue<A, E>> =>
  * await Effect.runPromise(program) // => [2, 3, 4]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -586,6 +601,7 @@ export const sliding = <A, E = never>(capacity: number): Effect<Queue<A, E>> =>
  * await Effect.runPromise(program) // => [true, true, false, [1, 2]]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -624,6 +640,7 @@ export const dropping = <A, E = never>(capacity: number): Effect<Queue<A, E>> =>
  * await Effect.runPromise(program) // => { size: 5, messages: ["message1", "message2", "message3", "message4", "message5"] }
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -658,6 +675,7 @@ export const unbounded = <A, E = never>(): Effect<Queue<A, E>> => make()
  * await Effect.runPromise(program) // => { offered: [true, true], size: 2 }
  * ```
  *
+ * @stability stable
  * @category offering
  * @since 2.0.0
  */
@@ -691,6 +709,7 @@ export const offer: {
    * await Effect.runPromise(program) // => { offered: [true, true], size: 2 }
    * ```
    *
+   * @stability stable
    * @category offering
    * @since 2.0.0
    */
@@ -724,6 +743,7 @@ export const offer: {
    * await Effect.runPromise(program) // => { offered: [true, true], size: 2 }
    * ```
    *
+   * @stability stable
    * @category offering
    * @since 2.0.0
    */
@@ -774,6 +794,7 @@ export const offer: {
  * await Effect.runPromise(program) // => { offered: [true, true], size: 2 }
  * ```
  *
+ * @stability stable
  * @category offering
  * @since 4.0.0
  */
@@ -828,6 +849,7 @@ export const offerUnsafe = <A, E>(self: Enqueue<A, E>, message: Types.NoInfer<A>
  * await Effect.runPromise(program) // => [4, 5]
  * ```
  *
+ * @stability stable
  * @category offering
  * @since 2.0.0
  */
@@ -863,6 +885,7 @@ export const offerAll: {
    * await Effect.runPromise(program) // => [4, 5]
    * ```
    *
+   * @stability stable
    * @category offering
    * @since 2.0.0
    */
@@ -898,6 +921,7 @@ export const offerAll: {
    * await Effect.runPromise(program) // => [4, 5]
    * ```
    *
+   * @stability stable
    * @category offering
    * @since 2.0.0
    */
@@ -936,6 +960,7 @@ export const offerAll: {
    * await Effect.runPromise(program) // => [4, 5]
    * ```
    *
+   * @stability stable
    * @category offering
    * @since 2.0.0
    */
@@ -980,6 +1005,7 @@ export const offerAll: {
  * await Effect.runPromise(program) // => { remaining: [4, 5], size: 3 }
  * ```
  *
+ * @stability stable
  * @category offering
  * @since 4.0.0
  */
@@ -1040,6 +1066,7 @@ export const offerAllUnsafe = <A, E>(self: Enqueue<A, E>, messages: Iterable<A>)
  * await Effect.runPromise(program) // => [true, Exit.fail("Something went wrong")]
  * ```
  *
+ * @stability stable
  * @category completion
  * @since 4.0.0
  */
@@ -1067,6 +1094,7 @@ export const fail: {
    * await Effect.runPromise(program) // => [true, Exit.fail("Something went wrong")]
    * ```
    *
+   * @stability stable
    * @category completion
    * @since 4.0.0
    */
@@ -1094,6 +1122,7 @@ export const fail: {
    * await Effect.runPromise(program) // => [true, Exit.fail("Something went wrong")]
    * ```
    *
+   * @stability stable
    * @category completion
    * @since 4.0.0
    */
@@ -1124,6 +1153,7 @@ export const fail: {
  * await Effect.runPromise(program) // => [true, Exit.failCause(Cause.fail("Queue processing failed"))]
  * ```
  *
+ * @stability stable
  * @category completion
  * @since 4.0.0
  */
@@ -1152,6 +1182,7 @@ export const failCause: {
    * await Effect.runPromise(program) // => [true, Exit.failCause(Cause.fail("Queue processing failed"))]
    * ```
    *
+   * @stability stable
    * @category completion
    * @since 4.0.0
    */
@@ -1180,6 +1211,7 @@ export const failCause: {
    * await Effect.runPromise(program) // => [true, Exit.failCause(Cause.fail("Queue processing failed"))]
    * ```
    *
+   * @stability stable
    * @category completion
    * @since 4.0.0
    */
@@ -1223,6 +1255,7 @@ export const failCause: {
  * await Effect.runPromise(program) // => [true, Exit.failCause(Cause.fail("Processing error"))]
  * ```
  *
+ * @stability stable
  * @category completion
  * @since 4.0.0
  */
@@ -1283,6 +1316,7 @@ export const failCauseUnsafe = <A, E>(self: Enqueue<A, E>, cause: Cause<E>): boo
  * await Effect.runPromise(program) // => [true, false, 1]
  * ```
  *
+ * @stability stable
  * @category completion
  * @since 4.0.0
  */
@@ -1334,6 +1368,7 @@ export const end = <A, E>(self: Enqueue<A, E | Done>): Effect<boolean> => failCa
  * await Effect.runPromise(program) // => { ended: true, states: ["Closing", "Done"] }
  * ```
  *
+ * @stability stable
  * @category completion
  * @since 4.0.0
  */
@@ -1378,6 +1413,7 @@ export const endUnsafe = <A, E>(self: Enqueue<A, E | Done>) => failCauseUnsafe(s
  * await Effect.runPromise(program) // => { interrupted: true, offerResult: false, messages: [1, 2], isDone: true }
  * ```
  *
+ * @stability stable
  * @category completion
  * @since 4.0.0
  */
@@ -1417,6 +1453,7 @@ export const interrupt = <A, E>(self: Enqueue<A, E>): Effect<boolean> =>
  * ```
  *
  * @see {@link shutdownUnsafe} for synchronous shutdown
+ * @stability stable
  * @category completion
  * @since 2.0.0
  */
@@ -1440,6 +1477,7 @@ export const shutdown = <A, E>(self: Enqueue<A, E>): Effect<boolean> => internal
  *
  * @see {@link shutdown} for the effectful variant
  * @see {@link failCauseUnsafe} to set a failure before discarding buffered messages
+ * @stability stable
  * @category completion
  * @since 4.0.0
  */
@@ -1489,16 +1527,14 @@ export const shutdownUnsafe = <A, E>(self: Enqueue<A, E>): boolean => {
  * await Effect.runPromise(program) // => { messages: [1, 2, 3, 4, 5], size: 0, empty: [] }
  * ```
  *
+ * @stability stable
  * @category taking
  * @since 4.0.0
  */
 export const clear = <A, E>(self: Dequeue<A, E>): Effect<Array<A>, Pull.ExcludeDone<E>> =>
-  internalEffect.suspend(() => {
+  suspendTake(() => {
     if (self.state._tag === "Done") {
-      if (Pull.isDoneCause(self.state.exit.cause)) {
-        return internalEffect.succeed([])
-      }
-      return self.state.exit
+      return Pull.catchDone(self.state.exit, () => internalEffect.succeed([]))
     }
     const messages = takeAllUnsafe(self)
     releaseCapacity(self)
@@ -1538,6 +1574,7 @@ export const clear = <A, E>(self: Dequeue<A, E>): Effect<Array<A>, Pull.ExcludeD
  * await Effect.runPromise(program) // => [1, 2, 3, 4, 5]
  * ```
  *
+ * @stability stable
  * @category taking
  * @since 2.0.0
  */
@@ -1566,6 +1603,7 @@ export const takeAll = <A, E>(self: Dequeue<A, E>): Effect<Arr.NonEmptyArray<A>,
  * await Effect.runPromise(program) // => [1, 2, 3, 4, 5]
  * ```
  *
+ * @stability stable
  * @category taking
  * @since 4.0.0
  */
@@ -1626,6 +1664,7 @@ export const collect = <A, E>(self: Dequeue<A, E | Done>): Effect<Array<A>, Pull
  * await Effect.runPromise(program) // => [[1, 2, 3], [4, 5], [6, 7]]
  * ```
  *
+ * @stability stable
  * @category taking
  * @since 2.0.0
  */
@@ -1667,6 +1706,7 @@ export const takeN: {
    * await Effect.runPromise(program) // => [[1, 2, 3], [4, 5], [6, 7]]
    * ```
    *
+   * @stability stable
    * @category taking
    * @since 2.0.0
    */
@@ -1708,6 +1748,7 @@ export const takeN: {
    * await Effect.runPromise(program) // => [[1, 2, 3], [4, 5], [6, 7]]
    * ```
    *
+   * @stability stable
    * @category taking
    * @since 2.0.0
    */
@@ -1751,6 +1792,7 @@ export const takeN: {
  * await Effect.runPromise(program) // => [[1, 2, 3, 4, 5], [6, 7, 8]]
  * ```
  *
+ * @stability stable
  * @category taking
  * @since 2.0.0
  */
@@ -1792,6 +1834,7 @@ export const takeBetween: {
    * await Effect.runPromise(program) // => [[1, 2, 3, 4, 5], [6, 7, 8]]
    * ```
    *
+   * @stability stable
    * @category taking
    * @since 2.0.0
    */
@@ -1833,6 +1876,7 @@ export const takeBetween: {
    * await Effect.runPromise(program) // => [[1, 2, 3, 4, 5], [6, 7, 8]]
    * ```
    *
+   * @stability stable
    * @category taking
    * @since 2.0.0
    */
@@ -1840,7 +1884,7 @@ export const takeBetween: {
 } = dual(3, <A, E>(self: Dequeue<A, E>, min: number, max: number): Effect<Array<A>, E> => {
   min = Count.normalize(min)
   max = Count.normalize(max)
-  return internalEffect.suspend(() =>
+  return suspendTake(() =>
     takeBetweenUnsafe(self, min, max) ??
       internalEffect.andThen(awaitTake(self, () => canTake(self, min)), takeBetween(self, min, max))
   )
@@ -1882,13 +1926,12 @@ export const takeBetween: {
  * await Effect.runPromise(program) // => [["first", "second"], Exit.fail(Cause.Done())]
  * ```
  *
+ * @stability stable
  * @category taking
  * @since 2.0.0
  */
 export const take = <A, E>(self: Dequeue<A, E>): Effect<A, E> =>
-  internalEffect.suspend(() =>
-    takeUnsafe(self) ?? internalEffect.andThen(awaitTake(self, () => canTake(self, 1)), take(self))
-  )
+  suspendTake(() => takeUnsafe(self) ?? internalEffect.andThen(awaitTake(self, () => canTake(self, 1)), take(self)))
 
 /**
  * Attempts to take one item from the queue without waiting.
@@ -1921,11 +1964,12 @@ export const take = <A, E>(self: Dequeue<A, E>): Effect<A, E> =>
  * await Effect.runPromise(program) // => [Option.none(), Option.some(42)]
  * ```
  *
+ * @stability stable
  * @category taking
  * @since 2.0.0
  */
 export const poll = <A, E>(self: Dequeue<A, E>): Effect<Option.Option<A>> =>
-  internalEffect.suspend(() => {
+  suspendTake(() => {
     const result = takeUnsafe(self)
     if (result === undefined) {
       return internalEffect.succeed(Option.none())
@@ -1960,6 +2004,7 @@ export const poll = <A, E>(self: Dequeue<A, E>): Effect<Option.Option<A>> =>
  * await Effect.runPromise(program) // => 42
  * ```
  *
+ * @stability stable
  * @category taking
  * @since 4.0.0
  */
@@ -2015,6 +2060,7 @@ export const peek = <A, E>(self: Dequeue<A, E>): Effect<A, E> =>
  * await Effect.runPromise(program) // => [Exit.succeed(1), Exit.succeed(2), undefined]
  * ```
  *
+ * @stability stable
  * @category taking
  * @since 4.0.0
  */
@@ -2067,6 +2113,7 @@ export const takeUnsafe = <A, E>(self: Dequeue<A, E>): Exit<A, E> | undefined =>
  * await Effect.runPromise(program) // => 1
  * ```
  *
+ * @stability stable
  * @category offering
  * @since 4.0.0
  */
@@ -2105,6 +2152,7 @@ export const flushUnsafe = <A, E>(self: Enqueue<A, E>): void => releaseTakers(se
  * await Effect.runPromise(program) // => 1
  * ```
  *
+ * @stability stable
  * @category offering
  * @since 4.0.0
  */
@@ -2150,6 +2198,7 @@ export {
    * @see {@link interrupt} for graceful interruption after buffered messages are drained
    * @see {@link shutdown} for immediately discarding buffered messages and resuming pending operations
    *
+   * @stability stable
    * @category completion
    * @since 4.0.0
    */
@@ -2193,6 +2242,7 @@ export {
  * await Effect.runPromise(program) // => [0, 5, 5]
  * ```
  *
+ * @stability stable
  * @category sizes
  * @since 2.0.0
  */
@@ -2221,6 +2271,7 @@ export const size = <A, E>(self: Dequeue<A, E>): Effect<number> => internalEffec
  * await Effect.runPromise(program) // => [false, true]
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -2271,6 +2322,7 @@ export const isFull = <A, E>(self: Dequeue<A, E>): Effect<boolean> => internalEf
  * await Effect.runPromise(program) // => [0, 3, 3]
  * ```
  *
+ * @stability stable
  * @category sizes
  * @since 4.0.0
  */
@@ -2304,6 +2356,7 @@ export const sizeUnsafe = <A, E>(self: Dequeue<A, E>): number => self.state._tag
  * await Effect.runPromise(program) // => [false, true]
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -2340,6 +2393,7 @@ export const isFullUnsafe = <A, E>(self: Dequeue<A, E>): boolean => sizeUnsafe(s
  * await Effect.runPromise(program) // => [true, Exit.fail(Cause.Done())]
  * ```
  *
+ * @stability stable
  * @category completion
  * @since 4.0.0
  */
@@ -2375,6 +2429,7 @@ export const into: {
    * await Effect.runPromise(program) // => [true, Exit.fail(Cause.Done())]
    * ```
    *
+   * @stability stable
    * @category completion
    * @since 4.0.0
    */
@@ -2412,6 +2467,7 @@ export const into: {
    * await Effect.runPromise(program) // => [true, Exit.fail(Cause.Done())]
    * ```
    *
+   * @stability stable
    * @category completion
    * @since 4.0.0
    */
@@ -2484,6 +2540,15 @@ const takeBetweenUnsafe = <A, E>(
   return core.exitSucceed(messages)
 }
 
+// Deliver dequeued results in the same fiber step to prevent message loss on interruption.
+const suspendTake: <A, E>(f: () => Effect<A, E>) => Effect<A, E> = core.makePrimitive({
+  op: "QueueTake",
+  [core.evaluate](fiber) {
+    const effect = this[core.args]()
+    return core.isExit(effect) ? (effect as unknown as core.Primitive)[core.evaluate](fiber) : effect
+  }
+})
+
 // Whether a take of at least `min` messages can complete without waiting.
 // A closing queue receives no more messages, so any remainder satisfies `min`.
 const canTake = <A, E>(self: Dequeue<A, E>, min: number): boolean =>
@@ -2573,6 +2638,11 @@ const releaseCapacity = <A, E>(self: Dequeue<A, E>): boolean => {
       self.state.offers.delete(entry)
       entry.resume(core.exitSucceed([]))
     }
+    // The resumed producer may have replaced the state with Done.
+    const state = self.state as Queue.State<A, E>
+    if (state._tag === "Done") {
+      return Pull.isDoneCause(state.exit.cause)
+    }
   }
   return false
 }

package/src/Random.ts

@@ -6,6 +6,7 @@
  * random generation is a service, tests and applications can replace the
  * generator used by Effect programs.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import type * as Arr from "./Array.ts"
@@ -20,6 +21,7 @@ import * as Predicate from "./Predicate.ts"
 /**
  * The service used to generate pseudo-random numbers.
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */
@@ -63,6 +65,7 @@ export interface Random {
  * await Effect.runPromise(program.pipe(Random.withSeed("example"))) // => [0.1633802591287037, 3434461687501127, 1]
  * ```
  *
+ * @stability stable
  * @category services
  * @since 2.0.0
  */
@@ -87,6 +90,7 @@ const randomWith = <A>(f: (random: Random) => A): Effect.Effect<A> =>
  * await Effect.runPromise(Random.next.pipe(Random.withSeed("example"))) // => 0.1633802591287037
  * ```
  *
+ * @stability stable
  * @category generators
  * @since 2.0.0
  */
@@ -107,6 +111,7 @@ export const next: Effect.Effect<number> = randomWith((r) => r.nextDoubleUnsafe(
  * await Effect.runPromise(Random.nextBoolean.pipe(Random.withSeed("example"))) // => false
  * ```
  *
+ * @stability stable
  * @category generators
  * @since 2.0.0
  */
@@ -129,6 +134,7 @@ export const nextBoolean: Effect.Effect<boolean> = randomWith((r) => r.nextDoubl
  * await Effect.runPromise(Random.nextInt.pipe(Random.withSeed("example"))) // => -6064002158214091
  * ```
  *
+ * @stability stable
  * @category generators
  * @since 2.0.0
  */
@@ -149,6 +155,7 @@ export const nextInt: Effect.Effect<number> = randomWith((r) => r.nextIntUnsafe(
  * await Effect.runPromise(Random.nextBetween(0, 1).pipe(Random.withSeed("example"))) // => 0.1633802591287037
  * ```
  *
+ * @stability stable
  * @category generators
  * @since 4.0.0
  */
@@ -185,6 +192,7 @@ export const nextBetween = (min: number, max: number): Effect.Effect<number> =>
  * await Effect.runPromise(program.pipe(Random.withSeed("example"))) // => [1, 4, 0]
  * ```
  *
+ * @stability stable
  * @category generators
  * @since 2.0.0
  */
@@ -214,6 +222,7 @@ export const nextIntBetween = (min: number, max: number, options?: {
  * await Effect.runPromise(Random.shuffle([1, 2, 3, 4, 5]).pipe(Random.withSeed("example"))) // => [4, 2, 5, 3, 1]
  * ```
  *
+ * @stability stable
  * @category generators
  * @since 2.0.0
  */
@@ -250,6 +259,7 @@ export const shuffle = <A>(elements: Iterable<A>): Effect.Effect<Array<A>> =>
  * await Effect.runPromise(Random.choice(["red", "green", "blue"] as const).pipe(Random.withSeed("example"))) // => "red"
  * ```
  *
+ * @stability stable
  * @category generators
  * @since 3.6.0
  */
@@ -298,6 +308,7 @@ export const choice: <Self extends Iterable<unknown>>(
  * ])) // => [[0.018368576514773527, 0.4010840628128671], [0.018368576514773527, 0.4010840628128671]]
  * ```
  *
+ * @stability stable
  * @category providing services
  * @since 4.0.0
  */
@@ -335,6 +346,7 @@ export const withSeed: {
    * ])) // => [[0.018368576514773527, 0.4010840628128671], [0.018368576514773527, 0.4010840628128671]]
    * ```
    *
+   * @stability stable
    * @category providing services
    * @since 4.0.0
    */
@@ -372,6 +384,7 @@ export const withSeed: {
    * ])) // => [[0.018368576514773527, 0.4010840628128671], [0.018368576514773527, 0.4010840628128671]]
    * ```
    *
+   * @stability stable
    * @category providing services
    * @since 4.0.0
    */