@effect/cluster 0.0.0-snapshot-d33d8b050b8e3c87dcde9587083e6c1cf733f72b

package/package.json

@@ -0,0 +1,259 @@
+{
+  "name": "@effect/cluster",
+  "version": "0.0.0-snapshot-d33d8b050b8e3c87dcde9587083e6c1cf733f72b",
+  "description": "Unified interfaces for common cluster-specific services",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Effect-TS/effect.git",
+    "directory": "packages/cluster"
+  },
+  "sideEffects": [],
+  "peerDependencies": {
+    "@effect/schema": "^0.0.0-snapshot-d33d8b050b8e3c87dcde9587083e6c1cf733f72b",
+    "@effect/sql": "^0.0.0-snapshot-d33d8b050b8e3c87dcde9587083e6c1cf733f72b",
+    "effect": "^0.0.0-snapshot-d33d8b050b8e3c87dcde9587083e6c1cf733f72b"
+  },
+  "publishConfig": {
+    "provenance": true
+  },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/dts/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/dts/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "default": "./dist/cjs/index.js"
+    },
+    "./AtLeastOnce": {
+      "types": "./dist/dts/AtLeastOnce.d.ts",
+      "import": "./dist/esm/AtLeastOnce.js",
+      "default": "./dist/cjs/AtLeastOnce.js"
+    },
+    "./AtLeastOnceStorage": {
+      "types": "./dist/dts/AtLeastOnceStorage.d.ts",
+      "import": "./dist/esm/AtLeastOnceStorage.js",
+      "default": "./dist/cjs/AtLeastOnceStorage.js"
+    },
+    "./Broadcaster": {
+      "types": "./dist/dts/Broadcaster.d.ts",
+      "import": "./dist/esm/Broadcaster.js",
+      "default": "./dist/cjs/Broadcaster.js"
+    },
+    "./ManagerConfig": {
+      "types": "./dist/dts/ManagerConfig.d.ts",
+      "import": "./dist/esm/ManagerConfig.js",
+      "default": "./dist/cjs/ManagerConfig.js"
+    },
+    "./Message": {
+      "types": "./dist/dts/Message.d.ts",
+      "import": "./dist/esm/Message.js",
+      "default": "./dist/cjs/Message.js"
+    },
+    "./MessageState": {
+      "types": "./dist/dts/MessageState.d.ts",
+      "import": "./dist/esm/MessageState.js",
+      "default": "./dist/cjs/MessageState.js"
+    },
+    "./Messenger": {
+      "types": "./dist/dts/Messenger.d.ts",
+      "import": "./dist/esm/Messenger.js",
+      "default": "./dist/cjs/Messenger.js"
+    },
+    "./Pod": {
+      "types": "./dist/dts/Pod.d.ts",
+      "import": "./dist/esm/Pod.js",
+      "default": "./dist/cjs/Pod.js"
+    },
+    "./PodAddress": {
+      "types": "./dist/dts/PodAddress.d.ts",
+      "import": "./dist/esm/PodAddress.js",
+      "default": "./dist/cjs/PodAddress.js"
+    },
+    "./Pods": {
+      "types": "./dist/dts/Pods.d.ts",
+      "import": "./dist/esm/Pods.js",
+      "default": "./dist/cjs/Pods.js"
+    },
+    "./PodsHealth": {
+      "types": "./dist/dts/PodsHealth.d.ts",
+      "import": "./dist/esm/PodsHealth.js",
+      "default": "./dist/cjs/PodsHealth.js"
+    },
+    "./PoisonPill": {
+      "types": "./dist/dts/PoisonPill.d.ts",
+      "import": "./dist/esm/PoisonPill.js",
+      "default": "./dist/cjs/PoisonPill.js"
+    },
+    "./RecipientAddress": {
+      "types": "./dist/dts/RecipientAddress.d.ts",
+      "import": "./dist/esm/RecipientAddress.js",
+      "default": "./dist/cjs/RecipientAddress.js"
+    },
+    "./RecipientBehaviour": {
+      "types": "./dist/dts/RecipientBehaviour.d.ts",
+      "import": "./dist/esm/RecipientBehaviour.js",
+      "default": "./dist/cjs/RecipientBehaviour.js"
+    },
+    "./RecipientBehaviourContext": {
+      "types": "./dist/dts/RecipientBehaviourContext.d.ts",
+      "import": "./dist/esm/RecipientBehaviourContext.js",
+      "default": "./dist/cjs/RecipientBehaviourContext.js"
+    },
+    "./RecipientType": {
+      "types": "./dist/dts/RecipientType.d.ts",
+      "import": "./dist/esm/RecipientType.js",
+      "default": "./dist/cjs/RecipientType.js"
+    },
+    "./Serialization": {
+      "types": "./dist/dts/Serialization.d.ts",
+      "import": "./dist/esm/Serialization.js",
+      "default": "./dist/cjs/Serialization.js"
+    },
+    "./SerializedEnvelope": {
+      "types": "./dist/dts/SerializedEnvelope.d.ts",
+      "import": "./dist/esm/SerializedEnvelope.js",
+      "default": "./dist/cjs/SerializedEnvelope.js"
+    },
+    "./SerializedMessage": {
+      "types": "./dist/dts/SerializedMessage.d.ts",
+      "import": "./dist/esm/SerializedMessage.js",
+      "default": "./dist/cjs/SerializedMessage.js"
+    },
+    "./ShardId": {
+      "types": "./dist/dts/ShardId.d.ts",
+      "import": "./dist/esm/ShardId.js",
+      "default": "./dist/cjs/ShardId.js"
+    },
+    "./ShardManager": {
+      "types": "./dist/dts/ShardManager.d.ts",
+      "import": "./dist/esm/ShardManager.js",
+      "default": "./dist/cjs/ShardManager.js"
+    },
+    "./ShardManagerClient": {
+      "types": "./dist/dts/ShardManagerClient.d.ts",
+      "import": "./dist/esm/ShardManagerClient.js",
+      "default": "./dist/cjs/ShardManagerClient.js"
+    },
+    "./Sharding": {
+      "types": "./dist/dts/Sharding.d.ts",
+      "import": "./dist/esm/Sharding.js",
+      "default": "./dist/cjs/Sharding.js"
+    },
+    "./ShardingConfig": {
+      "types": "./dist/dts/ShardingConfig.d.ts",
+      "import": "./dist/esm/ShardingConfig.js",
+      "default": "./dist/cjs/ShardingConfig.js"
+    },
+    "./ShardingEvent": {
+      "types": "./dist/dts/ShardingEvent.d.ts",
+      "import": "./dist/esm/ShardingEvent.js",
+      "default": "./dist/cjs/ShardingEvent.js"
+    },
+    "./ShardingException": {
+      "types": "./dist/dts/ShardingException.d.ts",
+      "import": "./dist/esm/ShardingException.js",
+      "default": "./dist/cjs/ShardingException.js"
+    },
+    "./ShardingRegistrationEvent": {
+      "types": "./dist/dts/ShardingRegistrationEvent.d.ts",
+      "import": "./dist/esm/ShardingRegistrationEvent.js",
+      "default": "./dist/cjs/ShardingRegistrationEvent.js"
+    },
+    "./Storage": {
+      "types": "./dist/dts/Storage.d.ts",
+      "import": "./dist/esm/Storage.js",
+      "default": "./dist/cjs/Storage.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "AtLeastOnce": [
+        "./dist/dts/AtLeastOnce.d.ts"
+      ],
+      "AtLeastOnceStorage": [
+        "./dist/dts/AtLeastOnceStorage.d.ts"
+      ],
+      "Broadcaster": [
+        "./dist/dts/Broadcaster.d.ts"
+      ],
+      "ManagerConfig": [
+        "./dist/dts/ManagerConfig.d.ts"
+      ],
+      "Message": [
+        "./dist/dts/Message.d.ts"
+      ],
+      "MessageState": [
+        "./dist/dts/MessageState.d.ts"
+      ],
+      "Messenger": [
+        "./dist/dts/Messenger.d.ts"
+      ],
+      "Pod": [
+        "./dist/dts/Pod.d.ts"
+      ],
+      "PodAddress": [
+        "./dist/dts/PodAddress.d.ts"
+      ],
+      "Pods": [
+        "./dist/dts/Pods.d.ts"
+      ],
+      "PodsHealth": [
+        "./dist/dts/PodsHealth.d.ts"
+      ],
+      "PoisonPill": [
+        "./dist/dts/PoisonPill.d.ts"
+      ],
+      "RecipientAddress": [
+        "./dist/dts/RecipientAddress.d.ts"
+      ],
+      "RecipientBehaviour": [
+        "./dist/dts/RecipientBehaviour.d.ts"
+      ],
+      "RecipientBehaviourContext": [
+        "./dist/dts/RecipientBehaviourContext.d.ts"
+      ],
+      "RecipientType": [
+        "./dist/dts/RecipientType.d.ts"
+      ],
+      "Serialization": [
+        "./dist/dts/Serialization.d.ts"
+      ],
+      "SerializedEnvelope": [
+        "./dist/dts/SerializedEnvelope.d.ts"
+      ],
+      "SerializedMessage": [
+        "./dist/dts/SerializedMessage.d.ts"
+      ],
+      "ShardId": [
+        "./dist/dts/ShardId.d.ts"
+      ],
+      "ShardManager": [
+        "./dist/dts/ShardManager.d.ts"
+      ],
+      "ShardManagerClient": [
+        "./dist/dts/ShardManagerClient.d.ts"
+      ],
+      "Sharding": [
+        "./dist/dts/Sharding.d.ts"
+      ],
+      "ShardingConfig": [
+        "./dist/dts/ShardingConfig.d.ts"
+      ],
+      "ShardingEvent": [
+        "./dist/dts/ShardingEvent.d.ts"
+      ],
+      "ShardingException": [
+        "./dist/dts/ShardingException.d.ts"
+      ],
+      "ShardingRegistrationEvent": [
+        "./dist/dts/ShardingRegistrationEvent.d.ts"
+      ],
+      "Storage": [
+        "./dist/dts/Storage.d.ts"
+      ]
+    }
+  }
+}

