webapi_session.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737
  1. package state
  2. import (
  3. "bytes"
  4. "context"
  5. "crypto/rand"
  6. "encoding/hex"
  7. "errors"
  8. "log/slog"
  9. mrand "math/rand/v2"
  10. "strconv"
  11. "sync"
  12. "time"
  13. "github.com/mk6i/open-oscar-server/server/webapi/types"
  14. "github.com/mk6i/open-oscar-server/wire"
  15. )
  16. var (
  17. // ErrNoWebAPISession is returned when a WebAPI session is not found.
  18. ErrNoWebAPISession = errors.New("WebAPI session not found")
  19. // ErrWebAPISessionExpired is returned when a WebAPI session has expired.
  20. ErrWebAPISessionExpired = errors.New("WebAPI session expired")
  21. // ErrWebAPISessionManagerClosed is returned when a session is requested from
  22. // a manager that has been shut down.
  23. ErrWebAPISessionManagerClosed = errors.New("WebAPI session manager is shut down")
  24. )
  25. // Web API session lifecycle timeline.
  26. //
  27. // A web client keeps its session alive by long-polling GET /aim/fetchEvents.
  28. // Every authenticated request touches the session (middleware.RequireSession
  29. // calls TouchSession at request arrival), sliding expiry to now + the TTL. A
  30. // single poll blocks for up to 60s (the fetchEvents long-poll cap) and the
  31. // client waits ~500ms (TimeToNextFetch) before re-polling, so in steady state a
  32. // healthy client touches the session at worst every ~60-65s once jitter is
  33. // included. That worst-case touch interval is the floor the TTL must clear.
  34. //
  35. // If a client hangs up without calling endSession, its last touch was at its
  36. // last poll: the session then expires webAPISessionTTL later and the reaper
  37. // sweeps it within one webAPISessionReapInterval tick. So a silent client is
  38. // removed (and its OSCAR session closed) within TTL + tick of going quiet.
  39. const (
  40. // webAPISessionTTL bounds how long a session survives without a poll. It is
  41. // sized to absorb one missed poll cycle: ~60s for the normal cycle, ~60s for
  42. // the absorbed miss, plus ~20s of jitter margin. Two consecutive misses mean
  43. // the client is genuinely gone and the session is reaped.
  44. webAPISessionTTL = 150 * time.Second
  45. // webAPISessionReapInterval is how often the cleanup goroutine sweeps for
  46. // expired sessions (~TTL/5). A dead session lingers at most
  47. // webAPISessionTTL + webAPISessionReapInterval before removal.
  48. webAPISessionReapInterval = 30 * time.Second
  49. )
  50. // WebAPISession represents an active Web AIM API session.
  51. type WebAPISession struct {
  52. AimSID string // Unique session ID for web client
  53. ScreenName DisplayScreenName // User identity
  54. OSCARSession *SessionInstance // Bridge to existing OSCAR session
  55. OSCARCookie []byte // OSCAR auth cookie for the startOSCARSession handoff
  56. BOSHost string // BOS host advertised to the web client
  57. BOSPort int // BOS port advertised to the web client
  58. UseSSL bool // Whether the handoff advertised an SSL BOS connection
  59. BaseURL string // Web API base URL advertised to the web client, used to build absolute asset URLs
  60. Events []string // Subscribed event types
  61. EventQueue *types.EventQueue // Per-session event queue
  62. DevID string // Developer ID that created this session
  63. ClientName string // Client application name
  64. ClientVersion string // Client application version
  65. CreatedAt time.Time // SessionInstance creation time
  66. LastAccessed time.Time // Last activity time
  67. ExpiresAt time.Time // SessionInstance expiration time
  68. FetchTimeout int // Long-polling timeout in milliseconds
  69. TimeToNextFetch int // Suggested delay before next fetch
  70. RemoteAddr string // Client IP address
  71. TempBuddies map[string]bool // Temporary buddies for this session only
  72. BuddyListRefresher func(ctx context.Context) (interface{}, error) // Called on feedbag changes to push buddylist event
  73. PermitDenyRefresher func(ctx context.Context) (interface{}, error) // Called on feedbag changes to push permitDeny event
  74. MyInfoRefresher func(ctx context.Context) (interface{}, error) // Called on self user-info updates (e.g. icon change) to push myInfo event
  75. BuddyAliasLoader func(ctx context.Context) (map[string]string, error)
  76. // BuddyIconURL formats the absolute buddyIcon URL for a buddy from the icon
  77. // hash carried in a presence SNAC. Returns "" when no URL can be published.
  78. BuddyIconURL func(screenName IdentScreenName, hash []byte) string
  79. aliases map[string]string // cached BuddyAliasLoader result, nil when unloaded or invalidated
  80. aliasMu sync.Mutex
  81. imLog map[string][]WebAPIStoredIM
  82. imLogMu sync.Mutex
  83. logger *slog.Logger // Logger for debugging
  84. listeners sync.WaitGroup
  85. ctx context.Context
  86. cancel context.CancelFunc
  87. closeMu sync.Mutex
  88. closed bool
  89. }
  90. // IsExpired checks if the session has expired.
  91. func (s *WebAPISession) IsExpired() bool {
  92. return time.Now().After(s.ExpiresAt)
  93. }
  94. // Aliases returns this session owner's private buddy aliases, keyed by normalized
  95. // screen name. Aliases live in the owner's feedbag, so the map is loaded once and
  96. // cached until a feedbag change invalidates it: a signon that brings a large buddy
  97. // list online costs one feedbag query instead of one per buddy.
  98. //
  99. // The map is owned by the session and must not be mutated by callers.
  100. //
  101. // aliasMu is deliberately held across the load rather than released while the
  102. // feedbag is queried. Another instance of the owner can rename a buddy mid-query,
  103. // and its FeedbagUpdateItem SNAC invalidates this cache; if the load ran outside
  104. // the lock, that query's pre-rename result could be stored *after* the
  105. // invalidation and serve the old alias until the next feedbag change. Holding the
  106. // lock makes the invalidation wait for the load and then win.
  107. func (s *WebAPISession) Aliases(ctx context.Context) map[string]string {
  108. s.aliasMu.Lock()
  109. defer s.aliasMu.Unlock()
  110. // The loader is wired after the session is created, so an event arriving in
  111. // that window has no way to resolve aliases.
  112. if s.BuddyAliasLoader == nil {
  113. return nil
  114. }
  115. if s.aliases == nil {
  116. aliases, err := s.BuddyAliasLoader(ctx)
  117. if err != nil {
  118. s.logger.Error("failed to load buddy aliases", "err", err.Error())
  119. return nil
  120. }
  121. s.aliases = aliases
  122. }
  123. return s.aliases
  124. }
  125. // InvalidateAliases drops the cached alias map so the next Aliases call reloads it.
  126. // Callers that change the owner's feedbag must call this: the feedbag service
  127. // relays FeedbagUpdateItem only to the owner's *other* instances, so a session
  128. // never sees a SNAC for its own writes.
  129. func (s *WebAPISession) InvalidateAliases() {
  130. s.aliasMu.Lock()
  131. defer s.aliasMu.Unlock()
  132. s.aliases = nil
  133. }
  134. // aliasFor returns this session owner's private alias for buddy, or "" when none is
  135. // set. The web client deletes the alias it holds whenever it merges a user map, so
  136. // every event naming a buddy has to repeat it.
  137. func (s *WebAPISession) aliasFor(buddy IdentScreenName) string {
  138. // Runs on the SNAC listener goroutine, which has no request context.
  139. return s.Aliases(s.ctx)[buddy.String()]
  140. }
  141. // Touch updates the last accessed time and extends expiration if needed.
  142. func (s *WebAPISession) Touch() {
  143. s.LastAccessed = time.Now()
  144. newExpiry := s.LastAccessed.Add(webAPISessionTTL)
  145. if newExpiry.After(s.ExpiresAt) {
  146. s.ExpiresAt = newExpiry
  147. }
  148. }
  149. // IsSubscribedTo checks if the session is subscribed to a specific event type.
  150. func (s *WebAPISession) IsSubscribedTo(eventType string) bool {
  151. for _, event := range s.Events {
  152. if event == eventType {
  153. return true
  154. }
  155. }
  156. return false
  157. }
  158. // StartListeningToOSCARSession starts a goroutine that listens to the OSCAR session's
  159. // message channel and converts SNAC messages into WebAPI events.
  160. func (s *WebAPISession) StartListeningToOSCARSession() {
  161. if s.OSCARSession == nil {
  162. return
  163. }
  164. s.closeMu.Lock()
  165. defer s.closeMu.Unlock()
  166. if s.closed {
  167. return
  168. }
  169. s.listeners.Add(1)
  170. go func() {
  171. defer s.listeners.Done()
  172. msgCh := s.OSCARSession.ReceiveMessage()
  173. for {
  174. select {
  175. case msg, ok := <-msgCh:
  176. if !ok {
  177. // Channel closed, OSCAR session ended
  178. return
  179. }
  180. s.handleSNACMessage(msg)
  181. case <-s.OSCARSession.Closed():
  182. // OSCAR session closed
  183. return
  184. }
  185. }
  186. }()
  187. }
  188. // Close tears down the session: it releases any parked event fetchers, closes
  189. // the OSCAR instance, and waits for the listener goroutine to unwind. Safe to
  190. // call more than once.
  191. func (s *WebAPISession) Close() {
  192. s.closeMu.Lock()
  193. if s.closed {
  194. s.closeMu.Unlock()
  195. return
  196. }
  197. s.closed = true
  198. s.closeMu.Unlock()
  199. s.EventQueue.Close()
  200. s.OSCARSession.CloseInstance()
  201. s.cancel()
  202. s.listeners.Wait()
  203. }
  204. // handleSNACMessage converts a SNAC message into WebAPI events and pushes them to the event queue.
  205. func (s *WebAPISession) handleSNACMessage(msg wire.SNACMessage) {
  206. if s.EventQueue == nil {
  207. return
  208. }
  209. // Convert SNAC message to WebAPI events based on food group and subgroup
  210. switch msg.Frame.FoodGroup {
  211. case wire.ICBM:
  212. s.handleICBMMessage(msg)
  213. case wire.Buddy:
  214. s.handleBuddyMessage(msg)
  215. case wire.Feedbag:
  216. s.handleFeedbagMessage(msg)
  217. case wire.OService:
  218. s.handleOServiceMessage(msg)
  219. }
  220. }
  221. // handleOServiceMessage handles OService SNAC messages relayed to the session's
  222. // own OSCAR instance. The only one we surface is OServiceUserInfoUpdate, which the
  223. // server relays to a user when their own user info changes (notably a buddy icon
  224. // upload or clear). The client re-renders its identity badge from myInfo events
  225. // only, so we translate this into a fresh myInfo.
  226. func (s *WebAPISession) handleOServiceMessage(msg wire.SNACMessage) {
  227. if msg.Frame.SubGroup != wire.OServiceUserInfoUpdate {
  228. return
  229. }
  230. if !s.IsSubscribedTo("myInfo") && !s.IsSubscribedTo("presence") {
  231. return
  232. }
  233. if s.MyInfoRefresher == nil {
  234. return
  235. }
  236. data, err := s.MyInfoRefresher(s.ctx)
  237. if err != nil {
  238. s.logger.Error("failed to refresh myInfo after user-info update", "err", err)
  239. return
  240. }
  241. s.EventQueue.Push(types.EventType("myInfo"), data)
  242. }
  243. // handleICBMMessage handles ICBM (instant messaging) SNAC messages.
  244. func (s *WebAPISession) handleICBMMessage(msg wire.SNACMessage) {
  245. switch msg.Frame.SubGroup {
  246. case wire.ICBMChannelMsgToClient:
  247. s.handleIncomingIM(msg)
  248. case wire.ICBMClientEvent:
  249. s.handleTypingNotification(msg)
  250. }
  251. }
  252. // handleIncomingIM handles incoming instant messages.
  253. func (s *WebAPISession) handleIncomingIM(msg wire.SNACMessage) {
  254. if !s.IsSubscribedTo("im") {
  255. return
  256. }
  257. body, ok := msg.Body.(wire.SNAC_0x04_0x07_ICBMChannelMsgToClient)
  258. if !ok {
  259. return
  260. }
  261. // Extract message text from TLV data
  262. var messageText string
  263. if msgData, hasMsg := body.Bytes(wire.ICBMTLVAOLIMData); hasMsg {
  264. if text, err := wire.UnmarshalICBMMessageText(msgData); err == nil {
  265. messageText = text
  266. }
  267. }
  268. if messageText == "" {
  269. return
  270. }
  271. // Check if it's an auto-response (channel 2)
  272. autoResponse := body.ChannelID == 0x0002
  273. // msgId must be unique per delivered event. The OSCAR cookie is not a
  274. // reliable unique id (some clients reuse it across messages), and the web
  275. // client dedupes its conversation list by msgId, silently dropping any
  276. // collisions. Mint a fresh random id instead of reusing body.Cookie.
  277. msgID := strconv.FormatUint(mrand.Uint64(), 16)
  278. // SNAC user info carries the sender's display screen name. The web client
  279. // keys conversations and users by the normalized aimId and only renders
  280. // displayId, so the two forms must not be interchanged.
  281. partnerDisplay := body.ScreenName
  282. partnerAimID := NewIdentScreenName(partnerDisplay).String()
  283. nowSec := time.Now().Unix()
  284. s.AddStoredIM(partnerAimID, partnerAimID, messageText, msgID, nowSec)
  285. // Create IM event
  286. imEvent := types.IMEvent{
  287. Source: types.UserInfo{
  288. AimID: partnerAimID,
  289. DisplayID: partnerDisplay,
  290. Friendly: s.aliasFor(NewIdentScreenName(partnerAimID)),
  291. UserType: "aim",
  292. State: "online",
  293. },
  294. Message: messageText,
  295. MsgID: msgID,
  296. Timestamp: float64(time.Now().Unix()),
  297. AutoResp: autoResponse,
  298. }
  299. s.EventQueue.Push(types.EventTypeIM, imEvent)
  300. s.logger.Debug("delivered instant message",
  301. "from", partnerDisplay,
  302. "to", s.ScreenName)
  303. if s.IsSubscribedTo("conversation") {
  304. // unread is 0 here, not 1, because the "im" event pushed above already
  305. // causes the client to increment its own persisted per-buddy unread
  306. // tally. The "Recent chats" badge is the sum of that persisted tally and
  307. // this conversation's unreadCount, so sending 1 here would double-count
  308. // the message (badge shows 2 for the first IM). Mirrors the sent-IM path,
  309. // which also passes 0.
  310. s.EventQueue.Push(types.EventTypeConversation, types.ConversationEventData("update", []map[string]interface{}{
  311. types.ConversationEntry(
  312. partnerAimID,
  313. partnerDisplay,
  314. messageText,
  315. msgID,
  316. partnerAimID,
  317. false,
  318. 0,
  319. ),
  320. }))
  321. }
  322. }
  323. // handleTypingNotification handles typing notifications.
  324. func (s *WebAPISession) handleTypingNotification(msg wire.SNACMessage) {
  325. if !s.IsSubscribedTo("typing") {
  326. return
  327. }
  328. body, ok := msg.Body.(wire.SNAC_0x04_0x14_ICBMClientEvent)
  329. if !ok {
  330. return
  331. }
  332. // Event types: 0x0000=none, 0x0001=typed (paused), 0x0002=typing
  333. var typingStatus string
  334. switch body.Event {
  335. case 0x0002:
  336. typingStatus = "typing"
  337. case 0x0001:
  338. typingStatus = "typed"
  339. default:
  340. typingStatus = "none"
  341. }
  342. typingEvent := types.TypingEvent{
  343. AimID: NewIdentScreenName(body.ScreenName).String(),
  344. TypingStatus: typingStatus,
  345. }
  346. s.EventQueue.Push(types.EventTypeTyping, typingEvent)
  347. }
  348. // handleBuddyMessage handles buddy/presence SNAC messages.
  349. func (s *WebAPISession) handleBuddyMessage(msg wire.SNACMessage) {
  350. switch msg.Frame.SubGroup {
  351. case wire.BuddyArrived:
  352. s.handleBuddyArrived(msg)
  353. case wire.BuddyDeparted:
  354. s.handleBuddyDeparted(msg)
  355. }
  356. }
  357. // handleBuddyArrived handles when a buddy comes online.
  358. func (s *WebAPISession) handleBuddyArrived(msg wire.SNACMessage) {
  359. if !s.IsSubscribedTo("presence") {
  360. return
  361. }
  362. body, ok := msg.Body.(wire.SNAC_0x03_0x0B_BuddyArrived)
  363. if !ok {
  364. return
  365. }
  366. stateStr := "online"
  367. // For BuddyArrived updates, infer presence state from the TLVUserInfo.
  368. // Away and invisible transitions are typically broadcast using BuddyArrived
  369. // with updated user flags/status bits, not BuddyDeparted.
  370. if body.IsInvisible() {
  371. stateStr = "offline"
  372. } else if body.IsAway() {
  373. stateStr = "away"
  374. } else if mask, ok := body.Uint32BE(wire.OServiceUserInfoStatus); ok {
  375. if mask&wire.OServiceUserStatusDND == wire.OServiceUserStatusDND {
  376. stateStr = "dnd"
  377. } else if mask&wire.OServiceUserStatusAway == wire.OServiceUserStatusAway {
  378. stateStr = "away"
  379. }
  380. }
  381. buddy := NewIdentScreenName(body.ScreenName)
  382. presenceEvent := types.PresenceEvent{
  383. AimID: buddy.String(),
  384. Friendly: s.aliasFor(buddy),
  385. State: stateStr,
  386. UserType: "aim",
  387. }
  388. // A BuddyArrived carries the buddy's current icon in TLV 0x1D whenever they
  389. // have one, so an icon change (or clear, which arrives as the sentinel hash)
  390. // rides along on the presence broadcast. Publish the matching URL: with an
  391. // icon it is content-addressed; without one it is the placeholder URL, which
  392. // differs from any prior icon URL and so clears a removed icon under the
  393. // client's shallow merge. An empty result (no origin known) is omitted, which
  394. // preserves whatever icon the client already holds.
  395. if s.BuddyIconURL != nil {
  396. var hash []byte
  397. if b, ok := body.Bytes(wire.OServiceUserInfoBARTInfo); ok {
  398. var id wire.BARTID
  399. if err := wire.UnmarshalBE(&id, bytes.NewBuffer(b)); err == nil {
  400. hash = id.Hash
  401. }
  402. }
  403. presenceEvent.BuddyIcon = s.BuddyIconURL(buddy, hash)
  404. }
  405. s.EventQueue.Push(types.EventTypePresence, presenceEvent)
  406. }
  407. // handleBuddyDeparted handles when a buddy goes offline.
  408. func (s *WebAPISession) handleBuddyDeparted(msg wire.SNACMessage) {
  409. if !s.IsSubscribedTo("presence") {
  410. return
  411. }
  412. body, ok := msg.Body.(wire.SNAC_0x03_0x0C_BuddyDeparted)
  413. if !ok {
  414. return
  415. }
  416. buddy := NewIdentScreenName(body.ScreenName)
  417. // BuddyIcon is deliberately omitted: an offline buddy keeps their icon, and
  418. // omitting it lets the client's merge preserve the icon it already holds.
  419. presenceEvent := types.PresenceEvent{
  420. AimID: buddy.String(),
  421. Friendly: s.aliasFor(buddy),
  422. State: "offline",
  423. UserType: "aim",
  424. }
  425. s.EventQueue.Push(types.EventTypePresence, presenceEvent)
  426. }
  427. func (s *WebAPISession) handleFeedbagMessage(msg wire.SNACMessage) {
  428. switch msg.Frame.SubGroup {
  429. case wire.FeedbagInsertItem, wire.FeedbagUpdateItem, wire.FeedbagDeleteItem:
  430. // A buddy item carries its alias, so any feedbag write can change the map.
  431. s.InvalidateAliases()
  432. if s.BuddyListRefresher != nil {
  433. groups, err := s.BuddyListRefresher(s.ctx)
  434. if err != nil {
  435. s.logger.Error("failed to refresh buddy list after feedbag change", "err", err)
  436. } else {
  437. s.EventQueue.Push(types.EventTypeBuddyList, map[string]interface{}{"groups": groups})
  438. }
  439. }
  440. if msg.Frame.SubGroup == wire.FeedbagUpdateItem && s.PermitDenyRefresher != nil {
  441. body, ok := msg.Body.(wire.SNAC_0x13_0x09_FeedbagUpdateItem)
  442. if ok {
  443. for _, item := range body.Items {
  444. if item.ClassID == wire.FeedbagClassIDPermit ||
  445. item.ClassID == wire.FeedbagClassIDDeny ||
  446. item.ClassID == wire.FeedbagClassIdPdinfo {
  447. pdd, err := s.PermitDenyRefresher(s.ctx)
  448. if err != nil {
  449. s.logger.Error("failed to refresh permit/deny after feedbag change", "err", err)
  450. } else {
  451. s.EventQueue.Push(types.EventTypePermitDeny, pdd)
  452. }
  453. break
  454. }
  455. }
  456. }
  457. }
  458. }
  459. }
  460. // WebAPISessionManager manages Web API sessions with thread-safe operations.
  461. // Construct it with NewWebAPISessionManager and drive its reaper with Run.
  462. type WebAPISessionManager struct {
  463. sessions map[string]*WebAPISession // Keyed by aimsid
  464. mu sync.RWMutex
  465. closed bool // set by Shutdown; rejects new sessions and makes drain idempotent
  466. stopCh chan struct{} // closed by Shutdown to stop the reaper
  467. reaperWG sync.WaitGroup // tracks a running reaper so Shutdown can join it
  468. }
  469. // NewWebAPISessionManager creates a new WebAPI session manager. It does not start
  470. // any goroutines; call Run to start reaping expired sessions.
  471. func NewWebAPISessionManager() *WebAPISessionManager {
  472. return &WebAPISessionManager{
  473. sessions: make(map[string]*WebAPISession),
  474. stopCh: make(chan struct{}),
  475. }
  476. }
  477. // CreateSession creates a new WebAPI session.
  478. //
  479. // The session does not begin listening to its OSCAR instance yet: the caller
  480. // must wire the session's refresher callbacks (BuddyListRefresher, BuddyIconURL,
  481. // MyInfoRefresher, ...) and then call StartListeningToOSCARSession. Wiring them
  482. // after the listener starts would race the goroutine, which reads them as it
  483. // converts SNACs into events.
  484. func (m *WebAPISessionManager) CreateSession(screenName DisplayScreenName, devID string, events []string, oscarSession *SessionInstance, baseURL string, logger *slog.Logger) (*WebAPISession, error) {
  485. m.mu.Lock()
  486. defer m.mu.Unlock()
  487. // Refuse to create sessions once shut down: the reaper is stopped, so a
  488. // session added now would never be closed or reaped.
  489. if m.closed {
  490. return nil, ErrWebAPISessionManagerClosed
  491. }
  492. // Generate unique session ID
  493. aimsid, err := generateSessionID()
  494. if err != nil {
  495. return nil, err
  496. }
  497. now := time.Now()
  498. sessCtx, sessCancel := context.WithCancel(context.Background())
  499. session := &WebAPISession{
  500. ctx: sessCtx,
  501. cancel: sessCancel,
  502. AimSID: aimsid,
  503. ScreenName: screenName,
  504. OSCARSession: oscarSession,
  505. BaseURL: baseURL,
  506. Events: events,
  507. EventQueue: types.NewEventQueue(1000), // Max 1000 events per session
  508. DevID: devID,
  509. CreatedAt: now,
  510. LastAccessed: now,
  511. ExpiresAt: now.Add(webAPISessionTTL),
  512. FetchTimeout: 60000, // 60 seconds default for better stability
  513. TimeToNextFetch: 500, // 500ms suggested delay
  514. logger: logger,
  515. }
  516. m.sessions[aimsid] = session
  517. // The caller starts the OSCAR listener (StartListeningToOSCARSession) once it
  518. // has wired the session's refresher callbacks; starting it here would race
  519. // those assignments.
  520. return session, nil
  521. }
  522. // GetSession retrieves a session by aimsid.
  523. func (m *WebAPISessionManager) GetSession(ctx context.Context, aimsid string) (*WebAPISession, error) {
  524. m.mu.RLock()
  525. defer m.mu.RUnlock()
  526. session, exists := m.sessions[aimsid]
  527. if !exists {
  528. return nil, ErrNoWebAPISession
  529. }
  530. if session.IsExpired() {
  531. return nil, ErrWebAPISessionExpired
  532. }
  533. return session, nil
  534. }
  535. // RemoveSession removes a session by aimsid.
  536. func (m *WebAPISessionManager) RemoveSession(ctx context.Context, aimsid string) error {
  537. m.mu.Lock()
  538. session, exists := m.sessions[aimsid]
  539. if !exists {
  540. m.mu.Unlock()
  541. return ErrNoWebAPISession
  542. }
  543. delete(m.sessions, aimsid)
  544. m.mu.Unlock()
  545. // Tear down outside the lock: CloseInstance fans out to buddy-departed
  546. // broadcasts and signout, which we don't want to run under m.mu.
  547. session.Close()
  548. return nil
  549. }
  550. // TouchSession updates the last accessed time for a session.
  551. func (m *WebAPISessionManager) TouchSession(ctx context.Context, aimsid string) error {
  552. m.mu.Lock()
  553. defer m.mu.Unlock()
  554. session, exists := m.sessions[aimsid]
  555. if !exists {
  556. return ErrNoWebAPISession
  557. }
  558. session.Touch()
  559. return nil
  560. }
  561. // Run reaps expired sessions on a fixed interval until ctx is cancelled or
  562. // Shutdown is called. The caller owns the goroutine's lifecycle; typically
  563. // launch it under the server's errgroup:
  564. //
  565. // g.Go(func() error { mgr.Run(ctx); return nil })
  566. //
  567. // Run is a no-op once the manager is closed, so a reaper that loses the race
  568. // with Shutdown never starts reaping a drained manager.
  569. func (m *WebAPISessionManager) Run(ctx context.Context) {
  570. m.mu.Lock()
  571. if m.closed {
  572. m.mu.Unlock()
  573. return
  574. }
  575. // Registering under m.mu is what makes Shutdown's join sound: Shutdown flips
  576. // closed under the same lock, so a reaper either registers before Shutdown
  577. // waits or is turned away here.
  578. m.reaperWG.Add(1)
  579. m.mu.Unlock()
  580. defer m.reaperWG.Done()
  581. ticker := time.NewTicker(webAPISessionReapInterval)
  582. defer ticker.Stop()
  583. for {
  584. select {
  585. case <-ticker.C:
  586. m.reapExpired()
  587. case <-m.stopCh:
  588. return
  589. case <-ctx.Done():
  590. return
  591. }
  592. }
  593. }
  594. // reapExpired removes every expired session and tears it down.
  595. func (m *WebAPISessionManager) reapExpired() {
  596. m.mu.Lock()
  597. now := time.Now()
  598. var expired []*WebAPISession
  599. for aimsid, session := range m.sessions {
  600. if now.After(session.ExpiresAt) {
  601. delete(m.sessions, aimsid)
  602. expired = append(expired, session)
  603. }
  604. }
  605. m.mu.Unlock()
  606. // Tear down outside the lock: CloseInstance fans out to buddy-departed
  607. // broadcasts and signout, which we don't want to run under m.mu.
  608. for _, session := range expired {
  609. session.Close()
  610. }
  611. }
  612. // Shutdown drains and closes all sessions, stops the reaper started by Run, and
  613. // blocks further CreateSession calls. It does not depend on the caller
  614. // cancelling Run's context. Safe to call more than once, though only the first
  615. // call waits for the drain. The drain is bounded by ctx: Shutdown returns
  616. // ctx.Err() rather than block forever on a listener that ignores cancellation.
  617. func (m *WebAPISessionManager) Shutdown(ctx context.Context) error {
  618. m.mu.Lock()
  619. if m.closed {
  620. m.mu.Unlock()
  621. return nil
  622. }
  623. m.closed = true
  624. close(m.stopCh)
  625. sessions := make([]*WebAPISession, 0, len(m.sessions))
  626. for _, session := range m.sessions {
  627. sessions = append(sessions, session)
  628. }
  629. // Clear all sessions
  630. m.sessions = make(map[string]*WebAPISession)
  631. m.mu.Unlock()
  632. drained := make(chan struct{})
  633. go func() {
  634. defer close(drained)
  635. // Tear down outside the lock: CloseInstance fans out to buddy-departed
  636. // broadcasts and signout, which we don't want to run under m.mu.
  637. for _, session := range sessions {
  638. session.Close()
  639. }
  640. m.reaperWG.Wait()
  641. }()
  642. select {
  643. case <-drained:
  644. return nil
  645. case <-ctx.Done():
  646. return ctx.Err()
  647. }
  648. }
  649. // generateSessionID creates a cryptographically secure session ID.
  650. func generateSessionID() (string, error) {
  651. bytes := make([]byte, 32) // 256 bits
  652. if _, err := rand.Read(bytes); err != nil {
  653. return "", err
  654. }
  655. return hex.EncodeToString(bytes), nil
  656. }