@effect/cluster 0.28.4 → 0.29.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/cluster",
-  "version": "0.28.4",
+  "version": "0.29.0",
   "description": "Unified interfaces for common cluster-specific services",
   "license": "MIT",
   "repository": {
@@ -10,8 +10,10 @@
   },
   "sideEffects": [],
   "peerDependencies": {
-    "@effect/sql": "^0.32.4",
-    "effect": "^3.13.12"
+    "@effect/platform": "^0.80.0",
+    "@effect/rpc": "^0.55.0",
+    "@effect/sql": "^0.33.0",
+    "effect": "^3.14.0"
   },
   "publishConfig": {
     "provenance": true
@@ -26,100 +28,110 @@
       "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"
+    "./ClusterError": {
+      "types": "./dist/dts/ClusterError.d.ts",
+      "import": "./dist/esm/ClusterError.js",
+      "default": "./dist/cjs/ClusterError.js"
     },
-    "./AtLeastOnceStorage": {
-      "types": "./dist/dts/AtLeastOnceStorage.d.ts",
-      "import": "./dist/esm/AtLeastOnceStorage.js",
-      "default": "./dist/cjs/AtLeastOnceStorage.js"
+    "./ClusterMetrics": {
+      "types": "./dist/dts/ClusterMetrics.d.ts",
+      "import": "./dist/esm/ClusterMetrics.js",
+      "default": "./dist/cjs/ClusterMetrics.js"
     },
-    "./Broadcaster": {
-      "types": "./dist/dts/Broadcaster.d.ts",
-      "import": "./dist/esm/Broadcaster.js",
-      "default": "./dist/cjs/Broadcaster.js"
+    "./ClusterSchema": {
+      "types": "./dist/dts/ClusterSchema.d.ts",
+      "import": "./dist/esm/ClusterSchema.js",
+      "default": "./dist/cjs/ClusterSchema.js"
     },
-    "./ManagerConfig": {
-      "types": "./dist/dts/ManagerConfig.d.ts",
-      "import": "./dist/esm/ManagerConfig.js",
-      "default": "./dist/cjs/ManagerConfig.js"
+    "./DeliverAt": {
+      "types": "./dist/dts/DeliverAt.d.ts",
+      "import": "./dist/esm/DeliverAt.js",
+      "default": "./dist/cjs/DeliverAt.js"
+    },
+    "./Entity": {
+      "types": "./dist/dts/Entity.d.ts",
+      "import": "./dist/esm/Entity.js",
+      "default": "./dist/cjs/Entity.js"
+    },
+    "./EntityAddress": {
+      "types": "./dist/dts/EntityAddress.d.ts",
+      "import": "./dist/esm/EntityAddress.js",
+      "default": "./dist/cjs/EntityAddress.js"
+    },
+    "./EntityId": {
+      "types": "./dist/dts/EntityId.d.ts",
+      "import": "./dist/esm/EntityId.js",
+      "default": "./dist/cjs/EntityId.js"
+    },
+    "./EntityType": {
+      "types": "./dist/dts/EntityType.d.ts",
+      "import": "./dist/esm/EntityType.js",
+      "default": "./dist/cjs/EntityType.js"
+    },
+    "./Envelope": {
+      "types": "./dist/dts/Envelope.d.ts",
+      "import": "./dist/esm/Envelope.js",
+      "default": "./dist/cjs/Envelope.js"
+    },
+    "./HttpCommon": {
+      "types": "./dist/dts/HttpCommon.d.ts",
+      "import": "./dist/esm/HttpCommon.js",
+      "default": "./dist/cjs/HttpCommon.js"
+    },
+    "./HttpRunner": {
+      "types": "./dist/dts/HttpRunner.d.ts",
+      "import": "./dist/esm/HttpRunner.js",
+      "default": "./dist/cjs/HttpRunner.js"
+    },
+    "./HttpShardManager": {
+      "types": "./dist/dts/HttpShardManager.d.ts",
+      "import": "./dist/esm/HttpShardManager.js",
+      "default": "./dist/cjs/HttpShardManager.js"
+    },
+    "./MachineId": {
+      "types": "./dist/dts/MachineId.d.ts",
+      "import": "./dist/esm/MachineId.js",
+      "default": "./dist/cjs/MachineId.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"
+    "./MessageStorage": {
+      "types": "./dist/dts/MessageStorage.d.ts",
+      "import": "./dist/esm/MessageStorage.js",
+      "default": "./dist/cjs/MessageStorage.js"
+    },
+    "./Reply": {
+      "types": "./dist/dts/Reply.d.ts",
+      "import": "./dist/esm/Reply.js",
+      "default": "./dist/cjs/Reply.js"
+    },
+    "./Runner": {
+      "types": "./dist/dts/Runner.d.ts",
+      "import": "./dist/esm/Runner.js",
+      "default": "./dist/cjs/Runner.js"
+    },
+    "./RunnerAddress": {
+      "types": "./dist/dts/RunnerAddress.d.ts",
+      "import": "./dist/esm/RunnerAddress.js",
+      "default": "./dist/cjs/RunnerAddress.js"
+    },
+    "./RunnerHealth": {
+      "types": "./dist/dts/RunnerHealth.d.ts",
+      "import": "./dist/esm/RunnerHealth.js",
+      "default": "./dist/cjs/RunnerHealth.js"
+    },
+    "./RunnerServer": {
+      "types": "./dist/dts/RunnerServer.d.ts",
+      "import": "./dist/esm/RunnerServer.js",
+      "default": "./dist/cjs/RunnerServer.js"
+    },
+    "./Runners": {
+      "types": "./dist/dts/Runners.d.ts",
+      "import": "./dist/esm/Runners.js",
+      "default": "./dist/cjs/Runners.js"
     },
     "./ShardId": {
       "types": "./dist/dts/ShardId.d.ts",
@@ -131,10 +143,10 @@
       "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"
+    "./ShardStorage": {
+      "types": "./dist/dts/ShardStorage.d.ts",
+      "import": "./dist/esm/ShardStorage.js",
+      "default": "./dist/cjs/ShardStorage.js"
     },
     "./Sharding": {
       "types": "./dist/dts/Sharding.d.ts",
@@ -146,85 +158,116 @@
       "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"
+    "./Singleton": {
+      "types": "./dist/dts/Singleton.d.ts",
+      "import": "./dist/esm/Singleton.js",
+      "default": "./dist/cjs/Singleton.js"
+    },
+    "./SingletonAddress": {
+      "types": "./dist/dts/SingletonAddress.d.ts",
+      "import": "./dist/esm/SingletonAddress.js",
+      "default": "./dist/cjs/SingletonAddress.js"
+    },
+    "./Snowflake": {
+      "types": "./dist/dts/Snowflake.d.ts",
+      "import": "./dist/esm/Snowflake.js",
+      "default": "./dist/cjs/Snowflake.js"
+    },
+    "./SocketRunner": {
+      "types": "./dist/dts/SocketRunner.d.ts",
+      "import": "./dist/esm/SocketRunner.js",
+      "default": "./dist/cjs/SocketRunner.js"
+    },
+    "./SocketShardManager": {
+      "types": "./dist/dts/SocketShardManager.d.ts",
+      "import": "./dist/esm/SocketShardManager.js",
+      "default": "./dist/cjs/SocketShardManager.js"
+    },
+    "./SqlMessageStorage": {
+      "types": "./dist/dts/SqlMessageStorage.d.ts",
+      "import": "./dist/esm/SqlMessageStorage.js",
+      "default": "./dist/cjs/SqlMessageStorage.js"
+    },
+    "./SqlShardStorage": {
+      "types": "./dist/dts/SqlShardStorage.d.ts",
+      "import": "./dist/esm/SqlShardStorage.js",
+      "default": "./dist/cjs/SqlShardStorage.js"
+    },
+    "./SynchronizedClock": {
+      "types": "./dist/dts/SynchronizedClock.d.ts",
+      "import": "./dist/esm/SynchronizedClock.js",
+      "default": "./dist/cjs/SynchronizedClock.js"
     }
   },
   "typesVersions": {
     "*": {
-      "AtLeastOnce": [
-        "./dist/dts/AtLeastOnce.d.ts"
+      "ClusterError": [
+        "./dist/dts/ClusterError.d.ts"
       ],
-      "AtLeastOnceStorage": [
-        "./dist/dts/AtLeastOnceStorage.d.ts"
+      "ClusterMetrics": [
+        "./dist/dts/ClusterMetrics.d.ts"
       ],
-      "Broadcaster": [
-        "./dist/dts/Broadcaster.d.ts"
+      "ClusterSchema": [
+        "./dist/dts/ClusterSchema.d.ts"
       ],
-      "ManagerConfig": [
-        "./dist/dts/ManagerConfig.d.ts"
+      "DeliverAt": [
+        "./dist/dts/DeliverAt.d.ts"
       ],
-      "Message": [
-        "./dist/dts/Message.d.ts"
+      "Entity": [
+        "./dist/dts/Entity.d.ts"
+      ],
+      "EntityAddress": [
+        "./dist/dts/EntityAddress.d.ts"
+      ],
+      "EntityId": [
+        "./dist/dts/EntityId.d.ts"
       ],
-      "MessageState": [
-        "./dist/dts/MessageState.d.ts"
+      "EntityType": [
+        "./dist/dts/EntityType.d.ts"
       ],
-      "Messenger": [
-        "./dist/dts/Messenger.d.ts"
+      "Envelope": [
+        "./dist/dts/Envelope.d.ts"
       ],
-      "Pod": [
-        "./dist/dts/Pod.d.ts"
+      "HttpCommon": [
+        "./dist/dts/HttpCommon.d.ts"
       ],
-      "PodAddress": [
-        "./dist/dts/PodAddress.d.ts"
+      "HttpRunner": [
+        "./dist/dts/HttpRunner.d.ts"
       ],
-      "Pods": [
-        "./dist/dts/Pods.d.ts"
+      "HttpShardManager": [
+        "./dist/dts/HttpShardManager.d.ts"
       ],
-      "PodsHealth": [
-        "./dist/dts/PodsHealth.d.ts"
+      "MachineId": [
+        "./dist/dts/MachineId.d.ts"
       ],
-      "PoisonPill": [
-        "./dist/dts/PoisonPill.d.ts"
+      "Message": [
+        "./dist/dts/Message.d.ts"
       ],
-      "RecipientAddress": [
-        "./dist/dts/RecipientAddress.d.ts"
+      "MessageStorage": [
+        "./dist/dts/MessageStorage.d.ts"
       ],
-      "RecipientBehaviour": [
-        "./dist/dts/RecipientBehaviour.d.ts"
+      "Reply": [
+        "./dist/dts/Reply.d.ts"
       ],
-      "RecipientBehaviourContext": [
-        "./dist/dts/RecipientBehaviourContext.d.ts"
+      "Runner": [
+        "./dist/dts/Runner.d.ts"
       ],
-      "RecipientType": [
-        "./dist/dts/RecipientType.d.ts"
+      "RunnerAddress": [
+        "./dist/dts/RunnerAddress.d.ts"
       ],
-      "Serialization": [
-        "./dist/dts/Serialization.d.ts"
+      "RunnerHealth": [
+        "./dist/dts/RunnerHealth.d.ts"
       ],
-      "SerializedEnvelope": [
-        "./dist/dts/SerializedEnvelope.d.ts"
+      "RunnerServer": [
+        "./dist/dts/RunnerServer.d.ts"
       ],
-      "SerializedMessage": [
-        "./dist/dts/SerializedMessage.d.ts"
+      "Runners": [
+        "./dist/dts/Runners.d.ts"
       ],
       "ShardId": [
         "./dist/dts/ShardId.d.ts"
@@ -232,8 +275,8 @@
       "ShardManager": [
         "./dist/dts/ShardManager.d.ts"
       ],
-      "ShardManagerClient": [
-        "./dist/dts/ShardManagerClient.d.ts"
+      "ShardStorage": [
+        "./dist/dts/ShardStorage.d.ts"
       ],
       "Sharding": [
         "./dist/dts/Sharding.d.ts"
@@ -241,17 +284,32 @@
       "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"
+      "Singleton": [
+        "./dist/dts/Singleton.d.ts"
+      ],
+      "SingletonAddress": [
+        "./dist/dts/SingletonAddress.d.ts"
+      ],
+      "Snowflake": [
+        "./dist/dts/Snowflake.d.ts"
+      ],
+      "SocketRunner": [
+        "./dist/dts/SocketRunner.d.ts"
+      ],
+      "SocketShardManager": [
+        "./dist/dts/SocketShardManager.d.ts"
+      ],
+      "SqlMessageStorage": [
+        "./dist/dts/SqlMessageStorage.d.ts"
+      ],
+      "SqlShardStorage": [
+        "./dist/dts/SqlShardStorage.d.ts"
+      ],
+      "SynchronizedClock": [
+        "./dist/dts/SynchronizedClock.d.ts"
       ]
     }
   }

package/src/ClusterError.ts

@@ -0,0 +1,193 @@
+/**
+ * @since 1.0.0
+ */
+import * as Cause from "effect/Cause"
+import * as Effect from "effect/Effect"
+import { hasProperty, isTagged } from "effect/Predicate"
+import * as Schema from "effect/Schema"
+import { EntityAddress } from "./EntityAddress.js"
+import { RunnerAddress } from "./RunnerAddress.js"
+import { SnowflakeFromString } from "./Snowflake.js"
+
+/**
+ * @since 1.0.0
+ * @category Symbols
+ */
+export const TypeId: unique symbol = Symbol.for("@effect/cluster/ClusterError")
+
+/**
+ * @since 1.0.0
+ * @category Symbols
+ */
+export type TypeId = typeof TypeId
+
+/**
+ * Represents an error that occurs when a Runner receives a message for an entity
+ * that it is not responsible for managing.
+ *
+ * @since 1.0.0
+ * @category errors
+ */
+export class EntityNotManagedByRunner extends Schema.TaggedError<EntityNotManagedByRunner>()(
+  "EntityNotManagedByRunner",
+  { address: EntityAddress }
+) {
+  /**
+   * @since 1.0.0
+   */
+  readonly [TypeId] = TypeId
+
+  /**
+   * @since 1.0.0
+   */
+  static is(u: unknown): u is EntityNotManagedByRunner {
+    return hasProperty(u, TypeId) && isTagged(u, "EntityNotManagedByRunner")
+  }
+}
+
+/**
+ * Represents an error that occurs when a message fails to be properly
+ * deserialized by an entity.
+ *
+ * @since 1.0.0
+ * @category errors
+ */
+export class MalformedMessage extends Schema.TaggedError<MalformedMessage>()(
+  "MalformedMessage",
+  { cause: Schema.Defect }
+) {
+  /**
+   * @since 1.0.0
+   */
+  readonly [TypeId] = TypeId
+
+  /**
+   * @since 1.0.0
+   */
+  static is(u: unknown): u is MalformedMessage {
+    return hasProperty(u, TypeId) && isTagged(u, "MalformedMessage")
+  }
+
+  /**
+   * @since 1.0.0
+   */
+  static refail: <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<
+    A,
+    MalformedMessage,
+    R
+  > = Effect.mapError((cause) => new MalformedMessage({ cause }))
+}
+
+/**
+ * Represents an error that occurs when a message fails to be persisted into
+ * cluster's mailbox storage.
+ *
+ * @since 1.0.0
+ * @category errors
+ */
+export class PersistenceError extends Schema.TaggedError<PersistenceError>()(
+  "PersistenceError",
+  { cause: Schema.Defect }
+) {
+  /**
+   * @since 1.0.0
+   */
+  readonly [TypeId] = TypeId
+
+  /**
+   * @since 1.0.0
+   */
+  static refail<A, E, R>(effect: Effect.Effect<A, E, R>): Effect.Effect<A, PersistenceError, R> {
+    return Effect.catchAllCause(effect, (cause) => Effect.fail(new PersistenceError({ cause: Cause.squash(cause) })))
+  }
+}
+
+/**
+ * Represents an error that occurs when a Runner is not registered with the shard
+ * manager.
+ *
+ * @since 1.0.0
+ * @category errors
+ */
+export class RunnerNotRegistered extends Schema.TaggedError<RunnerNotRegistered>()(
+  "RunnerNotRegistered",
+  { address: RunnerAddress }
+) {
+  /**
+   * @since 1.0.0
+   */
+  readonly [TypeId] = TypeId
+}
+
+/**
+ * Represents an error that occurs when a Runner is unresponsive.
+ *
+ * @since 1.0.0
+ * @category errors
+ */
+export class RunnerUnavailable extends Schema.TaggedError<RunnerUnavailable>()(
+  "RunnerUnavailable",
+  { address: RunnerAddress }
+) {
+  /**
+   * @since 1.0.0
+   */
+  readonly [TypeId] = TypeId
+
+  /**
+   * @since 1.0.0
+   */
+  static is(u: unknown): u is RunnerUnavailable {
+    return hasProperty(u, TypeId) && isTagged(u, "RunnerUnavailable")
+  }
+}
+
+/**
+ * Represents an error that occurs when the entities mailbox is full.
+ *
+ * @since 1.0.0
+ * @category errors
+ */
+export class MailboxFull extends Schema.TaggedError<MailboxFull>()(
+  "MailboxFull",
+  { address: EntityAddress }
+) {
+  /**
+   * @since 1.0.0
+   */
+  readonly [TypeId] = TypeId
+
+  /**
+   * @since 1.0.0
+   */
+  static is(u: unknown): u is MailboxFull {
+    return hasProperty(u, TypeId) && isTagged(u, "MailboxFull")
+  }
+}
+
+/**
+ * Represents an error that occurs when the entity is already processing a
+ * request.
+ *
+ * @since 1.0.0
+ * @category errors
+ */
+export class AlreadyProcessingMessage extends Schema.TaggedError<AlreadyProcessingMessage>()(
+  "AlreadyProcessingMessage",
+  {
+    envelopeId: SnowflakeFromString,
+    address: EntityAddress
+  }
+) {
+  /**
+   * @since 1.0.0
+   */
+  readonly [TypeId] = TypeId
+
+  /**
+   * @since 1.0.0
+   */
+  static is(u: unknown): u is AlreadyProcessingMessage {
+    return hasProperty(u, TypeId) && isTagged(u, "AlreadyProcessingMessage")
+  }
+}