All files / web/src/lib/classroom socket-emitter.ts

0% Statements 0/450
0% Branches 0/1
0% Functions 0/1
0% Lines 0/450

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
/**
 * Socket Emission Helper for Enrollment Events
 *
 * Provides a type-safe, centralized way to emit enrollment-related socket events.
 * This ensures consistent event payloads and makes it easy to audit who gets notified.
 *
 * Channel Patterns:
 * - classroom:${classroomId} - Teacher's view
 * - user:${userId}           - Parent/user notifications
 * - player:${playerId}       - Student-specific notifications
 */

import { getSocketIO } from '@/lib/socket-io'
import type {
  EnrollmentApprovedEvent,
  EnrollmentRequestApprovedEvent,
  EnrollmentRequestCreatedEvent,
  EnrollmentRequestDeniedEvent,
  EntryPromptAcceptedEvent,
  EntryPromptCreatedEvent,
  EntryPromptDeclinedEvent,
  SessionEndedEvent,
  SessionStartedEvent,
  StudentUnenrolledEvent,
} from './socket-events'

/**
 * Enrollment event payload - common fields for all enrollment events
 */
export interface EnrollmentEventPayload {
  requestId: string
  classroomId: string
  classroomName: string
  playerId: string
  playerName: string
}

/**
 * Recipients for socket events
 */
export interface SocketRecipients {
  /** Emit to the classroom channel (teacher's view) */
  classroomId?: string
  /** Emit to specific user channels (parents) */
  userIds?: string[]
  /** Emit to specific player channels */
  playerIds?: string[]
}

/**
 * Emit an enrollment request created event
 *
 * Use when: A new enrollment request is created (by teacher or parent)
 */
export async function emitEnrollmentRequestCreated(
  payload: EnrollmentEventPayload & { requestedByRole: 'teacher' | 'parent' },
  recipients: SocketRecipients
): Promise<void> {
  const io = await getSocketIO()
  if (!io) return

  const eventData: EnrollmentRequestCreatedEvent = {
    request: {
      id: payload.requestId,
      classroomId: payload.classroomId,
      classroomName: payload.classroomName,
      playerId: payload.playerId,
      playerName: payload.playerName,
      requestedByRole: payload.requestedByRole,
    },
  }

  emitToRecipients(io, 'enrollment-request-created', eventData, recipients, 'request-created')
}

/**
 * Emit an enrollment request approved event
 *
 * Use when: One side (teacher or parent) approves, but enrollment is not yet complete.
 * This notifies the other party that their approval is still pending.
 */
export async function emitEnrollmentRequestApproved(
  payload: EnrollmentEventPayload & { approvedBy: 'teacher' | 'parent' },
  recipients: SocketRecipients
): Promise<void> {
  const io = await getSocketIO()
  if (!io) return

  const eventData: EnrollmentRequestApprovedEvent = {
    requestId: payload.requestId,
    classroomId: payload.classroomId,
    classroomName: payload.classroomName,
    playerId: payload.playerId,
    playerName: payload.playerName,
    approvedBy: payload.approvedBy,
  }

  emitToRecipients(io, 'enrollment-request-approved', eventData, recipients, 'request-approved')
}

/**
 * Emit an enrollment request denied event
 *
 * Use when: Either side denies the enrollment request.
 */
export async function emitEnrollmentRequestDenied(
  payload: EnrollmentEventPayload & { deniedBy: 'teacher' | 'parent' },
  recipients: SocketRecipients
): Promise<void> {
  const io = await getSocketIO()
  if (!io) return

  const eventData: EnrollmentRequestDeniedEvent = {
    requestId: payload.requestId,
    classroomId: payload.classroomId,
    classroomName: payload.classroomName,
    playerId: payload.playerId,
    playerName: payload.playerName,
    deniedBy: payload.deniedBy,
  }

  emitToRecipients(io, 'enrollment-request-denied', eventData, recipients, 'request-denied')
}

/**
 * Emit an enrollment completed event
 *
 * Use when: Both sides have approved and the student is now enrolled.
 */
export async function emitEnrollmentCompleted(
  payload: Omit<EnrollmentEventPayload, 'requestId'>,
  recipients: SocketRecipients
): Promise<void> {
  const io = await getSocketIO()
  if (!io) return

  const eventData: EnrollmentApprovedEvent = {
    classroomId: payload.classroomId,
    classroomName: payload.classroomName,
    playerId: payload.playerId,
    playerName: payload.playerName,
  }

  emitToRecipients(io, 'enrollment-approved', eventData, recipients, 'enrollment-completed')
}

