forked from andyburke/autonomous.contact
refactor: events to a pure stream instead of being part of topics
NOTE: tests are passing, but the client is broken
This commit is contained in:
parent
c34069066d
commit
a5707e2f81
31 changed files with 934 additions and 686 deletions
91
models/channel.ts
Normal file
91
models/channel.ts
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
import { by_character, by_lurid } from '@andyburke/fsdb/organizers';
|
||||
import { FSDB_COLLECTION } from '@andyburke/fsdb';
|
||||
import { FSDB_INDEXER_SYMLINKS } from '@andyburke/fsdb/indexers';
|
||||
|
||||
/**
|
||||
* @typedef {object} CHANNEL_EVENT_PERMISSIONS
|
||||
* @property {string[]} read a list of user_ids with read permission for the channel events
|
||||
* @property {string[]} write a list of user_ids with write permission for the channel events
|
||||
*/
|
||||
|
||||
/**
|
||||
* @typedef {object} CHANNEL_PERMISSIONS
|
||||
* @property {string[]} read a list of user_ids with read permission for the channel
|
||||
* @property {string[]} write a list of user_ids with write permission for the channel
|
||||
* @property {CHANNEL_EVENT_PERMISSIONS} events
|
||||
*/
|
||||
|
||||
/**
|
||||
* @typedef {object} CHANNEL_TIMESTAMPS
|
||||
* @property {string} created when the channel was created
|
||||
* @property {string} updated the last time the channel was updated
|
||||
* @property {string} [archived] an option time the channel was archived
|
||||
*/
|
||||
|
||||
/**
|
||||
* CHANNEL
|
||||
*
|
||||
* @property {string} id - lurid (stable)
|
||||
* @property {string} name - channel name (max 64 characters, unique, unstable)
|
||||
* @property {string} creator_id - user id of the channel creator
|
||||
* @property {CHANNEL_PERMISSIONS} permissions - permissions setup for the channel
|
||||
* @property {string} [icon] - optional url for channel icon
|
||||
* @property {string} [topic] - optional topic for the channel
|
||||
* @property {string} [rules] - optional channel rules (Markdown/text)
|
||||
* @property {string[]} [tags] - optional tags for the channel
|
||||
* @property {Record<string,any>} [meta] - optional metadata about the channel
|
||||
* @property {CHANNEL_TIMESTAMPS} timestamps - timestamps
|
||||
*/
|
||||
|
||||
export type CHANNEL = {
|
||||
id: string;
|
||||
name: string;
|
||||
creator_id: string;
|
||||
permissions: {
|
||||
read: string[];
|
||||
write: string[];
|
||||
events: {
|
||||
read: string[];
|
||||
write: string[];
|
||||
};
|
||||
};
|
||||
icon?: string;
|
||||
topic?: string;
|
||||
rules?: string;
|
||||
tags?: string[];
|
||||
meta?: Record<string, any>;
|
||||
timestamps: {
|
||||
created: string;
|
||||
updated: string;
|
||||
archived: string | undefined;
|
||||
};
|
||||
};
|
||||
|
||||
export const CHANNELS = new FSDB_COLLECTION<CHANNEL>({
|
||||
name: 'channels',
|
||||
id_field: 'id',
|
||||
organize: by_lurid,
|
||||
indexers: {
|
||||
creator_id: new FSDB_INDEXER_SYMLINKS<CHANNEL>({
|
||||
name: 'creator_id',
|
||||
field: 'creator_id',
|
||||
to_many: true,
|
||||
organize: by_lurid
|
||||
}),
|
||||
|
||||
name: new FSDB_INDEXER_SYMLINKS<CHANNEL>({
|
||||
name: 'name',
|
||||
get_values_to_index: (channel) => [channel.name.toLowerCase()],
|
||||
organize: by_character
|
||||
}),
|
||||
|
||||
tags: new FSDB_INDEXER_SYMLINKS<CHANNEL>({
|
||||
name: 'tags',
|
||||
get_values_to_index: (channel): string[] => {
|
||||
return (channel.tags ?? []).map((tag) => tag.toLowerCase());
|
||||
},
|
||||
to_many: true,
|
||||
organize: by_character
|
||||
})
|
||||
}
|
||||
});
|
||||
153
models/event.ts
153
models/event.ts
|
|
@ -1,4 +1,4 @@
|
|||
import { by_character, by_lurid } from '@andyburke/fsdb/organizers';
|
||||
import { by_lurid } from '@andyburke/fsdb/organizers';
|
||||
import { FSDB_COLLECTION } from '@andyburke/fsdb';
|
||||
import { FSDB_INDEXER_SYMLINKS } from '@andyburke/fsdb/indexers';
|
||||
import { EMOJIS } from '../public/js/emojis/en.ts';
|
||||
|
|
@ -16,7 +16,9 @@ import { EMOJIS } from '../public/js/emojis/en.ts';
|
|||
* @property {string} creator_id - id of the source user
|
||||
* @property {string} type - event type
|
||||
* @property {string} [parent_id] - optional parent event id
|
||||
* @property {string[]} [tags] - optional event tags
|
||||
* @property {string} [channel] - optional channel
|
||||
* @property {string} [topic] - optional topic
|
||||
* @property {string[]} [tags] - optional tags
|
||||
* @property {Record<string,any>} [data] - optional data payload of the event
|
||||
* @property {TIMESTAMPS} timestamps - timestamps that will be set by the server
|
||||
*/
|
||||
|
|
@ -25,6 +27,8 @@ export type EVENT = {
|
|||
creator_id: string;
|
||||
type: string;
|
||||
parent_id?: string;
|
||||
channel?: string;
|
||||
topic?: string;
|
||||
tags?: string[];
|
||||
data?: Record<string, any>;
|
||||
timestamps: {
|
||||
|
|
@ -33,11 +37,6 @@ export type EVENT = {
|
|||
};
|
||||
};
|
||||
|
||||
type TOPIC_EVENT_CACHE_ENTRY = {
|
||||
collection: FSDB_COLLECTION<EVENT>;
|
||||
eviction_timeout: number;
|
||||
};
|
||||
|
||||
// TODO: separate out these different validators somewhere?
|
||||
export function VALIDATE_EVENT(event: EVENT) {
|
||||
const errors: any[] = [];
|
||||
|
|
@ -111,6 +110,8 @@ export function VALIDATE_EVENT(event: EVENT) {
|
|||
});
|
||||
}
|
||||
break;
|
||||
case 'presence':
|
||||
break;
|
||||
case 'reaction':
|
||||
if (typeof event.parent_id !== 'string') {
|
||||
errors.push({
|
||||
|
|
@ -148,78 +149,76 @@ export function VALIDATE_EVENT(event: EVENT) {
|
|||
return errors.length ? errors : undefined;
|
||||
}
|
||||
|
||||
const TOPIC_EVENT_ID_MATCHER = /^(?<event_type>.*):(?<event_id>.*)$/;
|
||||
const EVENT_ID_EXTRACTOR = /^(?<event_type>.*):(?<event_id>.*)$/;
|
||||
|
||||
const TOPIC_EVENTS: Record<string, TOPIC_EVENT_CACHE_ENTRY> = {};
|
||||
export function get_events_collection_for_topic(topic_id: string): FSDB_COLLECTION<EVENT> {
|
||||
TOPIC_EVENTS[topic_id] = TOPIC_EVENTS[topic_id] ?? {
|
||||
collection: new FSDB_COLLECTION<EVENT>({
|
||||
name: `topics/${topic_id.slice(0, 14)}/${topic_id.slice(0, 34)}/${topic_id}/events`,
|
||||
id_field: 'id',
|
||||
organize: (id) => {
|
||||
TOPIC_EVENT_ID_MATCHER.lastIndex = 0;
|
||||
|
||||
const groups: Record<string, string> | undefined = TOPIC_EVENT_ID_MATCHER.exec(id ?? '')?.groups;
|
||||
|
||||
if (!groups) {
|
||||
throw new Error('Could not parse event id: ' + id);
|
||||
}
|
||||
|
||||
const event_type = groups.event_type;
|
||||
const event_id = groups.event_id;
|
||||
|
||||
return [
|
||||
event_type,
|
||||
event_id.slice(0, 14),
|
||||
event_id.slice(0, 34),
|
||||
event_id,
|
||||
`${event_id}.json` /* TODO: this should be ${id}.json - need to write a converter */
|
||||
];
|
||||
},
|
||||
indexers: {
|
||||
creator_id: new FSDB_INDEXER_SYMLINKS<EVENT>({
|
||||
name: 'creator_id',
|
||||
field: 'creator_id',
|
||||
to_many: true,
|
||||
organize: by_lurid
|
||||
}),
|
||||
|
||||
parent_id: new FSDB_INDEXER_SYMLINKS<EVENT>({
|
||||
name: 'parent_id',
|
||||
field: 'parent_id',
|
||||
to_many: true,
|
||||
organize: by_lurid
|
||||
}),
|
||||
|
||||
tags: new FSDB_INDEXER_SYMLINKS<EVENT>({
|
||||
name: 'tags',
|
||||
get_values_to_index: (event: EVENT): string[] => {
|
||||
return (event.tags ?? []).map((tag: string) => tag.toLowerCase());
|
||||
},
|
||||
to_many: true,
|
||||
organize: by_character
|
||||
})
|
||||
}
|
||||
}),
|
||||
eviction_timeout: 0
|
||||
};
|
||||
|
||||
if (TOPIC_EVENTS[topic_id].eviction_timeout) {
|
||||
clearTimeout(TOPIC_EVENTS[topic_id].eviction_timeout);
|
||||
}
|
||||
|
||||
TOPIC_EVENTS[topic_id].eviction_timeout = setTimeout(() => {
|
||||
delete TOPIC_EVENTS[topic_id];
|
||||
}, 60_000 * 5);
|
||||
|
||||
return TOPIC_EVENTS[topic_id].collection;
|
||||
function smart_event_id_organizer(id: string) {
|
||||
const [event_type, event_id] = id.split(':', 2);
|
||||
const event_dirs = by_lurid(event_id).slice(0, -1);
|
||||
return [event_type, ...event_dirs, `${id}.json`];
|
||||
}
|
||||
|
||||
export function clear_topic_events_cache() {
|
||||
for (const [topic_id, cached] of Object.entries(TOPIC_EVENTS)) {
|
||||
if (cached.eviction_timeout) {
|
||||
clearTimeout(cached.eviction_timeout);
|
||||
export const EVENTS = new FSDB_COLLECTION<EVENT>({
|
||||
name: `events`,
|
||||
id_field: 'id',
|
||||
organize: (id) => {
|
||||
EVENT_ID_EXTRACTOR.lastIndex = 0;
|
||||
|
||||
const groups: Record<string, string> | undefined = EVENT_ID_EXTRACTOR.exec(id ?? '')?.groups;
|
||||
|
||||
if (!groups) {
|
||||
throw new Error('Could not parse event id: ' + id);
|
||||
}
|
||||
delete TOPIC_EVENTS[topic_id];
|
||||
|
||||
const event_type = groups.event_type;
|
||||
const event_id = groups.event_id;
|
||||
|
||||
return [
|
||||
event_type,
|
||||
event_id.slice(0, 14),
|
||||
event_id.slice(0, 34),
|
||||
event_id,
|
||||
`${id}.json`
|
||||
];
|
||||
},
|
||||
indexers: {
|
||||
creator_id: new FSDB_INDEXER_SYMLINKS<EVENT>({
|
||||
name: 'creator_id',
|
||||
field: 'creator_id',
|
||||
to_many: true,
|
||||
organize: by_lurid
|
||||
}),
|
||||
|
||||
parent_id: new FSDB_INDEXER_SYMLINKS<EVENT>({
|
||||
name: 'parent_id',
|
||||
field: 'parent_id',
|
||||
to_many: true,
|
||||
organize: smart_event_id_organizer
|
||||
}),
|
||||
|
||||
channel: new FSDB_INDEXER_SYMLINKS<EVENT>({
|
||||
name: 'channel',
|
||||
field: 'channel',
|
||||
to_many: true,
|
||||
organize: (channel: string) => [channel],
|
||||
organize_id: smart_event_id_organizer
|
||||
}),
|
||||
|
||||
topic: new FSDB_INDEXER_SYMLINKS<EVENT>({
|
||||
name: 'topic',
|
||||
field: 'topic',
|
||||
to_many: true,
|
||||
organize: (topic: string) => [topic],
|
||||
organize_id: smart_event_id_organizer
|
||||
}),
|
||||
|
||||
tags: new FSDB_INDEXER_SYMLINKS<EVENT>({
|
||||
name: 'tags',
|
||||
get_values_to_index: (event: EVENT): string[] => {
|
||||
return (event.tags ?? []).map((tag: string) => tag.toLowerCase());
|
||||
},
|
||||
to_many: true,
|
||||
organize: (tag: string) => tag.length > 3 ? [tag.substring(0, 3), tag] : [tag],
|
||||
organize_id: smart_event_id_organizer
|
||||
})
|
||||
}
|
||||
}
|
||||
});
|
||||
|
|
|
|||
|
|
@ -1,87 +0,0 @@
|
|||
import { by_character, by_lurid } from '@andyburke/fsdb/organizers';
|
||||
import { FSDB_COLLECTION } from '@andyburke/fsdb';
|
||||
import { FSDB_INDEXER_SYMLINKS } from '@andyburke/fsdb/indexers';
|
||||
|
||||
/**
|
||||
* @typedef {object} TOPIC_PERMISSIONS
|
||||
* @property {string[]} read a list of user_ids with read permission for the topic
|
||||
* @property {string[]} write a list of user_ids with write permission for the topic
|
||||
* @property {string[]} read_events a list of user_ids with read_events permission for this topic
|
||||
* @property {string[]} write_events a list of user_ids with write_events permission for this topic
|
||||
*/
|
||||
|
||||
/**
|
||||
* TOPIC
|
||||
*
|
||||
* @property {string} id - lurid (stable)
|
||||
* @property {string} name - channel name (max 64 characters, unique, unstable)
|
||||
* @property {string} creator_id - user id of the topic creator
|
||||
* @property {TOPIC_PERMISSIONS} permissions - permissions setup for the topic
|
||||
* @property {string} [icon_url] - optional url for topic icon
|
||||
* @property {string} [topic] - optional topic for the topic
|
||||
* @property {string} [rules] - optional topic rules (Markdown/text)
|
||||
* @property {string[]} [tags] - optional tags for the topic
|
||||
* @property {Record<string,any>} [meta] - optional metadata about the topic
|
||||
* @property {Record<string,string>} [emojis] - optional emojis table, eg: { 'rofl': 🤣, 'blap': 'https://somewhere.someplace/image.jpg' }
|
||||
*/
|
||||
|
||||
export type TOPIC = {
|
||||
id: string;
|
||||
name: string;
|
||||
creator_id: string;
|
||||
permissions: {
|
||||
read: string[];
|
||||
write: string[];
|
||||
read_events: string[];
|
||||
write_events: string[];
|
||||
};
|
||||
icon_url?: string;
|
||||
topic?: string;
|
||||
rules?: string;
|
||||
tags?: string[];
|
||||
meta?: Record<string, any>;
|
||||
emojis?: Record<string, string>; // either: string: emoji eg: { 'rofl: 🤣, ... } or { 'rofl': 🤣, 'blap': 'https://somewhere.someplace/image.jpg' }
|
||||
timestamps: {
|
||||
created: string;
|
||||
updated: string;
|
||||
archived: string | undefined;
|
||||
};
|
||||
};
|
||||
|
||||
export const TOPICS = new FSDB_COLLECTION<TOPIC>({
|
||||
name: 'topics',
|
||||
id_field: 'id',
|
||||
organize: by_lurid,
|
||||
indexers: {
|
||||
creator_id: new FSDB_INDEXER_SYMLINKS<TOPIC>({
|
||||
name: 'creator_id',
|
||||
field: 'creator_id',
|
||||
to_many: true,
|
||||
organize: by_lurid
|
||||
}),
|
||||
|
||||
name: new FSDB_INDEXER_SYMLINKS<TOPIC>({
|
||||
name: 'name',
|
||||
get_values_to_index: (topic) => [topic.name.toLowerCase()],
|
||||
organize: by_character
|
||||
}),
|
||||
|
||||
tags: new FSDB_INDEXER_SYMLINKS<TOPIC>({
|
||||
name: 'tags',
|
||||
get_values_to_index: (topic): string[] => {
|
||||
return (topic.tags ?? []).map((tag) => tag.toLowerCase());
|
||||
},
|
||||
to_many: true,
|
||||
organize: by_character
|
||||
}),
|
||||
|
||||
topic: new FSDB_INDEXER_SYMLINKS<TOPIC>({
|
||||
name: 'topic',
|
||||
get_values_to_index: (topic): string[] => {
|
||||
return (topic.topic ?? '').split(/\W/);
|
||||
},
|
||||
to_many: true,
|
||||
organize: by_character
|
||||
})
|
||||
}
|
||||
});
|
||||
|
|
@ -2,32 +2,30 @@ import { FSDB_COLLECTION } from '@andyburke/fsdb';
|
|||
import { by_lurid } from '@andyburke/fsdb/organizers';
|
||||
import { FSDB_INDEXER_SYMLINKS } from '@andyburke/fsdb/indexers';
|
||||
|
||||
/**
|
||||
* @typedef {object} WATCH_TYPE_INFO
|
||||
* @property {boolean} ignored if true, this type should NOT produce any indications or notifications
|
||||
* @property {string} last_id_seen the last event id the user has seen for this event type
|
||||
* @property {string} last_id_notified the last event id the user was notified about for this type
|
||||
*/
|
||||
|
||||
export type WATCH_TYPE_INFO = {
|
||||
ignored: boolean;
|
||||
last_id_seen: string;
|
||||
last_id_notified: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* @typedef {object} WATCH_TIMESTAMPS
|
||||
* @property {string} created the created date of the watch
|
||||
* @property {string} updated the last updated date, usually coinciding with the last seen id being changed
|
||||
*/
|
||||
|
||||
export type WATCH_TIMESTAMPS = {
|
||||
created: string;
|
||||
updated: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* WATCH
|
||||
*
|
||||
* @property {string} id - lurid (stable)
|
||||
* @property {string} creator_id - user id of the watch creator
|
||||
* @property {string} topic_id - the topic_id being watched
|
||||
* @property {[WATCH_TYPE_INFO]} types - information for types being watched within this topic
|
||||
* @property {string} [type] - a filter for event type
|
||||
* @property {string} [parent_id] - a filter for event parent_id
|
||||
* @property {string} [channel] - a filter for event channel
|
||||
* @property {string} [topic] - a filter for event topic
|
||||
* @property {string[]} [tags] - a filter for event tags
|
||||
* @property {Record<string,any>} [data] - a filter on event data, each leaf should be a RegExp
|
||||
* @property {string} last_id_seen - the last id the user has seen for this watch
|
||||
* @property {string} [last_id_notified] - the last id the user was notified about for this watch
|
||||
* @property {Record<string,any>} [meta] - optional metadata about the watch
|
||||
* @property {WATCH_TIMESTAMPS} timestamps - timestamps for the watch
|
||||
*/
|
||||
|
|
@ -35,13 +33,16 @@ export type WATCH_TYPE_INFO = {
|
|||
export type WATCH = {
|
||||
id: string;
|
||||
creator_id: string;
|
||||
topic_id: string;
|
||||
types: [WATCH_TYPE_INFO];
|
||||
type?: string;
|
||||
parent_id?: string;
|
||||
channel?: string;
|
||||
topic?: string;
|
||||
tags?: string[];
|
||||
data?: Record<string, any>;
|
||||
last_id_seen: string;
|
||||
last_id_notified?: string;
|
||||
meta?: Record<string, any>;
|
||||
timestamps: {
|
||||
created: string;
|
||||
updated: string;
|
||||
};
|
||||
timestamps: WATCH_TIMESTAMPS;
|
||||
};
|
||||
|
||||
export const WATCHES = new FSDB_COLLECTION<WATCH>({
|
||||
|
|
@ -56,11 +57,44 @@ export const WATCHES = new FSDB_COLLECTION<WATCH>({
|
|||
organize: by_lurid
|
||||
}),
|
||||
|
||||
topic_id: new FSDB_INDEXER_SYMLINKS<WATCH>({
|
||||
name: 'topic_id',
|
||||
field: 'topic_id',
|
||||
type: new FSDB_INDEXER_SYMLINKS<WATCH>({
|
||||
name: 'type',
|
||||
field: 'type',
|
||||
to_many: true,
|
||||
organize: by_lurid
|
||||
organize: (type: string) => [type],
|
||||
organize_id: by_lurid
|
||||
}),
|
||||
|
||||
parent_id: new FSDB_INDEXER_SYMLINKS<WATCH>({
|
||||
name: 'parent_id',
|
||||
field: 'parent_id',
|
||||
to_many: true,
|
||||
organize: by_lurid,
|
||||
organize_id: by_lurid
|
||||
}),
|
||||
|
||||
channel: new FSDB_INDEXER_SYMLINKS<WATCH>({
|
||||
name: 'channel',
|
||||
field: 'channel',
|
||||
to_many: true,
|
||||
organize: (channel: string) => channel.length > 3 ? [channel.substring(0, 3), channel] : [channel],
|
||||
organize_id: by_lurid
|
||||
}),
|
||||
|
||||
topic: new FSDB_INDEXER_SYMLINKS<WATCH>({
|
||||
name: 'topic',
|
||||
field: 'topic',
|
||||
to_many: true,
|
||||
organize: (topic: string) => topic.length > 3 ? [topic.substring(0, 3), topic] : [topic],
|
||||
organize_id: by_lurid
|
||||
}),
|
||||
|
||||
tags: new FSDB_INDEXER_SYMLINKS<WATCH>({
|
||||
name: 'tags',
|
||||
field: 'tags',
|
||||
to_many: true,
|
||||
organize: (tag: string) => tag.length > 3 ? [tag.substring(0, 3), tag] : [tag],
|
||||
organize_id: by_lurid
|
||||
})
|
||||
}
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue