effect 2.0.2 → 2.0.4

package/src/FiberMap.ts

@@ -0,0 +1,269 @@
+/**
+ * @since 2.0.0
+ */
+import * as Effect from "effect/Effect"
+import type * as Scope from "effect/Scope"
+import type { NoSuchElementException } from "./Cause.js"
+import * as Fiber from "./Fiber.js"
+import * as FiberId from "./FiberId.js"
+import { dual } from "./Function.js"
+import * as Inspectable from "./Inspectable.js"
+import * as MutableHashMap from "./MutableHashMap.js"
+import * as Option from "./Option.js"
+import { type Pipeable, pipeArguments } from "./Pipeable.js"
+import * as Predicate from "./Predicate.js"
+
+/**
+ * @since 2.0.0
+ * @categories type ids
+ */
+export const TypeId = Symbol.for("effect/FiberMap")
+
+/**
+ * @since 2.0.0
+ * @categories type ids
+ */
+export type TypeId = typeof TypeId
+
+/**
+ * @since 2.0.0
+ * @categories models
+ */
+export interface FiberMap<K, E = unknown, A = unknown>
+  extends Pipeable, Inspectable.Inspectable, Iterable<[K, Fiber.RuntimeFiber<E, A>]>
+{
+  readonly [TypeId]: TypeId
+  readonly backing: MutableHashMap.MutableHashMap<K, Fiber.RuntimeFiber<E, A>>
+}
+
+/**
+ * @since 2.0.0
+ * @categories refinements
+ */
+export const isFiberMap = (u: unknown): u is FiberMap<unknown> => Predicate.hasProperty(u, TypeId)
+
+const Proto = {
+  [TypeId]: TypeId,
+  [Symbol.iterator](this: FiberMap<unknown>) {
+    return this.backing[Symbol.iterator]()
+  },
+  toString(this: FiberMap<unknown>) {
+    return Inspectable.format(this.toJSON())
+  },
+  toJSON(this: FiberMap<unknown>) {
+    return {
+      _id: "FiberMap",
+      backing: this.backing.toJSON()
+    }
+  },
+  [Inspectable.NodeInspectSymbol](this: FiberMap<unknown>) {
+    return this.toJSON()
+  },
+  pipe() {
+    return pipeArguments(this, arguments)
+  }
+}
+
+const unsafeMake = <K, E = unknown, A = unknown>(): FiberMap<K, E, A> => {
+  const self = Object.create(Proto)
+  self.backing = MutableHashMap.empty()
+  return self
+}
+
+/**
+ * A FiberMap can be used to store a collection of fibers, indexed by some key.
+ * When the associated Scope is closed, all fibers in the map will be interrupted.
+ *
+ * You can add fibers to the map using `FiberMap.set` or `FiberMap.run`, and the fibers will
+ * be automatically removed from the FiberMap when they complete.
+ *
+ * @example
+ * import { Effect, FiberMap } from "effect"
+ *
+ * Effect.gen(function*(_) {
+ *   const map = yield* _(FiberMap.make<string>())
+ *
+ *   // run some effects and add the fibers to the map
+ *   yield* _(FiberMap.run(map, "fiber a", Effect.never))
+ *   yield* _(FiberMap.run(map, "fiber b", Effect.never))
+ *
+ *   yield* _(Effect.sleep(1000))
+ * }).pipe(
+ *   Effect.scoped // The fibers will be interrupted when the scope is closed
+ * )
+ *
+ * @since 2.0.0
+ * @categories constructors
+ */
+export const make = <K, E = unknown, A = unknown>(): Effect.Effect<Scope.Scope, never, FiberMap<K, E, A>> =>
+  Effect.acquireRelease(Effect.sync(() => unsafeMake<K, E, A>()), clear)
+
+/**
+ * Add a fiber to the FiberMap. When the fiber completes, it will be removed from the FiberMap.
+ * If the key already exists in the FiberMap, the previous fiber will be interrupted.
+ *
+ * @since 2.0.0
+ * @categories combinators
+ */
+export const unsafeSet: {
+  <K, E, A, XE extends E, XA extends A>(
+    key: K,
+    fiber: Fiber.RuntimeFiber<XE, XA>,
+    interruptAs?: FiberId.FiberId
+  ): (self: FiberMap<K, E, A>) => void
+  <K, E, A, XE extends E, XA extends A>(
+    self: FiberMap<K, E, A>,
+    key: K,
+    fiber: Fiber.RuntimeFiber<XE, XA>,
+    interruptAs?: FiberId.FiberId
+  ): void
+} = dual<
+  <K, E, A, XE extends E, XA extends A>(
+    key: K,
+    fiber: Fiber.RuntimeFiber<XE, XA>,
+    interruptAs?: FiberId.FiberId
+  ) => (self: FiberMap<K, E, A>) => void,
+  <K, E, A, XE extends E, XA extends A>(
+    self: FiberMap<K, E, A>,
+    key: K,
+    fiber: Fiber.RuntimeFiber<XE, XA>,
+    interruptAs?: FiberId.FiberId
+  ) => void
+>((args) => isFiberMap(args[0]), (self, key, fiber, interruptAs) => {
+  const previous = MutableHashMap.get(self.backing, key)
+  if (previous._tag === "Some") {
+    if (previous.value === fiber) {
+      return
+    }
+    previous.value.unsafeInterruptAsFork(interruptAs ?? FiberId.none)
+  }
+  MutableHashMap.set(self.backing, key, fiber)
+  fiber.addObserver((_) => {
+    const current = MutableHashMap.get(self.backing, key)
+    if (Option.isSome(current) && fiber === current.value) {
+      MutableHashMap.remove(self.backing, key)
+    }
+  })
+})
+
+/**
+ * Add a fiber to the FiberMap. When the fiber completes, it will be removed from the FiberMap.
+ * If the key already exists in the FiberMap, the previous fiber will be interrupted.
+ *
+ * @since 2.0.0
+ * @categories combinators
+ */
+export const set: {
+  <K, E, A, XE extends E, XA extends A>(
+    key: K,
+    fiber: Fiber.RuntimeFiber<XE, XA>
+  ): (self: FiberMap<K, E, A>) => Effect.Effect<never, never, void>
+  <K, E, A, XE extends E, XA extends A>(
+    self: FiberMap<K, E, A>,
+    key: K,
+    fiber: Fiber.RuntimeFiber<XE, XA>
+  ): Effect.Effect<never, never, void>
+} = dual<
+  <K, E, A, XE extends E, XA extends A>(
+    key: K,
+    fiber: Fiber.RuntimeFiber<XE, XA>
+  ) => (self: FiberMap<K, E, A>) => Effect.Effect<never, never, void>,
+  <K, E, A, XE extends E, XA extends A>(
+    self: FiberMap<K, E, A>,
+    key: K,
+    fiber: Fiber.RuntimeFiber<XE, XA>
+  ) => Effect.Effect<never, never, void>
+>(3, (self, key, fiber) =>
+  Effect.fiberIdWith(
+    (fiberId) => Effect.sync(() => unsafeSet(self, key, fiber, fiberId))
+  ))
+
+/**
+ * Retrieve a fiber from the FiberMap.
+ *
+ * @since 2.0.0
+ * @categories combinators
+ */
+export const unsafeGet: {
+  <K>(key: K): <E, A>(self: FiberMap<K, E, A>) => Option.Option<Fiber.RuntimeFiber<E, A>>
+  <K, E, A>(self: FiberMap<K, E, A>, key: K): Option.Option<Fiber.RuntimeFiber<E, A>>
+} = dual<
+  <K>(
+    key: K
+  ) => <E, A>(self: FiberMap<K, E, A>) => Option.Option<Fiber.RuntimeFiber<E, A>>,
+  <K, E, A>(
+    self: FiberMap<K, E, A>,
+    key: K
+  ) => Option.Option<Fiber.RuntimeFiber<E, A>>
+>(2, (self, key) => MutableHashMap.get(self.backing, key))
+
+/**
+ * Retrieve a fiber from the FiberMap.
+ *
+ * @since 2.0.0
+ * @categories combinators
+ */
+export const get: {
+  <K>(key: K): <E, A>(self: FiberMap<K, E, A>) => Effect.Effect<never, NoSuchElementException, Fiber.RuntimeFiber<E, A>>
+  <K, E, A>(self: FiberMap<K, E, A>, key: K): Effect.Effect<never, NoSuchElementException, Fiber.RuntimeFiber<E, A>>
+} = dual<
+  <K>(
+    key: K
+  ) => <E, A>(self: FiberMap<K, E, A>) => Effect.Effect<never, NoSuchElementException, Fiber.RuntimeFiber<E, A>>,
+  <K, E, A>(
+    self: FiberMap<K, E, A>,
+    key: K
+  ) => Effect.Effect<never, NoSuchElementException, Fiber.RuntimeFiber<E, A>>
+>(2, (self, key) => Effect.suspend(() => MutableHashMap.get(self.backing, key)))
+
+/**
+ * @since 2.0.0
+ * @categories combinators
+ */
+export const clear = <K, E, A>(self: FiberMap<K, E, A>): Effect.Effect<never, never, void> =>
+  Effect.zipRight(
+    Effect.forEach(self.backing, ([_, fiber]) => Fiber.interrupt(fiber)),
+    Effect.sync(() => {
+      MutableHashMap.clear(self.backing)
+    })
+  )
+
+/**
+ * Run an Effect and add the forked fiber to the FiberMap.
+ * When the fiber completes, it will be removed from the FiberMap.
+ *
+ * @since 2.0.0
+ * @categories combinators
+ */
+export const run: {
+  <K, E, A, R, XE extends E, XA extends A>(
+    key: K,
+    effect: Effect.Effect<R, XE, XA>
+  ): (self: FiberMap<K, E, A>) => Effect.Effect<R, never, Fiber.RuntimeFiber<XE, XA>>
+  <K, E, A, R, XE extends E, XA extends A>(
+    self: FiberMap<K, E, A>,
+    key: K,
+    effect: Effect.Effect<R, XE, XA>
+  ): Effect.Effect<R, never, Fiber.RuntimeFiber<XE, XA>>
+} = dual<
+  <K, E, A, R, XE extends E, XA extends A>(
+    key: K,
+    effect: Effect.Effect<R, XE, XA>
+  ) => (self: FiberMap<K, E, A>) => Effect.Effect<R, never, Fiber.RuntimeFiber<XE, XA>>,
+  <K, E, A, R, XE extends E, XA extends A>(
+    self: FiberMap<K, E, A>,
+    key: K,
+    effect: Effect.Effect<R, XE, XA>
+  ) => Effect.Effect<R, never, Fiber.RuntimeFiber<XE, XA>>
+>(3, (self, key, effect) =>
+  Effect.tap(
+    Effect.forkDaemon(effect),
+    (fiber) => set(self, key, fiber)
+  ))
+
+/**
+ * @since 2.0.0
+ * @categories combinators
+ */
+export const size = <K, E, A>(self: FiberMap<K, E, A>): Effect.Effect<never, never, number> =>
+  Effect.sync(() => MutableHashMap.size(self.backing))

