@effect/cluster 0.53.1 → 0.53.2

package/dist/esm/internal/entityReaper.js.map

@@ -1 +1 @@
-{"version":3,"file":"entityReaper.js","names":["Effect","EntityReaper","Service","scoped","gen","currentResolution","registered","latch","makeLatch","register","options","suspend","Math","max","min","maxIdleTime","push","open","clock","sleep","now","unsafeCurrentTimeMillis","entities","servers","state","values","duration","lastActiveCheck","activeRequests","size","fork","removeIgnore","address","pipe","whenOpen","interruptible","forkScoped"],"sources":["../../../src/internal/entityReaper.ts"],"sourcesContent":[null],"mappings":"AAAA,OAAO,KAAKA,MAAM,MAAM,eAAe;AAOvC;AACA,OAAM,MAAOC,YAAa,sBAAQD,MAAM,CAACE,OAAO,EAAgB,CAAC,8BAA8B,EAAE;EAC/FC,MAAM,eAAEH,MAAM,CAACI,GAAG,CAAC,aAAS;IAC1B,IAAIC,iBAAiB,GAAG,MAAM;IAC9B,MAAMC,UAAU,GAIX,EAAE;IACP,MAAMC,KAAK,GAAG,OAAOP,MAAM,CAACQ,SAAS,EAAE;IAEvC,MAAMC,QAAQ,GAAIC,OAIjB,IACCV,MAAM,CAACW,OAAO,CAAC,MAAK;MAClBN,iBAAiB,GAAGO,IAAI,CAACC,GAAG,CAACD,IAAI,CAACE,GAAG,CAACT,iBAAiB,EAAEK,OAAO,CAACK,WAAW,CAAC,EAAE,IAAI,CAAC;MACpFT,UAAU,CAACU,IAAI,CAACN,OAAO,CAAC;MACxB,OAAOH,KAAK,CAACU,IAAI;IACnB,CAAC,CAAC;IAEJ,MAAMC,KAAK,GAAG,OAAOlB,MAAM,CAACkB,KAAK;IACjC,OAAOlB,MAAM,CAACI,GAAG,CAAC,aAAS;MACzB,OAAO,IAAI,EAAE;QACX,OAAOJ,MAAM,CAACmB,KAAK,CAACd,iBAAiB,CAAC;QACtC,MAAMe,GAAG,GAAGF,KAAK,CAACG,uBAAuB,EAAE;QAC3C,KAAK,MAAM;UAAEC,QAAQ;UAAEP,WAAW;UAAEQ;QAAO,CAAE,IAAIjB,UAAU,EAAE;UAC3D,KAAK,MAAMkB,KAAK,IAAID,OAAO,CAACE,MAAM,EAAE,EAAE;YACpC,MAAMC,QAAQ,GAAGN,GAAG,GAAGI,KAAK,CAACG,eAAe;YAC5C,IAAIH,KAAK,CAACI,cAAc,CAACC,IAAI,GAAG,CAAC,IAAIH,QAAQ,GAAGX,WAAW,EAAE;cAC3D;YACF;YACA,OAAOf,MAAM,CAAC8B,IAAI,CAACR,QAAQ,CAACS,YAAY,CAACP,KAAK,CAACQ,OAAO,CAAC,CAAC;UAC1D;QACF;MACF;IACF,CAAC,CAAC,CAACC,IAAI,CACL1B,KAAK,CAAC2B,QAAQ,EACdlC,MAAM,CAACmC,aAAa,EACpBnC,MAAM,CAACoC,UAAU,CAClB;IAED,OAAO;MAAE3B;IAAQ,CAAW;EAC9B,CAAC;CACF,CAAC","ignoreList":[]}
+{"version":3,"file":"entityReaper.js","names":["Effect","EntityReaper","Service","scoped","gen","currentResolution","registered","latch","makeLatch","register","options","suspend","Math","max","min","maxIdleTime","push","open","clock","sleep","now","unsafeCurrentTimeMillis","entities","servers","state","values","duration","lastActiveCheck","keepAliveEnabled","activeRequests","size","fork","removeIgnore","address","pipe","whenOpen","interruptible","forkScoped"],"sources":["../../../src/internal/entityReaper.ts"],"sourcesContent":[null],"mappings":"AAAA,OAAO,KAAKA,MAAM,MAAM,eAAe;AAOvC;AACA,OAAM,MAAOC,YAAa,sBAAQD,MAAM,CAACE,OAAO,EAAgB,CAAC,8BAA8B,EAAE;EAC/FC,MAAM,eAAEH,MAAM,CAACI,GAAG,CAAC,aAAS;IAC1B,IAAIC,iBAAiB,GAAG,MAAM;IAC9B,MAAMC,UAAU,GAIX,EAAE;IACP,MAAMC,KAAK,GAAG,OAAOP,MAAM,CAACQ,SAAS,EAAE;IAEvC,MAAMC,QAAQ,GAAIC,OAIjB,IACCV,MAAM,CAACW,OAAO,CAAC,MAAK;MAClBN,iBAAiB,GAAGO,IAAI,CAACC,GAAG,CAACD,IAAI,CAACE,GAAG,CAACT,iBAAiB,EAAEK,OAAO,CAACK,WAAW,CAAC,EAAE,IAAI,CAAC;MACpFT,UAAU,CAACU,IAAI,CAACN,OAAO,CAAC;MACxB,OAAOH,KAAK,CAACU,IAAI;IACnB,CAAC,CAAC;IAEJ,MAAMC,KAAK,GAAG,OAAOlB,MAAM,CAACkB,KAAK;IACjC,OAAOlB,MAAM,CAACI,GAAG,CAAC,aAAS;MACzB,OAAO,IAAI,EAAE;QACX,OAAOJ,MAAM,CAACmB,KAAK,CAACd,iBAAiB,CAAC;QACtC,MAAMe,GAAG,GAAGF,KAAK,CAACG,uBAAuB,EAAE;QAC3C,KAAK,MAAM;UAAEC,QAAQ;UAAEP,WAAW;UAAEQ;QAAO,CAAE,IAAIjB,UAAU,EAAE;UAC3D,KAAK,MAAMkB,KAAK,IAAID,OAAO,CAACE,MAAM,EAAE,EAAE;YACpC,MAAMC,QAAQ,GAAGN,GAAG,GAAGI,KAAK,CAACG,eAAe;YAC5C,IAAIH,KAAK,CAACI,gBAAgB,IAAIJ,KAAK,CAACK,cAAc,CAACC,IAAI,GAAG,CAAC,IAAIJ,QAAQ,GAAGX,WAAW,EAAE;cACrF;YACF;YACA,OAAOf,MAAM,CAAC+B,IAAI,CAACT,QAAQ,CAACU,YAAY,CAACR,KAAK,CAACS,OAAO,CAAC,CAAC;UAC1D;QACF;MACF;IACF,CAAC,CAAC,CAACC,IAAI,CACL3B,KAAK,CAAC4B,QAAQ,EACdnC,MAAM,CAACoC,aAAa,EACpBpC,MAAM,CAACqC,UAAU,CAClB;IAED,OAAO;MAAE5B;IAAQ,CAAW;EAC9B,CAAC;CACF,CAAC","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/cluster",
-  "version": "0.53.1",
+  "version": "0.53.2",
   "description": "Unified interfaces for common cluster-specific services",
   "license": "MIT",
   "repository": {
@@ -11,11 +11,11 @@
   "sideEffects": [],
   "homepage": "https://effect.website",
   "peerDependencies": {
-    "@effect/sql": "^0.48.0",
     "@effect/platform": "^0.93.3",
+    "@effect/sql": "^0.48.0",
     "@effect/workflow": "^0.13.0",
-    "@effect/rpc": "^0.72.2",
-    "effect": "^3.19.5"
+    "effect": "^3.19.6",
+    "@effect/rpc": "^0.72.2"
   },
   "publishConfig": {
     "provenance": true
@@ -85,6 +85,11 @@
       "import": "./dist/esm/EntityProxyServer.js",
       "default": "./dist/cjs/EntityProxyServer.js"
     },
+    "./EntityResource": {
+      "types": "./dist/dts/EntityResource.d.ts",
+      "import": "./dist/esm/EntityResource.js",
+      "default": "./dist/cjs/EntityResource.js"
+    },
     "./EntityType": {
       "types": "./dist/dts/EntityType.d.ts",
       "import": "./dist/esm/EntityType.js",
@@ -241,6 +246,9 @@
       "EntityProxyServer": [
         "./dist/dts/EntityProxyServer.d.ts"
       ],
+      "EntityResource": [
+        "./dist/dts/EntityResource.d.ts"
+      ],
       "EntityType": [
         "./dist/dts/EntityType.d.ts"
       ],

package/src/Entity.ts

@@ -609,6 +609,7 @@ export const keepAlive: (
   const address = yield* CurrentAddress
   const requestId = yield* sharding.getSnowflake
   const span = yield* Effect.orDie(Effect.currentSpan)
+  olatch.value.unsafeClose()
   yield* Effect.orDie(sharding.sendOutgoing(
     new Message.OutgoingRequest({
       rpc: KeepAliveRpc,

package/src/EntityResource.ts

@@ -0,0 +1,117 @@
+/**
+ * @since 1.0.0
+ */
+import * as Duration from "effect/Duration"
+import * as Effect from "effect/Effect"
+import { identity } from "effect/Function"
+import * as RcRef from "effect/RcRef"
+import * as Scope from "effect/Scope"
+import * as Entity from "./Entity.js"
+import type { Sharding } from "./Sharding.js"
+
+/**
+ * @since 1.0.0
+ * @category Type ids
+ */
+export const TypeId: TypeId = "~@effect/cluster/EntityResource"
+
+/**
+ * @since 1.0.0
+ * @category Type ids
+ */
+export type TypeId = "~@effect/cluster/EntityResource"
+
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export interface EntityResource<out A, out E = never> {
+  readonly [TypeId]: TypeId
+  readonly get: Effect.Effect<A, E, Scope.Scope>
+  readonly close: Effect.Effect<void>
+}
+
+/**
+ * A `EntityResource` is a resource that can be acquired inside a cluster
+ * entity, which will keep the entity alive even across restarts.
+ *
+ * The resource will only be fully released when the idle time to live is
+ * reached, or when the `close` effect is called.
+ *
+ * By default, the `idleTimeToLive` is infinite, meaning the resource will only
+ * be released when `close` is called.
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export const make: <A, E, R>(options: {
+  readonly acquire: Effect.Effect<A, E, R>
+  readonly idleTimeToLive?: Duration.DurationInput | undefined
+  /**
+   * When to close the resource Scope.
+   *
+   * If set to "explicit", the resource will only be cleaned up when either the
+   * `idleTimeToLive` is reached, or the .close effect is called.
+   *
+   * Defaults to "always", which means the resource will be cleaned up when the
+   * the parent Scope is closed.
+   */
+  readonly shutdownMode?: "explicit" | "always" | undefined
+}) => Effect.Effect<
+  EntityResource<A, E>,
+  E,
+  Scope.Scope | R | Sharding | Entity.CurrentAddress
+> = Effect.fnUntraced(function*<A, E, R>(options: {
+  readonly acquire: Effect.Effect<A, E, R>
+  readonly idleTimeToLive?: Duration.DurationInput | undefined
+  readonly shutdownMode?: "explicit" | "always" | undefined
+}) {
+  const shutdownMode = options.shutdownMode ?? "always"
+  let shuttingDown = false
+
+  const ref = yield* RcRef.make({
+    acquire: Effect.gen(function*() {
+      let scope = yield* Effect.scope
+
+      if (shutdownMode === "explicit") {
+        const closeable = yield* Scope.make()
+        const context = yield* Effect.context<Sharding | Entity.CurrentAddress>()
+        yield* Scope.addFinalizerExit(
+          scope,
+          Effect.fnUntraced(function*(exit) {
+            if (shuttingDown) return
+            yield* Scope.close(closeable, exit)
+            yield* Entity.keepAlive(false)
+          }, Effect.provide(context))
+        )
+        scope = closeable
+      } else {
+        yield* Effect.addFinalizer(() => {
+          if (shuttingDown) return Effect.void
+          return Entity.keepAlive(false)
+        })
+      }
+
+      yield* Entity.keepAlive(true)
+
+      return yield* options.acquire.pipe(
+        Scope.extend(scope)
+      )
+    }),
+    idleTimeToLive: options.idleTimeToLive ?? Duration.infinity
+  })
+
+  yield* Effect.addFinalizer(() => {
+    shuttingDown = true
+    return Effect.void
+  })
+
+  // Initialize the resource
+  yield* Effect.scoped(RcRef.get(ref))
+
+  return identity<EntityResource<A, E>>({
+    [TypeId]: TypeId,
+    get: RcRef.get(ref),
+    close: RcRef.invalidate(ref)
+  })
+})

package/src/SqlMessageStorage.ts

@@ -302,30 +302,36 @@ export const make = Effect.fnUntraced(function*(options?: {
     mssql: () => (s: string) => `N'${s}'`,
     orElse: () => (s: string) => `'${s}'`
   })
+  const forUpdate = sql.onDialectOrElse({
+    sqlite: () => sql.literal(""),
+    orElse: () => sql.literal("FOR UPDATE")
+  })
 
   const getUnprocessedMessages = sql.onDialectOrElse({
     pg: () => (shardIds: ReadonlyArray<string>, now: number) =>
       sql<MessageJoinRow>`
-        UPDATE ${messagesTableSql} m
-        SET last_read = ${sqlNow}
-        FROM (
-          SELECT m.*
-          FROM ${messagesTableSql} m
-          WHERE m.shard_id IN (${sql.literal(shardIds.map(wrapString).join(","))})
-          AND NOT EXISTS (
-            SELECT 1 FROM ${repliesTableSql}
-            WHERE request_id = m.request_id
-            AND (kind = ${replyKindWithExit} OR acked = ${sqlFalse})
-          )
-          AND m.processed = ${sqlFalse}
-          AND (m.last_read IS NULL OR m.last_read < ${tenMinutesAgo})
-          AND (m.deliver_at IS NULL OR m.deliver_at <= ${sql.literal(String(now))})
-          ORDER BY m.rowid ASC
-          FOR UPDATE
-        ) AS ids
-        LEFT JOIN ${repliesTableSql} r ON r.id = ids.last_reply_id
-        WHERE m.id = ids.id
-        RETURNING ids.*, r.id as reply_reply_id, r.kind as reply_kind, r.payload as reply_payload, r.sequence as reply_sequence
+        WITH messages AS (
+          UPDATE ${messagesTableSql} m
+          SET last_read = ${sqlNow}
+          FROM (
+            SELECT m.*
+            FROM ${messagesTableSql} m
+            WHERE m.shard_id IN (${sql.literal(shardIds.map(wrapString).join(","))})
+            AND NOT EXISTS (
+              SELECT 1 FROM ${repliesTableSql}
+              WHERE request_id = m.request_id
+              AND (kind = ${replyKindWithExit} OR acked = ${sqlFalse})
+            )
+            AND m.processed = ${sqlFalse}
+            AND (m.last_read IS NULL OR m.last_read < ${tenMinutesAgo})
+            AND (m.deliver_at IS NULL OR m.deliver_at <= ${sql.literal(String(now))})
+            FOR UPDATE
+          ) AS ids
+          LEFT JOIN ${repliesTableSql} r ON r.id = ids.last_reply_id
+          WHERE m.id = ids.id
+          RETURNING ids.*, r.id as reply_reply_id, r.kind as reply_kind, r.payload as reply_payload, r.sequence as reply_sequence
+        )
+        SELECT * FROM messages ORDER BY rowid ASC
       `,
     orElse: () => (shardIds: ReadonlyArray<string>, now: number) =>
       sql<MessageJoinRow>`
@@ -342,6 +348,7 @@ export const make = Effect.fnUntraced(function*(options?: {
         AND (m.last_read IS NULL OR m.last_read < ${tenMinutesAgo})
         AND (m.deliver_at IS NULL OR m.deliver_at <= ${sql.literal(String(now))})
         ORDER BY m.rowid ASC
+        ${forUpdate}
       `.unprepared.pipe(
         Effect.tap((rows) => {
           if (rows.length === 0) {

package/src/index.ts

@@ -53,6 +53,11 @@ export * as EntityProxy from "./EntityProxy.js"
  */
 export * as EntityProxyServer from "./EntityProxyServer.js"
 
+/**
+ * @since 1.0.0
+ */
+export * as EntityResource from "./EntityResource.js"
+
 /**
  * @since 1.0.0
  */

package/src/internal/entityManager.ts

@@ -131,7 +131,7 @@ export const make = Effect.fnUntraced(function*<
 
     const scope = yield* Effect.scope
     const endLatch = Effect.unsafeMakeLatch()
-    const keepAliveLatch = Effect.unsafeMakeLatch()
+    const keepAliveLatch = Effect.unsafeMakeLatch(false)
 
     // on shutdown, reset the storage for the entity
     yield* Scope.addFinalizerExit(
@@ -420,7 +420,6 @@ export const make = Effect.fnUntraced(function*<
 
                 if (server.keepAliveEnabled) return reply
                 server.keepAliveEnabled = true
-                server.keepAliveLatch.unsafeClose()
                 return server.keepAliveLatch.whenOpen(Effect.suspend(() => {
                   server.keepAliveEnabled = false
                   return reply
@@ -537,7 +536,7 @@ export const make = Effect.fnUntraced(function*<
                   requestId: message.envelope.requestId,
                   exit: Exit.die(new MalformedMessage({ cause }))
                 }),
-                rpc: entity.protocol.requests.get(message.envelope.tag)!,
+                rpc: entityRpcs.get(message.envelope.tag)!,
                 context
               })
             ))
@@ -549,7 +548,7 @@ export const make = Effect.fnUntraced(function*<
               )
             }
             const request = message as Message.IncomingRequest<any>
-            const rpc = entity.protocol.requests.get(decoded.envelope.tag)!
+            const rpc = entityRpcs.get(decoded.envelope.tag)!
             return sendLocal(
               new Message.IncomingRequestLocal({
                 envelope: decoded.envelope,

package/src/internal/entityReaper.ts

@@ -35,7 +35,7 @@ export class EntityReaper extends Effect.Service<EntityReaper>()("@effect/cluste
         for (const { entities, maxIdleTime, servers } of registered) {
           for (const state of servers.values()) {
             const duration = now - state.lastActiveCheck
-            if (state.activeRequests.size > 0 || duration < maxIdleTime) {
+            if (state.keepAliveEnabled || state.activeRequests.size > 0 || duration < maxIdleTime) {
               continue
             }
             yield* Effect.fork(entities.removeIgnore(state.address))