Files
snort/packages/system/src/background-loader.ts

129 lines
3.5 KiB
TypeScript

import debug from "debug";
import { CachedTable, removeUndefined } from "@snort/shared";
import { SystemInterface, TaggedNostrEvent, RequestBuilder } from ".";
export abstract class BackgroundLoader<T extends { loaded: number; created: number }> {
#system: SystemInterface;
readonly cache: CachedTable<T>;
#log = debug(this.name());
#blacklist = new Set();
/**
* List of pubkeys to fetch metadata for
*/
#wantsKeys = new Set<string>();
/**
* Custom loader function for fetching data from alternative sources
*/
loaderFn?: (pubkeys: Array<string>) => Promise<Array<T>>;
constructor(system: SystemInterface, cache: CachedTable<T>) {
this.#system = system;
this.cache = cache;
this.#FetchMetadata();
}
/**
* Name of this loader service
*/
abstract name(): string;
/**
* Handle fetched data
*/
abstract onEvent(e: Readonly<TaggedNostrEvent>): T | undefined;
/**
* Get expire time as uxix milliseconds
*/
abstract getExpireCutoff(): number;
/**
* Build subscription for missing keys
*/
protected abstract buildSub(missing: Array<string>): RequestBuilder;
/**
* Start requesting a set of keys to be loaded
*/
TrackKeys(pk: string | Array<string>) {
for (const p of Array.isArray(pk) ? pk : [pk]) {
this.#wantsKeys.add(p);
}
}
/**
* Stop requesting a set of keys to be loaded
*/
UntrackKeys(pk: string | Array<string>) {
for (const p of Array.isArray(pk) ? pk : [pk]) {
this.#wantsKeys.delete(p);
}
}
/**
* Get object from cache or fetch if missing
*/
async fetch(key: string) {
const existing = this.cache.get(key);
if (existing) {
return existing;
} else {
return await new Promise<T>((resolve, reject) => {
this.TrackKeys(key);
const handler = (keys: Array<string>) => {
if (keys.includes(key)) {
const existing = this.cache.getFromCache(key);
if (existing) {
resolve(existing);
this.UntrackKeys(key);
this.cache.off("change", handler);
} else {
// should never happen
reject(new Error("Not found"));
}
}
};
this.cache.on("change", handler);
});
}
}
async #FetchMetadata() {
const loading = [...this.#wantsKeys].filter(a => !this.#blacklist.has(a));
await this.cache.buffer(loading);
const missing = loading.filter(a => (this.cache.getFromCache(a)?.loaded ?? 0) < this.getExpireCutoff());
if (missing.length > 0) {
this.#log("Fetching keys: %O", missing);
try {
const found = await this.#loadData(missing);
const noResult = removeUndefined(missing.filter(a => !found.some(b => a === this.cache.key(b))));
if (noResult.length > 0) {
noResult.forEach(a => this.#blacklist.add(a));
}
} catch (e) {
this.#log("Error: %O", e);
}
}
setTimeout(() => this.#FetchMetadata(), 500);
}
async #loadData(missing: Array<string>) {
this.#log("Loading data", missing);
if (this.loaderFn) {
const results = await this.loaderFn(missing);
await Promise.all(results.map(a => this.cache.update(a)));
return results;
} else {
const v = await this.#system.Fetch(this.buildSub(missing));
this.#log("Got data", v);
const results = removeUndefined(v.map(this.onEvent));
await Promise.all(results.map(a => this.cache.update(a)));
return results;
}
}
}