package/src/FiberSet.ts

@@ -0,0 +1,194 @@
+/**
+ * @since 2.0.0
+ */
+import * as Effect from "effect/Effect"
+import type * as Scope from "effect/Scope"
+import * as Fiber from "./Fiber.js"
+import { dual } from "./Function.js"
+import * as Inspectable from "./Inspectable.js"
+import { type Pipeable, pipeArguments } from "./Pipeable.js"
+import * as Predicate from "./Predicate.js"
+
+/**
+ * @since 2.0.0
+ * @categories type ids
+ */
+export const TypeId = Symbol.for("effect/FiberSet")
+
+/**
+ * @since 2.0.0
+ * @categories type ids
+ */
+export type TypeId = typeof TypeId
+
+/**
+ * @since 2.0.0
+ * @categories models
+ */
+export interface FiberSet<E = unknown, A = unknown>
+  extends Pipeable, Inspectable.Inspectable, Iterable<Fiber.RuntimeFiber<E, A>>
+{
+  readonly [TypeId]: TypeId
+  readonly backing: Set<Fiber.RuntimeFiber<E, A>>
+}
+
+/**
+ * @since 2.0.0
+ * @categories refinements
+ */
+export const isFiberSet = (u: unknown): u is FiberSet<unknown> => Predicate.hasProperty(u, TypeId)
+
+const Proto = {
+  [TypeId]: TypeId,
+  [Symbol.iterator](this: FiberSet) {
+    return this.backing[Symbol.iterator]()
+  },
+  toString(this: FiberSet) {
+    return Inspectable.format(this.toJSON())
+  },
+  toJSON(this: FiberSet) {
+    return {
+      _id: "FiberMap",
+      backing: Inspectable.toJSON(Array.from(this.backing))
+    }
+  },
+  [Inspectable.NodeInspectSymbol](this: FiberSet) {
+    return this.toJSON()
+  },
+  pipe() {
+    return pipeArguments(this, arguments)
+  }
+}
+
+const unsafeMake = <E = unknown, A = unknown>(): FiberSet<E, A> => {
+  const self = Object.create(Proto)
+  self.backing = new Set()
+  return self
+}
+
+/**
+ * A FiberSet can be used to store a collection of fibers.
+ * When the associated Scope is closed, all fibers in the set will be interrupted.
+ *
+ * You can add fibers to the set using `FiberSet.add` or `FiberSet.run`, and the fibers will
+ * be automatically removed from the FiberSet when they complete.
+ *
+ * @example
+ * import { Effect, FiberSet } from "effect"
+ *
+ * Effect.gen(function*(_) {
+ *   const set = yield* _(FiberSet.make())
+ *
+ *   // run some effects and add the fibers to the set
+ *   yield* _(FiberSet.run(set, Effect.never))
+ *   yield* _(FiberSet.run(set, Effect.never))
+ *
+ *   yield* _(Effect.sleep(1000))
+ * }).pipe(
+ *   Effect.scoped // The fibers will be interrupted when the scope is closed
+ * )
+ *
+ * @since 2.0.0
+ * @categories constructors
+ */
+export const make = <E = unknown, A = unknown>(): Effect.Effect<Scope.Scope, never, FiberSet<E, A>> =>
+  Effect.acquireRelease(Effect.sync(() => unsafeMake<E, A>()), clear)
+
+/**
+ * Add a fiber to the FiberSet. When the fiber completes, it will be removed.
+ *
+ * @since 2.0.0
+ * @categories combinators
+ */
+export const unsafeAdd: {
+  <E, A, XE extends E, XA extends A>(fiber: Fiber.RuntimeFiber<XE, XA>): (self: FiberSet<E, A>) => void
+  <E, A, XE extends E, XA extends A>(self: FiberSet<E, A>, fiber: Fiber.RuntimeFiber<XE, XA>): void
+} = dual<
+  <E, A, XE extends E, XA extends A>(
+    fiber: Fiber.RuntimeFiber<XE, XA>
+  ) => (self: FiberSet<E, A>) => void,
+  <E, A, XE extends E, XA extends A>(
+    self: FiberSet<E, A>,
+    fiber: Fiber.RuntimeFiber<XE, XA>
+  ) => void
+>(2, (self, fiber) => {
+  if (self.backing.has(fiber)) {
+    return
+  }
+  self.backing.add(fiber)
+  fiber.addObserver((_) => {
+    self.backing.delete(fiber)
+  })
+})
+
+/**
+ * Add a fiber to the FiberSet. When the fiber completes, it will be removed.
+ *
+ * @since 2.0.0
+ * @categories combinators
+ */
+export const add: {
+  <E, A, XE extends E, XA extends A>(
+    fiber: Fiber.RuntimeFiber<XE, XA>
+  ): (self: FiberSet<E, A>) => Effect.Effect<never, never, void>
+  <E, A, XE extends E, XA extends A>(
+    self: FiberSet<E, A>,
+    fiber: Fiber.RuntimeFiber<XE, XA>
+  ): Effect.Effect<never, never, void>
+} = dual<
+  <E, A, XE extends E, XA extends A>(
+    fiber: Fiber.RuntimeFiber<XE, XA>
+  ) => (self: FiberSet<E, A>) => Effect.Effect<never, never, void>,
+  <E, A, XE extends E, XA extends A>(
+    self: FiberSet<E, A>,
+    fiber: Fiber.RuntimeFiber<XE, XA>
+  ) => Effect.Effect<never, never, void>
+>(2, (self, fiber) => Effect.sync(() => unsafeAdd(self, fiber)))
+
+/**
+ * @since 2.0.0
+ * @categories combinators
+ */
+export const clear = <E, A>(self: FiberSet<E, A>): Effect.Effect<never, never, void> =>
+  Effect.zipRight(
+    Effect.forEach(self.backing, (fiber) => Fiber.interrupt(fiber)),
+    Effect.sync(() => {
+      self.backing.clear()
+    })
+  )
+
+/**
+ * Fork an Effect and add the forked fiber to the FiberSet.
+ * When the fiber completes, it will be removed from the FiberSet.
+ *
+ * @since 2.0.0
+ * @categories combinators
+ */
+export const run: {
+  <E, A, R, XE extends E, XA extends A>(
+    effect: Effect.Effect<R, XE, XA>
+  ): (self: FiberSet<E, A>) => Effect.Effect<R, never, Fiber.RuntimeFiber<XE, XA>>
+  <E, A, R, XE extends E, XA extends A>(
+    self: FiberSet<E, A>,
+    effect: Effect.Effect<R, XE, XA>
+  ): Effect.Effect<R, never, Fiber.RuntimeFiber<XE, XA>>
+} = dual<
+  <E, A, R, XE extends E, XA extends A>(
+    effect: Effect.Effect<R, XE, XA>
+  ) => (self: FiberSet<E, A>) => Effect.Effect<R, never, Fiber.RuntimeFiber<XE, XA>>,
+  <E, A, R, XE extends E, XA extends A>(
+    self: FiberSet<E, A>,
+    effect: Effect.Effect<R, XE, XA>
+  ) => Effect.Effect<R, never, Fiber.RuntimeFiber<XE, XA>>
+>(2, (self, effect) =>
+  Effect.tap(
+    Effect.forkDaemon(effect),
+    (fiber) => add(self, fiber)
+  ))
+
+/**
+ * @since 2.0.0
+ * @categories combinators
+ */
+export const size = <E, A>(self: FiberSet<E, A>): Effect.Effect<never, never, number> =>
+  Effect.sync(() => self.backing.size)

