nick/amethyst
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

refactor: simplify relay API with AutoCloseable and serve() helper

Browse Source 
- NostrServer and IEventStore implement AutoCloseable for .use {} support
- Add NostrServer.serve() to handle session lifecycle automatically
- IRelayPolicy + operator now returns PolicyStack instead of List
- Deprecate shutdown() in favor of close()
- Update RELAY.md guide to use simplified API patterns

https://claude.ai/code/session_013oL9PkQaFyNQHKVg2vw9qs
This commit is contained in:
Claude
2026-03-30 12:35:27 +00:00
parent e556f7716c
commit df88cab92d
6 changed files with 130 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files
quartz/src/commonMain/kotlin/com/vitorpamplona/quartz/nip01Core/relay/server/IRelayPolicy.kt
+2 -1
View File
@@ -27,6 +27,7 @@ import com.vitorpamplona.quartz.nip01Core.relay.commands.toRelay.Command
import com.vitorpamplona.quartz.nip01Core.relay.commands.toRelay.CountCmd
import com.vitorpamplona.quartz.nip01Core.relay.commands.toRelay.EventCmd
import com.vitorpamplona.quartz.nip01Core.relay.commands.toRelay.ReqCmd
import com.vitorpamplona.quartz.nip01Core.relay.server.policies.PolicyStack
/**
* Defines custom behavior for this relay.
@@ -76,7 +77,7 @@ interface IRelayPolicy {
*/
fun canSendToSession(event: Event): Boolean = true
operator fun plus(other: IRelayPolicy) = listOf(this, other)
operator fun plus(other: IRelayPolicy): IRelayPolicy = PolicyStack(this, other)
}
sealed interface PolicyResult<T : Command> {
quartz/src/commonMain/kotlin/com/vitorpamplona/quartz/nip01Core/relay/server/NostrServer.kt
+30 -3
View File
@@ -41,7 +41,7 @@ class NostrServer(
private val store: IEventStore,
private val policyBuilder: () -> IRelayPolicy = { VerifyPolicy },
private val parentContext: CoroutineContext = SupervisorJob(),
) {
) : AutoCloseable {
private val subStore = LiveEventStore(store)
/** Scope for all subscriptions. */
@@ -70,11 +70,38 @@ class NostrServer(
}
/**
* Shuts down the server, cancelling all subscriptions and sessions.
* Registers a new client connection and serves it for the duration of
* [incoming]. The session is automatically closed when [incoming] returns.
*
* @param send Callback the server uses to send JSON messages to this client.
* @param incoming Suspend block that yields raw JSON strings from the client
* (e.g., reading WebSocket text frames in a loop).
*/
fun shutdown() {
suspend fun serve(
send: (String) -> Unit,
incoming: suspend (RelaySession) -> Unit,
) {
val session = connect(send)
try {
incoming(session)
} finally {
session.close()
}
}
/**
* Shuts down the server, cancelling all subscriptions and closing the store.
*/
override fun close() {
connections.forEach { _, session -> session.cancelAllSubscriptions() }
connections.clear()
scope.cancel()
store.close()
}
/**
* Shuts down the server, cancelling all subscriptions and closing the store.
*/
@Deprecated("Use close() instead", replaceWith = ReplaceWith("close()"))
fun shutdown() = close()
}
quartz/src/commonMain/kotlin/com/vitorpamplona/quartz/nip01Core/store/IEventStore.kt
+2 -2
View File
@@ -23,7 +23,7 @@ package com.vitorpamplona.quartz.nip01Core.store
import com.vitorpamplona.quartz.nip01Core.core.Event
import com.vitorpamplona.quartz.nip01Core.relay.filters.Filter
interface IEventStore {
interface IEventStore : AutoCloseable {
fun insert(event: Event)
interface ITransaction {
@@ -56,5 +56,5 @@ interface IEventStore {
fun deleteExpiredEvents()
fun close()
override fun close()
}
quartz/src/commonTest/kotlin/com/vitorpamplona/quartz/nip01Core/relay/server/NostrServerAuthTest.kt
+14 -14
View File
@@ -142,7 +142,7 @@ class NostrServerAuthTest {
assertEquals(1, collector.messages.size)
assertTrue(collector.messages[0].contains("\"AUTH\""))
server.shutdown()
server.close()
}
@Test
@@ -167,7 +167,7 @@ class NostrServerAuthTest {
assertTrue((session.policy as FullAuthPolicy).isAuthenticated())
assertTrue(session.policy.authenticatedUsers.contains(pubkey))
server.shutdown()
server.close()
}
@Test
@@ -188,7 +188,7 @@ class NostrServerAuthTest {
assertTrue(okMessages[0].contains("challenge"))
assertFalse((session.policy as FullAuthPolicy).isAuthenticated())
server.shutdown()
server.close()
}
@Test
@@ -213,7 +213,7 @@ class NostrServerAuthTest {
assertTrue(okMessages[0].contains("relay url"))
assertFalse((session.policy as FullAuthPolicy).isAuthenticated())
server.shutdown()
server.close()
}
@Test
@@ -242,7 +242,7 @@ class NostrServerAuthTest {
assertTrue(okMessages[0].contains("created_at"))
assertFalse((session.policy as FullAuthPolicy).isAuthenticated())
server.shutdown()
server.close()
}
@Test
@@ -281,7 +281,7 @@ class NostrServerAuthTest {
assertTrue(okMessages[0].contains("could not parse message"))
assertFalse((session.policy as FullAuthPolicy).isAuthenticated())
server.shutdown()
server.close()
}
@Test
@@ -315,7 +315,7 @@ class NostrServerAuthTest {
assertTrue(authedPubkeys.contains(pubkey))
assertTrue(authedPubkeys.contains(pubkey2))
server.shutdown()
server.close()
}
// -- NIP-42: requireAuth ---------------------------------------------------
@@ -337,7 +337,7 @@ class NostrServerAuthTest {
assertTrue(okMessages[0].contains("\"false\""))
assertTrue(okMessages[0].contains("auth-required:"))
server.shutdown()
server.close()
}
@Test
@@ -354,7 +354,7 @@ class NostrServerAuthTest {
assertEquals(1, closedMessages.size)
assertTrue(closedMessages[0].contains("auth-required:"))
server.shutdown()
server.close()
}
@Test
@@ -371,7 +371,7 @@ class NostrServerAuthTest {
assertEquals(1, closedMessages.size)
assertTrue(closedMessages[0].contains("auth-required:"))
server.shutdown()
server.close()
}
@Test
@@ -410,7 +410,7 @@ class NostrServerAuthTest {
val eoseMessages = collector.rawMessagesContaining("EOSE")
assertTrue(eoseMessages.isNotEmpty())
server.shutdown()
server.close()
}
@Test
@@ -430,7 +430,7 @@ class NostrServerAuthTest {
assertEquals(1, okMessages.size)
assertTrue(okMessages[0].contains("\"true\""))
server.shutdown()
server.close()
}
// -- Custom AuthPolicy tests -----------------------------------------------
@@ -471,7 +471,7 @@ class NostrServerAuthTest {
assertTrue(okMessages[1].contains("\"false\""))
assertTrue(okMessages[1].contains("auth-required:"))
server.shutdown()
server.close()
}
@Test
@@ -531,6 +531,6 @@ class NostrServerAuthTest {
assertEquals(1, events.size)
assertEquals(pubkey, events[0].event.pubKey)
server.shutdown()
server.close()
}
}
quartz/src/commonTest/kotlin/com/vitorpamplona/quartz/nip01Core/relay/server/NostrServerTest.kt
+11 -11
View File
@@ -115,7 +115,7 @@ class NostrServerTest {
val stored = store.query<Event>(Filter(ids = listOf(event.id)))
assertEquals(1, stored.size)
server.shutdown()
server.close()
}
@Test
@@ -138,7 +138,7 @@ class NostrServerTest {
assertTrue(okMessages[0].contains("\"true\""))
assertTrue(okMessages[1].contains("\"false\""))
server.shutdown()
server.close()
}
// -- REQ command -----------------------------------------------------------
@@ -172,7 +172,7 @@ class NostrServerTest {
// Events should be newest first
assertTrue(events[0].event.createdAt >= events[1].event.createdAt)
server.shutdown()
server.close()
}
@Test
@@ -195,7 +195,7 @@ class NostrServerTest {
val events = collector.parsedEventMessages().filterIsInstance<EventMessage>()
assertEquals(3, events.size)
server.shutdown()
server.close()
}
// -- Live subscription -----------------------------------------------------
@@ -226,7 +226,7 @@ class NostrServerTest {
assertTrue(newMessages.isNotEmpty())
assertTrue(newMessages[0].contains("\"EVENT\""))
server.shutdown()
server.close()
}
@Test
@@ -251,7 +251,7 @@ class NostrServerTest {
assertEquals(countAfterEose, collector1.messages.size)
server.shutdown()
server.close()
}
// -- CLOSE command ---------------------------------------------------------
@@ -282,7 +282,7 @@ class NostrServerTest {
assertEquals(countAfterClose, collector1.messages.size)
server.shutdown()
server.close()
}
@Test
@@ -318,7 +318,7 @@ class NostrServerTest {
assertTrue(newMessages[0].contains("\"EVENT\""))
assertTrue(newMessages[0].contains(hexId(2)))
server.shutdown()
server.close()
}
// -- COUNT command (NIP-45) ------------------------------------------------
@@ -344,7 +344,7 @@ class NostrServerTest {
assertEquals(1, countMessages.size)
assertTrue(countMessages[0].contains("\"count\":2"))
server.shutdown()
server.close()
}
// -- Disconnect ------------------------------------------------------------
@@ -374,7 +374,7 @@ class NostrServerTest {
assertEquals(countAfterDisconnect, collector1.messages.size)
assertEquals(2, collector2.messages.size)
server.shutdown()
server.close()
}
// -- Invalid messages ------------------------------------------------------
@@ -392,6 +392,6 @@ class NostrServerTest {
assertEquals(1, collector.messages.size)
assertTrue(collector.messages[0].contains("NOTICE"))
server.shutdown()
server.close()
}
}