package/src/AtLeastOnce.ts

@@ -0,0 +1,28 @@
+/**
+ * @since 1.0.0
+ */
+import type * as Duration from "effect/Duration"
+import type * as Effect from "effect/Effect"
+import type * as Scope from "effect/Scope"
+import type * as AtLeastOnceStorage from "./AtLeastOnceStorage.js"
+import * as internal from "./internal/atLeastOnce.js"
+import type * as RecipientBehaviour from "./RecipientBehaviour.js"
+import type * as Sharding from "./Sharding.js"
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const atLeastOnceRecipientBehaviour: <Msg, R>(
+  fa: RecipientBehaviour.RecipientBehaviour<Msg, R>
+) => RecipientBehaviour.RecipientBehaviour<Msg, R | AtLeastOnceStorage.AtLeastOnceStorage> =
+  internal.atLeastOnceRecipientBehaviour
+
+/**
+ * @since 1.0.0
+ * @category utils
+ */
+export const runPendingMessageSweeperScoped: (
+  interval: Duration.Duration
+) => Effect.Effect<void, never, AtLeastOnceStorage.AtLeastOnceStorage | Sharding.Sharding | Scope.Scope> =
+  internal.runPendingMessageSweeperScoped

package/src/AtLeastOnceStorage.ts

@@ -0,0 +1,96 @@
+/**
+ * @since 1.0.0
+ */
+import type { Message } from "@effect/cluster/Message"
+import type { SqlClient } from "@effect/sql/SqlClient"
+import type { SqlError } from "@effect/sql/SqlError"
+import type { Tag } from "effect/Context"
+import type { Effect } from "effect/Effect"
+import type { Layer } from "effect/Layer"
+import type { Stream } from "effect/Stream"
+import * as Internal from "./internal/atLeastOnceStorage.js"
+import type { RecipientType } from "./RecipientType.js"
+import type { Serialization } from "./Serialization.js"
+import type { SerializedEnvelope } from "./SerializedEnvelope.js"
+import type { ShardId } from "./ShardId.js"
+
+/**
+ * @since 1.0.0
+ * @category symbols
+ */
+export const TypeId: unique symbol = Internal.TypeId
+
+/**
+ * @since 1.0.0
+ * @category symbols
+ */
+export type TypeId = typeof TypeId
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export interface AtLeastOnceStorage extends AtLeastOnceStorage.Proto {
+  /**
+   * Upserts a message into the storage, eventually returning the already
+   * existing message state as result in the storage.
+   */
+  upsert<Msg extends Message.Any>(
+    recipientType: RecipientType<Msg>,
+    shardId: ShardId,
+    entityId: string,
+    message: Msg
+  ): Effect<void>
+
+  /**
+   * Marks the specified message as processed to prevent additional attempts to
+   * send the message.
+   */
+  markAsProcessed<Msg extends Message.Any>(
+    recipientType: RecipientType<Msg>,
+    shardId: ShardId,
+    entityId: string,
+    message: Msg
+  ): Effect<void>
+
+  /**
+   * Returns a stream of messages that will be sent to the local pod as a second
+   * attempt.
+   */
+  sweepPending(shardIds: Iterable<ShardId>): Stream<SerializedEnvelope>
+}
+
+/**
+ * @since 1.0.0
+ * @category context
+ */
+export const AtLeastOnceStorage: Tag<AtLeastOnceStorage, AtLeastOnceStorage> = Internal.atLeastOnceStorageTag
+
+/**
+ * @since 1.0.0
+ */
+export declare namespace AtLeastOnceStorage {
+  /**
+   * @since 1.0.0
+   * @category models
+   */
+  export interface Proto {
+    readonly [TypeId]: TypeId
+  }
+
+  /**
+   * @since 1.0.0
+   * @category models
+   */
+  export interface MakeOptions {
+    readonly table: string
+  }
+}
+
+/**
+ * @since 1.0.0
+ * @category context
+ */
+export const layer: (
+  options: AtLeastOnceStorage.MakeOptions
+) => Layer<AtLeastOnceStorage, SqlError, SqlClient | Serialization> = Internal.layer

