refactor: events to a pure stream instead of being part of topics

NOTE: tests are passing, but the client is broken

public/api/channels/:channel_id/README.md

@@ -0,0 +1,23 @@
+# /api/channels/:channel_id
+
+Interact with a specific channel.
+
+## GET /api/channels/:channel_id
+
+Get the channel specified by `:channel_id`.
+
+## PUT /api/channels/:channel_id
+
+Update the channels specified by `:channel_id`.
+
+Eg:
+
+```
+{
+	name?: string;
+}
+```
+
+## DELETE /api/channels/:channel_id
+
+Delete the channel specified by `:channel_id`.

public/api/channels/:channel_id/events/:event_id/index.ts

@@ -0,0 +1,40 @@
+import { EVENT, EVENTS } from '../../../../../../models/event.ts';
+import { CHANNEL, CHANNELS } from '../../../../../../models/channel.ts';
+import * as CANNED_RESPONSES from '../../../../../../utils/canned_responses.ts';
+import { get_session, get_user, PRECHECK_TABLE, require_user } from '../../../../../../utils/prechecks.ts';
+
+export const PRECHECKS: PRECHECK_TABLE = {};
+
+// GET /api/channels/:channel_id/events/:id - Get an event
+PRECHECKS.GET = [get_session, get_user, require_user, async (_req: Request, meta: Record<string, any>): Promise<Response | undefined> => {
+	const channel_id: string = meta.params?.channel_id?.toLowerCase().trim() ?? '';
+
+	// lurid is 49 chars as we use them, eg: "also-play-flow-want-form-wide-thus-work-burn-same"
+	const channel: CHANNEL | null = channel_id.length === 49 ? await CHANNELS.get(channel_id) : null;
+
+	if (!channel) {
+		return CANNED_RESPONSES.not_found();
+	}
+
+	meta.channel = channel;
+	const channel_is_public = channel.permissions.read.length === 0;
+	const user_has_read_for_channel = channel_is_public || channel.permissions.read.includes(meta.user.id);
+	const channel_has_public_events = user_has_read_for_channel && (channel.permissions.events.read.length === 0);
+	const user_has_read_events_for_channel = user_has_read_for_channel &&
+		(channel_has_public_events || channel.permissions.events.read.includes(meta.user.id));
+
+	if (!user_has_read_events_for_channel) {
+		return CANNED_RESPONSES.permission_denied();
+	}
+}];
+export async function GET(_req: Request, meta: Record<string, any>): Promise<Response> {
+	const event: EVENT | null = await EVENTS.get(meta.params.event_id);
+
+	if (!event) {
+		return CANNED_RESPONSES.not_found();
+	}
+
+	return Response.json(event, {
+		status: 200
+	});
+}

public/api/channels/:channel_id/events/index.ts

