Re-work feed to reduce annoyance of calling loaders

This commit is contained in:
Jon Staab
2024-11-07 09:07:03 -08:00
parent a3987cbf88
commit 0074b51aba
6 changed files with 165 additions and 121 deletions
+265
View File
@@ -0,0 +1,265 @@
import {inc, memoize, omitVals, max, min, now} from '@welshman/lib'
import type {TrustedEvent, Filter} from '@welshman/util'
import {EPOCH, trimFilters, guessFilterDelta} from '@welshman/util'
import type {Feed, RequestItem, FeedOptions} from './core'
import {FeedType} from './core'
import {FeedCompiler} from './compiler'
export class FeedController {
compiler: FeedCompiler
constructor(readonly options: FeedOptions) {
this.compiler = new FeedCompiler(options)
}
getFilters = memoize(async () => {
return this.compiler.canCompile(this.options.feed)
? this.compiler.compile(this.options.feed)
: undefined
})
getLoader = memoize(async () => {
const [type, ...feed] = this.options.feed
const filters = await this.getFilters()
if (filters) {
return this._getRequestsLoader(filters)
}
switch(type) {
case FeedType.Difference:
return this._getDifferenceLoader(feed as Feed[])
case FeedType.Intersection:
return this._getIntersectionLoader(feed as Feed[])
case FeedType.Union:
return this._getUnionLoader(feed as Feed[])
default:
throw new Error(`Unable to convert feed of type ${type} to loader`)
}
})
load = async (limit: number) => (await this.getLoader())(limit)
async _getRequestsLoader(requests: RequestItem[], overrides: Partial<FeedOptions> = {}) {
const {onEvent, onExhausted} = {...this.options, ...overrides}
const seen = new Set()
const exhausted = new Set()
const loaders = await Promise.all(
requests.map(
request => this._getRequestLoader(request, {
onExhausted: () => exhausted.add(request),
onEvent: e => {
if (!seen.has(e.id)) {
onEvent(e)
seen.add(e.id)
}
},
})
)
)
return async (limit: number) => {
await Promise.all(loaders.map(loader => loader(limit)))
if (exhausted.size === requests.length) {
onExhausted()
}
}
}
async _getRequestLoader({relays, filters}: RequestItem, overrides: Partial<FeedOptions> = {}) {
const {useWindowing, onEvent, onExhausted, request} = {...this.options, ...overrides}
// Make sure we have some kind of filter to send if we've been given an empty one, as happens with relay feeds
if (!filters || filters.length === 0) {
filters = [{}]
}
const untils = filters.flatMap((filter: Filter) => filter.until ? [filter.until] : [])
const sinces = filters.flatMap((filter: Filter) => filter.since ? [filter.since] : [])
const maxUntil = untils.length === filters.length ? max(untils) : now()
const minSince = sinces.length === filters.length ? min(sinces) : EPOCH
const initialDelta = guessFilterDelta(filters)
let delta = initialDelta
let since = useWindowing ? maxUntil - delta : minSince
let until = maxUntil
return async (limit: number) => {
const requestFilters = filters!
// Remove filters that don't fit our window
.filter((filter: Filter) => {
const filterSince = filter.since || minSince
const filterUntil = filter.until || maxUntil
return filterSince < until && filterUntil > since
})
// Modify the filters to define our window
.map((filter: Filter) => ({...filter, until, limit, since}))
if (requestFilters.length === 0) {
return onExhausted()
}
let count = 0
await request(omitVals([undefined], {
relays,
filters: trimFilters(requestFilters),
onEvent: (event: TrustedEvent) => {
count += 1
until = Math.min(until, event.created_at - 1)
onEvent(event)
},
}))
if (useWindowing) {
if (since === minSince) {
onExhausted()
}
// Relays can't be relied upon to return events in descending order, do exponential
// windowing to ensure we get the most recent stuff on first load, but eventually find it all
if (count < limit) {
delta = delta * Math.round(10 - 9 * (Math.log(count + 1) / Math.log(limit + 1)))
until = since
}
since = Math.max(minSince, until - delta)
} else if (count === 0) {
onExhausted()
}
}
}
async _getDifferenceLoader(feeds: Feed[], overrides: Partial<FeedOptions> = {}) {
const {onEvent, onExhausted, ...options} = {...this.options, ...overrides}
const exhausted = new Set<number>()
const skip = new Set<string>()
const events: TrustedEvent[] = []
const seen = new Set()
const controllers = await Promise.all(
feeds.map((thisFeed: Feed, i: number) =>
new FeedController({
...options,
feed: thisFeed,
onExhausted: () => exhausted.add(i),
onEvent: (event: TrustedEvent) => {
if (i === 0) {
events.push(event)
} else {
skip.add(event.id)
}
},
})
)
)
return async (limit: number) => {
await Promise.all(
controllers.map(async (controller: FeedController, i: number) => {
if (exhausted.has(i)) {
return
}
await controller.load(limit)
})
)
for (const event of events.splice(0)) {
if (!skip.has(event.id) && !seen.has(event.id)) {
onEvent(event)
seen.add(event.id)
}
}
if (exhausted.size === controllers.length) {
onExhausted()
}
}
}
async _getIntersectionLoader(feeds: Feed[], overrides: Partial<FeedOptions> = {}) {
const {onEvent, onExhausted, ...options} = {...this.options, ...overrides}
const exhausted = new Set<number>()
const counts = new Map<string, number>()
const events: TrustedEvent[] = []
const seen = new Set()
const controllers = await Promise.all(
feeds.map((thisFeed: Feed, i: number) =>
new FeedController({
...options,
feed: thisFeed,
onExhausted: () => exhausted.add(i),
onEvent: (event: TrustedEvent) => {
events.push(event)
counts.set(event.id, inc(counts.get(event.id)))
},
})
)
)
return async (limit: number) => {
await Promise.all(
controllers.map(async (controller: FeedController, i: number) => {
if (exhausted.has(i)) {
return
}
await controller.load(limit)
})
)
for (const event of events.splice(0)) {
if (counts.get(event.id) === controllers.length && !seen.has(event.id)) {
onEvent(event)
seen.add(event.id)
}
}
if (exhausted.size === controllers.length) {
onExhausted()
}
}
}
async _getUnionLoader(feeds: Feed[], overrides: Partial<FeedOptions> = {}) {
const {onEvent, onExhausted, ...options} = {...this.options, ...overrides}
const exhausted = new Set<number>()
const seen = new Set()
const controllers = await Promise.all(
feeds.map((thisFeed: Feed, i: number) =>
new FeedController({
...options,
feed: thisFeed,
onExhausted: () => exhausted.add(i),
onEvent: (event: TrustedEvent) => {
if (!seen.has(event.id)) {
onEvent(event)
seen.add(event.id)
}
},
})
)
)
return async (limit: number) => {
await Promise.all(
controllers.map(async (controller: FeedController, i: number) => {
if (exhausted.has(i)) {
return
}
await controller.load(limit)
})
)
if (exhausted.size === controllers.length) {
onExhausted()
}
}
}
}