package/src/MutableHashMap.ts

@@ -344,6 +344,16 @@ export const remove: {
   return self
 })
 
+/**
+ * @since 2.0.0
+ */
+export const clear = <K, V>(self: MutableHashMap<K, V>) => {
+  self.referential.clear()
+  self.buckets.clear()
+  self.bucketsSize = 0
+  return self
+}
+
 /**
  * @since 2.0.0
  * @category elements

package/src/MutableHashSet.ts

@@ -118,3 +118,9 @@ export const remove: {
  * @category elements
  */
 export const size = <V>(self: MutableHashSet<V>): number => MutableHashMap.size(self.keyMap)
+
+/**
+ * @since 2.0.0
+ * @category elements
+ */
+export const clear = <V>(self: MutableHashSet<V>): MutableHashSet<V> => (MutableHashMap.clear(self.keyMap), self)

package/src/MutableList.ts

@@ -76,13 +76,21 @@ interface MutableListImpl<A> extends MutableList<A> {
 }
 
 /** @internal */
-class LinkedListNode<T> {
-  removed = false
-  prev: LinkedListNode<T> | undefined = undefined
-  next: LinkedListNode<T> | undefined = undefined
-  constructor(readonly value: T) {}
+interface LinkedListNode<T> {
+  removed: boolean
+  value: T
+  prev: LinkedListNode<T> | undefined
+  next: LinkedListNode<T> | undefined
 }
 
+/** @internal */
+const makeNode = <T>(value: T): LinkedListNode<T> => ({
+  value,
+  removed: false,
+  prev: undefined,
+  next: undefined
+})
+
 /**
  * Creates an empty `MutableList`.
  *
@@ -196,7 +204,7 @@ export const append: {
   <A>(value: A) => (self: MutableList<A>) => MutableList<A>,
   <A>(self: MutableList<A>, value: A) => MutableList<A>
 >(2, <A>(self: MutableList<A>, value: A) => {
-  const node = new LinkedListNode(value)
+  const node = makeNode(value)
   if (self.head === undefined) {
     self.head = node
   }
@@ -252,7 +260,7 @@ export const prepend: {
   <A>(value: A) => (self: MutableList<A>) => MutableList<A>,
   <A>(self: MutableList<A>, value: A) => MutableList<A>
 >(2, <A>(self: MutableList<A>, value: A) => {
-  const node = new LinkedListNode(value)
+  const node = makeNode(value)
   node.next = self.head
   if (self.head !== undefined) {
     self.head.prev = node

package/src/Schedule.ts

@@ -4,6 +4,7 @@
 import type * as Cause from "./Cause.js"
 import type * as Chunk from "./Chunk.js"
 import type * as Context from "./Context.js"
+import type * as Cron from "./Cron.js"
 import type * as Duration from "./Duration.js"
 import type * as Effect from "./Effect.js"
 import type * as Either from "./Either.js"
@@ -405,6 +406,18 @@ export const mapInputEffect: {
  */
 export const count: Schedule<never, unknown, number> = internal.count
 
+/**
+ * Cron schedule that recurs every `minute` that matches the schedule.
+ *
+ * It triggers at zero second of the minute. Producing the timestamps of the cron window.
+ *
+ * NOTE: `expression` parameter is validated lazily. Must be a valid cron expression.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const cron: (expression: string | Cron.Cron) => Schedule<never, unknown, [number, number]> = internal.cron
+
 /**
  * Cron-like schedule that recurs every specified `day` of month. Won't recur
  * on months containing less days than specified in `day` param.

package/src/Struct.ts

@@ -7,7 +7,7 @@
 import * as Equivalence from "./Equivalence.js"
 import { dual } from "./Function.js"
 import * as order from "./Order.js"
-import type { Simplify } from "./Types.js"
+import type { MatchRecord, Simplify } from "./Types.js"
 
 /**
  * Create a new object by picking properties of an existing object.
@@ -20,13 +20,15 @@ import type { Simplify } from "./Types.js"
  *
  * @since 2.0.0
  */
-export const pick = <S, Keys extends readonly [keyof S, ...Array<keyof S>]>(
+export const pick = <Keys extends Array<PropertyKey>>(
   ...keys: Keys
 ) =>
-(s: S): Simplify<Pick<S, Keys[number]>> => {
+<S extends Record<Keys[number], any>>(
+  s: S
+): MatchRecord<S, { [K in Keys[number]]: S[K] | undefined }, { [K in Keys[number]]: S[K] }> => {
   const out: any = {}
   for (const k of keys) {
-    out[k] = s[k]
+    out[k] = (s as any)[k]
   }
   return out
 }
@@ -42,10 +44,10 @@ export const pick = <S, Keys extends readonly [keyof S, ...Array<keyof S>]>(
  *
  * @since 2.0.0
  */
-export const omit = <S, Keys extends readonly [keyof S, ...Array<keyof S>]>(
+export const omit = <Keys extends Array<PropertyKey>>(
   ...keys: Keys
 ) =>
-(s: S): Simplify<Omit<S, Keys[number]>> => {
+<S extends Record<Keys[number], any>>(s: S): Simplify<Omit<S, Keys[number]>> => {
   const out: any = { ...s }
   for (const k of keys) {
     delete out[k]
@@ -150,3 +152,19 @@ export const evolve: {
     return out as any
   }
 )
+
+/**
+ * Retrieves the value associated with the specified key from a struct.
+ *
+ * @example
+ * import * as Struct from "effect/Struct"
+ * import { pipe } from "effect/Function"
+ *
+ * const value = pipe({ a: 1, b: 2 }, Struct.get("a"))
+ *
+ * assert.deepStrictEqual(value, 1)
+ *
+ * @since 2.0.0
+ */
+export const get =
+  <K extends PropertyKey>(key: K) => <S extends Record<K, any>>(s: S): MatchRecord<S, S[K] | undefined, S[K]> => s[key]