package/src/Broadcaster.ts

@@ -0,0 +1,48 @@
+/**
+ * @since 1.0.0
+ */
+import type * as Effect from "effect/Effect"
+import type * as Either from "effect/Either"
+import type * as HashMap from "effect/HashMap"
+import type * as Message from "./Message.js"
+import type * as PodAddress from "./PodAddress.js"
+import type * as ShardingException from "./ShardingException.js"
+
+/**
+ * An interface to communicate with a remote broadcast receiver
+ *
+ * @since 1.0.0
+ * @category models
+ */
+export interface Broadcaster<Msg extends Message.Message.Any> {
+  /**
+   * Broadcast a message without waiting for a response (fire and forget)
+   *
+   * You can use Effect timeout to get send timeouts. The default behaviour is to send the message indifinetely.
+   * @since 1.0.0
+   */
+  readonly broadcastDiscard: (
+    topicId: string
+  ) => (message: Msg) => Effect.Effect<void, ShardingException.ShardingException>
+
+  /**
+   * Broadcast a message and wait for a response from each consumer
+   *
+   * You can use Effect timeout to get send timeouts. The default behaviour is to send the message indifinetely
+   * @since 1.0.0
+   */
+  readonly broadcast: (
+    topicId: string
+  ) => <A extends Msg>(
+    message: A
+  ) => Effect.Effect<
+    HashMap.HashMap<
+      PodAddress.PodAddress,
+      Either.Either<
+        ShardingException.ShardingException | Message.Message.Error<A>,
+        Message.Message.Success<A>
+      >
+    >,
+    ShardingException.ShardingException
+  >
+}

