jumble/src/lib/relay-list-builder.ts

/**
 * Comprehensive relay list builder utility
 * Handles all relay selection requirements:
 * - Filters blocked relays
 * - Includes local relays from kind 10432
 * - Handles author's outboxes/inboxes
 * - Handles user's outboxes/inboxes
 * - Includes relay hints
 * - Includes seen relays
 */

import { FAST_READ_RELAY_URLS, FAST_WRITE_RELAY_URLS, PROFILE_FETCH_RELAY_URLS, SEARCHABLE_RELAY_URLS } from '@/constants'
import { isHttpRelayUrl, normalizeAnyRelayUrl, normalizeUrl } from '@/lib/url'
import { getCacheRelayUrls } from './private-relays'
import client from '@/services/client.service'
import logger from '@/lib/logger'
import type { Event } from 'nostr-tools'

function dedupeNormalizedRelayUrls(urls: string[]): string[] {
  const seen = new Set<string>()
  const out: string[] = []
  for (const u of urls) {
    if (isHttpRelayUrl(u)) continue
    const n = normalizeAnyRelayUrl(u) || u.trim()
    if (!n || seen.has(n)) continue
    seen.add(n)
    out.push(n)
  }
  return out
}

/**
 * Relays to bootstrap Explore replaceable fetches (e.g. kind 10012 batch) before NIP-65 resolves.
 * PROFILE_FETCH + FAST_READ.
 */
function exploreDiscoveryBootstrapRelayUrls(): string[] {
  return dedupeNormalizedRelayUrls([...PROFILE_FETCH_RELAY_URLS, ...FAST_READ_RELAY_URLS])
}

export interface RelayListBuilderOptions {
  /** Author's pubkey - will include their outboxes (write relays) */
  authorPubkey?: string
  /** Logged-in user's pubkey - will include their inboxes (read relays) and outboxes (write relays) */
  userPubkey?: string
  /** Explicit relay hints (from bech32 IDs or event tags) */
  relayHints?: string[]
  /** Relays where an event was seen */
  seenRelays?: string[]
  /** Relays where a containing event was found (for embedded events) */
  containingEventRelays?: string[]
  /** Whether to include user's own relays (read/write/local) - for profiles/metadata */
  includeUserOwnRelays?: boolean
  /** Whether to include PROFILE_FETCH_RELAY_URLS - for profiles/metadata */
  includeProfileFetchRelays?: boolean
  /** Whether to include FAST_READ_RELAY_URLS as fallback */
  includeFastReadRelays?: boolean
  /** Whether to include FAST_WRITE_RELAY_URLS as fallback */
  includeFastWriteRelays?: boolean
  /** Whether to include SEARCHABLE_RELAY_URLS - for search */
  includeSearchableRelays?: boolean
  /** Blocked relays to filter out */
  blockedRelays?: string[]
  /** Whether to include local relays from kind 10432 */
  includeLocalRelays?: boolean
  /** Whether to include user's favorite relays (kind 10012) */
  includeFavoriteRelays?: boolean
  /**
   * When true with fast-read / searchable includes: insert `FAST_READ_RELAY_URLS` and
   * `SEARCHABLE_RELAY_URLS` immediately after hints/seen/containing and **before** author + user
   * NIP-65 lists. Used for single-event / embed fetches so public mirrors (e.g. nos.lol) are not
   * queued behind dozens of personal relays under the global connection cap.
   */
  preferPublicReadRelaysEarly?: boolean
}

/**
 * Build comprehensive relay list according to requirements
 */