@@ -0,0 +1,134 @@
+import { get_session, get_user, PRECHECK_TABLE, require_user } from '../../../../../utils/prechecks.ts';
+import { CHANNEL, CHANNELS } from '../../../../../models/channel.ts';
+import * as CANNED_RESPONSES from '../../../../../utils/canned_responses.ts';
+import { EVENT, EVENTS } from '../../../../../models/event.ts';
+import { FSDB_SEARCH_OPTIONS, WALK_ENTRY } from '@andyburke/fsdb';
+
+export const PRECHECKS: PRECHECK_TABLE = {};
+
+// GET /api/channels/:channel_id/events - get channel events
+// query parameters:
+//   partial_id: the partial id subset you would like to match (remember, lurids are lexigraphically sorted)
+PRECHECKS.GET = [get_session, get_user, require_user, async (_req: Request, meta: Record<string, any>): Promise<Response | undefined> => {
+	const channel_id: string = meta.params?.channel_id?.toLowerCase().trim() ?? '';
+
+	// lurid is 49 chars as we use them, eg: "also-play-flow-want-form-wide-thus-work-burn-same"
+	const channel: CHANNEL | null = channel_id.length === 49 ? await CHANNELS.get(channel_id) : null;
+
+	if (!channel) {
+		return CANNED_RESPONSES.not_found();
+	}
+
+	meta.channel = channel;
+
+	const channel_is_public: boolean = meta.channel.permissions.read.length === 0;
+	const user_has_read_for_channel = channel_is_public || meta.channel.permissions.read.includes(meta.user.id);
+
+	if (!user_has_read_for_channel) {
+		return CANNED_RESPONSES.permission_denied();
+	}
+}];
+export async function GET(request: Request, meta: Record<string, any>): Promise<Response> {
+	const sorts = EVENTS.sorts;
+	const sort_name: string = meta.query.sort ?? 'newest';
+	const key = sort_name as keyof typeof sorts;
+	const sort: any = sorts[key];
+	if (!sort) {
+		return Response.json({
+			error: {
+				message: 'You must specify a sort: newest, oldest, latest, stalest',
+				cause: 'invalid_sort'
+			}
+		}, {
+			status: 400
+		});
+	}
+
+	const options: FSDB_SEARCH_OPTIONS<EVENT> = {
+		...(meta.query ?? {}),
+		limit: Math.min(parseInt(meta.query?.limit ?? '10', 10), 1_000),
+		offset: Math.max(parseInt(meta.query?.offset ?? '0', 10), 0),
+		sort,
+		filter: (entry: WALK_ENTRY<EVENT>) => {
+			const {
+				event_type,
+				event_id
+			} = /^.*\/(?<event_type>.*?):(?<event_id>[A-Za-z-]+)\.json$/.exec(entry.path)?.groups ?? {};
+
+			if (meta.query.after_id && event_id <= meta.query.after_id) {
+				return false;
+			}
+
+			if (meta.query.before_id && event_id >= meta.query.before_id) {
+				return false;
+			}
+
+			if (meta.query.type && !meta.query.type.split(',').includes(event_type)) {
+				return false;
+			}
+
+			return true;
+		}
+	};
+
+	const headers = {
+		'Cache-Control': 'no-cache, must-revalidate'
+	};
+
+	const results = (await EVENTS.find({
+		channel: meta.channel.id
+	}, options))
+		.map((entry: WALK_ENTRY<EVENT>) => entry.load())
+		.sort((lhs_item: EVENT, rhs_item: EVENT) => rhs_item.timestamps.created.localeCompare(lhs_item.timestamps.created));
+
+	// long-polling support
+	if (results.length === 0 && meta.query.wait) {
+		return new Promise((resolve, reject) => {
+			function on_create(create_event: any) {
+				if (create_event.item.channel !== meta.channel.id) {
+					return;
+				}
+
+				if (meta.query.type && !meta.query.type.split(',').includes(create_event.item.type)) {
+					return;
+				}
+
+				results.push(create_event.item);
+				clearTimeout(timeout);
+				EVENTS.off('create', on_create);
+
+				return resolve(Response.json(results, {
+					status: 200,
+					headers
+				}));
+			}
+
+			const timeout = setTimeout(() => {
+				EVENTS.off('create', on_create);
+				return resolve(Response.json(results, {
+					status: 200,
+					headers
+				}));
+			}, 60_000); // 60 seconds
+			EVENTS.on('create', on_create);
+			request.signal.addEventListener('abort', () => {
+				EVENTS.off('create', on_create);
+				clearTimeout(timeout);
+				reject(new Error('request aborted'));
+			});
+			Deno.addSignalListener('SIGINT', () => {
+				EVENTS.off('create', on_create);
+				clearTimeout(timeout);
+				return resolve(Response.json(results, {
+					status: 200,
+					headers
+				}));
+			});
+		});
+	}
+
+	return Response.json(results, {
+		status: 200,
+		headers
+	});
+}

public/api/channels/:channel_id/index.ts

