Update publish

This commit is contained in:
Jon Staab
2025-04-11 08:03:44 -07:00
parent 989fc74374
commit 837fd1ab66
12 changed files with 219 additions and 274 deletions
+4 -9
View File
@@ -1,5 +1,5 @@
import {nthEq, partition, race, now} from "@welshman/lib" import {nthEq, partition, race, now} from "@welshman/lib"
import {createEvent, getPubkeyTagValues} from "@welshman/util" import {createEvent, getPubkeyTagValues, TrustedEvent} from "@welshman/util"
import {request, Tracker} from "@welshman/net" import {request, Tracker} from "@welshman/net"
import {Scope, FeedController, RequestOpts, FeedOptions, DVMOpts, Feed} from "@welshman/feeds" import {Scope, FeedController, RequestOpts, FeedOptions, DVMOpts, Feed} from "@welshman/feeds"
import {makeDvmRequest, DVMEvent} from "@welshman/dvm" import {makeDvmRequest, DVMEvent} from "@welshman/dvm"
@@ -20,14 +20,9 @@ export const makeFeedRequestHandler = ({signal}: FeedRequestHandlerOptions) =>
const requestOptions = {} const requestOptions = {}
if (relays.length > 0) { if (relays.length > 0) {
await new Promise(resolve => { await request({tracker, signal, relays, filters, onEvent, autoClose: true})
const req = request({tracker, signal, autoClose: true, relays, filters})
req.on(RequestEvent.Event, onEvent)
req.on(RequestEvent.Close, resolve)
})
} else { } else {
const promises: Promise<TrustedEvent>[][] = [] const promises: Promise<TrustedEvent[]>[] = []
const [withSearch, withoutSearch] = partition(f => Boolean(f.search), filters) const [withSearch, withoutSearch] = partition(f => Boolean(f.search), filters)
if (withSearch.length > 0) { if (withSearch.length > 0) {
@@ -35,7 +30,7 @@ export const makeFeedRequestHandler = ({signal}: FeedRequestHandlerOptions) =>
request({ request({
signal, signal,
tracker, tracker,
onEvent onEvent,
threshold: 0.1, threshold: 0.1,
autoClose: true, autoClose: true,
filters: withSearch, filters: withSearch,
+2 -8
View File
@@ -10,7 +10,7 @@ import {
getRelayTagValues, getRelayTagValues,
} from "@welshman/util" } from "@welshman/util"
import {TrustedEvent, Filter, PublishedList, List} from "@welshman/util" import {TrustedEvent, Filter, PublishedList, List} from "@welshman/util"
import {request, load, RequestEvent} from "@welshman/net" import {request, load} from "@welshman/net"
import {deriveEventsMapped} from "@welshman/store" import {deriveEventsMapped} from "@welshman/store"
import {repository} from "./core.js" import {repository} from "./core.js"
import {Router} from "./router.js" import {Router} from "./router.js"
@@ -52,13 +52,7 @@ export const makeOutboxLoader = (kinds: number[]) => {
const filters = [{authors, kinds}] const filters = [{authors, kinds}]
const relays = router.merge(scenarios).getUrls() const relays = router.merge(scenarios).getUrls()
const promise = request({filters, relays, autoClose: true})
const promise = new Promise<void>(resolve => {
const req = request({filters, relays, autoClose: true})
req.on(RequestEvent.Eose, () => resolve())
req.on(RequestEvent.Close, () => resolve())
})
return requests.map(always(promise)) return requests.map(always(promise))
}) })
+2 -10
View File
@@ -3,8 +3,7 @@ import {isSignedEvent, SignedEvent} from "@welshman/util"
import { import {
push as basePush, push as basePush,
pull as basePull, pull as basePull,
PublishEvent, publishOne,
SinglePublish,
requestOne, requestOne,
} from "@welshman/net" } from "@welshman/net"
import {repository} from "./core.js" import {repository} from "./core.js"
@@ -46,14 +45,7 @@ export const push = async ({relays, filters}: AppSyncOpts) => {
relays.map(async relay => { relays.map(async relay => {
await (hasNegentropy(relay) await (hasNegentropy(relay)
? basePush({filters, events, relays: [relay]}) ? basePush({filters, events, relays: [relay]})
: Promise.all( : Promise.all(events.map((event: SignedEvent) => publishOne({event, relay}))))
events.map(
(event: SignedEvent) =>
new Promise<void>(resolve => {
new SinglePublish({event, relay}).on(PublishEvent.Complete, resolve)
}),
),
))
}), }),
) )
} }
+30 -35
View File
@@ -26,7 +26,7 @@ import {
isUnwrappedEvent, isUnwrappedEvent,
isSignedEvent, isSignedEvent,
} from "@welshman/util" } from "@welshman/util"
import {MultiPublish, AdapterContext, PublishStatus, PublishEvent} from "@welshman/net" import {publish, AdapterContext, PublishStatus} from "@welshman/net"
import {repository, tracker} from "./core.js" import {repository, tracker} from "./core.js"
import {pubkey, getSession, getSigner} from "./session.js" import {pubkey, getSession, getSigner} from "./session.js"
@@ -47,14 +47,14 @@ export type ThunkStatus = {
status: PublishStatus status: PublishStatus
} }
export type ThunkStatusByUrl = Record<string, ThunkStatus> export type ThunkStatusByRelay = Record<string, ThunkStatus>
export type Thunk = { export type Thunk = {
event: TrustedEvent event: TrustedEvent
request: ThunkRequest request: ThunkRequest
controller: AbortController controller: AbortController
result: Deferred<ThunkStatusByUrl> result: Deferred<ThunkStatusByRelay>
status: Writable<ThunkStatusByUrl> status: Writable<ThunkStatusByRelay>
} }
export const prepEvent = (event: ThunkEvent) => { export const prepEvent = (event: ThunkEvent) => {
@@ -85,8 +85,8 @@ export const makeThunk = (request: ThunkRequest) => {
export type MergedThunk = { export type MergedThunk = {
thunks: Thunk[] thunks: Thunk[]
controller: AbortController controller: AbortController
result: Promise<ThunkStatusByUrl[]> result: Promise<ThunkStatusByRelay[]>
status: Readable<ThunkStatusByUrl> status: Readable<ThunkStatusByRelay>
} }
export const isMergedThunk = (thunk: Thunk | MergedThunk): thunk is MergedThunk => export const isMergedThunk = (thunk: Thunk | MergedThunk): thunk is MergedThunk =>
@@ -108,7 +108,7 @@ export const mergeThunks = (thunks: Thunk[]) => {
status: derived( status: derived(
thunks.map(thunk => thunk.status), thunks.map(thunk => thunk.status),
statuses => { statuses => {
const mergedStatus: ThunkStatusByUrl = {} const mergedStatus: ThunkStatusByRelay = {}
for (const url of uniq(statuses.flatMap(s => Object.keys(s)))) { for (const url of uniq(statuses.flatMap(s => Object.keys(s)))) {
const urlStatuses = statuses.map(s => s[url]) const urlStatuses = statuses.map(s => s[url])
@@ -196,7 +196,7 @@ export const thunkQueue = new TaskQueue<Thunk>({
// Avoid making this function async so multiple publishes can run concurrently // Avoid making this function async so multiple publishes can run concurrently
Promise.resolve().then(async () => { Promise.resolve().then(async () => {
const fail = (message: string) => { const fail = (message: string) => {
const status: ThunkStatusByUrl = {} const status: ThunkStatusByRelay = {}
for (const url of thunk.request.relays) { for (const url of thunk.request.relays) {
status[url] = {status: PublishStatus.Failure, message} status[url] = {status: PublishStatus.Failure, message}
@@ -239,17 +239,37 @@ export const thunkQueue = new TaskQueue<Thunk>({
fromPairs( fromPairs(
thunk.request.relays.map(url => [ thunk.request.relays.map(url => [
url, url,
{status: PublishStatus.Pending, message: "Sending your message..."}, {status: Pending, message: "Sending your message..."},
]), ]),
), ),
) )
// Send it off // Send it off
const pub = new MultiPublish({ publish({
event: signedEvent, event: signedEvent,
relays: thunk.request.relays, relays: thunk.request.relays,
context: thunk.request.context, context: thunk.request.context,
timeout: thunk.request.timeout, timeout: thunk.request.timeout,
onSuccess: (message: string, url: string) => {
tracker.track(signedEvent.id, url)
thunk.status.update(assoc(url, {status: PublishStatus.Success, message}))
},
onFailure: (message: string, url: string) => {
thunk.status.update(assoc(url, {status: PublishStatus.Failure, message}))
},
onTimeout: (url: string) => {
const message = "Publish timed out"
thunk.status.update(assoc(url, {status: PublishStatus.Timeout, message}))
},
onAborted: (url: string) => {
const message = "Publish was aborted"
thunk.status.update(assoc(url, {status: PublishStatus.Aborted, message}))
},
onComplete: () => {
thunk.result.resolve(get(thunk.status))
},
}) })
// Copy the signature over since we had deferred it // Copy the signature over since we had deferred it
@@ -259,31 +279,6 @@ export const thunkQueue = new TaskQueue<Thunk>({
if (savedEvent) { if (savedEvent) {
savedEvent.sig = signedEvent.sig savedEvent.sig = signedEvent.sig
} }
pub.on(PublishEvent.Success, (id: string, message: string, url: string) => {
tracker.track(id, url)
thunk.status.update(assoc(url, {status: PublishStatus.Success, message}))
})
pub.on(PublishEvent.Failure, (id: string, message: string, url: string) => {
thunk.status.update(assoc(url, {status: PublishStatus.Failure, message}))
})
pub.on(PublishEvent.Timeout, (url: string) => {
thunk.status.update(
assoc(url, {status: PublishStatus.Timeout, message: "Publish timed out"}),
)
})
pub.on(PublishEvent.Aborted, (url: string) => {
thunk.status.update(
assoc(url, {status: PublishStatus.Aborted, message: "Publish was aborted"}),
)
})
pub.on(PublishEvent.Complete, () => {
thunk.result.resolve(get(thunk.status))
})
}) })
}, },
}) })
+2 -4
View File
@@ -1,7 +1,7 @@
import {now} from "@welshman/lib" import {now} from "@welshman/lib"
import {Nip01Signer} from "@welshman/signer" import {Nip01Signer} from "@welshman/signer"
import {TrustedEvent, StampedEvent, Filter} from "@welshman/util" import {TrustedEvent, StampedEvent, Filter} from "@welshman/util"
import {request, MultiPublish, PublishEvent, AdapterContext} from "@welshman/net" import {request, publish, AdapterContext} from "@welshman/net"
export type DVMHandler = { export type DVMHandler = {
stop?: () => void stop?: () => void
@@ -118,8 +118,6 @@ export class DVM {
const {relays, context} = this.opts const {relays, context} = this.opts
const event = await this.signer.sign(template) const event = await this.signer.sign(template)
await new Promise<void>(resolve => { await publish({event, relays, context})
new MultiPublish({event, relays, context}).on(PublishEvent.Complete, resolve)
})
} }
} }
+3 -4
View File
@@ -1,6 +1,6 @@
import {Emitter, now} from "@welshman/lib" import {Emitter, now} from "@welshman/lib"
import {TrustedEvent, SignedEvent, Filter} from "@welshman/util" import {TrustedEvent, SignedEvent, Filter} from "@welshman/util"
import {request, MultiPublish, AdapterContext} from "@welshman/net" import {request, publish, AdapterContext} from "@welshman/net"
export enum DVMEvent { export enum DVMEvent {
Progress = "progress", Progress = "progress",
@@ -19,7 +19,6 @@ export type DVMRequestOptions = {
export type DVMRequest = { export type DVMRequest = {
options: DVMRequestOptions options: DVMRequestOptions
emitter: Emitter emitter: Emitter
pub: MultiPublish
} }
export const makeDvmRequest = (options: DVMRequestOptions) => { export const makeDvmRequest = (options: DVMRequestOptions) => {
@@ -56,8 +55,8 @@ export const makeDvmRequest = (options: DVMRequestOptions) => {
}, },
}) })
const pub = new MultiPublish({relays, event, timeout, context}) publish({relays, event, timeout, context})
return {options, emitter, pub} as DVMRequest return {options, emitter} as DVMRequest
} }
+54 -62
View File
@@ -1,11 +1,11 @@
import {describe, expect, it, vi, beforeEach, afterEach} from "vitest" import {describe, expect, it, vi, beforeEach, afterEach} from "vitest"
import {SinglePublish, MultiPublish, PublishEvent} from "../src/publish" import {publishOne, publish} from "../src/publish"
import {MockAdapter} from "../src/adapter" import {MockAdapter} from "../src/adapter"
import {ClientMessageType} from "../src/message" import {ClientMessageType} from "../src/message"
import {makeEvent} from "@welshman/util" import {makeEvent} from "@welshman/util"
import {Nip01Signer} from "@welshman/signer" import {Nip01Signer} from "@welshman/signer"
describe("SinglePublish", () => { describe("publishOne", () => {
beforeEach(() => { beforeEach(() => {
vi.useFakeTimers() vi.useFakeTimers()
}) })
@@ -19,20 +19,18 @@ describe("SinglePublish", () => {
const adapter = new MockAdapter("1", sendSpy) const adapter = new MockAdapter("1", sendSpy)
const signer = Nip01Signer.ephemeral() const signer = Nip01Signer.ephemeral()
const event = await signer.sign(makeEvent(1)) const event = await signer.sign(makeEvent(1))
const pub = new SinglePublish({
relay: "1",
context: {getAdapter: () => adapter},
event,
})
const successSpy = vi.fn() const successSpy = vi.fn()
const failureSpy = vi.fn() const failureSpy = vi.fn()
const completeSpy = vi.fn() const completeSpy = vi.fn()
pub.on(PublishEvent.Success, successSpy) publishOne({
pub.on(PublishEvent.Failure, failureSpy) event,
pub.on(PublishEvent.Complete, completeSpy) relay: "1",
context: {getAdapter: () => adapter},
onSuccess: successSpy,
onFailure: failureSpy,
onComplete: completeSpy,
})
await vi.advanceTimersByTimeAsync(200) await vi.advanceTimersByTimeAsync(200)
@@ -42,7 +40,7 @@ describe("SinglePublish", () => {
await vi.runAllTimers() await vi.runAllTimers()
expect(successSpy).toHaveBeenCalledWith(event.id, "hi") expect(successSpy).toHaveBeenCalledWith("hi", "1")
expect(failureSpy).not.toHaveBeenCalled() expect(failureSpy).not.toHaveBeenCalled()
expect(completeSpy).toHaveBeenCalled() expect(completeSpy).toHaveBeenCalled()
}) })
@@ -52,20 +50,18 @@ describe("SinglePublish", () => {
const adapter = new MockAdapter("1", sendSpy) const adapter = new MockAdapter("1", sendSpy)
const signer = Nip01Signer.ephemeral() const signer = Nip01Signer.ephemeral()
const event = await signer.sign(makeEvent(1)) const event = await signer.sign(makeEvent(1))
const pub = new SinglePublish({
relay: "1",
context: {getAdapter: () => adapter},
event,
})
const successSpy = vi.fn() const successSpy = vi.fn()
const failureSpy = vi.fn() const failureSpy = vi.fn()
const completeSpy = vi.fn() const completeSpy = vi.fn()
pub.on(PublishEvent.Success, successSpy) publishOne({
pub.on(PublishEvent.Failure, failureSpy) event,
pub.on(PublishEvent.Complete, completeSpy) relay: "1",
context: {getAdapter: () => adapter},
onSuccess: successSpy,
onFailure: failureSpy,
onComplete: completeSpy,
})
await vi.advanceTimersByTimeAsync(200) await vi.advanceTimersByTimeAsync(200)
@@ -76,7 +72,7 @@ describe("SinglePublish", () => {
await vi.runAllTimers() await vi.runAllTimers()
expect(successSpy).not.toHaveBeenCalled() expect(successSpy).not.toHaveBeenCalled()
expect(failureSpy).toHaveBeenCalledWith(event.id, "hi") expect(failureSpy).toHaveBeenCalledWith("hi", "1")
expect(completeSpy).toHaveBeenCalled() expect(completeSpy).toHaveBeenCalled()
}) })
@@ -85,22 +81,20 @@ describe("SinglePublish", () => {
const adapter = new MockAdapter("1", sendSpy) const adapter = new MockAdapter("1", sendSpy)
const signer = Nip01Signer.ephemeral() const signer = Nip01Signer.ephemeral()
const event = await signer.sign(makeEvent(1)) const event = await signer.sign(makeEvent(1))
const pub = new SinglePublish({
relay: "1",
context: {getAdapter: () => adapter},
event,
})
const successSpy = vi.fn() const successSpy = vi.fn()
const failureSpy = vi.fn() const failureSpy = vi.fn()
const completeSpy = vi.fn() const completeSpy = vi.fn()
const timeoutSpy = vi.fn() const timeoutSpy = vi.fn()
pub.on(PublishEvent.Success, successSpy) publishOne({
pub.on(PublishEvent.Failure, failureSpy) event,
pub.on(PublishEvent.Complete, completeSpy) relay: "1",
pub.on(PublishEvent.Timeout, timeoutSpy) context: {getAdapter: () => adapter},
onSuccess: successSpy,
onFailure: failureSpy,
onComplete: completeSpy,
onTimeout: timeoutSpy,
})
await vi.runAllTimers() await vi.runAllTimers()
@@ -119,28 +113,28 @@ describe("SinglePublish", () => {
const adapter = new MockAdapter("1", sendSpy) const adapter = new MockAdapter("1", sendSpy)
const signer = Nip01Signer.ephemeral() const signer = Nip01Signer.ephemeral()
const event = await signer.sign(makeEvent(1)) const event = await signer.sign(makeEvent(1))
const ctrl = new AbortController()
const pub = new SinglePublish({
relay: "1",
context: {getAdapter: () => adapter},
event,
})
const successSpy = vi.fn() const successSpy = vi.fn()
const failureSpy = vi.fn() const failureSpy = vi.fn()
const completeSpy = vi.fn() const completeSpy = vi.fn()
const abortSpy = vi.fn() const abortSpy = vi.fn()
pub.on(PublishEvent.Success, successSpy) publishOne({
pub.on(PublishEvent.Failure, failureSpy) event,
pub.on(PublishEvent.Complete, completeSpy) relay: "1",
pub.on(PublishEvent.Timeout, abortSpy) signal: ctrl.signal,
context: {getAdapter: () => adapter},
onSuccess: successSpy,
onFailure: failureSpy,
onComplete: completeSpy,
onTimeout: abortSpy,
})
await vi.runAllTimers() await vi.runAllTimers()
expect(sendSpy).toHaveBeenCalledWith([ClientMessageType.Event, event]) expect(sendSpy).toHaveBeenCalledWith([ClientMessageType.Event, event])
pub.abort() ctrl.abort()
await vi.runAllTimers() await vi.runAllTimers()
@@ -151,7 +145,7 @@ describe("SinglePublish", () => {
}) })
}) })
describe("MultiPublish", () => { describe("publish", () => {
beforeEach(() => { beforeEach(() => {
vi.useFakeTimers() vi.useFakeTimers()
}) })
@@ -169,8 +163,12 @@ describe("MultiPublish", () => {
const adapter3 = new MockAdapter("3", send3Spy) const adapter3 = new MockAdapter("3", send3Spy)
const signer = Nip01Signer.ephemeral() const signer = Nip01Signer.ephemeral()
const event = await signer.sign(makeEvent(1)) const event = await signer.sign(makeEvent(1))
const successSpy = vi.fn()
const failureSpy = vi.fn()
const completeSpy = vi.fn()
const timeoutSpy = vi.fn()
const pub = new MultiPublish({ publish({
event, event,
relays: ["1", "2", "3"], relays: ["1", "2", "3"],
context: { context: {
@@ -187,25 +185,19 @@ describe("MultiPublish", () => {
} }
}, },
}, },
onSuccess: successSpy,
onFailure: failureSpy,
onComplete: completeSpy,
onTimeout: timeoutSpy,
}) })
const successSpy = vi.fn()
const failureSpy = vi.fn()
const completeSpy = vi.fn()
const timeoutSpy = vi.fn()
pub.on(PublishEvent.Success, successSpy)
pub.on(PublishEvent.Failure, failureSpy)
pub.on(PublishEvent.Complete, completeSpy)
pub.on(PublishEvent.Timeout, timeoutSpy)
adapter1.receive(["OK", event.id, true, "hi"]) adapter1.receive(["OK", event.id, true, "hi"])
adapter2.receive(["OK", event.id, false, "hi"]) adapter2.receive(["OK", event.id, false, "hi"])
await vi.runAllTimers() await vi.runAllTimersAsync()
expect(successSpy).toHaveBeenCalledWith(event.id, "hi", "1") expect(successSpy).toHaveBeenCalledWith("hi", "1")
expect(failureSpy).toHaveBeenCalledWith(event.id, "hi", "2") expect(failureSpy).toHaveBeenCalledWith("hi", "2")
expect(completeSpy).toHaveBeenCalledTimes(1) expect(completeSpy).toHaveBeenCalledTimes(1)
expect(timeoutSpy).toHaveBeenCalledWith("3") expect(timeoutSpy).toHaveBeenCalledWith("3")
}) })
+37 -19
View File
@@ -15,8 +15,14 @@ describe("requestOne", () => {
}) })
it("everything basically works", async () => { it("everything basically works", async () => {
const sendSpy = vi.fn() let id
const sendSpy = vi.fn(m => {
if (m[0] === 'REQ') {
id = m[1]
}
})
const adapter = new MockAdapter("1", sendSpy) const adapter = new MockAdapter("1", sendSpy)
const ctrl = new AbortController()
const duplicateSpy = vi.fn() const duplicateSpy = vi.fn()
const invalidSpy = vi.fn() const invalidSpy = vi.fn()
const filteredSpy = vi.fn() const filteredSpy = vi.fn()
@@ -28,6 +34,7 @@ describe("requestOne", () => {
relay: "whatever", relay: "whatever",
filters: [{kinds: [1]}], filters: [{kinds: [1]}],
context: {getAdapter: () => adapter}, context: {getAdapter: () => adapter},
signal: ctrl.signal,
onDuplicate: duplicateSpy, onDuplicate: duplicateSpy,
onInvalid: invalidSpy, onInvalid: invalidSpy,
onFiltered: filteredSpy, onFiltered: filteredSpy,
@@ -38,7 +45,7 @@ describe("requestOne", () => {
await vi.runAllTimersAsync() await vi.runAllTimersAsync()
expect(sendSpy).toHaveBeenCalledWith([ClientMessageType.Req, expect.any(String), {kinds: [1]}]) expect(sendSpy).toHaveBeenCalledWith([ClientMessageType.Req, id, {kinds: [1]}])
const signer = Nip01Signer.ephemeral() const signer = Nip01Signer.ephemeral()
const event1 = await signer.sign(makeEvent(1)) const event1 = await signer.sign(makeEvent(1))
@@ -52,17 +59,17 @@ describe("requestOne", () => {
await vi.runAllTimersAsync() await vi.runAllTimersAsync()
expect(duplicateSpy).toHaveBeenCalledWith(event1) expect(duplicateSpy).toHaveBeenCalledWith(event1, "1")
expect(filteredSpy).toHaveBeenCalledWith(event2) expect(filteredSpy).toHaveBeenCalledWith(event2, "1")
expect(invalidSpy).toHaveBeenCalledWith(event3) expect(invalidSpy).toHaveBeenCalledWith(event3, "1")
expect(eventSpy).toHaveBeenCalledWith(event1) expect(eventSpy).toHaveBeenCalledWith(event1, "1")
expect(eoseSpy).toHaveBeenCalledTimes(0) expect(eoseSpy).toHaveBeenCalledTimes(0)
adapter.receive(["EOSE", id]) adapter.receive(["EOSE", id])
expect(eoseSpy).toHaveBeenCalledTimes(1) expect(eoseSpy).toHaveBeenCalledTimes(1)
req.close() ctrl.abort()
expect(closeSpy).toHaveBeenCalledTimes(1) expect(closeSpy).toHaveBeenCalledTimes(1)
}) })
@@ -78,10 +85,20 @@ describe("request", () => {
}) })
it("everything basically works", async () => { it("everything basically works", async () => {
const send1Spy = vi.fn() let id1, id2
const send1Spy = vi.fn(m => {
if (m[0] === 'REQ') {
id1 = m[1]
}
})
const adapter1 = new MockAdapter("1", send1Spy) const adapter1 = new MockAdapter("1", send1Spy)
const send2Spy = vi.fn() const send2Spy = vi.fn(m => {
if (m[0] === 'REQ') {
id2 = m[1]
}
})
const adapter2 = new MockAdapter("2", send2Spy) const adapter2 = new MockAdapter("2", send2Spy)
const ctrl = new AbortController()
const duplicateSpy = vi.fn() const duplicateSpy = vi.fn()
const invalidSpy = vi.fn() const invalidSpy = vi.fn()
const filteredSpy = vi.fn() const filteredSpy = vi.fn()
@@ -92,6 +109,7 @@ describe("request", () => {
request({ request({
relays: ["1", "2"], relays: ["1", "2"],
filters: [{kinds: [1]}], filters: [{kinds: [1]}],
signal: ctrl.signal,
context: { context: {
getAdapter: (url: string) => (url === "1" ? adapter1 : adapter2), getAdapter: (url: string) => (url === "1" ? adapter1 : adapter2),
}, },
@@ -105,8 +123,8 @@ describe("request", () => {
await vi.runAllTimersAsync() await vi.runAllTimersAsync()
expect(send1Spy).toHaveBeenCalledTimes(1) expect(send1Spy).toHaveBeenCalledWith([ClientMessageType.Req, id1, {kinds: [1]}])
expect(send2Spy).toHaveBeenCalledTimes(1) expect(send2Spy).toHaveBeenCalledWith([ClientMessageType.Req, id2, {kinds: [1]}])
const signer = Nip01Signer.ephemeral() const signer = Nip01Signer.ephemeral()
const event1 = await signer.sign(makeEvent(1)) const event1 = await signer.sign(makeEvent(1))
@@ -114,11 +132,11 @@ describe("request", () => {
const event3 = makeEvent(1) const event3 = makeEvent(1)
const event4 = await signer.sign(makeEvent(1)) const event4 = await signer.sign(makeEvent(1))
adapter1.receive(["EVENT", expect.any(String), event1]) adapter1.receive(["EVENT", id1, event1])
adapter1.receive(["EVENT", expect.any(String), event2]) adapter1.receive(["EVENT", id1, event2])
adapter1.receive(["EVENT", expect.any(String), event3]) adapter1.receive(["EVENT", id1, event3])
adapter2.receive(["EVENT", expect.any(String), event1]) adapter2.receive(["EVENT", id2, event1])
adapter2.receive(["EVENT", expect.any(String), event4]) adapter2.receive(["EVENT", id2, event4])
await vi.runAllTimersAsync() await vi.runAllTimersAsync()
@@ -128,12 +146,12 @@ describe("request", () => {
expect(eventSpy).toHaveBeenCalledWith(event1, "1") expect(eventSpy).toHaveBeenCalledWith(event1, "1")
expect(eoseSpy).toHaveBeenCalledTimes(0) expect(eoseSpy).toHaveBeenCalledTimes(0)
adapter1.receive(["EOSE", expect.any(String)]) adapter1.receive(["EOSE", id1])
adapter2.receive(["EOSE", expect.any(String)]) adapter2.receive(["EOSE", id2])
expect(eoseSpy).toHaveBeenCalledTimes(2) expect(eoseSpy).toHaveBeenCalledTimes(2)
req.close() ctrl.abort()
expect(closeSpy).toHaveBeenCalledTimes(1) expect(closeSpy).toHaveBeenCalledTimes(1)
}) })
+2 -4
View File
@@ -11,7 +11,7 @@ import {
import {getAdapter, AdapterContext, AbstractAdapter, AdapterEvent} from "./adapter.js" import {getAdapter, AdapterContext, AbstractAdapter, AdapterEvent} from "./adapter.js"
import {Negentropy, NegentropyStorageVector} from "./negentropy.js" import {Negentropy, NegentropyStorageVector} from "./negentropy.js"
import {requestOne} from "./request.js" import {requestOne} from "./request.js"
import {MultiPublish, PublishEvent} from "./publish.js" import {publish} from "./publish.js"
export enum DifferenceEvent { export enum DifferenceEvent {
Message = "difference:event:message", Message = "difference:event:message",
@@ -237,9 +237,7 @@ export const push = async ({context, events, ...options}: PushOptions) => {
const relays = relaysById.get(event.id) const relays = relaysById.get(event.id)
if (relays) { if (relays) {
new Promise<void>(resolve => { await publish({event, relays, context})
new MultiPublish({event, relays, context}).on(PublishEvent.Complete, resolve)
})
} }
}), }),
) )
+75 -112
View File
@@ -12,159 +12,122 @@ export enum PublishStatus {
Aborted = "publish:status:aborted", Aborted = "publish:status:aborted",
} }
export enum PublishEvent { export type PublishResult = {
Success = "publish:event:success", status: PublishStatus
Failure = "publish:event:failure", detail: string
Timeout = "publish:event:timeout",
Aborted = "publish:event:aborted",
Complete = "publish:event:complete",
} }
// SinglePublish export type PublishOneOptions = {
export type SinglePublishOptions = {
event: SignedEvent event: SignedEvent
relay: string relay: string
context?: AdapterContext signal?: AbortSignal
timeout?: number timeout?: number
context?: AdapterContext
onStatus?: (status: PublishStatus, relay: string) => void
onSuccess?: (detail: string, relay: string) => void
onFailure?: (detail: string, relay: string) => void
onTimeout?: (relay: string) => void
onAborted?: (relay: string) => void
onComplete?: () => void
} }
export class SinglePublish extends EventEmitter { export const publishOne = (options: PublishOneOptions) =>
status = PublishStatus.Pending new Promise(resolve => {
const adapter = getAdapter(options.relay, options.context)
_unsubscriber: () => void let status = PublishStatus.Pending
_adapter: AbstractAdapter
constructor(readonly options: SinglePublishOptions) { const setStatus = (_status: PublishStatus) => {
super() status = _status
options.onStatus?.(status, options.relay)
}
// Set up our adapter const cleanup = () => {
this._adapter = getAdapter(this.options.relay, this.options.context) options.onComplete?.()
adapter.cleanup()
resolve(status)
}
// Listen for SinglePublish result adapter.on(
this._unsubscriber = on(
this._adapter,
AdapterEvent.Receive, AdapterEvent.Receive,
(message: RelayMessage, url: string) => { (message: RelayMessage, url: string) => {
if (isRelayOk(message)) { if (isRelayOk(message)) {
const [_, id, ok, detail] = message const [_, id, ok, detail] = message
if (id !== this.options.event.id) return if (id !== options.event.id) return
if (ok) { if (ok) {
this.status = PublishStatus.Success setStatus(PublishStatus.Success)
this.emit(PublishEvent.Success, id, detail) options.onSuccess?.(detail, options.relay)
} else { } else {
this.status = PublishStatus.Failure setStatus(PublishStatus.Failure)
this.emit(PublishEvent.Failure, id, detail) options.onFailure?.(detail, options.relay)
} }
this.cleanup() cleanup()
} }
}, },
) )
// Set timeout options.signal?.addEventListener('abort', () => {
sleep(this.options.timeout || 10_000).then(() => { if (status === PublishStatus.Pending) {
if (this.status === PublishStatus.Pending) { setStatus(PublishStatus.Aborted)
this.status = PublishStatus.Timeout options.onAborted?.(options.relay)
this.emit(PublishEvent.Timeout)
} }
this.cleanup() cleanup()
}) })
// Start asynchronously so the caller can set up listeners setTimeout(() => {
yieldThread().then(() => { if (status === PublishStatus.Pending) {
this._adapter.send([ClientMessageType.Event, this.options.event]) setStatus(PublishStatus.Timeout)
options.onTimeout?.(options.relay)
}
cleanup()
}, options.timeout || 10_000)
adapter.send([ClientMessageType.Event, options.event])
setStatus(PublishStatus.Pending)
}) })
}
abort = () => { export type PublishStatusByRelay = Record<string, PublishStatus>
if (this.status === PublishStatus.Pending) {
this.status = PublishStatus.Aborted
this.emit(PublishEvent.Aborted)
this.cleanup()
}
}
cleanup = () => { export type PublishOptions = Omit<PublishOneOptions, "relay"> & {
this.emit(PublishEvent.Complete)
this.removeAllListeners()
this._adapter.cleanup()
this._unsubscriber()
}
}
// MultiPublish
export type MultiPublishOptions = Omit<SinglePublishOptions, "relay"> & {
relays: string[] relays: string[]
onUpdate?: (status: PublishStatusByRelay) => void
} }
export class MultiPublish extends EventEmitter { export const publish = async (options: PublishOptions) => {
status: Record<string, PublishStatus> const status: PublishStatusByRelay = {}
const completed = new Set<string>()
_children: SinglePublish[] = []
_completed = new Set<string>()
constructor(options: MultiPublishOptions) {
super()
const relays = new Set(options.relays) const relays = new Set(options.relays)
if (relays.size !== options.relays.length) { if (relays.size !== options.relays.length) {
console.warn("Non-unique relays passed to MultiPublish") console.warn("Non-unique relays passed to publish")
} }
this.status = fromPairs(Array.from(relays).map(relay => [relay, PublishStatus.Pending])) await Promise.all(
options.relays.map(relay =>
publishOne({
relay,
...options,
onStatus: (_status: PublishStatus, relay: string) => {
status[relay] = _status
options.onStatus?.(_status, relay)
options.onUpdate?.(status)
},
onComplete: () => {
completed.add(relay)
for (const relay of relays) { if (completed.size === relays.size) {
const unicast = new SinglePublish({relay, ...options}) options.onComplete?.()
}
unicast.on(PublishEvent.Success, (id: string, detail: string) => { },
this.status[relay] = unicast.status
this.emit(PublishEvent.Success, id, detail, relay)
}) })
)
)
unicast.on(PublishEvent.Failure, (id: string, detail: string) => { return status
this.status[relay] = unicast.status
this.emit(PublishEvent.Failure, id, detail, relay)
})
unicast.on(PublishEvent.Timeout, () => {
this.status[relay] = unicast.status
this.emit(PublishEvent.Timeout, relay)
})
unicast.on(PublishEvent.Aborted, () => {
this.status[relay] = unicast.status
this.emit(PublishEvent.Aborted, relay)
})
unicast.on(PublishEvent.Complete, () => {
this._completed.add(relay)
this.status[relay] = unicast.status
if (this._completed.size === relays.size) {
this.emit(PublishEvent.Complete)
this.cleanup()
} }
})
this._children.push(unicast)
}
}
abort() {
for (const child of this._children) {
child.abort()
}
}
cleanup() {
this.removeAllListeners()
}
}
export const publish = (options: MultiPublishOptions) => new MultiPublish(options)
+4 -3
View File
@@ -15,7 +15,7 @@ import {
StampedEvent, StampedEvent,
NOSTR_CONNECT, NOSTR_CONNECT,
} from "@welshman/util" } from "@welshman/util"
import {MultiPublish, request, AdapterContext} from "@welshman/net" import {publish, request, AdapterContext} from "@welshman/net"
import {ISigner, EncryptionImplementation, decrypt, hash, own} from "../util.js" import {ISigner, EncryptionImplementation, decrypt, hash, own} from "../util.js"
import {Nip01Signer} from "./nip01.js" import {Nip01Signer} from "./nip01.js"
@@ -167,9 +167,10 @@ export class Nip46Sender extends Emitter {
const content = await this.signer[algorithm].encrypt(signerPubkey, payload) const content = await this.signer[algorithm].encrypt(signerPubkey, payload)
const template = createEvent(NOSTR_CONNECT, {content, tags: [["p", signerPubkey]]}) const template = createEvent(NOSTR_CONNECT, {content, tags: [["p", signerPubkey]]})
const event = await this.signer.sign(template) const event = await this.signer.sign(template)
const pub = new MultiPublish({relays, event, context})
this.emit(Nip46Event.Send, {...request, pub}) publish({relays, event, context})
this.emit(Nip46Event.Send, request)
} }
// process the queue of requests // process the queue of requests
+1 -1
View File
@@ -74,7 +74,7 @@ export const verifyEvent = (() => {
}) })
} }
return (event: TrustedEvent) => Boolean(event.sig && verify(event as SignedEvent)) return (event: TrustedEvent) => Boolean(event.sig && (event[verifiedSymbol] || verify(event as SignedEvent)))
})() })()
export const isEventTemplate = (e: EventTemplate): e is EventTemplate => export const isEventTemplate = (e: EventTemplate): e is EventTemplate =>