export async function buildComprehensiveRelayList(options: RelayListBuilderOptions = {}): Promise<string[]> {
  const {
    authorPubkey,
    userPubkey,
    relayHints = [],
    seenRelays = [],
    containingEventRelays = [],
    includeUserOwnRelays = false,
    includeProfileFetchRelays = false,
    includeFastReadRelays = true,
    includeFastWriteRelays = false,
    includeSearchableRelays = false,
    blockedRelays = [],
    includeLocalRelays = true,
    includeFavoriteRelays = false,
    preferPublicReadRelaysEarly = false
  } = options

  const relayUrls = new Set<string>()
  const normalizedBlocked = new Set(
    (blockedRelays || []).map(url => {
      const normalized = normalizeUrl(url) || url
      return normalized.toLowerCase()
    }).filter((url): url is string => !!url)
  )

  const addRelay = (url: string | undefined) => {
    if (!url) return
    // This builder feeds WebSocket REQ/publish lists; keep HTTP relays separate.
    if (isHttpRelayUrl(url)) return
    const normalized = normalizeAnyRelayUrl(url)
    if (!normalized) return
    // Filter blocked (case-insensitive comparison)
    if (normalizedBlocked.has(normalized.toLowerCase())) return
    relayUrls.add(normalized)
  }

  // 1. Relay hints (highest priority - explicit hints)
  relayHints.forEach(addRelay)

  // 2. Relays where event was seen
  seenRelays.forEach(addRelay)

  // 3. Relays where containing event was found (for embedded events)
  containingEventRelays.forEach(addRelay)

  // 3b. Public read / index relays before author + user NIP-65 expansion (embed + fetchEvent).
  if (preferPublicReadRelaysEarly) {
    if (includeFastReadRelays) {
      FAST_READ_RELAY_URLS.forEach(addRelay)
    }
    if (includeSearchableRelays) {
      SEARCHABLE_RELAY_URLS.forEach(addRelay)
    }
  }

  // 4. Author's outboxes (write relays) - where they publish (IndexedDB + defaults; no network gate)
  if (authorPubkey) {
    try {
      const authorRelayList = await client.peekRelayListFromStorage(authorPubkey)
      const authorOutboxes = [...(authorRelayList.write || []).slice(0, 10)]
      authorOutboxes.forEach(addRelay)
      const authorInboxes = [...(authorRelayList.read || []).slice(0, 10)]
      authorInboxes.forEach(addRelay)
      logger.debug('[RelayListBuilder] Added author relays', {
        author: authorPubkey.substring(0, 8),
        outboxes: authorOutboxes.length,
        inboxes: authorInboxes.length
      })
    } catch (error) {
      logger.debug('[RelayListBuilder] Failed to read author relay list from storage', { error })
    }
  }

  // 5. User's own relays (for profiles/metadata)
  if (includeUserOwnRelays && userPubkey) {
    try {
      const userRelayList = await client.peekRelayListFromStorage(userPubkey)
      const userRead = [...(userRelayList.read || []).slice(0, 10)]
      const userWrite = [...(userRelayList.write || []).slice(0, 10)]
      userRead.forEach(addRelay)
      userWrite.forEach(addRelay)

      // Include local relays from kind 10432
      if (includeLocalRelays) {
        const localRelays = await getCacheRelayUrls(userPubkey)
        localRelays.forEach(addRelay)
      }
      
      // Include favorite relays (kind 10012) if requested
      let favoriteRelaysCount = 0
      if (includeFavoriteRelays) {
        try {
          const favoriteRelays = await client.fetchFavoriteRelays(userPubkey)
          favoriteRelays.forEach(addRelay)
          favoriteRelaysCount = favoriteRelays.length
          logger.debug('[RelayListBuilder] Added user favorite relays', {
            count: favoriteRelaysCount
          })
        } catch (error) {
          logger.debug('[RelayListBuilder] Failed to fetch user favorite relays', { error })
        }
      }
      
      logger.debug('[RelayListBuilder] Added user own relays', {
        read: (userRelayList.read || []).length,
        write: (userRelayList.write || []).length,
        local: includeLocalRelays ? (await getCacheRelayUrls(userPubkey)).length : 0,
        favorite: favoriteRelaysCount
      })
    } catch (error) {
      logger.debug('[RelayListBuilder] Failed to fetch user relay list', { error })
    }
  } else if (userPubkey) {
    // Even if not including user's own relays, still include user's inboxes for reading
    try {
      const userRelayList = await client.peekRelayListFromStorage(userPubkey)
      ;[...(userRelayList.read || []).slice(0, 10)].forEach(addRelay)

      // Include local relays from kind 10432 if enabled
      if (includeLocalRelays) {
        const localRelays = await getCacheRelayUrls(userPubkey)
        localRelays.forEach(addRelay)
      }
      // Menu / feed “favorite relays” (kind 10012) — same list as the sidebar; not part of NIP-65 alone.
      if (includeFavoriteRelays) {
        try {
          const favoriteRelays = await client.fetchFavoriteRelays(userPubkey)
          favoriteRelays.forEach(addRelay)
          logger.debug('[RelayListBuilder] Added user favorite relays (with inboxes path)', {
            count: favoriteRelays.length
          })
        } catch (error) {
          logger.debug('[RelayListBuilder] Failed to fetch user favorite relays', { error })
        }
      }
    } catch (error) {
      logger.debug('[RelayListBuilder] Failed to fetch user inboxes', { error })
    }
  }

  // 6. Profile fetch relays (for profiles/metadata)
  if (includeProfileFetchRelays) {
    PROFILE_FETCH_RELAY_URLS.forEach(addRelay)
  }

  // 7. Fast read relays (fallback)
  if (includeFastReadRelays && !preferPublicReadRelaysEarly) {
    FAST_READ_RELAY_URLS.forEach(addRelay)
  }

  // 8. Fast write relays (for writing)
  if (includeFastWriteRelays) {
    FAST_WRITE_RELAY_URLS.forEach(addRelay)
  }

  // 9. Searchable relays (for search)
  if (includeSearchableRelays && !preferPublicReadRelaysEarly) {
    SEARCHABLE_RELAY_URLS.forEach(addRelay)
  }

  return Array.from(relayUrls)
}

/**
 * Explore: Following's Favorites (kind 10012 batch) / replaceable discovery.
 * Bootstrap relays (profile + FAST_READ) plus the viewer's read/write and cache (10432) when logged in.
 */