@@ -0,0 +1,113 @@
+import { get_session, get_user, PRECHECK_TABLE, require_user } from '../../../../utils/prechecks.ts';
+import parse_body from '../../../../utils/bodyparser.ts';
+import * as CANNED_RESPONSES from '../../../../utils/canned_responses.ts';
+import { CHANNEL, CHANNELS } from '../../../../models/channel.ts';
+
+export const PRECHECKS: PRECHECK_TABLE = {};
+
+// GET /api/channels/:id - Get a channel
+PRECHECKS.GET = [get_session, get_user, require_user, async (_req: Request, meta: Record<string, any>): Promise<Response | undefined> => {
+	const channel_id: string = meta.params?.channel_id?.toLowerCase().trim() ?? '';
+
+	// lurid is 49 chars as we use them, eg: "also-play-flow-want-form-wide-thus-work-burn-same"
+	const channel: CHANNEL | null = channel_id.length === 49 ? await CHANNELS.get(channel_id) : null;
+
+	if (!channel) {
+		return CANNED_RESPONSES.not_found();
+	}
+
+	meta.channel = channel;
+	const channel_is_public = channel.permissions.read.length === 0;
+	const user_has_read_for_channel = channel_is_public || channel.permissions.read.includes(meta.user.id);
+
+	if (!user_has_read_for_channel) {
+		return CANNED_RESPONSES.permission_denied();
+	}
+}];
+export function GET(_req: Request, meta: Record<string, any>): Response {
+	return Response.json(meta.channel, {
+		status: 200
+	});
+}
+
+// PUT /api/channels/:id - Update channel
+PRECHECKS.PUT = [get_session, get_user, require_user, async (_req: Request, meta: Record<string, any>): Promise<Response | undefined> => {
+	const channel_id: string = meta.params?.channel_id?.toLowerCase().trim() ?? '';
+
+	// lurid is 49 chars as we use them, eg: "also-play-flow-want-form-wide-thus-work-burn-same"
+	const channel: CHANNEL | null = channel_id.length === 49 ? await CHANNELS.get(channel_id) : null;
+
+	if (!channel) {
+		return CANNED_RESPONSES.not_found();
+	}
+
+	meta.channel = channel;
+	const user_has_write_for_channel = channel.permissions.write.includes(meta.user.id);
+
+	if (!user_has_write_for_channel) {
+		return CANNED_RESPONSES.permission_denied();
+	}
+}];
+export async function PUT(req: Request, meta: Record<string, any>): Promise<Response> {
+	const now = new Date().toISOString();
+
+	try {
+		const body = await parse_body(req);
+		const updated = {
+			...meta.channel,
+			...body,
+			id: meta.channel.id,
+			timestamps: {
+				created: meta.channel.timestamps.created,
+				updated: now
+			}
+		};
+
+		await CHANNELS.update(updated);
+		return Response.json(updated, {
+			status: 200
+		});
+	} catch (err) {
+		return Response.json({
+			error: {
+				message: (err as Error)?.message ?? 'Unknown error due to invalid data.',
+				cause: (err as Error)?.cause ?? 'invalid_data'
+			}
+		}, {
+			status: 400
+		});
+	}
+}
+
+// DELETE /api/channels/:id - Delete channel
+PRECHECKS.DELETE = [
+	get_session,
+	get_user,
+	require_user,
+	async (_req: Request, meta: Record<string, any>): Promise<Response | undefined> => {
+		const channel_id: string = meta.params?.channel_id?.toLowerCase().trim() ?? '';
+
+		// lurid is 49 chars as we use them, eg: "also-play-flow-want-form-wide-thus-work-burn-same"
+		const channel: CHANNEL | null = channel_id.length === 49 ? await CHANNELS.get(channel_id) : null;
+
+		if (!channel) {
+			return CANNED_RESPONSES.not_found();
+		}
+
+		meta.channel = channel;
+		const user_has_write_for_channel = channel.permissions.write.includes(meta.user.id);
+
+		if (!user_has_write_for_channel) {
+			return CANNED_RESPONSES.permission_denied();
+		}
+	}
+];
+export async function DELETE(_req: Request, meta: Record<string, any>): Promise<Response> {
+	await CHANNELS.delete(meta.channel);
+
+	return Response.json({
+		deleted: true
+	}, {
+		status: 200
+	});
+}