/**
 * Emit a student unenrolled event
 *
 * Use when: A student is removed from a classroom (by teacher or parent).
 * This also implies their presence was removed if they were in the classroom.
 */
export async function emitStudentUnenrolled(
  payload: Omit<EnrollmentEventPayload, 'requestId'> & {
    unenrolledBy: 'teacher' | 'parent'
  },
  recipients: SocketRecipients
): Promise<void> {
  const io = await getSocketIO()
  if (!io) return

  const eventData: StudentUnenrolledEvent = {
    classroomId: payload.classroomId,
    classroomName: payload.classroomName,
    playerId: payload.playerId,
    playerName: payload.playerName,
    unenrolledBy: payload.unenrolledBy,
  }

  emitToRecipients(io, 'student-unenrolled', eventData, recipients, 'student-unenrolled')
}

/**
 * Internal helper to emit to all specified recipients
 */
function emitToRecipients<T>(
  io: ReturnType<typeof getSocketIO> extends Promise<infer U> ? NonNullable<U> : never,
  eventName: string,
  eventData: T,
  recipients: SocketRecipients,
  logLabel: string
): void {
  const { classroomId, userIds, playerIds } = recipients

  try {
    // Emit to classroom channel
    if (classroomId) {
      io.to(`classroom:${classroomId}`).emit(eventName, eventData)
      console.log(`[SocketEmitter] ${logLabel} -> classroom:${classroomId}`)
    }

    // Emit to user channels
    if (userIds?.length) {
      for (const userId of userIds) {
        io.to(`user:${userId}`).emit(eventName, eventData)
        console.log(`[SocketEmitter] ${logLabel} -> user:${userId}`)
      }
    }

    // Emit to player channels
    if (playerIds?.length) {
      for (const playerId of playerIds) {
        io.to(`player:${playerId}`).emit(eventName, eventData)
        console.log(`[SocketEmitter] ${logLabel} -> player:${playerId}`)
      }
    }
  } catch (error) {
    console.error(`[SocketEmitter] Failed to emit ${logLabel}:`, error)
  }
}

// ============================================================================
// Session Events
// ============================================================================

/**
 * Session event payload
 */
export interface SessionEventPayload {
  sessionId: string
  playerId: string
  playerName: string
}

/**
 * Emit a session started event
 *
 * Use when: A student starts a practice session while present in a classroom.
 * This notifies the teacher so they can see the session in their active sessions view.
 */
export async function emitSessionStarted(
  payload: SessionEventPayload,
  classroomId: string
): Promise<void> {
  const io = await getSocketIO()
  if (!io) return

  const eventData: SessionStartedEvent = {
    sessionId: payload.sessionId,
    playerId: payload.playerId,
    playerName: payload.playerName,
  }

  try {
    io.to(`classroom:${classroomId}`).emit('session-started', eventData)
    console.log(`[SocketEmitter] session-started -> classroom:${classroomId}`)
  } catch (error) {
    console.error('[SocketEmitter] Failed to emit session-started:', error)
  }
}

/**
 * Emit a session ended event
 *
 * Use when: A student's practice session ends (completed, ended early, or abandoned)
 * while they are present in a classroom.
 */
export async function emitSessionEnded(
  payload: SessionEventPayload & {
    reason: 'completed' | 'ended_early' | 'abandoned'
  },
  classroomId: string
): Promise<void> {
  const io = await getSocketIO()
  if (!io) return

  const eventData: SessionEndedEvent = {
    sessionId: payload.sessionId,
    playerId: payload.playerId,
    playerName: payload.playerName,
    reason: payload.reason,
  }

  try {
    io.to(`classroom:${classroomId}`).emit('session-ended', eventData)
    console.log(`[SocketEmitter] session-ended (${payload.reason}) -> classroom:${classroomId}`)
  } catch (error) {
    console.error('[SocketEmitter] Failed to emit session-ended:', error)
  }
}

/**
 * Emit a session started event to the player channel
 *
 * Use when: A student starts a practice session.
 * This notifies parents who are subscribed to their child's player channel.
 */
export async function emitSessionStartedToPlayer(payload: SessionEventPayload): Promise<void> {
  const io = await getSocketIO()
  if (!io) return

  const eventData: SessionStartedEvent = {
    sessionId: payload.sessionId,
    playerId: payload.playerId,
    playerName: payload.playerName,
  }

  try {
    io.to(`player:${payload.playerId}`).emit('session-started', eventData)
    console.log(`[SocketEmitter] session-started -> player:${payload.playerId}`)
  } catch (error) {
    console.error('[SocketEmitter] Failed to emit session-started to player:', error)
  }
}