export async function buildExploreProfileAndUserRelayList(
  userPubkey: string | null | undefined
): Promise<string[]> {
  const boot = exploreDiscoveryBootstrapRelayUrls()
  if (!userPubkey) {
    return boot
  }
  try {
    const built = await buildComprehensiveRelayList({
      userPubkey,
      includeUserOwnRelays: true,
      includeProfileFetchRelays: true,
      includeFastReadRelays: true,
      includeFavoriteRelays: false,
      includeLocalRelays: true,
      includeFastWriteRelays: false,
      includeSearchableRelays: false
    })
    if (!built.length) return boot
    return dedupeNormalizedRelayUrls([...boot, ...built])
  } catch {
    return boot
  }
}

/** NIP-10 relay hints from `e` / `E` tags (third value) on the focused event or thread. */
export function relayHintsFromEventTags(event: { tags: string[][] }): string[] {
  const out = new Set<string>()
  for (const tag of event.tags) {
    if ((tag[0] === 'e' || tag[0] === 'E') && tag[2]) {
      const n = normalizeUrl(tag[2]) || tag[2]
      if (n) out.add(n)
    }
  }
  return [...out]
}

const POLL_RESULTS_MAX_RELAYS = 40
const POLL_RESULTS_NIP65_READ_SLICE = 16

/**
 * Relays to REQ poll responses (kind 1068 replies), in priority order:
 * seen relays, NIP-10 `e`/`E` hints, poll `relay` tags, viewer NIP-65 **read** (inbox),
 * favorite relays (kind 10012 from props), viewer cache relays (10432), {@link FAST_READ_RELAY_URLS},
 * poll author NIP-65 **read** (inbox).
 */
export async function buildPollResultsReadRelayUrls(options: {
  pollEvent: Event
  pollRelayUrls: string[]
  viewerPubkey: string | null | undefined
  /** From {@link useFavoriteRelays} — avoids a second kind 10012 fetch. */
  viewerFavoriteRelayUrls?: string[]
  blockedRelays?: string[]
}): Promise<string[]> {
  const {
    pollEvent,
    pollRelayUrls,
    viewerPubkey,
    viewerFavoriteRelayUrls = [],
    blockedRelays = []
  } = options

  const normalizedBlocked = new Set(
    blockedRelays
      .map((url) => (normalizeUrl(url) || url).toLowerCase())
      .filter(Boolean)
  )

  const ordered: string[] = []
  const seenNorm = new Set<string>()

  const pushLayer = (urls: string[]) => {
    for (const raw of urls) {
      if (isHttpRelayUrl(raw)) continue
      const normalized = normalizeUrl(raw) || raw?.trim()
      if (!normalized || normalizedBlocked.has(normalized.toLowerCase())) continue
      if (seenNorm.has(normalized)) continue
      seenNorm.add(normalized)
      ordered.push(normalized)
    }
  }

  pushLayer(client.getSeenEventRelayUrls(pollEvent.id))
  pushLayer(relayHintsFromEventTags(pollEvent))
  pushLayer(pollRelayUrls)

  let authorReadSlice: string[] = []
  let viewerReadSlice: string[] = []
  try {
    const [authorRl, viewerRl] = await Promise.all([
      pollEvent.pubkey ? client.peekRelayListFromStorage(pollEvent.pubkey) : Promise.resolve(null),
      viewerPubkey ? client.peekRelayListFromStorage(viewerPubkey) : Promise.resolve(null)
    ])
    if (authorRl?.read?.length) {
      authorReadSlice = authorRl.read.slice(0, POLL_RESULTS_NIP65_READ_SLICE)
    }
    if (viewerRl?.read?.length) {
      viewerReadSlice = viewerRl.read.slice(0, POLL_RESULTS_NIP65_READ_SLICE)
    }
  } catch {
    logger.debug('[RelayListBuilder] poll results: NIP-65 relay list race failed')
  }

  pushLayer(viewerReadSlice)

  if (viewerPubkey) {
    pushLayer(viewerFavoriteRelayUrls)
    try {
      const localRelays = await getCacheRelayUrls(viewerPubkey)
      pushLayer(localRelays)
    } catch {
      logger.debug('[RelayListBuilder] poll results: cache relays failed')
    }
  }

  pushLayer([...FAST_READ_RELAY_URLS])
  pushLayer(authorReadSlice)

  return ordered.slice(0, POLL_RESULTS_MAX_RELAYS)
}

/**
 * Build relay list for reading replies/comments
 * READ from: FAST_READ_RELAY_URLS + user's inboxes + local relays + OP author's outboxes
 */
export async function buildReplyReadRelayList(
  opAuthorPubkey: string | undefined,
  userPubkey: string | undefined,
  blockedRelays: string[] = [],
  threadRelayHints: string[] = []
): Promise<string[]> {
  return buildComprehensiveRelayList({
    authorPubkey: opAuthorPubkey,
    userPubkey,
    relayHints: threadRelayHints,
    includeFastReadRelays: true,
    includeSearchableRelays: true,
    includeLocalRelays: true,
    blockedRelays
  })
}