Feat/messaging ui foundation #11
@@ -5,7 +5,7 @@ import { MessageGateway } from './message.gateway';
|
|||||||
import type { MessageService, MessagePrincipal } from './message.service';
|
import type { MessageService, MessagePrincipal } from './message.service';
|
||||||
import { SessionVerifier } from '../platform/session.verifier';
|
import { SessionVerifier } from '../platform/session.verifier';
|
||||||
import type { OutboxBus } from '../outbox/outbox.bus';
|
import type { OutboxBus } from '../outbox/outbox.bus';
|
||||||
import type { PresenceService } from '../notifications/presence.service';
|
import type { PresencePort } from '../notifications/presence.port';
|
||||||
|
|
||||||
// Realtime delegation: the browser opens the socket with a short-lived token minted for the
|
// Realtime delegation: the browser opens the socket with a short-lived token minted for the
|
||||||
// realtime audience (iios-message). When IIOS_REALTIME_AUDIENCE is set, the gateway accepts ONLY
|
// realtime audience (iios-message). When IIOS_REALTIME_AUDIENCE is set, the gateway accepts ONLY
|
||||||
@@ -54,7 +54,7 @@ function gatewayReturning(principal: MessagePrincipal): MessageGateway {
|
|||||||
undefined as unknown as MessageService,
|
undefined as unknown as MessageService,
|
||||||
session,
|
session,
|
||||||
undefined as unknown as OutboxBus,
|
undefined as unknown as OutboxBus,
|
||||||
undefined as unknown as PresenceService,
|
undefined as unknown as PresencePort,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import { randomUUID } from 'node:crypto';
|
import { randomUUID } from 'node:crypto';
|
||||||
import { Logger } from '@nestjs/common';
|
import { Inject, Logger } from '@nestjs/common';
|
||||||
import {
|
import {
|
||||||
ConnectedSocket,
|
ConnectedSocket,
|
||||||
MessageBody,
|
MessageBody,
|
||||||
@@ -16,7 +16,7 @@ import { logJson } from '../observability/logger';
|
|||||||
import { MessageService, type MessagePrincipal } from './message.service';
|
import { MessageService, type MessagePrincipal } from './message.service';
|
||||||
import { SessionVerifier } from '../platform/session.verifier';
|
import { SessionVerifier } from '../platform/session.verifier';
|
||||||
import { OutboxBus } from '../outbox/outbox.bus';
|
import { OutboxBus } from '../outbox/outbox.bus';
|
||||||
import { PresenceService } from '../notifications/presence.service';
|
import { PRESENCE_PORT, type PresencePort } from '../notifications/presence.port';
|
||||||
|
|
||||||
interface SocketState {
|
interface SocketState {
|
||||||
principal: MessagePrincipal;
|
principal: MessagePrincipal;
|
||||||
@@ -39,7 +39,7 @@ export class MessageGateway implements OnGatewayInit, OnGatewayConnection, OnGat
|
|||||||
private readonly messages: MessageService,
|
private readonly messages: MessageService,
|
||||||
private readonly session: SessionVerifier,
|
private readonly session: SessionVerifier,
|
||||||
private readonly bus: OutboxBus,
|
private readonly bus: OutboxBus,
|
||||||
private readonly presence: PresenceService,
|
@Inject(PRESENCE_PORT) private readonly presence: PresencePort,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
afterInit(): void {
|
afterInit(): void {
|
||||||
@@ -77,7 +77,8 @@ export class MessageGateway implements OnGatewayInit, OnGatewayConnection, OnGat
|
|||||||
}
|
}
|
||||||
|
|
||||||
handleDisconnect(client: Socket): void {
|
handleDisconnect(client: Socket): void {
|
||||||
this.presence.clearSocket(client.id);
|
// Fire-and-forget: presence is best-effort and must not block the disconnect path.
|
||||||
|
void this.presence.clearSocket(client.id).catch((err) => this.logger.warn(`presence clear failed: ${(err as Error).message}`));
|
||||||
}
|
}
|
||||||
|
|
||||||
/** The app reports which thread is in the foreground (or null when blurred) — presence. */
|
/** The app reports which thread is in the foreground (or null when blurred) — presence. */
|
||||||
@@ -85,7 +86,9 @@ export class MessageGateway implements OnGatewayInit, OnGatewayConnection, OnGat
|
|||||||
focusThread(@ConnectedSocket() client: Socket, @MessageBody() body: { threadId: string | null }): void {
|
focusThread(@ConnectedSocket() client: Socket, @MessageBody() body: { threadId: string | null }): void {
|
||||||
const state = client.data as SocketState | undefined;
|
const state = client.data as SocketState | undefined;
|
||||||
if (!state?.principal) return;
|
if (!state?.principal) return;
|
||||||
this.presence.setFocus(client.id, state.principal.userId, body?.threadId ?? null);
|
void this.presence
|
||||||
|
.setFocus(client.id, state.principal.userId, body?.threadId ?? null)
|
||||||
|
.catch((err) => this.logger.warn(`presence set failed: ${(err as Error).message}`));
|
||||||
}
|
}
|
||||||
|
|
||||||
@SubscribeMessage('open_thread')
|
@SubscribeMessage('open_thread')
|
||||||
|
|||||||
@@ -3,10 +3,21 @@ import { MessageService } from './message.service';
|
|||||||
import { MessageGateway } from './message.gateway';
|
import { MessageGateway } from './message.gateway';
|
||||||
import { OutboxModule } from '../outbox/outbox.module';
|
import { OutboxModule } from '../outbox/outbox.module';
|
||||||
import { PresenceService } from '../notifications/presence.service';
|
import { PresenceService } from '../notifications/presence.service';
|
||||||
|
import { RedisPresenceService } from '../notifications/redis-presence.service';
|
||||||
|
import { PRESENCE_PORT } from '../notifications/presence.port';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* PRESENCE_PORT is single-instance in-memory by default; with REDIS_URL set it's Redis-backed so
|
||||||
|
* "who is viewing what" is shared across replicas (mirrors the socket.io Redis adapter gating).
|
||||||
|
*/
|
||||||
|
const presenceProvider = {
|
||||||
|
provide: PRESENCE_PORT,
|
||||||
|
useFactory: () => (process.env.REDIS_URL ? new RedisPresenceService(process.env.REDIS_URL) : new PresenceService()),
|
||||||
|
};
|
||||||
|
|
||||||
@Module({
|
@Module({
|
||||||
imports: [OutboxModule],
|
imports: [OutboxModule],
|
||||||
providers: [MessageService, MessageGateway, PresenceService],
|
providers: [MessageService, MessageGateway, presenceProvider],
|
||||||
exports: [MessageService, PresenceService],
|
exports: [MessageService, PRESENCE_PORT],
|
||||||
})
|
})
|
||||||
export class MessageModule {}
|
export class MessageModule {}
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import { PrismaService } from '../prisma/prisma.service';
|
|||||||
import { OutboxBus } from '../outbox/outbox.bus';
|
import { OutboxBus } from '../outbox/outbox.bus';
|
||||||
import { DlqService } from '../outbox/dlq.service';
|
import { DlqService } from '../outbox/dlq.service';
|
||||||
import { ProjectionCursorService } from '../projection/projection-cursor.service';
|
import { ProjectionCursorService } from '../projection/projection-cursor.service';
|
||||||
import { PresenceService } from './presence.service';
|
import { PRESENCE_PORT, type PresencePort } from './presence.port';
|
||||||
import { NOTIFICATION_PORT, type NotificationPort } from './notification.port';
|
import { NOTIFICATION_PORT, type NotificationPort } from './notification.port';
|
||||||
|
|
||||||
interface MsgData {
|
interface MsgData {
|
||||||
@@ -40,7 +40,7 @@ export class NotificationProjector implements OnModuleInit {
|
|||||||
private readonly bus: OutboxBus,
|
private readonly bus: OutboxBus,
|
||||||
private readonly dlq: DlqService,
|
private readonly dlq: DlqService,
|
||||||
private readonly cursor: ProjectionCursorService,
|
private readonly cursor: ProjectionCursorService,
|
||||||
private readonly presence: PresenceService,
|
@Inject(PRESENCE_PORT) private readonly presence: PresencePort,
|
||||||
@Inject(NOTIFICATION_PORT) private readonly port: NotificationPort,
|
@Inject(NOTIFICATION_PORT) private readonly port: NotificationPort,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
@@ -123,7 +123,7 @@ export class NotificationProjector implements OnModuleInit {
|
|||||||
if (!(alwaysNotify || mentioned || repliedToMe)) continue;
|
if (!(alwaysNotify || mentioned || repliedToMe)) continue;
|
||||||
|
|
||||||
// gate 2 — presence
|
// gate 2 — presence
|
||||||
if (userId && this.presence.isViewing(userId, data.threadId)) continue;
|
if (userId && (await this.presence.isViewing(userId, data.threadId))) continue;
|
||||||
|
|
||||||
// gate 3 — mute
|
// gate 3 — mute
|
||||||
if (p.muted) continue;
|
if (p.muted) continue;
|
||||||
|
|||||||
@@ -0,0 +1,15 @@
|
|||||||
|
/**
|
||||||
|
* Presence seam: tracks which thread each socket has in the foreground so the notification
|
||||||
|
* projector can suppress push for a thread the recipient is actively viewing. Async so it can be
|
||||||
|
* backed by Redis across replicas (prod) or an in-memory Map on a single instance (dev).
|
||||||
|
*/
|
||||||
|
export interface PresencePort {
|
||||||
|
/** Record a socket's foregrounded thread (null when the window is blurred / no thread open). */
|
||||||
|
setFocus(socketId: string, userId: string, threadId: string | null): Promise<void>;
|
||||||
|
/** Forget everything about a socket (on disconnect). */
|
||||||
|
clearSocket(socketId: string): Promise<void>;
|
||||||
|
/** True if ANY of the user's sockets currently has this thread in the foreground. */
|
||||||
|
isViewing(userId: string, threadId: string): Promise<boolean>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const PRESENCE_PORT = Symbol('PRESENCE_PORT');
|
||||||
@@ -2,23 +2,23 @@ import { describe, it, expect } from 'vitest';
|
|||||||
import { PresenceService } from './presence.service';
|
import { PresenceService } from './presence.service';
|
||||||
|
|
||||||
describe('PresenceService', () => {
|
describe('PresenceService', () => {
|
||||||
it('reports viewing only for the focused thread, and clears on disconnect', () => {
|
it('reports viewing only for the focused thread, and clears on disconnect', async () => {
|
||||||
const p = new PresenceService();
|
const p = new PresenceService();
|
||||||
expect(p.isViewing('alice', 'T1')).toBe(false);
|
expect(await p.isViewing('alice', 'T1')).toBe(false);
|
||||||
p.setFocus('sock1', 'alice', 'T1');
|
await p.setFocus('sock1', 'alice', 'T1');
|
||||||
expect(p.isViewing('alice', 'T1')).toBe(true);
|
expect(await p.isViewing('alice', 'T1')).toBe(true);
|
||||||
expect(p.isViewing('alice', 'T2')).toBe(false); // joined-elsewhere ≠ viewing
|
expect(await p.isViewing('alice', 'T2')).toBe(false); // joined-elsewhere ≠ viewing
|
||||||
p.setFocus('sock1', 'alice', 'T2'); // moved focus
|
await p.setFocus('sock1', 'alice', 'T2'); // moved focus
|
||||||
expect(p.isViewing('alice', 'T1')).toBe(false);
|
expect(await p.isViewing('alice', 'T1')).toBe(false);
|
||||||
expect(p.isViewing('alice', 'T2')).toBe(true);
|
expect(await p.isViewing('alice', 'T2')).toBe(true);
|
||||||
p.clearSocket('sock1');
|
await p.clearSocket('sock1');
|
||||||
expect(p.isViewing('alice', 'T2')).toBe(false);
|
expect(await p.isViewing('alice', 'T2')).toBe(false);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('any of the actor’s sockets counts as viewing', () => {
|
it('any of the actor’s sockets counts as viewing', async () => {
|
||||||
const p = new PresenceService();
|
const p = new PresenceService();
|
||||||
p.setFocus('sockA', 'bob', 'T9');
|
await p.setFocus('sockA', 'bob', 'T9');
|
||||||
p.setFocus('sockB', 'bob', null); // a second tab, no focus
|
await p.setFocus('sockB', 'bob', null); // a second tab, no focus
|
||||||
expect(p.isViewing('bob', 'T9')).toBe(true);
|
expect(await p.isViewing('bob', 'T9')).toBe(true);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,24 +1,28 @@
|
|||||||
import { Injectable } from '@nestjs/common';
|
import { Injectable } from '@nestjs/common';
|
||||||
|
import type { PresencePort } from './presence.port';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* In-memory focus tracker (single instance). Keyed on userId (the stable externalId the
|
* In-memory focus tracker (single instance). Keyed on userId (the stable externalId the
|
||||||
* gateway has as principal.userId). NOTE: room membership ≠ viewing — the sidebar joins
|
* gateway has as principal.userId). NOTE: room membership ≠ viewing — the sidebar joins
|
||||||
* every thread room for live updates, so presence uses an explicit `focus_thread` signal.
|
* every thread room for live updates, so presence uses an explicit `focus_thread` signal.
|
||||||
* Prod (multi-replica): back this with Redis.
|
* Multi-replica prod uses {@link RedisPresenceService} instead (wired when REDIS_URL is set).
|
||||||
|
*
|
||||||
|
* Methods are async to satisfy the PresencePort seam; the map is mutated synchronously, so an
|
||||||
|
* un-awaited setFocus is still visible to an immediately-following isViewing.
|
||||||
*/
|
*/
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class PresenceService {
|
export class PresenceService implements PresencePort {
|
||||||
private readonly focus = new Map<string, { userId: string; threadId: string | null }>(); // socketId → focus
|
private readonly focus = new Map<string, { userId: string; threadId: string | null }>(); // socketId → focus
|
||||||
|
|
||||||
setFocus(socketId: string, userId: string, threadId: string | null): void {
|
async setFocus(socketId: string, userId: string, threadId: string | null): Promise<void> {
|
||||||
this.focus.set(socketId, { userId, threadId });
|
this.focus.set(socketId, { userId, threadId });
|
||||||
}
|
}
|
||||||
|
|
||||||
clearSocket(socketId: string): void {
|
async clearSocket(socketId: string): Promise<void> {
|
||||||
this.focus.delete(socketId);
|
this.focus.delete(socketId);
|
||||||
}
|
}
|
||||||
|
|
||||||
isViewing(userId: string, threadId: string): boolean {
|
async isViewing(userId: string, threadId: string): Promise<boolean> {
|
||||||
for (const f of this.focus.values()) if (f.userId === userId && f.threadId === threadId) return true;
|
for (const f of this.focus.values()) if (f.userId === userId && f.threadId === threadId) return true;
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,64 @@
|
|||||||
|
import { Logger, type OnModuleDestroy } from '@nestjs/common';
|
||||||
|
import { Redis } from 'ioredis';
|
||||||
|
import type { PresencePort } from './presence.port';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Redis-backed presence for multi-replica prod: a socket connected to replica A and a message
|
||||||
|
* projected on replica B must share the same "who is viewing what" view, which an in-memory Map
|
||||||
|
* cannot provide. Wired (in place of {@link PresenceService}) only when REDIS_URL is set.
|
||||||
|
*
|
||||||
|
* Layout (per user, tiny):
|
||||||
|
* sock:{socketId} -> userId (so clearSocket can find the user), EX TTL
|
||||||
|
* user:{userId} -> HASH socketId=threadId, EX TTL
|
||||||
|
* isViewing = does the user hash hold this threadId for any socket. Keys carry a TTL so a crashed
|
||||||
|
* replica's entries self-heal; expiry errs toward "not viewing" (push is sent), the safe default.
|
||||||
|
*/
|
||||||
|
export class RedisPresenceService implements PresencePort, OnModuleDestroy {
|
||||||
|
private readonly logger = new Logger(RedisPresenceService.name);
|
||||||
|
private readonly redis: Redis;
|
||||||
|
private static readonly TTL_SECONDS = 300;
|
||||||
|
private static readonly PREFIX = 'iios:presence';
|
||||||
|
|
||||||
|
constructor(url: string, client?: Redis) {
|
||||||
|
this.redis = client ?? new Redis(url, { maxRetriesPerRequest: null });
|
||||||
|
this.redis.on('error', (err) => this.logger.error(`redis presence error: ${err.message}`));
|
||||||
|
}
|
||||||
|
|
||||||
|
private sockKey(socketId: string): string {
|
||||||
|
return `${RedisPresenceService.PREFIX}:sock:${socketId}`;
|
||||||
|
}
|
||||||
|
private userKey(userId: string): string {
|
||||||
|
return `${RedisPresenceService.PREFIX}:user:${userId}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
async setFocus(socketId: string, userId: string, threadId: string | null): Promise<void> {
|
||||||
|
const ttl = RedisPresenceService.TTL_SECONDS;
|
||||||
|
const sock = this.sockKey(socketId);
|
||||||
|
const user = this.userKey(userId);
|
||||||
|
const pipe = this.redis.multi().set(sock, userId, 'EX', ttl);
|
||||||
|
if (threadId === null) {
|
||||||
|
// Blurred / no thread open — the socket stays connected but is viewing nothing.
|
||||||
|
pipe.hdel(user, socketId);
|
||||||
|
} else {
|
||||||
|
pipe.hset(user, socketId, threadId).expire(user, ttl);
|
||||||
|
}
|
||||||
|
await pipe.exec();
|
||||||
|
}
|
||||||
|
|
||||||
|
async clearSocket(socketId: string): Promise<void> {
|
||||||
|
const sock = this.sockKey(socketId);
|
||||||
|
const userId = await this.redis.get(sock);
|
||||||
|
const pipe = this.redis.multi().del(sock);
|
||||||
|
if (userId) pipe.hdel(this.userKey(userId), socketId);
|
||||||
|
await pipe.exec();
|
||||||
|
}
|
||||||
|
|
||||||
|
async isViewing(userId: string, threadId: string): Promise<boolean> {
|
||||||
|
const threads = await this.redis.hvals(this.userKey(userId));
|
||||||
|
return threads.includes(threadId);
|
||||||
|
}
|
||||||
|
|
||||||
|
async onModuleDestroy(): Promise<void> {
|
||||||
|
await this.redis.quit().catch(() => undefined);
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user