public/api/channels/index.ts

@@ -0,0 +1,113 @@
+import lurid from '@andyburke/lurid';
+import parse_body from '../../../utils/bodyparser.ts';
+import { get_session, get_user, require_user } from '../../../utils/prechecks.ts';
+import * as CANNED_RESPONSES from '../../../utils/canned_responses.ts';
+import { PRECHECK_TABLE } from '../../../utils/prechecks.ts';
+import { CHANNEL, CHANNELS } from '../../../models/channel.ts';
+
+export const PRECHECKS: PRECHECK_TABLE = {};
+
+// GET /api/channels - get channels
+PRECHECKS.GET = [get_session, get_user, require_user, (_req: Request, meta: Record<string, any>): Response | undefined => {
+	const can_read_channels = meta.user.permissions.includes('channels.read');
+
+	if (!can_read_channels) {
+		return CANNED_RESPONSES.permission_denied();
+	}
+}];
+export async function GET(_req: Request, meta: Record<string, any>): Promise<Response> {
+	const limit = Math.min(parseInt(meta.query.limit ?? '100'), 100);
+	const channels = (await CHANNELS.all({
+		limit
+	})).map((topic_entry) => topic_entry.load());
+
+	return Response.json(channels, {
+		status: 200
+	});
+}
+
+// POST /api/channels - Create a channel
+PRECHECKS.POST = [get_session, get_user, require_user, (_req: Request, meta: Record<string, any>): Response | undefined => {
+	const can_create_channels = meta.user.permissions.includes('channels.create');
+
+	if (!can_create_channels) {
+		return CANNED_RESPONSES.permission_denied();
+	}
+}];
+export async function POST(req: Request, meta: Record<string, any>): Promise<Response> {
+	try {
+		const now = new Date().toISOString();
+
+		const body = await parse_body(req);
+
+		if (typeof body.name !== 'string' || body.name.length === 0) {
+			return Response.json({
+				error: {
+					cause: 'missing_channel_name',
+					message: 'You must specify a unique name for a channel.'
+				}
+			}, {
+				status: 400
+			});
+		}
+
+		if (body.name.length > 64) {
+			return Response.json({
+				error: {
+					cause: 'invalid_channel_name',
+					message: 'channel names must be 64 characters or fewer.'
+				}
+			}, {
+				status: 400
+			});
+		}
+
+		const normalized_name = body.name.toLowerCase();
+
+		const existing_channel = (await CHANNELS.find({
+			name: normalized_name
+		})).shift();
+		if (existing_channel) {
+			return Response.json({
+				error: {
+					cause: 'channel_name_conflict',
+					message: 'There is already a channel with this name.'
+				}
+			}, {
+				status: 400
+			});
+		}
+
+		const channel: CHANNEL = {
+			...body,
+			id: lurid(),
+			creator_id: meta.user.id,
+			permissions: {
+				read: (body.permissions?.read ?? []),
+				write: (body.permissions?.write ?? [meta.user.id]),
+				events: {
+					read: (body.permissions?.events?.read ?? []),
+					write: (body.permissions?.events?.write ?? [])
+				}
+			},
+			timestamps: {
+				created: now,
+				updated: now,
+				archived: undefined
+			}
+		};
+
+		await CHANNELS.create(channel);
+
+		return Response.json(channel, {
+			status: 201
+		});
+	} catch (error) {
+		return Response.json({
+			error: {
+				message: (error as Error).message ?? 'Unknown Error!',
+				cause: (error as Error).cause ?? 'unknown'
+			}
+		}, { status: 500 });
+	}
+}