package/src/ManagerConfig.ts

@@ -0,0 +1,67 @@
+/**
+ * @since 1.0.0
+ */
+import type * as ConfigError from "effect/ConfigError"
+import type * as Context from "effect/Context"
+import type * as Duration from "effect/Duration"
+import type * as Layer from "effect/Layer"
+import * as internal from "./internal/managerConfig.js"
+
+/**
+ * @since 1.0.0
+ * @category symbols
+ */
+export const ManagerConfigTypeId: unique symbol = internal.ManagerConfigTypeId
+
+/**
+ * @since 1.0.0
+ * @category symbols
+ */
+export type ManagerConfigTypeId = typeof ManagerConfigTypeId
+
+/**
+ * This is the Shard Manager configuration.
+ *
+ * @param numberOfShards number of shards (see documentation on how to choose this), should be same on all nodes
+ * @param apiPort port to expose the GraphQL API
+ * @param rebalanceInterval interval for regular rebalancing of shards
+ * @param rebalanceRetryInterval retry interval for rebalancing when some shards failed to be rebalanced
+ * @param pingTimeout time to wait for a pod to respond to a ping request
+ * @param persistRetryInterval retry interval for persistence of pods and shard assignments
+ * @param persistRetryCount max retry count for persistence of pods and shard assignments
+ * @param rebalanceRate max ratio of shards to rebalance at once
+ * @since 1.0.0
+ * @category models
+ */
+export interface ManagerConfig {
+  readonly numberOfShards: number
+  readonly apiPort: number
+  readonly rebalanceInterval: Duration.Duration
+  readonly rebalanceRetryInterval: Duration.Duration
+  readonly pingTimeout: Duration.Duration
+  readonly persistRetryInterval: Duration.Duration
+  readonly persistRetryCount: number
+  readonly rebalanceRate: number
+}
+
+/**
+ * @since 1.0.0
+ * @category context
+ */
+export const ManagerConfig: Context.Tag<ManagerConfig, ManagerConfig> = internal.managerConfigTag
+
+/**
+ * Uses the default as ManagerConfig.
+ *
+ * @since 1.0.0
+ * @category utils
+ */
+export const defaults: Layer.Layer<ManagerConfig> = internal.defaults
+
+/**
+ * Reads the ManagerConfig from the provided Config.
+ *
+ * @since 1.0.0
+ * @category constructors
+ */
+export const fromConfig: Layer.Layer<ManagerConfig, ConfigError.ConfigError, never> = internal.fromConfig

