enhance batching

This commit is contained in:
Shusui MOYATANI
2023-03-20 12:45:07 +09:00
parent cd38f7e976
commit 9a764ba086
16 changed files with 562 additions and 384 deletions

View File

@@ -1,97 +1,344 @@
import { createSignal, createMemo, createRoot, type Signal, type Accessor } from 'solid-js';
import { type Event as NostrEvent, type Filter } from 'nostr-tools';
import { createSignal, createMemo, untrack, type Accessor, type Signal } from 'solid-js';
import { type Event as NostrEvent, type Filter, Kind } from 'nostr-tools';
import { createQuery, useQueryClient, type CreateQueryResult } from '@tanstack/solid-query';
import useConfig from '@/nostr/useConfig';
import timeout from '@/utils/timeout';
import usePool from '@/nostr/usePool';
import useBatch, { type Task } from '@/nostr/useBatch';
import eventWrapper from '@/core/event';
import useSubscription from '@/nostr/useSubscription';
import useConfig from './useConfig';
export type UseBatchedEventsProps<TaskArgs> = {
interval?: number;
generateKey: (args: TaskArgs) => string | number;
mergeFilters: (args: TaskArgs[]) => Filter[];
extractKey: (event: NostrEvent) => string | number | undefined;
type TaskArg =
| { type: 'Profile'; pubkey: string }
| { type: 'TextNote'; eventId: string }
| { type: 'Reactions'; mentionedEventId: string }
| { type: 'DeprecatedReposts'; mentionedEventId: string };
type BatchedEvents = { completed: boolean; events: NostrEvent[] };
type TaskRes = Accessor<BatchedEvents>;
// Profile
// TODO zodにする
// deleted等の特殊なもの
export type StandardProfile = {
name?: string;
about?: string;
// user's icon
picture?: string;
// user's banner image
banner?: string;
nip05?: string; // NIP-05
lud06?: string; // NIP-57
lud16?: string; // NIP-57
};
export type BatchedEvents = {
events: NostrEvent[];
completed: boolean;
export type NonStandardProfile = {
display_name?: string;
website?: string;
};
const emptyBatchedEvents = () => ({ completed: true, events: [] });
export type Profile = StandardProfile & NonStandardProfile;
const completeBatchedEvents = (current: BatchedEvents): BatchedEvents => ({
...current,
completed: true,
});
export type UseProfileProps = {
pubkey: string;
};
const addEvent =
(event: NostrEvent) =>
(current: BatchedEvents): BatchedEvents => ({
...current,
events: [...current.events, event],
});
type UseProfile = {
profile: () => Profile | undefined;
query: CreateQueryResult<Accessor<NostrEvent> | undefined>;
};
const useBatchedEvents = <TaskArgs>(propsProvider: () => UseBatchedEventsProps<TaskArgs>) => {
// Textnote
export type UseTextNoteProps = {
eventId: string;
};
export type UseTextNote = {
event: Accessor<NostrEvent | undefined>;
query: CreateQueryResult<Accessor<NostrEvent> | undefined>;
};
// Reactions
export type UseReactionsProps = {
eventId: string;
};
export type UseReactions = {
reactions: Accessor<NostrEvent[]>;
reactionsGroupedByContent: Accessor<Map<string, NostrEvent[]>>;
isReactedBy: (pubkey: string) => boolean;
invalidateReactions: () => Promise<void>;
query: CreateQueryResult<Accessor<BatchedEvents>>;
};
// DeprecatedReposts
export type UseDeprecatedRepostsProps = {
eventId: string;
};
export type UseDeprecatedReposts = {
reposts: Accessor<NostrEvent[]>;
isRepostedBy: (pubkey: string) => boolean;
invalidateDeprecatedReposts: () => Promise<void>;
query: CreateQueryResult<Accessor<BatchedEvents>>;
};
const { exec } = useBatch<TaskArg, TaskRes>(() => ({
executor: (tasks) => {
const profileTasks = new Map<string, Task<TaskArg, TaskRes>[]>();
const textNoteTasks = new Map<string, Task<TaskArg, TaskRes>[]>();
const reactionsTasks = new Map<string, Task<TaskArg, TaskRes>[]>();
const repostsTasks = new Map<string, Task<TaskArg, TaskRes>[]>();
tasks.forEach((task) => {
if (task.args.type === 'Profile') {
const current = profileTasks.get(task.args.pubkey) ?? [];
profileTasks.set(task.args.pubkey, [...current, task]);
} else if (task.args.type === 'TextNote') {
const current = textNoteTasks.get(task.args.eventId) ?? [];
textNoteTasks.set(task.args.eventId, [...current, task]);
} else if (task.args.type === 'Reactions') {
const current = reactionsTasks.get(task.args.mentionedEventId) ?? [];
reactionsTasks.set(task.args.mentionedEventId, [...current, task]);
} else if (task.args.type === 'DeprecatedReposts') {
const current = repostsTasks.get(task.args.mentionedEventId) ?? [];
repostsTasks.set(task.args.mentionedEventId, [...current, task]);
}
});
const profilePubkeys = [...profileTasks.keys()];
const textNoteIds = [...textNoteTasks.keys()];
const reactionsIds = [...reactionsTasks.keys()];
const repostsIds = [...repostsTasks.keys()];
const filters: Filter[] = [];
if (profilePubkeys.length > 0) {
filters.push({ kinds: [Kind.Metadata], authors: profilePubkeys });
}
if (textNoteIds.length > 0) {
filters.push({ kinds: [Kind.Text], ids: textNoteIds });
}
if (reactionsIds.length > 0) {
filters.push({ kinds: [Kind.Reaction], '#e': reactionsIds });
}
if (repostsIds.length > 0) {
filters.push({ kinds: [6], '#e': repostsIds });
}
if (filters.length === 0) return;
const signals = new Map<number, Signal<BatchedEvents>>();
const resolveTasks = (registeredTasks: Task<TaskArg, TaskRes>[], event: NostrEvent) => {
registeredTasks.forEach((task) => {
const signal = signals.get(task.id) ?? createSignal({ events: [], completed: false });
const [batchedEvents, setBatchedEvents] = signal;
setBatchedEvents((current) => ({
...current,
events: [...current.events, event],
}));
task.resolve(batchedEvents);
});
};
const emptyBatchedEvents = () => ({ events: [], completed: true });
const finalizeTasks = () => {
tasks.forEach((task) => {
const signal = signals.get(task.id);
if (signal != null) {
const setEvents = signal[1];
setEvents((current) => ({ ...current, completed: true }));
} else {
task.resolve(emptyBatchedEvents);
}
});
};
const { config } = useConfig();
useSubscription(() => ({
relayUrls: config().relayUrls,
filters,
continuous: false,
onEvent: (event: NostrEvent & { id: string }) => {
if (event.kind === Kind.Metadata) {
const registeredTasks = profileTasks.get(event.pubkey) ?? [];
resolveTasks(registeredTasks, event);
} else if (event.kind === Kind.Text) {
const registeredTasks = textNoteTasks.get(event.id) ?? [];
resolveTasks(registeredTasks, event);
} else if (event.kind === Kind.Reaction) {
const eventTags = eventWrapper(event).taggedEvents();
eventTags.forEach((eventTag) => {
const taggedEventId = eventTag.id;
const registeredTasks = reactionsTasks.get(taggedEventId) ?? [];
resolveTasks(registeredTasks, event);
});
} else if ((event.kind as number) === 6) {
const eventTags = eventWrapper(event).taggedEvents();
eventTags.forEach((eventTag) => {
const taggedEventId = eventTag.id;
const registeredTasks = repostsTasks.get(taggedEventId) ?? [];
resolveTasks(registeredTasks, event);
});
}
},
onEOSE: () => {
finalizeTasks();
},
}));
},
}));
export const useProfile = (propsProvider: () => UseProfileProps | null): UseProfile => {
const props = createMemo(propsProvider);
return useBatch<TaskArgs, Accessor<BatchedEvents>>(() => ({
interval: props().interval,
executor: (tasks) => {
const { generateKey, mergeFilters, extractKey } = props();
// TODO relayUrlsを考慮する
const { config } = useConfig();
const keyTaskMap = new Map<string | number, Task<TaskArgs, Accessor<BatchedEvents>>>(
tasks.map((task) => [generateKey(task.args), task]),
);
const filters = mergeFilters(tasks.map((task) => task.args));
const keyEventSignalsMap = new Map<string | number, Signal<BatchedEvents>>();
const getSignalForKey = (key: string | number): Signal<BatchedEvents> => {
const eventsSignal =
keyEventSignalsMap.get(key) ??
createRoot((dispose) => {
return createSignal<BatchedEvents>({
events: [],
completed: false,
});
});
keyEventSignalsMap.set(key, eventsSignal);
return eventsSignal;
};
const didReceivedEventsForKey = (key: string | number): boolean =>
keyEventSignalsMap.has(key);
useSubscription(() => ({
relayUrls: config().relayUrls,
filters,
continuous: false,
onEvent: (event: NostrEvent) => {
const key = extractKey(event);
if (key == null) return;
const task = keyTaskMap.get(key);
if (task == null) return;
const [events, setEvents] = getSignalForKey(key);
setEvents(addEvent(event));
task.resolve(events);
},
onEOSE: () => {
tasks.forEach((task) => {
const key = generateKey(task.args);
if (didReceivedEventsForKey(key)) {
const [, setEvents] = getSignalForKey(key);
setEvents(completeBatchedEvents);
} else {
task.resolve(emptyBatchedEvents);
}
});
},
}));
const query = createQuery(
() => ['useProfile', props()] as const,
({ queryKey, signal }) => {
const [, currentProps] = queryKey;
if (currentProps == null) return undefined;
const { pubkey } = currentProps;
const promise = exec({ type: 'Profile', pubkey }, signal).then((batchedEvents) => {
return createMemo(() => {
const { events } = batchedEvents();
if (events == null || events.length === 0)
throw new Error(`profile not found: ${pubkey}`);
const latest = events.reduce((a, b) => (a.created_at > b.created_at ? a : b));
return latest;
});
});
// TODO timeoutと同時にsignalでキャンセルするようにしたい
return timeout(15000, `useProfile: ${pubkey}`)(promise);
},
}));
{
// 5 minutes
staleTime: 5 * 60 * 1000,
cacheTime: 15 * 60 * 1000,
},
);
const profile = createMemo((): Profile | undefined => {
const event = query.data;
if (event == null) return undefined;
const { content } = event();
if (content == null || content.length === 0) return undefined;
// TODO 大きすぎたりしないかどうか、JSONかどうかのチェック
try {
return JSON.parse(content) as Profile;
} catch (err) {
console.error('failed to parse profile (kind 0): ', err, content);
return undefined;
}
});
return { profile, query };
};
export default useBatchedEvents;
export const useReactions = (propsProvider: () => UseReactionsProps | null): UseReactions => {
const queryClient = useQueryClient();
const props = createMemo(propsProvider);
const queryKey = createMemo(() => ['useReactions', props()] as const);
const query = createQuery(
() => queryKey(),
({ queryKey: currentQueryKey, signal }) => {
const [, currentProps] = currentQueryKey;
if (currentProps == null) return () => ({ events: [], completed: false });
const { eventId: mentionedEventId } = currentProps;
const promise = exec({ type: 'Reactions', mentionedEventId }, signal);
return timeout(15000, `useReactions: ${mentionedEventId}`)(promise);
},
{
// 3 minutes
staleTime: 1 * 60 * 1000,
cacheTime: 3 * 60 * 1000,
},
);
const reactions = () => query.data?.()?.events ?? [];
const reactionsGroupedByContent = () => {
const result = new Map<string, NostrEvent[]>();
reactions().forEach((event) => {
const events = result.get(event.content) ?? [];
events.push(event);
result.set(event.content, events);
});
return result;
};
const isReactedBy = (pubkey: string): boolean =>
reactions().findIndex((event) => event.pubkey === pubkey) !== -1;
const invalidateReactions = (): Promise<void> => queryClient.invalidateQueries(queryKey());
return { reactions, reactionsGroupedByContent, isReactedBy, invalidateReactions, query };
};
export const useTextNote = (propsProvider: () => UseTextNoteProps | null): UseTextNote => {
const props = createMemo(propsProvider);
const query = createQuery(
() => ['useEvent', props()] as const,
({ queryKey, signal }) => {
const [, currentProps] = queryKey;
if (currentProps == null) return undefined;
const { eventId } = currentProps;
const promise = exec({ type: 'TextNote', eventId }, signal).then((events) => {
return createMemo(() => {
const event = events().events[0];
if (event == null) throw new Error(`event not found: ${eventId}`);
return event;
});
});
return timeout(15000, `useEvent: ${eventId}`)(promise);
},
{
// a hour
staleTime: 60 * 60 * 1000,
cacheTime: 60 * 60 * 1000,
},
);
const event = () => query.data?.();
return { event, query };
};
export const useDeprecatedReposts = (
propsProvider: () => UseDeprecatedRepostsProps,
): UseDeprecatedReposts => {
const queryClient = useQueryClient();
const props = createMemo(propsProvider);
const queryKey = createMemo(() => ['useDeprecatedReposts', props()] as const);
const query = createQuery(
() => queryKey(),
({ queryKey: currentQueryKey, signal }) => {
const [, currentProps] = currentQueryKey;
if (currentProps == null) return () => ({ events: [], completed: false });
const { eventId: mentionedEventId } = currentProps;
const promise = exec({ type: 'DeprecatedReposts', mentionedEventId }, signal);
return timeout(15000, `useDeprecatedReposts: ${mentionedEventId}`)(promise);
},
{
// 1 minutes
staleTime: 1 * 60 * 1000,
cacheTime: 1 * 60 * 1000,
},
);
const reposts = () => query.data?.()?.events ?? [];
const isRepostedBy = (pubkey: string): boolean =>
reposts().findIndex((event) => event.pubkey === pubkey) !== -1;
const invalidateDeprecatedReposts = (): Promise<void> =>
queryClient.invalidateQueries(queryKey());
return { reposts, isRepostedBy, invalidateDeprecatedReposts, query };
};