effect 4.0.0-beta.2 → 4.0.0-beta.21

package/src/TxSubscriptionRef.ts

@@ -0,0 +1,639 @@
+/**
+ * TxSubscriptionRef is a TxRef that allows subscribing to all committed changes. Subscribers
+ * receive the current value followed by every subsequent update via a transactional queue.
+ *
+ * @since 4.0.0
+ */
+import * as Effect from "./Effect.ts"
+import { dual } from "./Function.ts"
+import type { Inspectable } from "./Inspectable.ts"
+import { NodeInspectSymbol, toJson } from "./Inspectable.ts"
+import type { Pipeable } from "./Pipeable.ts"
+import { pipeArguments } from "./Pipeable.ts"
+import { hasProperty } from "./Predicate.ts"
+import type * as Scope from "./Scope.ts"
+import * as Stream from "./Stream.ts"
+import * as TxPubSub from "./TxPubSub.ts"
+import * as TxQueue from "./TxQueue.ts"
+import * as TxRef from "./TxRef.ts"
+
+const TypeId = "~effect/transactions/TxSubscriptionRef"
+
+/**
+ * A TxSubscriptionRef is a transactional reference that allows subscribing to all
+ * committed changes. Subscribers receive the current value followed by every subsequent
+ * update via a transactional dequeue.
+ *
+ * @example
+ * ```ts
+ * import { Effect, TxSubscriptionRef, TxQueue } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const ref = yield* TxSubscriptionRef.make(0)
+ *
+ *   yield* Effect.scoped(
+ *     Effect.gen(function*() {
+ *       const sub = yield* TxSubscriptionRef.changes(ref)
+ *       const initial = yield* TxQueue.take(sub)
+ *       console.log(initial) // 0
+ *
+ *       yield* TxSubscriptionRef.set(ref, 1)
+ *       const next = yield* TxQueue.take(sub)
+ *       console.log(next) // 1
+ *     })
+ *   )
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category models
+ */
+export interface TxSubscriptionRef<in out A> extends Inspectable, Pipeable {
+  readonly [TypeId]: typeof TypeId
+  /** @internal */
+  readonly ref: TxRef.TxRef<A>
+  /** @internal */
+  readonly pubsub: TxPubSub.TxPubSub<A>
+}
+
+const TxSubscriptionRefProto: Omit<TxSubscriptionRef<any>, typeof TypeId | "ref" | "pubsub"> = {
+  [NodeInspectSymbol](this: TxSubscriptionRef<unknown>) {
+    return toJson(this)
+  },
+  toJSON(this: TxSubscriptionRef<unknown>) {
+    return { _id: "TxSubscriptionRef" }
+  },
+  toString() {
+    return "TxSubscriptionRef"
+  },
+  pipe() {
+    return pipeArguments(this, arguments)
+  }
+}
+
+// =============================================================================
+// Constructors
+// =============================================================================
+
+/**
+ * Creates a new TxSubscriptionRef with the specified initial value.
+ *
+ * @example
+ * ```ts
+ * import { Effect, TxSubscriptionRef } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const ref = yield* TxSubscriptionRef.make(42)
+ *   const value = yield* TxSubscriptionRef.get(ref)
+ *   console.log(value) // 42
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category constructors
+ */
+export const make = <A>(value: A): Effect.Effect<TxSubscriptionRef<A>, never, Effect.Transaction> =>
+  Effect.gen(function*() {
+    const ref = yield* TxRef.make(value)
+    const pubsub = yield* TxPubSub.unbounded<A>()
+    const self = Object.create(TxSubscriptionRefProto)
+    self[TypeId] = TypeId
+    self.ref = ref
+    self.pubsub = pubsub
+    return self
+  })
+
+// =============================================================================
+// Getters
+// =============================================================================
+
+/**
+ * Reads the current value of the TxSubscriptionRef.
+ *
+ * @example
+ * ```ts
+ * import { Effect, TxSubscriptionRef } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const ref = yield* TxSubscriptionRef.make("hello")
+ *   const value = yield* TxSubscriptionRef.get(ref)
+ *   console.log(value) // "hello"
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category getters
+ */
+export const get = <A>(self: TxSubscriptionRef<A>): Effect.Effect<A, never, Effect.Transaction> => TxRef.get(self.ref)
+
+// =============================================================================
+// Mutations
+// =============================================================================
+
+/**
+ * Modifies the value of the TxSubscriptionRef using a function that returns both a
+ * result and the new value. The new value is published to all subscribers atomically.
+ *
+ * @example
+ * ```ts
+ * import { Effect, TxSubscriptionRef } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const ref = yield* TxSubscriptionRef.make(10)
+ *   const result = yield* TxSubscriptionRef.modify(ref, (n) => [`was ${n}`, n + 1])
+ *   console.log(result) // "was 10"
+ *   console.log(yield* TxSubscriptionRef.get(ref)) // 11
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category mutations
+ */
+export const modify: {
+  // =============================================================================
+  // Mutations
+  // =============================================================================
+
+  /**
+   * Modifies the value of the TxSubscriptionRef using a function that returns both a
+   * result and the new value. The new value is published to all subscribers atomically.
+   *
+   * @example
+   * ```ts
+   * import { Effect, TxSubscriptionRef } from "effect"
+   *
+   * const program = Effect.gen(function*() {
+   *   const ref = yield* TxSubscriptionRef.make(10)
+   *   const result = yield* TxSubscriptionRef.modify(ref, (n) => [`was ${n}`, n + 1])
+   *   console.log(result) // "was 10"
+   *   console.log(yield* TxSubscriptionRef.get(ref)) // 11
+   * })
+   * ```
+   *
+   * @since 4.0.0
+   * @category mutations
+   */
+  <A, B>(f: (current: A) => [returnValue: B, newValue: A]): (self: TxSubscriptionRef<A>) => Effect.Effect<B, never, Effect.Transaction>
+  // =============================================================================
+  // Mutations
+  // =============================================================================
+
+  /**
+   * Modifies the value of the TxSubscriptionRef using a function that returns both a
+   * result and the new value. The new value is published to all subscribers atomically.
+   *
+   * @example
+   * ```ts
+   * import { Effect, TxSubscriptionRef } from "effect"
+   *
+   * const program = Effect.gen(function*() {
+   *   const ref = yield* TxSubscriptionRef.make(10)
+   *   const result = yield* TxSubscriptionRef.modify(ref, (n) => [`was ${n}`, n + 1])
+   *   console.log(result) // "was 10"
+   *   console.log(yield* TxSubscriptionRef.get(ref)) // 11
+   * })
+   * ```
+   *
+   * @since 4.0.0
+   * @category mutations
+   */
+  <A, B>(
+    self: TxSubscriptionRef<A>,
+    f: (current: A) => [returnValue: B, newValue: A]
+  ): Effect.Effect<B, never, Effect.Transaction>
+} = dual(
+  2,
+  <A, B>(
+    self: TxSubscriptionRef<A>,
+    f: (current: A) => [returnValue: B, newValue: A]
+  ): Effect.Effect<B, never, Effect.Transaction> =>
+    Effect.gen(function*() {
+      const current = yield* TxRef.get(self.ref)
+      const [returnValue, newValue] = f(current)
+      yield* TxRef.set(self.ref, newValue)
+      yield* TxPubSub.publish(self.pubsub, newValue)
+      return returnValue
+    })
+)
+
+/**
+ * Sets the value of the TxSubscriptionRef and publishes the new value to all subscribers.
+ *
+ * @example
+ * ```ts
+ * import { Effect, TxSubscriptionRef } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const ref = yield* TxSubscriptionRef.make(0)
+ *   yield* TxSubscriptionRef.set(ref, 42)
+ *   console.log(yield* TxSubscriptionRef.get(ref)) // 42
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category mutations
+ */
+export const set: {
+  /**
+   * Sets the value of the TxSubscriptionRef and publishes the new value to all subscribers.
+   *
+   * @example
+   * ```ts
+   * import { Effect, TxSubscriptionRef } from "effect"
+   *
+   * const program = Effect.gen(function*() {
+   *   const ref = yield* TxSubscriptionRef.make(0)
+   *   yield* TxSubscriptionRef.set(ref, 42)
+   *   console.log(yield* TxSubscriptionRef.get(ref)) // 42
+   * })
+   * ```
+   *
+   * @since 4.0.0
+   * @category mutations
+   */
+  <A>(value: A): (self: TxSubscriptionRef<A>) => Effect.Effect<void, never, Effect.Transaction>
+  /**
+   * Sets the value of the TxSubscriptionRef and publishes the new value to all subscribers.
+   *
+   * @example
+   * ```ts
+   * import { Effect, TxSubscriptionRef } from "effect"
+   *
+   * const program = Effect.gen(function*() {
+   *   const ref = yield* TxSubscriptionRef.make(0)
+   *   yield* TxSubscriptionRef.set(ref, 42)
+   *   console.log(yield* TxSubscriptionRef.get(ref)) // 42
+   * })
+   * ```
+   *
+   * @since 4.0.0
+   * @category mutations
+   */
+  <A>(self: TxSubscriptionRef<A>, value: A): Effect.Effect<void, never, Effect.Transaction>
+} = dual(
+  2,
+  <A>(self: TxSubscriptionRef<A>, value: A): Effect.Effect<void, never, Effect.Transaction> =>
+    modify(self, () => [void 0, value])
+)
+
+/**
+ * Updates the value of the TxSubscriptionRef using a function and publishes the new
+ * value to all subscribers.
+ *
+ * @example
+ * ```ts
+ * import { Effect, TxSubscriptionRef } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const ref = yield* TxSubscriptionRef.make(5)
+ *   yield* TxSubscriptionRef.update(ref, (n) => n * 2)
+ *   console.log(yield* TxSubscriptionRef.get(ref)) // 10
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category mutations
+ */
+export const update: {
+  /**
+   * Updates the value of the TxSubscriptionRef using a function and publishes the new
+   * value to all subscribers.
+   *
+   * @example
+   * ```ts
+   * import { Effect, TxSubscriptionRef } from "effect"
+   *
+   * const program = Effect.gen(function*() {
+   *   const ref = yield* TxSubscriptionRef.make(5)
+   *   yield* TxSubscriptionRef.update(ref, (n) => n * 2)
+   *   console.log(yield* TxSubscriptionRef.get(ref)) // 10
+   * })
+   * ```
+   *
+   * @since 4.0.0
+   * @category mutations
+   */
+  <A>(f: (current: A) => A): (self: TxSubscriptionRef<A>) => Effect.Effect<void, never, Effect.Transaction>
+  /**
+   * Updates the value of the TxSubscriptionRef using a function and publishes the new
+   * value to all subscribers.
+   *
+   * @example
+   * ```ts
+   * import { Effect, TxSubscriptionRef } from "effect"
+   *
+   * const program = Effect.gen(function*() {
+   *   const ref = yield* TxSubscriptionRef.make(5)
+   *   yield* TxSubscriptionRef.update(ref, (n) => n * 2)
+   *   console.log(yield* TxSubscriptionRef.get(ref)) // 10
+   * })
+   * ```
+   *
+   * @since 4.0.0
+   * @category mutations
+   */
+  <A>(self: TxSubscriptionRef<A>, f: (current: A) => A): Effect.Effect<void, never, Effect.Transaction>
+} = dual(
+  2,
+  <A>(self: TxSubscriptionRef<A>, f: (current: A) => A): Effect.Effect<void, never, Effect.Transaction> =>
+    modify(self, (current) => [void 0, f(current)])
+)
+
+/**
+ * Gets the current value and sets a new value atomically. Publishes the new value
+ * to all subscribers.
+ *
+ * @example
+ * ```ts
+ * import { Effect, TxSubscriptionRef } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const ref = yield* TxSubscriptionRef.make("a")
+ *   const old = yield* TxSubscriptionRef.getAndSet(ref, "b")
+ *   console.log(old) // "a"
+ *   console.log(yield* TxSubscriptionRef.get(ref)) // "b"
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category mutations
+ */
+export const getAndSet: {
+  /**
+   * Gets the current value and sets a new value atomically. Publishes the new value
+   * to all subscribers.
+   *
+   * @example
+   * ```ts
+   * import { Effect, TxSubscriptionRef } from "effect"
+   *
+   * const program = Effect.gen(function*() {
+   *   const ref = yield* TxSubscriptionRef.make("a")
+   *   const old = yield* TxSubscriptionRef.getAndSet(ref, "b")
+   *   console.log(old) // "a"
+   *   console.log(yield* TxSubscriptionRef.get(ref)) // "b"
+   * })
+   * ```
+   *
+   * @since 4.0.0
+   * @category mutations
+   */
+  <A>(value: A): (self: TxSubscriptionRef<A>) => Effect.Effect<A, never, Effect.Transaction>
+  /**
+   * Gets the current value and sets a new value atomically. Publishes the new value
+   * to all subscribers.
+   *
+   * @example
+   * ```ts
+   * import { Effect, TxSubscriptionRef } from "effect"
+   *
+   * const program = Effect.gen(function*() {
+   *   const ref = yield* TxSubscriptionRef.make("a")
+   *   const old = yield* TxSubscriptionRef.getAndSet(ref, "b")
+   *   console.log(old) // "a"
+   *   console.log(yield* TxSubscriptionRef.get(ref)) // "b"
+   * })
+   * ```
+   *
+   * @since 4.0.0
+   * @category mutations
+   */
+  <A>(self: TxSubscriptionRef<A>, value: A): Effect.Effect<A, never, Effect.Transaction>
+} = dual(
+  2,
+  <A>(self: TxSubscriptionRef<A>, value: A): Effect.Effect<A, never, Effect.Transaction> =>
+    modify(self, (current) => [current, value])
+)
+
+/**
+ * Gets the current value and updates it using a function atomically. Publishes
+ * the new value to all subscribers.
+ *
+ * @example
+ * ```ts
+ * import { Effect, TxSubscriptionRef } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const ref = yield* TxSubscriptionRef.make(1)
+ *   const old = yield* TxSubscriptionRef.getAndUpdate(ref, (n) => n + 10)
+ *   console.log(old) // 1
+ *   console.log(yield* TxSubscriptionRef.get(ref)) // 11
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category mutations
+ */
+export const getAndUpdate: {
+  /**
+   * Gets the current value and updates it using a function atomically. Publishes
+   * the new value to all subscribers.
+   *
+   * @example
+   * ```ts
+   * import { Effect, TxSubscriptionRef } from "effect"
+   *
+   * const program = Effect.gen(function*() {
+   *   const ref = yield* TxSubscriptionRef.make(1)
+   *   const old = yield* TxSubscriptionRef.getAndUpdate(ref, (n) => n + 10)
+   *   console.log(old) // 1
+   *   console.log(yield* TxSubscriptionRef.get(ref)) // 11
+   * })
+   * ```
+   *
+   * @since 4.0.0
+   * @category mutations
+   */
+  <A>(f: (current: A) => A): (self: TxSubscriptionRef<A>) => Effect.Effect<A, never, Effect.Transaction>
+  /**
+   * Gets the current value and updates it using a function atomically. Publishes
+   * the new value to all subscribers.
+   *
+   * @example
+   * ```ts
+   * import { Effect, TxSubscriptionRef } from "effect"
+   *
+   * const program = Effect.gen(function*() {
+   *   const ref = yield* TxSubscriptionRef.make(1)
+   *   const old = yield* TxSubscriptionRef.getAndUpdate(ref, (n) => n + 10)
+   *   console.log(old) // 1
+   *   console.log(yield* TxSubscriptionRef.get(ref)) // 11
+   * })
+   * ```
+   *
+   * @since 4.0.0
+   * @category mutations
+   */
+  <A>(self: TxSubscriptionRef<A>, f: (current: A) => A): Effect.Effect<A, never, Effect.Transaction>
+} = dual(
+  2,
+  <A>(self: TxSubscriptionRef<A>, f: (current: A) => A): Effect.Effect<A, never, Effect.Transaction> =>
+    modify(self, (current) => [current, f(current)])
+)
+
+/**
+ * Updates the value using a function and returns the new value. Publishes the
+ * new value to all subscribers.
+ *
+ * @example
+ * ```ts
+ * import { Effect, TxSubscriptionRef } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const ref = yield* TxSubscriptionRef.make(3)
+ *   const result = yield* TxSubscriptionRef.updateAndGet(ref, (n) => n * 3)
+ *   console.log(result) // 9
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category mutations
+ */
+export const updateAndGet: {
+  /**
+   * Updates the value using a function and returns the new value. Publishes the
+   * new value to all subscribers.
+   *
+   * @example
+   * ```ts
+   * import { Effect, TxSubscriptionRef } from "effect"
+   *
+   * const program = Effect.gen(function*() {
+   *   const ref = yield* TxSubscriptionRef.make(3)
+   *   const result = yield* TxSubscriptionRef.updateAndGet(ref, (n) => n * 3)
+   *   console.log(result) // 9
+   * })
+   * ```
+   *
+   * @since 4.0.0
+   * @category mutations
+   */
+  <A>(f: (current: A) => A): (self: TxSubscriptionRef<A>) => Effect.Effect<A, never, Effect.Transaction>
+  /**
+   * Updates the value using a function and returns the new value. Publishes the
+   * new value to all subscribers.
+   *
+   * @example
+   * ```ts
+   * import { Effect, TxSubscriptionRef } from "effect"
+   *
+   * const program = Effect.gen(function*() {
+   *   const ref = yield* TxSubscriptionRef.make(3)
+   *   const result = yield* TxSubscriptionRef.updateAndGet(ref, (n) => n * 3)
+   *   console.log(result) // 9
+   * })
+   * ```
+   *
+   * @since 4.0.0
+   * @category mutations
+   */
+  <A>(self: TxSubscriptionRef<A>, f: (current: A) => A): Effect.Effect<A, never, Effect.Transaction>
+} = dual(
+  2,
+  <A>(self: TxSubscriptionRef<A>, f: (current: A) => A): Effect.Effect<A, never, Effect.Transaction> =>
+    modify(self, (current) => {
+      const newValue = f(current)
+      return [newValue, newValue]
+    })
+)
+
+// =============================================================================
+// Subscriptions
+// =============================================================================
+
+/**
+ * Subscribes to all changes of the TxSubscriptionRef. Returns a scoped TxDequeue
+ * that first yields the current value, then every subsequent update.
+ *
+ * @example
+ * ```ts
+ * import { Effect, TxSubscriptionRef, TxQueue } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const ref = yield* TxSubscriptionRef.make(0)
+ *
+ *   yield* Effect.scoped(
+ *     Effect.gen(function*() {
+ *       const sub = yield* TxSubscriptionRef.changes(ref)
+ *       const initial = yield* TxQueue.take(sub)
+ *       console.log(initial) // 0
+ *
+ *       yield* TxSubscriptionRef.set(ref, 1)
+ *       const next = yield* TxQueue.take(sub)
+ *       console.log(next) // 1
+ *     })
+ *   )
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category subscriptions
+ */
+export const changes = <A>(
+  self: TxSubscriptionRef<A>
+): Effect.Effect<TxQueue.TxQueue<A>, never, Scope.Scope> =>
+  Effect.acquireRelease(
+    Effect.transaction(
+      Effect.gen(function*() {
+        const sub = yield* TxPubSub.acquireSubscriber(self.pubsub)
+        const current = yield* TxRef.get(self.ref)
+        yield* TxQueue.offer(sub, current)
+        return sub
+      })
+    ),
+    (queue) => Effect.transaction(TxPubSub.releaseSubscriber(self.pubsub, queue))
+  )
+
+/**
+ * Returns a Stream of all changes to the TxSubscriptionRef, starting with the
+ * current value followed by every subsequent update.
+ *
+ * @example
+ * ```ts
+ * import { Effect, Stream, TxSubscriptionRef } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const ref = yield* TxSubscriptionRef.make(0)
+ *   yield* TxSubscriptionRef.set(ref, 1)
+ *   yield* TxSubscriptionRef.set(ref, 2)
+ *
+ *   const values = yield* Stream.runCollect(
+ *     TxSubscriptionRef.changesStream(ref).pipe(Stream.take(1))
+ *   )
+ *   console.log(values) // [2]
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category subscriptions
+ */
+export const changesStream = <A>(self: TxSubscriptionRef<A>): Stream.Stream<A, never, never> =>
+  Stream.unwrap(
+    Effect.map(
+      changes(self),
+      (sub) => Stream.fromEffectRepeat(Effect.transaction(TxQueue.take(sub)))
+    )
+  )
+
+// =============================================================================
+// Guards
+// =============================================================================
+
+/**
+ * Checks if the given value is a TxSubscriptionRef.
+ *
+ * @example
+ * ```ts
+ * import { TxSubscriptionRef } from "effect"
+ *
+ * declare const someValue: unknown
+ *
+ * if (TxSubscriptionRef.isTxSubscriptionRef(someValue)) {
+ *   console.log("This is a TxSubscriptionRef")
+ * }
+ * ```
+ *
+ * @since 4.0.0
+ * @category guards
+ */
+export const isTxSubscriptionRef = (u: unknown): u is TxSubscriptionRef<unknown> => hasProperty(u, TypeId)