libp2r2p 0.11.13 → 0.11.14

package/README.md

@@ -877,9 +877,42 @@ the first pass routes through up to `maxPerPubkey` shared relays, and missing
 authors are retried on every remaining relay plus `fallbackRelays` (default:
 the first three `freeRelays`), excluding what was already queried. It accepts
 `relaysByPubkey` to reuse a previous discovery (only missing pubkeys are then
-discovered) and returns `{ events, byPubkey, relaysByPubkey }` so the merged
+discovered) and returns `{ events, byPubkey, relaysByPubkey, requests }` so the merged
 relay map can be passed back on later calls.
 
+
+Read diagnostics preserve native failures rather than treating an empty result
+as proof that every relay completed successfully. `requests` contains records
+`{ phase, authors, relays, errors?, error? }`: phase is `discovery`, `primary` or
+`fallback`; `relays` uses the pool's `{ relay, status, error? }` outcomes. An
+operation-wide exception is retained as `error`. Events remain in the existing
+result fields, never in diagnostic records. `onQueryResult(record)` receives each
+record as the underlying query settles, including before a later cancellation.
+
+Both discovery and latest-event queries accept `signal`. Cancelling one consumer
+of shared NIP-65 discovery releases only its interest; the underlying query is
+aborted when its last consumer leaves. Discovery's optional `onQueryResult`
+receives the same native report for every joining caller. Incomplete/failed
+lookups can use fallback relays for that call but never negatively cache a
+missing relay list for forty minutes. Actual lists and completely empty EOSE
+responses retain their normal cache behavior.
+
+`getLatestEventsByPubkey` accepts `excludeRelaysByPubkey` (object or Map) for both
+passes. `getRelaysByPubkey` accepts `excludeRelays` for seed discovery; pass it
+through `relayListOptions` when using the two-pass query. Different exclusion
+sets do not share in-flight discovery that could contact a refused relay.
+
+`isRetryableRelayFailure(error)` identifies connection/transport/timeouts and
+leading `rate-limited:`/`error:` relay failures. `isReplaceableRelayFailure(error)`
+also admits relay policy refusals (`blocked:`, `restricted:`, `auth-required:`,
+`pow:`) for routing to alternatives, preserving the messenger's existing policy.
+Local authentication denials, invalid events and unknown errors qualify for
+neither policy. Predicates classify individual native errors; callers decide
+how to handle mixed per-relay outcomes and application-specific aggregates.
+Existing rate-limit parsing preserves numeric positive `retry_after` seconds as
+`retryAfterMs` and absolute `retryAt`, bounded to five minutes. Schedulers must
+use the later of their backoff deadline and `retryAt`, not add the two delays.
+
 ## Binary encodings
 
 Base16, Base36, Base62, Base64/Base64URL, and Base93 helpers are available

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2r2p",
-  "version": "0.11.13",
+  "version": "0.11.14",
   "description": "Peer-to-relay-to-peer",
   "keywords": [
     "p2r2p",

package/private-messenger/helpers/send-routing.js

@@ -1,19 +1,11 @@
 import { normalizeRelayUrl } from '../../url/index.js'
 import { ValidationError } from '../../error/index.js'
+import { isReplaceableRelayFailure } from '../../relay/helpers/failure.js'
 
-const REJECTION_PREFIXES = new Set(['blocked', 'restricted', 'auth-required', 'pow', 'rate-limited', 'error'])
-const TRANSPORT_CATEGORIES = new Set(['connection', 'transport', 'timeout'])
 const EXCLUSION_MS = 5 * 60 * 1000
 const normalized = relay => { try { return normalizeRelayUrl(relay) } catch { return '' } }
 
-// Only machine-readable relay policy/server failures qualify. Invalid events,
-// local signer denials and unknown prose must not rotate relays.
-export function isReplaceableRelayFailure (error) {
-  if (error?.name === 'Nip42AuthenticationError') return false
-  if (TRANSPORT_CATEGORIES.has(error?.category)) return true
-  if (error?.category && error.category !== 'relay') return false
-  return REJECTION_PREFIXES.has(/^([a-z-]+):/.exec(error?.message || '')?.[1])
-}
+export { isReplaceableRelayFailure }
 
 export function normalizeFallbackRelays (value = []) {
   if (!Array.isArray(value)) throw new ValidationError('INVALID_FALLBACK_RELAYS')

package/relay/helpers/failure.js

@@ -0,0 +1,15 @@
+const TRANSPORT_CATEGORIES = new Set(['connection', 'transport', 'timeout'])
+const RETRY_PREFIXES = new Set(['rate-limited', 'error'])
+const REPLACEMENT_PREFIXES = new Set(['blocked', 'restricted', 'auth-required', 'pow', ...RETRY_PREFIXES])
+
+// Retry and replacement are different policies: a refusal can justify another
+// relay without making the same operation retryable on the refusing relay.
+function matches (error, prefixes) {
+  if (error?.name === 'Nip42AuthenticationError') return false
+  if (TRANSPORT_CATEGORIES.has(error?.category)) return true
+  if (error?.category && error.category !== 'relay') return false
+  return prefixes.has(/^([a-z-]+):/.exec(error?.message || '')?.[1])
+}
+
+export const isRetryableRelayFailure = error => matches(error, RETRY_PREFIXES)
+export const isReplaceableRelayFailure = error => matches(error, REPLACEMENT_PREFIXES)

package/relay/index.js

@@ -1,4 +1,5 @@
 export { freeRelays, nappRelays, seedRelays } from './constants/index.js'
+export { isRetryableRelayFailure, isReplaceableRelayFailure } from './helpers/failure.js'
 export { pickRelaysForPubkeys } from './helpers/routing.js'
 export { RelayPool, relayPool } from './services/relay-pool.js'
 export { getLatestEventsByPubkey } from './services/events.js'

package/relay/services/events.js

@@ -45,7 +45,7 @@ function getSelectedRelaysByPubkey (pubkeys, relayToAuthors) {
 }
 
 // Fetches batched events and keeps the newest event per address.
-async function fetchLatestEventsByRelay (relayToAuthors, { kinds, dTagsByPubkey, getEvents }) {
+async function fetchLatestEventsByRelay (relayToAuthors, { kinds, dTagsByPubkey, getEvents, report, phase, signal }) {
   const requests = []
   for (const [relay, authors] of relayToAuthors) {
     const authorsByD = new Map()
@@ -57,8 +57,17 @@ async function fetchLatestEventsByRelay (relayToAuthors, { kinds, dTagsByPubkey,
     for (const [d, dAuthors] of authorsByD) {
       const filter = { kinds, authors: dAuthors }
       if (d) filter['#d'] = [d]
-      requests.push(getEvents(filter, [relay])
-        .then(response => ({ requested: new Set(dAuthors), events: (response.result || []).map(({ event }) => event) })))
+      requests.push(Promise.resolve().then(async () => {
+        signal?.throwIfAborted()
+        try {
+          const response = await getEvents(filter, [relay], signal ? { signal } : {})
+          report({ phase, authors: dAuthors, relays: response.relays || [], errors: response.errors || [] })
+          return { requested: new Set(dAuthors), events: (response.result || []).map(({ event }) => event) }
+        } catch (error) {
+          report({ phase, authors: dAuthors, relays: [{ relay, status: 'error', error }], error })
+          throw error
+        }
+      }))
     }
   }
 
@@ -95,11 +104,20 @@ export async function getLatestEventsByPubkey (pubkeys, {
   fallbackRelays = freeRelays.slice(0, DEFAULT_FALLBACK_RELAY_COUNT),
   relaysByPubkey,
   relayListOptions,
+  excludeRelaysByPubkey,
+  signal,
+  onQueryResult,
   _getRelaysByPubkey = getRelaysByPubkey,
   _getEvents = getEvents
 } = {}) {
+  signal?.throwIfAborted()
+  const requests = []
+  const report = request => { requests.push(request); onQueryResult?.(request) }
+  const excluded = pubkey => excludeRelaysByPubkey instanceof Map
+    ? excludeRelaysByPubkey.get(pubkey) || []
+    : excludeRelaysByPubkey?.[pubkey] || []
   const authors = [...new Set(pubkeys || [])].filter(Boolean)
-  if (!authors.length) return { events: [], byPubkey: {}, relaysByPubkey: {} }
+  if (!authors.length) return { events: [], byPubkey: {}, relaysByPubkey: {}, requests }
   if (!Array.isArray(kinds) || kinds.length === 0) {
     throw new ValidationError('MISSING_EVENT_KINDS', { message: 'Missing kinds' })
   }
@@ -110,9 +128,16 @@ export async function getLatestEventsByPubkey (pubkeys, {
   if (missingRelayAuthors.length) {
     let discovered
     try {
-      discovered = await _getRelaysByPubkey(missingRelayAuthors, relayListOptions)
+      discovered = await _getRelaysByPubkey(missingRelayAuthors, {
+        ...relayListOptions,
+        ...(signal ? { signal } : {}),
+        onQueryResult: request => { report({ ...request, phase: 'discovery' }); relayListOptions?.onQueryResult?.(request) }
+      })
     } catch (error) {
-      console.error('Failed to discover publisher relays:', error)
+      signal?.throwIfAborted()
+      if (!requests.some(request => request.phase === 'discovery' && request.error === error)) {
+        report({ phase: 'discovery', authors: missingRelayAuthors, relays: [], error })
+      }
       discovered = Object.fromEntries(missingRelayAuthors.map(pubkey => [pubkey, { read: [], write: [] }]))
     }
     for (const pubkey of missingRelayAuthors) {
@@ -120,14 +145,17 @@ export async function getLatestEventsByPubkey (pubkeys, {
     }
   }
 
+  signal?.throwIfAborted()
   const primaryAuthors = authors.filter(pubkey => relaysByAuthor[pubkey]?.[type]?.length)
-  const primaryRoutes = pickRelaysForPubkeys(primaryAuthors, relaysByAuthor, { maxPerPubkey, relayType })
+  const primaryRoutes = pickRelaysForPubkeys(primaryAuthors, relaysByAuthor, { maxPerPubkey, relayType, excludeRelaysByPubkey, emptyRelaysFallback: [] })
   const selectedRelays = getSelectedRelaysByPubkey(authors, primaryRoutes)
+  for (const pubkey of authors) for (const relay of excluded(pubkey)) selectedRelays[pubkey].add(relay)
   const latestByAddress = await fetchLatestEventsByRelay(primaryRoutes, {
     kinds,
     dTagsByPubkey,
-    getEvents: _getEvents
+    getEvents: _getEvents, report, phase: 'primary', signal
   })
+  signal?.throwIfAborted()
   const foundPubkeys = new Set(Object.values(latestByAddress).map(event => event.pubkey))
   const missingAuthors = authors.filter(pubkey => !foundPubkeys.has(pubkey))
 
@@ -145,13 +173,14 @@ export async function getLatestEventsByPubkey (pubkeys, {
       await fetchLatestEventsByRelay(fallbackRoutes, {
         kinds,
         dTagsByPubkey,
-        getEvents: _getEvents
+        getEvents: _getEvents, report, phase: 'fallback', signal
       })
     ))
   }
 
+  signal?.throwIfAborted()
   const events = Object.values(latestByAddress)
   const byPubkey = {}
   for (const event of events) byPubkey[event.pubkey] = event
-  return { events, byPubkey, relaysByPubkey: relaysByAuthor }
+  return { events, byPubkey, relaysByPubkey: relaysByAuthor, requests }
 }

package/relay/services/query.js

@@ -224,28 +224,27 @@ export function subscribeRelayListUpdates (pubkeys, {
 }
 
 async function loadMissingRelays (missingPubkeys, {
-  getEvents,
-  cacheMs,
-  timeout = RELAY_LIST_QUERY_TIMEOUT_MS,
-  timeoutAfterFirstEose = RELAY_LIST_QUERY_TIMEOUT_AFTER_FIRST_EOSE_MS,
-  relayUrlPolicy,
-  emptyRelaysFallback = freeRelays.slice(0, 2)
+  getEvents, cacheMs, timeout, timeoutAfterFirstEose, relayUrlPolicy,
+  emptyRelaysFallback, excludeRelays, signal
 }) {
-  const { result: events } = await getEvents({
-    kinds: [10002],
-    authors: missingPubkeys,
-    limit: missingPubkeys.length
-  }, seedRelays, {
-    timeout,
-    timeoutAfterFirstEose
-  })
-
+  let response
+  try {
+    response = await getEvents({ kinds: [10002], authors: missingPubkeys, limit: missingPubkeys.length },
+      seedRelays.filter(relay => !excludeRelays.includes(relay)), { timeout, timeoutAfterFirstEose, signal })
+    signal.throwIfAborted()
+  } catch (error) {
+    return { entries: {}, report: { authors: missingPubkeys, relays: [], error } }
+  }
+  const report = { authors: missingPubkeys, relays: response.relays || [], errors: response.errors || [] }
+  const complete = response.relays
+    ? response.relays.length > 0 && response.relays.every(item => item.status === 'eose')
+    : !response.errors?.length
   const latestByPubkey = {}
-  for (const { event } of events || []) {
+  for (const { event } of response.result || []) {
     if (!missingPubkeys.includes(event.pubkey)) continue
     if (isNewerRelayListEvent(event, latestByPubkey[event.pubkey])) latestByPubkey[event.pubkey] = event
   }
-
+  const entries = {}
   for (const pubkey of missingPubkeys) {
     const fetchedEvent = latestByPubkey[pubkey]
     const cachedEvent = relayCacheEventByPubkey[pubkey] || null
@@ -253,9 +252,29 @@ async function loadMissingRelays (missingPubkeys, {
     const relays = event
       ? parseRelayListEvent(event, relayUrlPolicy)
       : { read: [...emptyRelaysFallback], write: [...emptyRelaysFallback] }
-    setCachedRelays(pubkey, relays, event, cacheMs)
+    entries[pubkey] = { ...relays, event }
+    // A failed/incomplete lookup may use fallbacks for this call, but must not
+    // turn that failure into a forty-minute negative discovery cache entry.
+    if (fetchedEvent || complete) setCachedRelays(pubkey, relays, event, cacheMs)
   }
   pruneRelayCache()
+  return { entries, report }
+}
+
+// Each caller owns its wait, not another caller's shared discovery request.
+function waitForDiscovery (record, signal) {
+  signal?.throwIfAborted()
+  record.users++
+  return new Promise((resolve, reject) => {
+    const abort = () => reject(signal.reason)
+    signal?.addEventListener('abort', abort, { once: true })
+    record.promise.then(resolve, reject).finally(() => signal?.removeEventListener('abort', abort))
+  }).finally(() => {
+    if (--record.users === 0 && !record.finished) {
+      record.controller.abort()
+      record.remove()
+    }
+  })
 }
 
 export async function getRelaysByPubkey (pubkeys, {
@@ -266,40 +285,48 @@ export async function getRelaysByPubkey (pubkeys, {
   timeout = RELAY_LIST_QUERY_TIMEOUT_MS,
   timeoutAfterFirstEose = RELAY_LIST_QUERY_TIMEOUT_AFTER_FIRST_EOSE_MS,
   relayUrlPolicy,
-  emptyRelaysFallback = freeRelays.slice(0, 2)
+  emptyRelaysFallback = freeRelays.slice(0, 2),
+  excludeRelays = [],
+  signal,
+  onQueryResult
 } = {}) {
+  signal?.throwIfAborted()
   const pubkeyList = uniquePubkeys(pubkeys, { requireHex: _getEvents === getEvents })
   if (!pubkeyList.length) return {}
-
-  const loadPubkeys = forceRefresh
-    ? pubkeyList
-    : pubkeyList.filter(pubkey => !hasCachedKey(relaysByPubkey, pubkey))
-  const pubkeysToLoad = loadPubkeys.filter(pubkey => !relayRequestsByPubkey.has(pubkey))
+  // Different exclusions cannot share a request that contacts a refused relay.
+  const scope = JSON.stringify([...new Set(excludeRelays)].sort())
+  const key = pubkey => `${pubkey}:${scope}`
+  const loadPubkeys = forceRefresh ? pubkeyList : pubkeyList.filter(pubkey => !hasCachedKey(relaysByPubkey, pubkey))
+  const pubkeysToLoad = loadPubkeys.filter(pubkey => !relayRequestsByPubkey.has(key(pubkey)))
   if (pubkeysToLoad.length) {
-    const request = loadMissingRelays(pubkeysToLoad, {
-      getEvents: _getEvents,
-      cacheMs,
-      timeout,
-      timeoutAfterFirstEose,
-      relayUrlPolicy,
-      emptyRelaysFallback
-    }).finally(() => {
+    const record = { controller: new AbortController(), users: 0, finished: false }
+    record.remove = () => {
       for (const pubkey of pubkeysToLoad) {
-        if (relayRequestsByPubkey.get(pubkey) === request) relayRequestsByPubkey.delete(pubkey)
+        if (relayRequestsByPubkey.get(key(pubkey)) === record) relayRequestsByPubkey.delete(key(pubkey))
       }
-    })
-    for (const pubkey of pubkeysToLoad) relayRequestsByPubkey.set(pubkey, request)
+    }
+    record.promise = loadMissingRelays(pubkeysToLoad, {
+      getEvents: _getEvents, cacheMs, timeout, timeoutAfterFirstEose, relayUrlPolicy,
+      emptyRelaysFallback, excludeRelays, signal: record.controller.signal
+    }).finally(() => { record.finished = true; record.remove() })
+    for (const pubkey of pubkeysToLoad) relayRequestsByPubkey.set(key(pubkey), record)
   }
-
-  await Promise.all([...new Set(
-    loadPubkeys.map(pubkey => relayRequestsByPubkey.get(pubkey)).filter(Boolean)
-  )])
-
-  return Object.fromEntries(pubkeyList
-    .filter(pubkey => hasCachedKey(relaysByPubkey, pubkey))
-    .map(pubkey => {
-      const entry = cloneRelays(relaysByPubkey[pubkey])
-      if (includeEvents) entry.event = cloneRelayListEvent(relayCacheEventByPubkey[pubkey])
-      return [pubkey, entry]
-    }))
+  const entries = {}
+  const records = [...new Set(loadPubkeys.map(pubkey => relayRequestsByPubkey.get(key(pubkey))).filter(Boolean))]
+  await Promise.all(records.map(async record => {
+    const result = await waitForDiscovery(record, signal)
+    signal?.throwIfAborted()
+    // Deliver the same native diagnostics to every interested caller, including
+    // callers that joined an already running query.
+    onQueryResult?.(result.report)
+    if (result.report.error) throw result.report.error
+    Object.assign(entries, result.entries)
+  }))
+  signal?.throwIfAborted()
+  return Object.fromEntries(pubkeyList.map(pubkey => {
+    const source = hasCachedKey(relaysByPubkey, pubkey) ? relaysByPubkey[pubkey] : entries[pubkey]
+    const entry = cloneRelays(source || { read: emptyRelaysFallback, write: emptyRelaysFallback })
+    if (includeEvents) entry.event = cloneRelayListEvent(relayCacheEventByPubkey[pubkey] || entries[pubkey]?.event)
+    return [pubkey, entry]
+  }))
 }