package/src/Message.ts

@@ -0,0 +1,132 @@
+/**
+ * @since 1.0.0
+ */
+import type * as Schema from "@effect/schema/Schema"
+import type * as Serializable from "@effect/schema/Serializable"
+import type * as Exit_ from "effect/Exit"
+import type * as PrimaryKey from "effect/PrimaryKey"
+import type * as Types from "effect/Types"
+import * as internal from "./internal/message.js"
+
+/**
+ * A Message is a request for an entity that will process it.
+ * A Message also has a PrimaryKey so that the receiver is eventually able to detect duplicated messages.
+ *
+ * @since 1.0.0
+ * @category models
+ */
+export interface Message<A, AI, E, EI>
+  extends Serializable.SerializableWithResult<any, any, never, A, AI, E, EI, never>, PrimaryKey.PrimaryKey
+{}
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export namespace Message {
+  /**
+   * @since 1.0.0
+   * @category models
+   */
+  export type Any =
+    | Message<any, any, any, any>
+    | Message<any, any, never, never>
+
+  /**
+   * Extracts the success type from a `Message`.
+   *
+   * @since 1.0.0
+   * @category utils
+   */
+  export type Success<S> = S extends Message<infer A, infer _AI, infer _E, infer _EI> ? A : never
+
+  /**
+   * Extracts the success type from a `Message`.
+   *
+   * @since 1.0.0
+   * @category utils
+   */
+  export type SuccessEncoded<S> = S extends Message<infer _A, infer _AI, infer _E, infer _EI> ? _AI : never
+
+  /**
+   * Extracts the error type from a `Message`.
+   *
+   * @since 1.0.0
+   * @category utils
+   */
+  export type Error<S> = S extends Message<infer _A, infer _AI, infer E, infer _EI> ? E : never
+
+  /**
+   * Extracts the error type from a `Message`.
+   *
+   * @since 1.0.0
+   * @category utils
+   */
+  export type ErrorEncoded<S> = S extends Message<infer _A, infer _AI, infer _E, infer _EI> ? _EI : never
+
+  /**
+   * Extracts the exit type from a `Message`.
+   *
+   * @since 1.0.0
+   * @category utils
+   */
+  export type Exit<S> = S extends Serializable.WithResult<infer A, infer _AI, infer E, infer _EI, infer _R> ?
+    Exit_.Exit<A, E>
+    : never
+}
+
+/**
+ * @since 1.0.0
+ * @category schemas
+ */
+export interface TaggedMessageConstructor<Tag extends string, Self, R, IS, S, IE, E, IA, A>
+  extends Schema.Schema<Self, Types.Simplify<IS & { readonly _tag: Tag }>, R>
+{
+  new(
+    props: Types.Equals<S, {}> extends true ? void : S,
+    disableValidation?: boolean
+  ): Schema.TaggedRequest<Tag, S, IS & { readonly _tag: Tag }, never, A, IA, E, IE, never> & S & PrimaryKey.PrimaryKey
+}
+
+/**
+ * @since 1.0.0
+ * @category schemas
+ */
+export const TaggedMessage = internal.TaggedMessage_
+
+/**
+ * @since 1.0.0
+ * @category utils
+ */
+export const isMessageWithResult: (value: unknown) => value is Message<unknown, unknown, unknown, unknown> =
+  internal.isMessageWithResult
+
+/**
+ * Extracts the exit schema from a Message. This schema will be used to encode the remote exit of the Message processor.
+ *
+ * @since 1.0.0
+ * @category utils
+ */
+export const exitSchema: <A extends Message.Any>(
+  message: A
+) => Schema.Schema<Message.Exit<A>, unknown> = internal.exitSchema
+
+/**
+ * Extracts the failure schema from a Message. This schema will be used to encode remote failures of the Message processor.
+ *
+ * @since 1.0.0
+ * @category utils
+ */
+export const failureSchema: <A extends Message.Any>(
+  message: A
+) => Schema.Schema<Message.Error<A>, unknown> = internal.failureSchema
+
+/**
+ * Extracts the success schema from a Message. This schema will be used to encode the remote success of the Message processor.
+ *
+ * @since 1.0.0
+ * @category utils
+ */
+export const successSchema: <A extends Message.Any>(
+  message: A
+) => Schema.Schema<Message.Success<A>, unknown> = internal.successSchema