Events · Modules

E

3 modules · 6 exports · 0 repositories · 0 e2e tests · 2 routes

OverviewModulesPermissions

Who imports who · hover a node

EventBus

serverapp/features/events/core/EventBus.server.ts

No overview comment at the top of the file.

Imports

no other modules

Used by

2 routes1 module1 other

Functions & values

function

publish

:11

Delivers the event to every live subscriber of the channels, once each even when listening on several.

export function publish(channels: string[], event: ServerEvent): void

Unit tests (6)

• fans out to subscribers on every published channel
• delivers
  • once to a subscriber listening on several published channels
  • to every subscriber of the same channel
• does not deliver events published to other channels
• publishing to a channel with no subscribers is a no-op
• queues events for a slow consumer and delivers them in order

Routes/api/chat/rooms/:id/messages

Modulesvoice/VoicePresence.server.ts

Otherchat/ChatSystemMessage.server.ts

function

subscribe

:26

Yields the channels' events until the signal aborts (pending events dropped) or the consumer stops iterating.

export function subscribe(
	channels: string[],
	signal: AbortSignal,
): AsyncIterable<ServerEvent>

Unit tests (5)

• registers for each channel and unregisters every one on abort
• drops events still queued when the signal aborts
• unregisters when the consumer stops iterating
• completes immediately without registering for an already aborted signal
• wakes a consumer waiting for its next event

Routes/sse

Not shown, only used by tests: subscriberCount

SseConnections

serverapp/features/events/core/SseConnections.server.ts

No overview comment at the top of the file.

Imports

no other modules

Used by

2 routes

Functions & values

function

register

:9

Registers a live SSE connection so its topic set can be addressed by connection id.

export function register(connectionId: string, connection: SseConnection)

Routes/sse

function

unregister

:14

Removes a closed SSE connection from the registry.

export function unregister(connectionId: string)

Routes/sse

function

replaceTopics

:19

Replaces the connection's topic set wholesale. Returns false when the user has no live connection with the given id.

export function replaceTopics(
	connectionId: string,
	userId: number,
	topics: string[],
): boolean

Routes/sse/:connectionId/topics

TopicAccess

serverapp/features/events/core/TopicAccess.server.ts

No overview comment at the top of the file.

Imports

no other modules

Used by

1 route

Functions & values

function

canSubscribeToAll

:15

Whether the user may subscribe their SSE connection to every one of the topics. The user__ channel is never client-controllable.

export async function canSubscribeToAll(
	userId: number,
	topics: string[],
): Promise<boolean>

Unit tests (5)

• $topic -> $allowed× 8
• chat room topics › participants may subscribe to their room
• chat room topics › site staff may subscribe as observers
• chat room topics › other users may not subscribe
• chat room topics › one forbidden topic denies the whole batch

Routes/sse/:connectionId/topics