/**
 * Emit a session ended event to the player channel
 *
 * Use when: A student's practice session ends.
 * This notifies parents who are subscribed to their child's player channel.
 */
export async function emitSessionEndedToPlayer(
  payload: SessionEventPayload & {
    reason: 'completed' | 'ended_early' | 'abandoned'
  }
): Promise<void> {
  const io = await getSocketIO()
  if (!io) return

  const eventData: SessionEndedEvent = {
    sessionId: payload.sessionId,
    playerId: payload.playerId,
    playerName: payload.playerName,
    reason: payload.reason,
  }

  try {
    io.to(`player:${payload.playerId}`).emit('session-ended', eventData)
    console.log(`[SocketEmitter] session-ended (${payload.reason}) -> player:${payload.playerId}`)
  } catch (error) {
    console.error('[SocketEmitter] Failed to emit session-ended to player:', error)
  }
}

// ============================================================================
// Entry Prompt Events
// ============================================================================

/**
 * Entry prompt event payload
 */
export interface EntryPromptPayload {
  promptId: string
  classroomId: string
  classroomName: string
  playerId: string
  playerName: string
  playerEmoji: string
}

/**
 * Emit an entry prompt created event
 *
 * Use when: A teacher creates an entry prompt for a student.
 * This notifies all parents of the student to prompt them to enter the child.
 */
export async function emitEntryPromptCreated(
  payload: EntryPromptPayload & { teacherName: string; expiresAt: Date },
  parentIds: string[]
): Promise<void> {
  const io = await getSocketIO()
  if (!io) return

  const eventData: EntryPromptCreatedEvent = {
    promptId: payload.promptId,
    classroomId: payload.classroomId,
    classroomName: payload.classroomName,
    playerId: payload.playerId,
    playerName: payload.playerName,
    playerEmoji: payload.playerEmoji,
    teacherName: payload.teacherName,
    expiresAt: payload.expiresAt.toISOString(),
  }

  try {
    // Emit to each parent's user channel
    for (const parentId of parentIds) {
      io.to(`user:${parentId}`).emit('entry-prompt-created', eventData)
      console.log(`[SocketEmitter] entry-prompt-created -> user:${parentId}`)
    }
  } catch (error) {
    console.error('[SocketEmitter] Failed to emit entry-prompt-created:', error)
  }
}

/**
 * Emit an entry prompt accepted event
 *
 * Use when: A parent accepts an entry prompt, entering their child into the classroom.
 * This notifies the teacher and updates the classroom presence view.
 */
export async function emitEntryPromptAccepted(
  payload: Omit<EntryPromptPayload, 'playerEmoji'> & { acceptedBy: string },
  teacherId: string
): Promise<void> {
  const io = await getSocketIO()
  if (!io) return

  const eventData: EntryPromptAcceptedEvent = {
    promptId: payload.promptId,
    classroomId: payload.classroomId,
    playerId: payload.playerId,
    playerName: payload.playerName,
    acceptedBy: payload.acceptedBy,
  }

  try {
    // Emit to teacher's user channel
    io.to(`user:${teacherId}`).emit('entry-prompt-accepted', eventData)
    console.log(`[SocketEmitter] entry-prompt-accepted -> user:${teacherId}`)

    // Also emit to classroom channel for real-time presence updates
    io.to(`classroom:${payload.classroomId}`).emit('entry-prompt-accepted', eventData)
    console.log(`[SocketEmitter] entry-prompt-accepted -> classroom:${payload.classroomId}`)
  } catch (error) {
    console.error('[SocketEmitter] Failed to emit entry-prompt-accepted:', error)
  }
}

/**
 * Emit an entry prompt declined event
 *
 * Use when: A parent declines an entry prompt.
 * This only notifies the teacher (no need to update classroom).
 */
export async function emitEntryPromptDeclined(
  payload: Omit<EntryPromptPayload, 'playerEmoji' | 'classroomName'> & {
    declinedBy: string
  },
  teacherId: string
): Promise<void> {
  const io = await getSocketIO()
  if (!io) return

  const eventData: EntryPromptDeclinedEvent = {
    promptId: payload.promptId,
    classroomId: payload.classroomId,
    playerId: payload.playerId,
    playerName: payload.playerName,
    declinedBy: payload.declinedBy,
  }

  try {
    // Emit only to teacher's user channel
    io.to(`user:${teacherId}`).emit('entry-prompt-declined', eventData)
    console.log(`[SocketEmitter] entry-prompt-declined -> user:${teacherId}`)
  } catch (error) {
    console.error('[SocketEmitter] Failed to emit entry-prompt-declined:', error)
  }
}