4
0

session_test.go 73 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187
  1. package webapi
  2. import (
  3. "context"
  4. "encoding/hex"
  5. "fmt"
  6. "io"
  7. "log/slog"
  8. "testing"
  9. "time"
  10. "github.com/stretchr/testify/assert"
  11. "github.com/stretchr/testify/require"
  12. "github.com/mk6i/open-oscar-server/state"
  13. "github.com/mk6i/open-oscar-server/wire"
  14. )
  15. func TestSession_IsExpired(t *testing.T) {
  16. tests := []struct {
  17. name string
  18. expiresAt time.Time
  19. isExpired bool
  20. }{
  21. {
  22. name: "Not_Expired",
  23. expiresAt: time.Now().Add(time.Hour),
  24. isExpired: false,
  25. },
  26. {
  27. name: "Already_Expired",
  28. expiresAt: time.Now().Add(-time.Hour),
  29. isExpired: true,
  30. },
  31. {
  32. name: "Just_Expired",
  33. expiresAt: time.Now().Add(-time.Second),
  34. isExpired: true,
  35. },
  36. }
  37. for _, tt := range tests {
  38. t.Run(tt.name, func(t *testing.T) {
  39. session := &Session{
  40. AimSID: "test-session",
  41. ScreenName: state.DisplayScreenName("testuser"),
  42. ExpiresAt: tt.expiresAt,
  43. }
  44. assert.Equal(t, tt.isExpired, session.IsExpired())
  45. })
  46. }
  47. }
  48. func TestSessionManager_ShutdownIdempotent(t *testing.T) {
  49. mgr := NewSessionManager()
  50. _ = mgr.Shutdown(context.Background())
  51. assert.NotPanics(t, func() {
  52. _ = mgr.Shutdown(context.Background())
  53. })
  54. }
  55. // TestSessionManager_CreateAfterShutdown verifies that a session cannot be
  56. // created once the manager is shut down. Otherwise the reaper is stopped and the
  57. // session would never be closed or reaped, leaking its OSCAR session.
  58. func TestSessionManager_CreateAfterShutdown(t *testing.T) {
  59. mgr := NewSessionManager()
  60. _ = mgr.Shutdown(context.Background())
  61. sess, err := mgr.CreateSession(state.DisplayScreenName("testuser"), []string{"presence"}, nil, "", nil)
  62. assert.Nil(t, sess)
  63. assert.ErrorIs(t, err, ErrWebAPISessionManagerClosed)
  64. }
  65. // A broadcast rate limit SNAC surfaces to the client only for the IM class: the
  66. // web client renders any rateLimit event as the conversation-window alert. Code 1
  67. // (a class-params change) is not a status transition and is dropped.
  68. func TestSession_handleRateLimitUpdate(t *testing.T) {
  69. const imClass = wire.RateLimitClassID(3)
  70. newSession := func() *Session {
  71. return &Session{
  72. IMRateClassID: imClass,
  73. EventQueue: NewEventQueue(10),
  74. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  75. FeedbagLoader: emptyFeedbagLoader,
  76. }
  77. }
  78. rateSNAC := func(classID uint16, code uint16) wire.SNACMessage {
  79. return wire.SNACMessage{
  80. Frame: wire.SNACFrame{FoodGroup: wire.OService, SubGroup: wire.OServiceRateParamChange},
  81. Body: wire.SNAC_0x01_0x0A_OServiceRateParamsChange{Code: code, Rate: wire.RateParamsSNAC{ID: classID}},
  82. }
  83. }
  84. t.Run("IM-class transitions become rateLimit events", func(t *testing.T) {
  85. sess := newSession()
  86. sess.handleSNACMessage(rateSNAC(uint16(imClass), 3)) // limited
  87. sess.handleSNACMessage(rateSNAC(uint16(imClass), 4)) // clear
  88. events := sess.EventQueue.GetAllEvents()
  89. require.Len(t, events, 2)
  90. assert.Equal(t, "limit", events[0].Data.(RateLimitEvent).Classes[0].Status)
  91. assert.Equal(t, "clear", events[1].Data.(RateLimitEvent).Classes[0].Status)
  92. })
  93. t.Run("other classes and non-status codes are ignored", func(t *testing.T) {
  94. sess := newSession()
  95. sess.handleSNACMessage(rateSNAC(1, 3)) // class 1 limited: not the IM class
  96. sess.handleSNACMessage(rateSNAC(uint16(imClass), 1)) // IM class param change, not a status
  97. assert.Empty(t, sess.EventQueue.GetAllEvents())
  98. })
  99. t.Run("a session with no IM class disables the alert", func(t *testing.T) {
  100. sess := newSession()
  101. sess.IMRateClassID = 0
  102. sess.handleSNACMessage(rateSNAC(uint16(imClass), 3))
  103. assert.Empty(t, sess.EventQueue.GetAllEvents())
  104. })
  105. }
  106. // A rate-limit disconnect closes the account's OSCAR session; the web session's
  107. // aimsid must then stop resolving. Before this fix GetSession only checked
  108. // time-based expiry, so a client told to disconnect could keep issuing charged
  109. // requests against a dead session (and, downstream, spam clear events on every
  110. // one of them). Once the aimsid is turned away at RequireSession, neither is
  111. // possible.
  112. func TestSessionManager_GetSession_rejectsAfterRateLimitDisconnect(t *testing.T) {
  113. mgr := NewSessionManager()
  114. // A rate class that escalates to disconnect after a short back-to-back burst.
  115. var classes [5]wire.RateClass
  116. for i := range classes {
  117. classes[i] = wire.RateClass{
  118. ID: wire.RateLimitClassID(i + 1),
  119. WindowSize: 2,
  120. ClearLevel: 100,
  121. AlertLevel: 80,
  122. LimitLevel: 70,
  123. DisconnectLevel: 2,
  124. MaxLevel: 200,
  125. }
  126. }
  127. inst := state.NewSession().AddInstance()
  128. inst.Session().SetRateClasses(time.Now(), wire.NewRateLimitClasses(classes))
  129. sess, err := mgr.CreateSession(state.DisplayScreenName("advbot"), []string{"presence"}, inst, "", slog.Default())
  130. require.NoError(t, err)
  131. sess.FeedbagLoader = emptyFeedbagLoader
  132. // Healthy session resolves.
  133. got, err := mgr.GetSession(context.Background(), sess.AimSID)
  134. require.NoError(t, err)
  135. assert.Same(t, sess, got)
  136. // Burst until EvaluateRateLimit escalates to disconnect, which closes the
  137. // account's OSCAR session.
  138. var status wire.RateLimitStatus
  139. now := time.Now()
  140. for range 10 {
  141. if status = inst.Session().EvaluateRateLimit(now, 1); status == wire.RateLimitStatusDisconnect {
  142. break
  143. }
  144. }
  145. require.Equal(t, wire.RateLimitStatusDisconnect, status)
  146. require.True(t, inst.IsClosed(), "disconnect must close the OSCAR instance")
  147. // The aimsid no longer resolves, even though ExpiresAt is far in the future.
  148. _, err = mgr.GetSession(context.Background(), sess.AimSID)
  149. assert.ErrorIs(t, err, ErrWebAPISessionExpired)
  150. assert.False(t, sess.IsExpired(), "the guard must fire on OSCAR close, not on time expiry")
  151. // The reaper frees the dead entry on its next sweep.
  152. mgr.reapExpired()
  153. assert.NotContains(t, mgr.sessions, sess.AimSID)
  154. }
  155. // TestSessionManager_ShutdownDrainsAndClosesSessions verifies that Shutdown
  156. // collects every live session and tears it down: it drains the maps and closes
  157. // each session's event queue and OSCAR instance.
  158. func TestSessionManager_ShutdownDrainsAndClosesSessions(t *testing.T) {
  159. mgr := NewSessionManager()
  160. ctx := context.Background()
  161. inst1 := state.NewSession().AddInstance()
  162. inst2 := state.NewSession().AddInstance()
  163. s1, err := mgr.CreateSession(state.DisplayScreenName("alice"), []string{"presence"}, inst1, "", slog.Default())
  164. assert.NoError(t, err)
  165. s1.FeedbagLoader = emptyFeedbagLoader
  166. s2, err := mgr.CreateSession(state.DisplayScreenName("bob"), []string{"presence"}, inst2, "", slog.Default())
  167. assert.NoError(t, err)
  168. s2.FeedbagLoader = emptyFeedbagLoader
  169. assert.NoError(t, mgr.Shutdown(context.Background()))
  170. // Maps drained: the collect loop ran over both sessions.
  171. assert.Empty(t, mgr.sessions)
  172. // Each session's event queue and OSCAR instance were closed: the teardown
  173. // loop ran for every collected session.
  174. for _, s := range []*Session{s1, s2} {
  175. assertQueueClosed(t, ctx, s)
  176. }
  177. for _, inst := range []*state.SessionInstance{inst1, inst2} {
  178. select {
  179. case <-inst.Closed():
  180. default:
  181. t.Error("OSCAR instance should be closed")
  182. }
  183. }
  184. }
  185. // TestSessionManager_ReapExpired verifies reapExpired removes and tears
  186. // down only expired sessions, leaving live ones untouched.
  187. func TestSessionManager_ReapExpired(t *testing.T) {
  188. mgr := NewSessionManager()
  189. ctx := context.Background()
  190. expiredInst := state.NewSession().AddInstance()
  191. liveInst := state.NewSession().AddInstance()
  192. expired, err := mgr.CreateSession("alice", []string{"presence"}, expiredInst, "", slog.Default())
  193. assert.NoError(t, err)
  194. expired.FeedbagLoader = emptyFeedbagLoader
  195. live, err := mgr.CreateSession("bob", []string{"presence"}, liveInst, "", slog.Default())
  196. assert.NoError(t, err)
  197. live.FeedbagLoader = emptyFeedbagLoader
  198. // Force alice's session into the past; bob keeps its default future expiry.
  199. expired.ExpiresAt = time.Now().Add(-time.Minute)
  200. mgr.reapExpired()
  201. // Expired session removed; live session retained.
  202. assert.NotContains(t, mgr.sessions, expired.AimSID)
  203. assert.Contains(t, mgr.sessions, live.AimSID)
  204. // Expired session torn down: event queue and OSCAR instance closed.
  205. assertQueueClosed(t, ctx, expired)
  206. select {
  207. case <-expiredInst.Closed():
  208. default:
  209. t.Error("expired session's OSCAR instance should be closed")
  210. }
  211. // Live session left running.
  212. select {
  213. case <-liveInst.Closed():
  214. t.Error("live session's OSCAR instance should not be closed")
  215. default:
  216. }
  217. }
  218. // assertQueueClosed asserts the session's event queue is closed: a fetch returns
  219. // straight away with no events and no error, rather than parking for the timeout.
  220. func assertQueueClosed(t *testing.T, ctx context.Context, sess *Session) {
  221. t.Helper()
  222. const timeout = 5 * time.Second
  223. start := time.Now()
  224. events, err := sess.EventQueue.Fetch(ctx, 0, timeout)
  225. assert.NoError(t, err)
  226. assert.Empty(t, events)
  227. assert.Less(t, time.Since(start), timeout/2, "fetch parked instead of returning on a closed queue")
  228. }
  229. // TestSessionManager_ShutdownWithoutReaper verifies Shutdown returns when no
  230. // reaper was ever started. Shutdown must not depend on the caller cancelling the
  231. // context passed to Run.
  232. func TestSessionManager_ShutdownWithoutReaper(t *testing.T) {
  233. mgr := NewSessionManager()
  234. done := make(chan struct{})
  235. go func() {
  236. defer close(done)
  237. // This test is about Shutdown returning at all, not what it returns.
  238. _ = mgr.Shutdown(context.Background())
  239. }()
  240. select {
  241. case <-done:
  242. case <-time.After(5 * time.Second):
  243. t.Fatal("Shutdown hung waiting for a reaper that was never started")
  244. }
  245. }
  246. // TestSessionManager_ShutdownJoinsReaper verifies Shutdown stops a running
  247. // reaper on its own and does not return until that reaper has exited.
  248. func TestSessionManager_ShutdownJoinsReaper(t *testing.T) {
  249. mgr := NewSessionManager()
  250. reaperExited := make(chan struct{})
  251. go func() {
  252. defer close(reaperExited)
  253. mgr.Run(context.Background()) // context is never cancelled: Shutdown must stop it
  254. }()
  255. // Give Run a chance to register itself before shutting down.
  256. time.Sleep(50 * time.Millisecond)
  257. done := make(chan struct{})
  258. go func() {
  259. defer close(done)
  260. // This test is about Shutdown returning at all, not what it returns.
  261. _ = mgr.Shutdown(context.Background())
  262. }()
  263. select {
  264. case <-done:
  265. case <-time.After(5 * time.Second):
  266. t.Fatal("Shutdown hung instead of stopping the reaper")
  267. }
  268. // Shutdown joins the reaper, so it has already exited by the time it returns.
  269. select {
  270. case <-reaperExited:
  271. default:
  272. t.Error("Shutdown returned before the reaper exited")
  273. }
  274. }
  275. // TestSessionManager_RunAfterShutdown verifies a reaper that loses the race
  276. // with Shutdown never starts, so it cannot reap an already-drained manager.
  277. func TestSessionManager_RunAfterShutdown(t *testing.T) {
  278. mgr := NewSessionManager()
  279. assert.NoError(t, mgr.Shutdown(context.Background()))
  280. done := make(chan struct{})
  281. go func() {
  282. defer close(done)
  283. mgr.Run(context.Background())
  284. }()
  285. select {
  286. case <-done:
  287. case <-time.After(5 * time.Second):
  288. t.Fatal("Run should be a no-op on a closed manager")
  289. }
  290. }
  291. // The client deletes the alias it holds each time it merges a user map, so every
  292. // event naming a buddy has to repeat it. An incoming IM and a presence change both
  293. // carry a user map, and both would otherwise rename an aliased buddy.
  294. func TestSession_UINBuddyReportsICQOnArrivalAndDeparture(t *testing.T) {
  295. sess := &Session{
  296. ScreenName: state.DisplayScreenName("me"),
  297. Events: []string{"presence"},
  298. EventQueue: NewEventQueue(10),
  299. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  300. FeedbagLoader: emptyFeedbagLoader,
  301. }
  302. sess.handleBuddyArrived(wire.SNACMessage{Body: wire.SNAC_0x03_0x0B_BuddyArrived{
  303. TLVUserInfo: wire.TLVUserInfo{ScreenName: "100003"},
  304. }})
  305. sess.handleBuddyDeparted(wire.SNACMessage{Body: wire.SNAC_0x03_0x0C_BuddyDeparted{
  306. TLVUserInfo: wire.TLVUserInfo{ScreenName: "100003"},
  307. }})
  308. events := sess.EventQueue.GetAllEvents()
  309. require.Len(t, events, 2)
  310. assert.Equal(t, "icq", events[0].Data.(PresenceEvent).UserType)
  311. assert.Equal(t, "icq", events[1].Data.(PresenceEvent).UserType)
  312. }
  313. func TestSession_RepeatsBuddyAliasOnOSCAREvents(t *testing.T) {
  314. newSession := func() *Session {
  315. return &Session{
  316. ScreenName: state.DisplayScreenName("me"),
  317. Events: []string{"im", "conversation", "presence"},
  318. EventQueue: NewEventQueue(10),
  319. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  320. FeedbagLoader: aliasFeedbagLoader(map[string]string{"mikekelly": "MICHAELKELLY"}),
  321. }
  322. }
  323. t.Run("incoming IM", func(t *testing.T) {
  324. sess := newSession()
  325. frags, err := wire.ICBMFragmentListASCII("hello")
  326. require.NoError(t, err)
  327. body := wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
  328. ChannelID: wire.ICBMChannelIM,
  329. TLVUserInfo: wire.TLVUserInfo{ScreenName: "Mike Kelly"},
  330. }
  331. body.Append(wire.NewTLVBE(wire.ICBMTLVAOLIMData, frags))
  332. sess.handleIncomingIM(wire.SNACMessage{Body: body})
  333. events := sess.EventQueue.GetAllEvents()
  334. require.NotEmpty(t, events)
  335. imEvent := events[0].Data.(IMEvent)
  336. assert.Equal(t, "mikekelly", imEvent.Source.AimID)
  337. assert.Equal(t, "Mike Kelly", imEvent.Source.DisplayID)
  338. assert.Equal(t, "MICHAELKELLY", imEvent.Source.Friendly)
  339. })
  340. t.Run("buddy arrived", func(t *testing.T) {
  341. sess := newSession()
  342. sess.handleBuddyArrived(wire.SNACMessage{Body: wire.SNAC_0x03_0x0B_BuddyArrived{
  343. TLVUserInfo: wire.TLVUserInfo{ScreenName: "Mike Kelly"},
  344. }})
  345. events := sess.EventQueue.GetAllEvents()
  346. require.Len(t, events, 1)
  347. presence := events[0].Data.(PresenceEvent)
  348. assert.Equal(t, "mikekelly", presence.AimID)
  349. assert.Equal(t, "MICHAELKELLY", presence.Friendly)
  350. })
  351. t.Run("buddy departed", func(t *testing.T) {
  352. sess := newSession()
  353. sess.handleBuddyDeparted(wire.SNACMessage{Body: wire.SNAC_0x03_0x0C_BuddyDeparted{
  354. TLVUserInfo: wire.TLVUserInfo{ScreenName: "Mike Kelly"},
  355. }})
  356. events := sess.EventQueue.GetAllEvents()
  357. require.Len(t, events, 1)
  358. presence := events[0].Data.(PresenceEvent)
  359. assert.Equal(t, "mikekelly", presence.AimID)
  360. assert.Equal(t, "MICHAELKELLY", presence.Friendly)
  361. })
  362. t.Run("unaliased buddy omits friendly", func(t *testing.T) {
  363. sess := newSession()
  364. sess.handleBuddyArrived(wire.SNACMessage{Body: wire.SNAC_0x03_0x0B_BuddyArrived{
  365. TLVUserInfo: wire.TLVUserInfo{ScreenName: "Someone Else"},
  366. }})
  367. events := sess.EventQueue.GetAllEvents()
  368. require.Len(t, events, 1)
  369. assert.Empty(t, events[0].Data.(PresenceEvent).Friendly)
  370. })
  371. }
  372. // Aliases all come from one feedbag query, so a signon that brings a whole buddy
  373. // list online must not re-query the feedbag per buddy.
  374. func TestSession_CachesBuddyAliases(t *testing.T) {
  375. var loads int
  376. sess := &Session{
  377. ScreenName: state.DisplayScreenName("me"),
  378. Events: []string{"presence"},
  379. EventQueue: NewEventQueue(10),
  380. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  381. FeedbagLoader: func(context.Context) ([]wire.FeedbagItem, error) {
  382. loads++
  383. return aliasFeedbagItems(map[string]string{"mikekelly": "MICHAELKELLY"}), nil
  384. },
  385. }
  386. for range 5 {
  387. sess.handleBuddyArrived(wire.SNACMessage{Body: wire.SNAC_0x03_0x0B_BuddyArrived{
  388. TLVUserInfo: wire.TLVUserInfo{ScreenName: "Mike Kelly"},
  389. }})
  390. }
  391. events := sess.EventQueue.GetAllEvents()
  392. require.Len(t, events, 5)
  393. for _, event := range events {
  394. assert.Equal(t, "MICHAELKELLY", event.Data.(PresenceEvent).Friendly)
  395. }
  396. assert.Equal(t, 1, loads, "aliases should be loaded once, not once per event")
  397. }
  398. // A feedbag change from another of the owner's clients arrives as a SNAC, which is
  399. // the session's only signal that its cached aliases are stale.
  400. func TestSession_FeedbagSNACInvalidatesAliasCache(t *testing.T) {
  401. alias := "MICHAELKELLY"
  402. sess := &Session{
  403. ScreenName: state.DisplayScreenName("me"),
  404. Events: []string{"presence"},
  405. EventQueue: NewEventQueue(10),
  406. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  407. FeedbagLoader: func(context.Context) ([]wire.FeedbagItem, error) {
  408. return aliasFeedbagItems(map[string]string{"mikekelly": alias}), nil
  409. },
  410. }
  411. arrive := func() PresenceEvent {
  412. sess.handleBuddyArrived(wire.SNACMessage{Body: wire.SNAC_0x03_0x0B_BuddyArrived{
  413. TLVUserInfo: wire.TLVUserInfo{ScreenName: "Mike Kelly"},
  414. }})
  415. events := sess.EventQueue.GetAllEvents()
  416. require.NotEmpty(t, events)
  417. return events[len(events)-1].Data.(PresenceEvent)
  418. }
  419. assert.Equal(t, "MICHAELKELLY", arrive().Friendly)
  420. // The buddy is renamed elsewhere: the feedbag SNAC must drop the cached map.
  421. alias = "MIKE"
  422. sess.handleFeedbagMessage(wire.SNACMessage{
  423. Frame: wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagUpdateItem},
  424. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{},
  425. })
  426. assert.Equal(t, "MIKE", arrive().Friendly)
  427. }
  428. // Permit/deny changes from another of the owner's clients arrive as an insert,
  429. // an update, or a delete, and all three have to refresh the client's privacy
  430. // state.
  431. func TestSession_FeedbagSNACRefreshesPermitDeny(t *testing.T) {
  432. denyItem := wire.FeedbagItem{ClassID: wire.FeedbagClassIDDeny, Name: "blockeduser"}
  433. buddyItem := wire.FeedbagItem{ClassID: wire.FeedbagClassIdBuddy, Name: "friend"}
  434. tests := []struct {
  435. name string
  436. subGroup uint16
  437. body any
  438. wantEvent bool
  439. }{
  440. {
  441. name: "insert relays an update body",
  442. subGroup: wire.FeedbagInsertItem,
  443. body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{Items: []wire.FeedbagItem{denyItem}},
  444. wantEvent: true,
  445. },
  446. {
  447. name: "update",
  448. subGroup: wire.FeedbagUpdateItem,
  449. body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{Items: []wire.FeedbagItem{denyItem}},
  450. wantEvent: true,
  451. },
  452. {
  453. name: "delete",
  454. subGroup: wire.FeedbagDeleteItem,
  455. body: wire.SNAC_0x13_0x0A_FeedbagDeleteItem{Items: []wire.FeedbagItem{denyItem}},
  456. wantEvent: true,
  457. },
  458. {
  459. name: "buddy item only",
  460. subGroup: wire.FeedbagInsertItem,
  461. body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{Items: []wire.FeedbagItem{buddyItem}},
  462. wantEvent: false,
  463. },
  464. }
  465. for _, tt := range tests {
  466. t.Run(tt.name, func(t *testing.T) {
  467. sess := &Session{
  468. ScreenName: state.DisplayScreenName("me"),
  469. EventQueue: NewEventQueue(10),
  470. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  471. PermitDenyRefresher: func(_ context.Context) (any, error) {
  472. return map[string]any{"pdMode": "denySome"}, nil
  473. },
  474. FeedbagLoader: emptyFeedbagLoader,
  475. }
  476. sess.handleFeedbagMessage(wire.SNACMessage{
  477. Frame: wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: tt.subGroup},
  478. Body: tt.body,
  479. })
  480. var got int
  481. for _, event := range sess.EventQueue.GetAllEvents() {
  482. if event.Type == EventTypePermitDeny {
  483. got++
  484. }
  485. }
  486. if tt.wantEvent {
  487. assert.Equal(t, 1, got)
  488. } else {
  489. assert.Zero(t, got)
  490. }
  491. })
  492. }
  493. }
  494. // A session sees no SNAC for feedbag writes it makes itself, so the handlers that
  495. // perform those writes invalidate the cache directly.
  496. func TestSession_InvalidateFeedbag(t *testing.T) {
  497. alias := "MICHAELKELLY"
  498. sess := &Session{
  499. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  500. FeedbagLoader: func(context.Context) ([]wire.FeedbagItem, error) {
  501. return aliasFeedbagItems(map[string]string{"mikekelly": alias}), nil
  502. },
  503. }
  504. assert.Equal(t, "MICHAELKELLY", sess.Aliases(context.Background())["mikekelly"])
  505. alias = "MIKE"
  506. assert.Equal(t, "MICHAELKELLY", sess.Aliases(context.Background())["mikekelly"], "cached until invalidated")
  507. sess.InvalidateFeedbag()
  508. assert.Equal(t, "MIKE", sess.Aliases(context.Background())["mikekelly"])
  509. }
  510. // A failed load must not be cached as an empty map: aliases would stay missing for
  511. // the life of the session.
  512. func TestSession_FeedbagLoadErrorIsNotCached(t *testing.T) {
  513. var loads int
  514. sess := &Session{
  515. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  516. FeedbagLoader: func(context.Context) ([]wire.FeedbagItem, error) {
  517. loads++
  518. if loads == 1 {
  519. return nil, io.EOF
  520. }
  521. return aliasFeedbagItems(map[string]string{"mikekelly": "MICHAELKELLY"}), nil
  522. },
  523. }
  524. assert.Empty(t, sess.Aliases(context.Background()))
  525. assert.Equal(t, "MICHAELKELLY", sess.Aliases(context.Background())["mikekelly"])
  526. }
  527. func TestSession_HandleIncomingIM_NormalizesAimID(t *testing.T) {
  528. sess := &Session{
  529. ScreenName: state.DisplayScreenName("me"),
  530. Events: []string{"im", "conversation"},
  531. EventQueue: NewEventQueue(10),
  532. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  533. FeedbagLoader: emptyFeedbagLoader,
  534. }
  535. frags, err := wire.ICBMFragmentListASCII("hello")
  536. assert.NoError(t, err)
  537. body := wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
  538. ChannelID: wire.ICBMChannelIM,
  539. TLVUserInfo: wire.TLVUserInfo{ScreenName: "Mike Kelly"},
  540. }
  541. body.Append(wire.NewTLVBE(wire.ICBMTLVAOLIMData, frags))
  542. sess.handleIncomingIM(wire.SNACMessage{Body: body})
  543. events := sess.EventQueue.GetAllEvents()
  544. require.Len(t, events, 2)
  545. imEvent := events[0].Data.(IMEvent)
  546. assert.Equal(t, "mikekelly", imEvent.Source.AimID)
  547. assert.Equal(t, "Mike Kelly", imEvent.Source.DisplayID)
  548. convData := events[1].Data.(*ConversationData)
  549. require.Len(t, convData.Conversations, 1)
  550. entry := convData.Conversations[0]
  551. assert.Equal(t, "mikekelly", entry.AimID)
  552. assert.Equal(t, "Mike Kelly", entry.DisplayID)
  553. require.NotNil(t, entry.LastIM)
  554. assert.Equal(t, "mikekelly", entry.LastIM.Sender)
  555. // The IM log is keyed by aimId, so the conversation the client opens from
  556. // this event finds its own history.
  557. msgs := sess.GetStoredIMs(StoredIMQuery{PartnerAimID: "mikekelly", NToGet: 10})
  558. require.Len(t, msgs, 1)
  559. assert.Equal(t, "hello", msgs[0].Message)
  560. }
  561. func TestSession_HandleIncomingIM_TracksPeerWantsTyping(t *testing.T) {
  562. frags, err := wire.ICBMFragmentListASCII("hello")
  563. require.NoError(t, err)
  564. im := func(wantEvents bool, offline bool) wire.SNACMessage {
  565. body := wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
  566. ChannelID: wire.ICBMChannelIM,
  567. TLVUserInfo: wire.TLVUserInfo{ScreenName: "Mike Kelly"},
  568. }
  569. body.Append(wire.NewTLVBE(wire.ICBMTLVAOLIMData, frags))
  570. if wantEvents {
  571. body.Append(wire.NewTLVBE(wire.ICBMTLVWantEvents, []byte{}))
  572. }
  573. if offline {
  574. body.Append(wire.NewTLVBE(wire.ICBMTLVSendTime, uint32(1)))
  575. }
  576. return wire.SNACMessage{Body: body}
  577. }
  578. sess := &Session{
  579. ScreenName: state.DisplayScreenName("me"),
  580. EventQueue: NewEventQueue(10),
  581. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  582. FeedbagLoader: emptyFeedbagLoader,
  583. }
  584. peer := state.NewIdentScreenName("mikekelly")
  585. assert.False(t, sess.PeerWantsTyping(peer), "no IM received yet")
  586. sess.handleIncomingIM(im(true, false))
  587. assert.True(t, sess.PeerWantsTyping(peer))
  588. sess.handleIncomingIM(im(false, true))
  589. assert.True(t, sess.PeerWantsTyping(peer), "offline IM does not change the peer's preference")
  590. sess.handleIncomingIM(im(false, false))
  591. assert.False(t, sess.PeerWantsTyping(peer))
  592. }
  593. func TestSession_HandleTypingNotification_NormalizesAimID(t *testing.T) {
  594. sess := &Session{
  595. Events: []string{"typing"},
  596. EventQueue: NewEventQueue(10),
  597. FeedbagLoader: emptyFeedbagLoader,
  598. }
  599. sess.handleTypingNotification(wire.SNACMessage{
  600. Body: wire.SNAC_0x04_0x14_ICBMClientEvent{
  601. ScreenName: "Mike Kelly",
  602. Event: 0x0002,
  603. },
  604. })
  605. events := sess.EventQueue.GetAllEvents()
  606. require.Len(t, events, 1)
  607. typing := events[0].Data.(TypingEvent)
  608. assert.Equal(t, "mikekelly", typing.AimID)
  609. assert.Equal(t, "typing", typing.TypingStatus)
  610. }
  611. func TestSession_HandleBuddyArrivedDeparted_NormalizesAimID(t *testing.T) {
  612. sess := &Session{
  613. Events: []string{"presence"},
  614. EventQueue: NewEventQueue(10),
  615. FeedbagLoader: emptyFeedbagLoader,
  616. }
  617. sess.handleBuddyArrived(wire.SNACMessage{
  618. Body: wire.SNAC_0x03_0x0B_BuddyArrived{
  619. TLVUserInfo: wire.TLVUserInfo{ScreenName: "Mike Kelly"},
  620. },
  621. })
  622. sess.handleBuddyDeparted(wire.SNACMessage{
  623. Body: wire.SNAC_0x03_0x0C_BuddyDeparted{
  624. TLVUserInfo: wire.TLVUserInfo{ScreenName: "Mike Kelly"},
  625. },
  626. })
  627. events := sess.EventQueue.GetAllEvents()
  628. require.Len(t, events, 2)
  629. arrived := events[0].Data.(PresenceEvent)
  630. assert.Equal(t, "mikekelly", arrived.AimID)
  631. assert.Equal(t, "online", arrived.State)
  632. departed := events[1].Data.(PresenceEvent)
  633. assert.Equal(t, "mikekelly", departed.AimID)
  634. assert.Equal(t, "offline", departed.State)
  635. }
  636. // A BuddyArrived carries the buddy's current icon as TLV 0x1D, so an icon change
  637. // rides along on the presence broadcast and must reach the presence event. The
  638. // stub BuddyIconURL stands in for the handlers-side URL formatter, which state
  639. // cannot import.
  640. var testIconBART = wire.BARTID{
  641. Type: wire.BARTTypesBuddyIcon,
  642. BARTInfo: wire.BARTInfo{Hash: []byte{0xde, 0xad, 0xbe, 0xef}},
  643. }
  644. var testStatusBART = statusBARTID("brb")
  645. // statusBARTID builds the BART item that advertises statusMsg as a user's status
  646. // message. It panics only on a message too long to fit the item.
  647. func statusBARTID(statusMsg string) wire.BARTID {
  648. var id wire.BARTID
  649. if err := id.SetStatusText(statusMsg); err != nil {
  650. panic(err)
  651. }
  652. return id
  653. }
  654. func TestSession_PublishesBuddyIconOnPresence(t *testing.T) {
  655. newSession := func() *Session {
  656. return &Session{
  657. ScreenName: state.DisplayScreenName("me"),
  658. Events: []string{"presence"},
  659. EventQueue: NewEventQueue(10),
  660. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  661. BuddyIconURL: func(sn state.IdentScreenName, hash []byte) string {
  662. if len(hash) == 0 {
  663. return "placeholder:" + sn.String()
  664. }
  665. return "icon:" + hex.EncodeToString(hash)
  666. },
  667. FeedbagLoader: emptyFeedbagLoader,
  668. }
  669. }
  670. arrived := func(sess *Session, screenName string, hash []byte) {
  671. info := wire.TLVUserInfo{ScreenName: screenName}
  672. if hash != nil {
  673. info.Append(wire.NewTLVBE(wire.OServiceUserInfoBARTInfo, wire.BARTID{
  674. Type: wire.BARTTypesBuddyIcon,
  675. BARTInfo: wire.BARTInfo{Hash: hash},
  676. }))
  677. }
  678. sess.handleBuddyArrived(wire.SNACMessage{Body: wire.SNAC_0x03_0x0B_BuddyArrived{TLVUserInfo: info}})
  679. }
  680. lastPresence := func(sess *Session) PresenceEvent {
  681. events := sess.EventQueue.GetAllEvents()
  682. require.Len(t, events, 1)
  683. return events[0].Data.(PresenceEvent)
  684. }
  685. t.Run("icon hash yields the content-addressed URL", func(t *testing.T) {
  686. sess := newSession()
  687. arrived(sess, "Mike Kelly", []byte{0xde, 0xad, 0xbe, 0xef})
  688. assert.Equal(t, "icon:deadbeef", lastPresence(sess).BuddyIcon)
  689. })
  690. t.Run("no icon TLV yields the placeholder URL", func(t *testing.T) {
  691. sess := newSession()
  692. arrived(sess, "Mike Kelly", nil)
  693. assert.Equal(t, "placeholder:mikekelly", lastPresence(sess).BuddyIcon)
  694. })
  695. // The BART TLV is a list, so a status message rides in it next to the icon.
  696. arrivedBART := func(sess *Session, screenName string, ids []wire.BARTID) {
  697. info := wire.TLVUserInfo{ScreenName: screenName}
  698. info.Append(wire.NewTLVBE(wire.OServiceUserInfoBARTInfo, ids))
  699. sess.handleBuddyArrived(wire.SNACMessage{Body: wire.SNAC_0x03_0x0B_BuddyArrived{TLVUserInfo: info}})
  700. }
  701. t.Run("a buddy's status message reaches the presence event", func(t *testing.T) {
  702. sess := newSession()
  703. arrivedBART(sess, "Mike Kelly", []wire.BARTID{testIconBART, testStatusBART})
  704. assert.Equal(t, "brb", lastPresence(sess).StatusMsg)
  705. })
  706. t.Run("no status message leaves the field empty", func(t *testing.T) {
  707. sess := newSession()
  708. arrivedBART(sess, "Mike Kelly", []wire.BARTID{testIconBART})
  709. assert.Empty(t, lastPresence(sess).StatusMsg)
  710. })
  711. t.Run("a status message next to the icon does not displace it", func(t *testing.T) {
  712. sess := newSession()
  713. arrivedBART(sess, "Mike Kelly", []wire.BARTID{testIconBART, testStatusBART})
  714. assert.Equal(t, "icon:deadbeef", lastPresence(sess).BuddyIcon)
  715. })
  716. t.Run("a status message without an icon yields the placeholder URL", func(t *testing.T) {
  717. sess := newSession()
  718. arrivedBART(sess, "Mike Kelly", []wire.BARTID{testStatusBART})
  719. assert.Equal(t, "placeholder:mikekelly", lastPresence(sess).BuddyIcon)
  720. })
  721. t.Run("cleared icon yields a URL naming the sentinel hash", func(t *testing.T) {
  722. sess := newSession()
  723. arrived(sess, "Mike Kelly", wire.GetClearIconHash())
  724. assert.Equal(t, "icon:"+hex.EncodeToString(wire.GetClearIconHash()), lastPresence(sess).BuddyIcon)
  725. })
  726. t.Run("departed omits the icon so the client preserves it", func(t *testing.T) {
  727. sess := newSession()
  728. sess.handleBuddyDeparted(wire.SNACMessage{Body: wire.SNAC_0x03_0x0C_BuddyDeparted{
  729. TLVUserInfo: wire.TLVUserInfo{ScreenName: "Mike Kelly"},
  730. }})
  731. assert.Empty(t, lastPresence(sess).BuddyIcon)
  732. })
  733. t.Run("no callback wired omits the icon", func(t *testing.T) {
  734. sess := newSession()
  735. sess.BuddyIconURL = nil
  736. arrived(sess, "Mike Kelly", []byte{0x01})
  737. assert.Empty(t, lastPresence(sess).BuddyIcon)
  738. })
  739. }
  740. // A change to a user's own info is relayed to their session as
  741. // OServiceUserInfoUpdate, which the pump turns into a myInfo event so the
  742. // identity badge re-renders.
  743. func TestSession_PushesMyInfoOnUserInfoUpdate(t *testing.T) {
  744. newSession := func(events ...string) *Session {
  745. return &Session{
  746. ScreenName: state.DisplayScreenName("me"),
  747. OSCARSession: state.NewSession().AddInstance(),
  748. BaseURL: "http://api.example.com",
  749. Events: events,
  750. EventQueue: NewEventQueue(10),
  751. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  752. BuddyIconURL: func(sn state.IdentScreenName, hash []byte) string {
  753. if len(hash) == 0 {
  754. return "placeholder:" + sn.String()
  755. }
  756. return "icon:" + hex.EncodeToString(hash)
  757. },
  758. FeedbagLoader: emptyFeedbagLoader,
  759. }
  760. }
  761. update := func(info wire.TLVUserInfo) wire.SNACMessage {
  762. return wire.SNACMessage{
  763. Frame: wire.SNACFrame{
  764. FoodGroup: wire.OService,
  765. SubGroup: wire.OServiceUserInfoUpdate,
  766. },
  767. Body: wire.SNAC_0x01_0x0F_OServiceUserInfoUpdate{
  768. UserInfo: []wire.TLVUserInfo{info},
  769. },
  770. }
  771. }
  772. lastMyInfo := func(t *testing.T, sess *Session) *MyInfo {
  773. t.Helper()
  774. events := sess.EventQueue.GetAllEvents()
  775. require.Len(t, events, 1)
  776. require.Equal(t, EventTypeMyInfo, events[0].Type)
  777. return events[0].Data.(*MyInfo)
  778. }
  779. t.Run("subscribed session gets one myInfo built from the SNAC", func(t *testing.T) {
  780. sess := newSession("myInfo")
  781. sess.handleSNACMessage(update(wire.TLVUserInfo{ScreenName: "Mike Kelly"}))
  782. myInfo := lastMyInfo(t, sess)
  783. assert.Equal(t, "mikekelly", myInfo.AimID)
  784. assert.Equal(t, "Mike Kelly", myInfo.DisplayID)
  785. assert.Equal(t, "Mike Kelly", myInfo.Friendly)
  786. assert.Equal(t, "online", myInfo.State)
  787. })
  788. t.Run("a presence subscription also delivers myInfo", func(t *testing.T) {
  789. sess := newSession("presence")
  790. sess.handleSNACMessage(update(wire.TLVUserInfo{ScreenName: "me"}))
  791. assert.Len(t, sess.EventQueue.GetAllEvents(), 1)
  792. })
  793. t.Run("unsubscribed session gets nothing", func(t *testing.T) {
  794. sess := newSession("im")
  795. sess.handleSNACMessage(update(wire.TLVUserInfo{ScreenName: "me"}))
  796. assert.Empty(t, sess.EventQueue.GetAllEvents())
  797. })
  798. t.Run("other OService subgroups are ignored", func(t *testing.T) {
  799. sess := newSession("myInfo")
  800. sess.handleSNACMessage(wire.SNACMessage{Frame: wire.SNACFrame{
  801. FoodGroup: wire.OService,
  802. SubGroup: wire.OServiceRateParamsQuery,
  803. }})
  804. assert.Empty(t, sess.EventQueue.GetAllEvents())
  805. })
  806. t.Run("an update carrying no user info block pushes nothing", func(t *testing.T) {
  807. sess := newSession("myInfo")
  808. sess.handleSNACMessage(wire.SNACMessage{
  809. Frame: wire.SNACFrame{
  810. FoodGroup: wire.OService,
  811. SubGroup: wire.OServiceUserInfoUpdate,
  812. },
  813. Body: wire.SNAC_0x01_0x0F_OServiceUserInfoUpdate{},
  814. })
  815. assert.Empty(t, sess.EventQueue.GetAllEvents())
  816. })
  817. t.Run("the away message comes from the session", func(t *testing.T) {
  818. sess := newSession("myInfo")
  819. // Session.AwayMessage reads only instances that are actually away.
  820. sess.OSCARSession.SetUserInfoFlag(wire.OServiceUserFlagUnavailable)
  821. sess.OSCARSession.SetAwayMessage("brb")
  822. info := wire.TLVUserInfo{ScreenName: "me"}
  823. info.Append(wire.NewTLVBE(wire.OServiceUserInfoUserFlags, wire.OServiceUserFlagUnavailable))
  824. sess.handleSNACMessage(update(info))
  825. myInfo := lastMyInfo(t, sess)
  826. assert.Equal(t, "away", myInfo.State)
  827. assert.Equal(t, "brb", myInfo.AwayMsg)
  828. })
  829. t.Run("a mood capability publishes its icon", func(t *testing.T) {
  830. sess := newSession("myInfo")
  831. info := wire.TLVUserInfo{ScreenName: "me"}
  832. info.Append(wire.NewTLVBE(wire.OServiceUserInfoOscarCaps, wire.CapXStatusPlate[:]))
  833. sess.handleSNACMessage(update(info))
  834. assert.Equal(t, "http://api.example.com/mood?id="+wire.MoodIconID("0icqmood6"), lastMyInfo(t, sess).MoodIcon)
  835. })
  836. t.Run("the icon hash yields the content-addressed URL", func(t *testing.T) {
  837. sess := newSession("myInfo")
  838. info := wire.TLVUserInfo{ScreenName: "me"}
  839. info.Append(wire.NewTLVBE(wire.OServiceUserInfoBARTInfo, wire.BARTID{
  840. Type: wire.BARTTypesBuddyIcon,
  841. BARTInfo: wire.BARTInfo{Hash: []byte{0xde, 0xad, 0xbe, 0xef}},
  842. }))
  843. sess.handleSNACMessage(update(info))
  844. assert.Equal(t, "icon:deadbeef", lastMyInfo(t, sess).BuddyIcon)
  845. })
  846. t.Run("a status message without an icon yields the placeholder URL", func(t *testing.T) {
  847. sess := newSession("myInfo")
  848. info := wire.TLVUserInfo{ScreenName: "me"}
  849. info.Append(wire.NewTLVBE(wire.OServiceUserInfoBARTInfo, []wire.BARTID{testStatusBART}))
  850. sess.handleSNACMessage(update(info))
  851. assert.Equal(t, "placeholder:me", lastMyInfo(t, sess).BuddyIcon)
  852. })
  853. // The user info update is the only myInfo raised after a status message is set,
  854. // so dropping the text here erases it from the user's own badge.
  855. t.Run("the user's own status message survives the update", func(t *testing.T) {
  856. sess := newSession("myInfo")
  857. info := wire.TLVUserInfo{ScreenName: "me"}
  858. info.Append(wire.NewTLVBE(wire.OServiceUserInfoBARTInfo, []wire.BARTID{testStatusBART}))
  859. sess.handleSNACMessage(update(info))
  860. assert.Equal(t, "brb", lastMyInfo(t, sess).StatusMsg)
  861. })
  862. t.Run("no status message leaves the field empty", func(t *testing.T) {
  863. sess := newSession("myInfo")
  864. sess.handleSNACMessage(update(wire.TLVUserInfo{ScreenName: "me"}))
  865. assert.Empty(t, lastMyInfo(t, sess).StatusMsg)
  866. })
  867. t.Run("no icon TLV yields the placeholder URL, which clears a removed icon", func(t *testing.T) {
  868. sess := newSession("myInfo")
  869. sess.handleSNACMessage(update(wire.TLVUserInfo{ScreenName: "me"}))
  870. assert.Equal(t, "placeholder:me", lastMyInfo(t, sess).BuddyIcon)
  871. })
  872. t.Run("the state is read off the user info block", func(t *testing.T) {
  873. tests := []struct {
  874. name string
  875. screenName string
  876. flags uint16
  877. status uint32
  878. idle uint16
  879. want string
  880. }{
  881. {name: "invisible", screenName: "me", status: wire.OServiceUserStatusInvisible, want: "invisible"},
  882. {name: "icq busy", screenName: "100003", status: wire.OServiceUserStatusBusy, want: "occupied"},
  883. {name: "aim busy reports away", screenName: "me", status: wire.OServiceUserStatusBusy, want: "away"},
  884. {name: "icq dnd", screenName: "100003", status: wire.OServiceUserStatusDND, want: "dnd"},
  885. {name: "away flag", screenName: "me", flags: wire.OServiceUserFlagUnavailable, want: "away"},
  886. {name: "away status bit", screenName: "me", status: wire.OServiceUserStatusAway, want: "away"},
  887. {name: "idle", screenName: "me", idle: 5, want: "idle"},
  888. {name: "nothing set", screenName: "me", want: "online"},
  889. }
  890. for _, tt := range tests {
  891. t.Run(tt.name, func(t *testing.T) {
  892. sess := newSession("myInfo")
  893. info := wire.TLVUserInfo{ScreenName: tt.screenName}
  894. info.Append(wire.NewTLVBE(wire.OServiceUserInfoUserFlags, tt.flags))
  895. info.Append(wire.NewTLVBE(wire.OServiceUserInfoStatus, tt.status))
  896. if tt.idle > 0 {
  897. info.Append(wire.NewTLVBE(wire.OServiceUserInfoIdleTime, tt.idle))
  898. }
  899. sess.handleSNACMessage(update(info))
  900. assert.Equal(t, tt.want, lastMyInfo(t, sess).State)
  901. })
  902. }
  903. })
  904. }
  905. // TestSessionManager_ShutdownBoundedByContext verifies that Shutdown
  906. // honors its context instead of blocking indefinitely. A listener goroutine that
  907. // ignores cancellation must not be able to hold the whole server open: main
  908. // budgets a few seconds for every server's shutdown combined, so an unbounded
  909. // wait here means the process never exits.
  910. func TestSessionManager_ShutdownBoundedByContext(t *testing.T) {
  911. mgr := NewSessionManager()
  912. inst := state.NewSession().AddInstance()
  913. sess, err := mgr.CreateSession("alice", []string{"presence"}, inst, "", slog.Default())
  914. assert.NoError(t, err)
  915. sess.FeedbagLoader = emptyFeedbagLoader
  916. // Stand in for a listener wedged somewhere that never observes cancellation.
  917. release := make(chan struct{})
  918. defer close(release)
  919. sess.listeners.Go(func() {
  920. <-release
  921. })
  922. ctx, cancel := context.WithTimeout(context.Background(), 100*time.Millisecond)
  923. defer cancel()
  924. start := time.Now()
  925. err = mgr.Shutdown(ctx)
  926. elapsed := time.Since(start)
  927. assert.ErrorIs(t, err, context.DeadlineExceeded)
  928. assert.Less(t, elapsed, 2*time.Second, "Shutdown must give up at its deadline, not wait on the stuck listener")
  929. }
  930. // TestSession_CloseCancelsSessionContext verifies that Close cancels the
  931. // context handed to the refresher callbacks. The listener runs feedbag queries
  932. // through it, and without cancellation Close's wait lasts as long as the query.
  933. func TestSession_CloseCancelsSessionContext(t *testing.T) {
  934. mgr := NewSessionManager()
  935. inst := state.NewSession().AddInstance()
  936. sess, err := mgr.CreateSession("alice", []string{"presence"}, inst, "", slog.Default())
  937. assert.NoError(t, err)
  938. sess.FeedbagLoader = emptyFeedbagLoader
  939. assert.NoError(t, sess.ctx.Err(), "session context should be live before Close")
  940. sess.Close()
  941. assert.ErrorIs(t, sess.ctx.Err(), context.Canceled)
  942. }
  943. // A message replayed out of the offline store arrives as an ordinary
  944. // ICBMChannelMsgToClient stamped with a send time. The client models that as its
  945. // own offlineIM event, keyed by a bare aimId and timestamped when the sender sent
  946. // it rather than when it was delivered.
  947. func TestSession_OfflineIM(t *testing.T) {
  948. sentAt := time.Now().Add(-2 * time.Hour).Unix()
  949. newSession := func(events ...string) *Session {
  950. return &Session{
  951. ScreenName: state.DisplayScreenName("me"),
  952. Events: events,
  953. EventQueue: NewEventQueue(10),
  954. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  955. FeedbagLoader: emptyFeedbagLoader,
  956. }
  957. }
  958. storedMsg := func(t *testing.T, withSendTime bool) wire.SNACMessage {
  959. t.Helper()
  960. frags, err := wire.ICBMFragmentListASCII("sent while you were out")
  961. require.NoError(t, err)
  962. body := wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
  963. ChannelID: wire.ICBMChannelIM,
  964. TLVUserInfo: wire.TLVUserInfo{ScreenName: "Mike Kelly"},
  965. }
  966. body.Append(wire.NewTLVBE(wire.ICBMTLVAOLIMData, frags))
  967. if withSendTime {
  968. body.Append(wire.NewTLVBE(wire.ICBMTLVSendTime, uint32(sentAt)))
  969. }
  970. return wire.SNACMessage{Body: body}
  971. }
  972. t.Run("send time yields an offlineIM event", func(t *testing.T) {
  973. sess := newSession("im", "offlineIM")
  974. sess.handleIncomingIM(storedMsg(t, true))
  975. events := sess.EventQueue.GetAllEvents()
  976. require.Len(t, events, 1)
  977. assert.Equal(t, EventTypeOfflineIM, events[0].Type)
  978. offline := events[0].Data.(OfflineIMEvent)
  979. assert.Equal(t, "mikekelly", offline.AimID)
  980. assert.Equal(t, "sent while you were out", offline.Message)
  981. assert.NotEmpty(t, offline.MsgID)
  982. assert.Equal(t, int64(sentAt), offline.Timestamp)
  983. })
  984. t.Run("no send time yields an im event", func(t *testing.T) {
  985. sess := newSession("im", "offlineIM")
  986. sess.handleIncomingIM(storedMsg(t, false))
  987. events := sess.EventQueue.GetAllEvents()
  988. require.Len(t, events, 1)
  989. assert.Equal(t, EventTypeIM, events[0].Type)
  990. })
  991. t.Run("offlineIM subscriber gets a conversation update", func(t *testing.T) {
  992. sess := newSession("offlineIM", "conversation")
  993. sess.handleIncomingIM(storedMsg(t, true))
  994. events := sess.EventQueue.GetAllEvents()
  995. require.Len(t, events, 2)
  996. assert.Equal(t, EventTypeOfflineIM, events[0].Type)
  997. assert.Equal(t, EventTypeConversation, events[1].Type)
  998. })
  999. // The history the client pulls with fetchStoredIMs has to order the message by
  1000. // when it was sent, not when the session that drained the store started.
  1001. t.Run("logs the message under its send time", func(t *testing.T) {
  1002. sess := newSession("offlineIM")
  1003. sess.handleIncomingIM(storedMsg(t, true))
  1004. stored := sess.GetStoredIMs(StoredIMQuery{PartnerAimID: "mikekelly", NToGet: 10})
  1005. require.Len(t, stored, 1)
  1006. assert.Equal(t, int64(sentAt), stored[0].Date)
  1007. })
  1008. // Only a live IM is filtered on subscription here. Retrieval answers the
  1009. // instance that asked and StartSession asks only for an offlineIM subscriber,
  1010. // so a stamped message reaching a session that did not subscribe is not a state
  1011. // this handler can be put in.
  1012. t.Run("no subscription drops a live message", func(t *testing.T) {
  1013. sess := newSession("presence")
  1014. sess.handleIncomingIM(storedMsg(t, false))
  1015. assert.Empty(t, sess.EventQueue.GetAllEvents())
  1016. })
  1017. }
  1018. // A boot closes the account's OSCAR session out from under its web session. The
  1019. // client is parked on a long poll at that moment, so it must be released with a
  1020. // sessionEnded event rather than left to hang until the reaper's next sweep —
  1021. // which measured 26-28s against a running server.
  1022. func TestSession_BootReleasesParkedFetcherWithSessionEnded(t *testing.T) {
  1023. mgr := NewSessionManager()
  1024. inst := state.NewSession().AddInstance()
  1025. sess, err := mgr.CreateSession(state.DisplayScreenName("mike"), []string{"presence"}, inst, "", slog.Default())
  1026. require.NoError(t, err)
  1027. sess.FeedbagLoader = emptyFeedbagLoader
  1028. sess.StartListeningToOSCARSession()
  1029. // Park a fetcher the way fetchEvents does, with nothing pending.
  1030. type result struct {
  1031. events []Event
  1032. err error
  1033. }
  1034. done := make(chan result, 1)
  1035. go func() {
  1036. events, err := sess.EventQueue.Fetch(context.Background(), 0, 60*time.Second)
  1037. done <- result{events, err}
  1038. }()
  1039. // Let the fetcher block before the session is taken away.
  1040. time.Sleep(50 * time.Millisecond)
  1041. inst.Session().CloseSession()
  1042. select {
  1043. case got := <-done:
  1044. require.NoError(t, got.err)
  1045. require.Len(t, got.events, 1)
  1046. assert.Equal(t, EventTypeSessionEnded, got.events[0].Type)
  1047. case <-time.After(5 * time.Second):
  1048. t.Fatal("parked fetcher was not released by the boot")
  1049. }
  1050. }
  1051. // A session tearing itself down — endSession, or the idle reaper — needs no
  1052. // sessionEnded event: the client already knows it is leaving. Close closes the
  1053. // queue before the instance, so the listener's push lands on a closed queue.
  1054. func TestSession_SelfCloseEmitsNoSessionEndedEvent(t *testing.T) {
  1055. mgr := NewSessionManager()
  1056. inst := state.NewSession().AddInstance()
  1057. sess, err := mgr.CreateSession(state.DisplayScreenName("mike"), []string{"presence"}, inst, "", slog.Default())
  1058. require.NoError(t, err)
  1059. sess.FeedbagLoader = emptyFeedbagLoader
  1060. sess.StartListeningToOSCARSession()
  1061. require.NoError(t, mgr.RemoveSession(context.Background(), sess.AimSID))
  1062. events, err := sess.EventQueue.Fetch(context.Background(), 0, time.Second)
  1063. require.NoError(t, err)
  1064. assert.Empty(t, events)
  1065. }
  1066. func TestSession_GetStoredIMs(t *testing.T) {
  1067. sess := &Session{}
  1068. sess.AddStoredIM("buddy1", "me", "hello", "msg-1", 100)
  1069. sess.AddStoredIM("buddy1", "buddy1", "hi back", "msg-2", 200)
  1070. sess.AddStoredIM("buddy2", "buddy2", "other chat", "msg-3", 150)
  1071. msgs := sess.GetStoredIMs(StoredIMQuery{
  1072. PartnerAimID: "buddy1",
  1073. SortOrder: "descendingDate",
  1074. NToGet: 10,
  1075. })
  1076. assert.Len(t, msgs, 2)
  1077. assert.Equal(t, "msg-2", msgs[0].MsgID)
  1078. assert.Equal(t, int64(200), msgs[0].Date)
  1079. assert.Equal(t, "hello", msgs[1].Message)
  1080. msgs = sess.GetStoredIMs(StoredIMQuery{
  1081. PartnerAimID: "buddy1",
  1082. SortOrder: "ascendingDate",
  1083. StartTime: 150,
  1084. EndTime: 250,
  1085. })
  1086. assert.Len(t, msgs, 1)
  1087. assert.Equal(t, "msg-2", msgs[0].MsgID)
  1088. }
  1089. func TestSession_GetStoredIMs_NormalizesPartner(t *testing.T) {
  1090. sess := &Session{}
  1091. sess.AddStoredIM("Mike Kelly", "mikekelly", "hello", "msg-1", 100)
  1092. // The web client queries history by the normalized aimId, never by the
  1093. // display screen name it was stored under.
  1094. msgs := sess.GetStoredIMs(StoredIMQuery{
  1095. PartnerAimID: "mikekelly",
  1096. NToGet: 10,
  1097. })
  1098. require.Len(t, msgs, 1)
  1099. assert.Equal(t, "msg-1", msgs[0].MsgID)
  1100. }
  1101. // A session gets no insert/update/delete SNAC for a feedbag change it made itself —
  1102. // those reach only a user's *other* instances. FeedbagStatus is the one notification
  1103. // it does receive, so it drives the roster event for the client's own edits.
  1104. func TestSession_FeedbagStatusRefreshesBuddyList(t *testing.T) {
  1105. tests := []struct {
  1106. name string
  1107. events []string
  1108. results []uint16
  1109. body any
  1110. wantEvent bool
  1111. }{
  1112. {
  1113. name: "stored item refreshes the roster",
  1114. events: []string{"buddylist"},
  1115. results: []uint16{0x0000},
  1116. wantEvent: true,
  1117. },
  1118. {
  1119. // The declined item is still worth a refresh: the roster is how the
  1120. // client discovers the buddy was not stored, since it is absent from it.
  1121. name: "declined item still refreshes the roster",
  1122. events: []string{"buddylist"},
  1123. results: []uint16{feedbagResultAuthRequired},
  1124. wantEvent: true,
  1125. },
  1126. {
  1127. name: "no event when not subscribed",
  1128. events: []string{"presence"},
  1129. results: []uint16{0x0000},
  1130. wantEvent: false,
  1131. },
  1132. {
  1133. name: "a body of the wrong type still refreshes",
  1134. events: []string{"buddylist"},
  1135. body: wire.SNAC_0x13_0x06_FeedbagReply{},
  1136. wantEvent: true,
  1137. },
  1138. }
  1139. for _, tt := range tests {
  1140. t.Run(tt.name, func(t *testing.T) {
  1141. refreshed := 0
  1142. sess := &Session{
  1143. ScreenName: state.DisplayScreenName("me"),
  1144. Events: tt.events,
  1145. EventQueue: NewEventQueue(10),
  1146. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  1147. BuddyListRefresher: func(_ context.Context) (any, error) {
  1148. refreshed++
  1149. return &BuddyListData{Groups: []BuddyGroup{}}, nil
  1150. },
  1151. FeedbagLoader: emptyFeedbagLoader,
  1152. }
  1153. body := tt.body
  1154. if body == nil {
  1155. body = wire.SNAC_0x13_0x0E_FeedbagStatus{Results: tt.results}
  1156. }
  1157. sess.handleFeedbagMessage(wire.SNACMessage{
  1158. Frame: wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagStatus},
  1159. Body: body,
  1160. })
  1161. var got int
  1162. for _, event := range sess.EventQueue.GetAllEvents() {
  1163. if event.Type == EventTypeBuddyList {
  1164. got++
  1165. }
  1166. }
  1167. if tt.wantEvent {
  1168. assert.Equal(t, 1, got)
  1169. assert.Equal(t, 1, refreshed)
  1170. } else {
  1171. assert.Zero(t, got)
  1172. assert.Zero(t, refreshed, "an unsubscribed session should not even query the roster")
  1173. }
  1174. })
  1175. }
  1176. }
  1177. func TestSession_HandleClientError(t *testing.T) {
  1178. const (
  1179. cookie = uint64(0xDEADBEEFCAFEF00D)
  1180. msgID = "11112222-3333-4444-8000-555566667777"
  1181. )
  1182. tests := []struct {
  1183. name string
  1184. // events is what the session subscribed to at startSession.
  1185. events []string
  1186. // record seeds the cookie->msgId map the way a prior im/sendIM would.
  1187. record bool
  1188. channelID uint16
  1189. wantEvent bool
  1190. wantCooki string
  1191. wantChan string
  1192. }{
  1193. {
  1194. name: "im channel names the message this session sent",
  1195. events: []string{"im"},
  1196. record: true,
  1197. channelID: wire.ICBMChannelIM,
  1198. wantEvent: true,
  1199. wantCooki: msgID,
  1200. wantChan: "im",
  1201. },
  1202. {
  1203. name: "rendezvous channel is reported as data",
  1204. events: []string{"im"},
  1205. record: true,
  1206. channelID: wire.ICBMChannelRendezvous,
  1207. wantEvent: true,
  1208. wantCooki: msgID,
  1209. wantChan: "data",
  1210. },
  1211. {
  1212. // Another instance of the account sent the message, so this session
  1213. // has no msgId for it and must not invent one.
  1214. name: "unknown cookie yields an empty msgId",
  1215. events: []string{"im"},
  1216. record: false,
  1217. channelID: wire.ICBMChannelIM,
  1218. wantEvent: true,
  1219. wantCooki: "",
  1220. wantChan: "im",
  1221. },
  1222. {
  1223. name: "not subscribed to im",
  1224. events: []string{"presence"},
  1225. record: true,
  1226. channelID: wire.ICBMChannelIM,
  1227. wantEvent: false,
  1228. },
  1229. }
  1230. for _, tt := range tests {
  1231. t.Run(tt.name, func(t *testing.T) {
  1232. sess := &Session{
  1233. Events: tt.events,
  1234. EventQueue: NewEventQueue(10),
  1235. FeedbagLoader: emptyFeedbagLoader,
  1236. }
  1237. if tt.record {
  1238. sess.RecordSentIM(cookie, msgID)
  1239. }
  1240. sess.handleSNACMessage(wire.SNACMessage{
  1241. Frame: wire.SNACFrame{
  1242. FoodGroup: wire.ICBM,
  1243. SubGroup: wire.ICBMClientErr,
  1244. },
  1245. Body: wire.SNAC_0x04_0x0B_ICBMClientErr{
  1246. Cookie: cookie,
  1247. ChannelID: tt.channelID,
  1248. ScreenName: "Mike Kelly",
  1249. Code: 0x0004,
  1250. },
  1251. })
  1252. events := sess.EventQueue.GetAllEvents()
  1253. if !tt.wantEvent {
  1254. assert.Empty(t, events)
  1255. return
  1256. }
  1257. require.Len(t, events, 1)
  1258. assert.Equal(t, EventTypeClientError, events[0].Type)
  1259. got := events[0].Data.(ClientErrorEvent)
  1260. assert.Equal(t, tt.wantCooki, got.Cookie)
  1261. assert.Equal(t, tt.wantChan, got.Channel)
  1262. // The client keys users by the normalized id and renders the sender's
  1263. // own formatting, so both forms have to survive the translation.
  1264. assert.Equal(t, "mikekelly", got.Source.AimID)
  1265. assert.Equal(t, "Mike Kelly", got.Source.DisplayID)
  1266. })
  1267. }
  1268. }
  1269. func TestSession_RecordSentIMEvictsOldestCookie(t *testing.T) {
  1270. sess := &Session{}
  1271. for i := 0; i <= sentIMCookieLimit; i++ {
  1272. sess.RecordSentIM(uint64(i), fmt.Sprintf("msg-%d", i))
  1273. }
  1274. // The map is capped, so the oldest send is forgotten while the newest and the
  1275. // one that pushed the map over its limit are both still resolvable.
  1276. assert.Equal(t, "", sess.msgIDForCookie(0))
  1277. assert.Equal(t, "msg-1", sess.msgIDForCookie(1))
  1278. assert.Equal(t, fmt.Sprintf("msg-%d", sentIMCookieLimit), sess.msgIDForCookie(uint64(sentIMCookieLimit)))
  1279. assert.Len(t, sess.sentIMs, sentIMCookieLimit)
  1280. // A repeat cookie updates in place rather than consuming another slot.
  1281. sess.RecordSentIM(1, "msg-1-again")
  1282. assert.Equal(t, "msg-1-again", sess.msgIDForCookie(1))
  1283. assert.Len(t, sess.sentIMs, sentIMCookieLimit)
  1284. }
  1285. // A buddy's mood rides along in the capability list of a BuddyArrived, so the
  1286. // presence event has to carry it as a mood icon URL.
  1287. func TestSession_PublishesMoodOnPresence(t *testing.T) {
  1288. newSession := func() *Session {
  1289. return &Session{
  1290. ScreenName: state.DisplayScreenName("me"),
  1291. BaseURL: "http://host",
  1292. Events: []string{"presence"},
  1293. EventQueue: NewEventQueue(10),
  1294. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  1295. FeedbagLoader: emptyFeedbagLoader,
  1296. }
  1297. }
  1298. // arrived delivers a BuddyArrived carrying a raw capabilities TLV value.
  1299. arrived := func(sess *Session, caps []byte, invisible bool) PresenceEvent {
  1300. info := wire.TLVUserInfo{ScreenName: "Mike Kelly"}
  1301. if caps != nil {
  1302. info.Append(wire.NewTLVBE(wire.OServiceUserInfoOscarCaps, caps))
  1303. }
  1304. if invisible {
  1305. info.Append(wire.NewTLVBE(wire.OServiceUserInfoStatus, wire.OServiceUserStatusInvisible))
  1306. }
  1307. sess.handleBuddyArrived(wire.SNACMessage{Body: wire.SNAC_0x03_0x0B_BuddyArrived{TLVUserInfo: info}})
  1308. events := sess.EventQueue.GetAllEvents()
  1309. require.Len(t, events, 1)
  1310. return events[0].Data.(PresenceEvent)
  1311. }
  1312. capBytes := func(caps ...[16]byte) []byte {
  1313. var b []byte
  1314. for _, c := range caps {
  1315. b = append(b, c[:]...)
  1316. }
  1317. return b
  1318. }
  1319. t.Run("a mood capability yields the mood icon URL", func(t *testing.T) {
  1320. got := arrived(newSession(), capBytes(wire.CapXStatusBeer), false)
  1321. assert.Equal(t, "http://host/mood?id="+wire.MoodIconID("0icqmood4"), got.MoodIcon)
  1322. })
  1323. t.Run("a placeholder capability resolves too", func(t *testing.T) {
  1324. got := arrived(newSession(), capBytes(wire.CapMoodOnTheWay), false)
  1325. assert.Equal(t, "http://host/mood?id="+wire.MoodIconID("0icqmood83"), got.MoodIcon)
  1326. })
  1327. t.Run("a shared capability resolves to the canonical mood", func(t *testing.T) {
  1328. // Console is reachable from 0icqmood15 and 0icqmood81; the table's first
  1329. // entry wins, so the client is told the one it labels "gamepad".
  1330. got := arrived(newSession(), capBytes(wire.CapXStatusConsole), false)
  1331. assert.Equal(t, "http://host/mood?id="+wire.MoodIconID("0icqmood81"), got.MoodIcon)
  1332. })
  1333. t.Run("a mood is found after other capabilities", func(t *testing.T) {
  1334. got := arrived(newSession(), capBytes(wire.CapChat, wire.CapXStatusBeer), false)
  1335. assert.Equal(t, "http://host/mood?id="+wire.MoodIconID("0icqmood4"), got.MoodIcon)
  1336. })
  1337. t.Run("capabilities carrying no mood yield no icon", func(t *testing.T) {
  1338. assert.Empty(t, arrived(newSession(), capBytes(wire.CapChat), false).MoodIcon)
  1339. })
  1340. t.Run("no capabilities TLV yields no icon", func(t *testing.T) {
  1341. assert.Empty(t, arrived(newSession(), nil, false).MoodIcon)
  1342. })
  1343. t.Run("a trailing partial capability is ignored", func(t *testing.T) {
  1344. // A truncated final chunk must not be read as a capability, nor panic.
  1345. truncated := append(capBytes(wire.CapXStatusBeer), 0x01, 0x02, 0x03)
  1346. got := arrived(newSession(), truncated, false)
  1347. assert.Equal(t, "http://host/mood?id="+wire.MoodIconID("0icqmood4"), got.MoodIcon)
  1348. })
  1349. t.Run("a partial capability alone yields no icon", func(t *testing.T) {
  1350. assert.Empty(t, arrived(newSession(), []byte{0x01, 0x02, 0x03}, false).MoodIcon)
  1351. })
  1352. t.Run("an invisible buddy shows no mood", func(t *testing.T) {
  1353. // A mood supersedes state on the client, so one here would render the
  1354. // buddy as present instead of offline.
  1355. got := arrived(newSession(), capBytes(wire.CapXStatusBeer), true)
  1356. assert.Equal(t, "offline", got.State)
  1357. assert.Empty(t, got.MoodIcon)
  1358. })
  1359. }
  1360. func TestSession_SetMood(t *testing.T) {
  1361. t.Run("advertises the mood alongside the existing capabilities", func(t *testing.T) {
  1362. sess := &Session{capabilities: [][16]byte{wire.CapChat}}
  1363. sess.SetMood(wire.CapXStatusBeer)
  1364. assert.Equal(t, [][16]byte{wire.CapChat, wire.CapXStatusBeer}, sess.Caps())
  1365. })
  1366. t.Run("a second mood replaces the first", func(t *testing.T) {
  1367. // A client shows one mood at a time, so the moods must not accumulate.
  1368. sess := &Session{capabilities: [][16]byte{wire.CapChat}}
  1369. sess.SetMood(wire.CapXStatusBeer)
  1370. sess.SetMood(wire.CapXStatusMusic)
  1371. assert.Equal(t, [][16]byte{wire.CapChat, wire.CapXStatusMusic}, sess.Caps())
  1372. })
  1373. t.Run("panics on a capability that is not a mood", func(t *testing.T) {
  1374. sess := &Session{}
  1375. assert.Panics(t, func() {
  1376. sess.SetMood(wire.CapChat)
  1377. })
  1378. })
  1379. }
  1380. func TestSession_ClearMood(t *testing.T) {
  1381. t.Run("removes the mood and keeps every other capability", func(t *testing.T) {
  1382. sess := &Session{capabilities: [][16]byte{wire.CapChat, wire.CapFileTransfer}}
  1383. sess.SetMood(wire.CapXStatusBeer)
  1384. sess.ClearMood()
  1385. assert.Equal(t, [][16]byte{wire.CapChat, wire.CapFileTransfer}, sess.Caps())
  1386. })
  1387. t.Run("is a no-op when no mood is set", func(t *testing.T) {
  1388. sess := &Session{capabilities: [][16]byte{wire.CapChat}}
  1389. sess.ClearMood()
  1390. assert.Equal(t, [][16]byte{wire.CapChat}, sess.Caps())
  1391. })
  1392. }
  1393. func TestSession_Caps(t *testing.T) {
  1394. t.Run("returns a copy the caller cannot write through", func(t *testing.T) {
  1395. sess := &Session{capabilities: [][16]byte{wire.CapChat}}
  1396. caps := sess.Caps()
  1397. caps[0] = wire.CapFileTransfer
  1398. assert.Equal(t, [][16]byte{wire.CapChat}, sess.Caps())
  1399. })
  1400. t.Run("a session advertising no capabilities returns an empty list", func(t *testing.T) {
  1401. assert.Empty(t, (&Session{}).Caps())
  1402. })
  1403. }
  1404. func TestSessionManager_CreateSession_SeedsCapabilities(t *testing.T) {
  1405. // setStatus rewrites the capability list wholesale from the session's own
  1406. // list, so the sign-on capabilities have to start out in it.
  1407. mgr := NewSessionManager()
  1408. logger := slog.New(slog.NewTextHandler(io.Discard, nil))
  1409. sess, err := mgr.CreateSession("testuser", nil, state.NewSession().AddInstance(), "", logger)
  1410. require.NoError(t, err)
  1411. sess.FeedbagLoader = emptyFeedbagLoader
  1412. assert.Equal(t, webAPICaps, sess.Caps())
  1413. sess.SetMood(wire.CapXStatusBeer)
  1414. other, err := mgr.CreateSession("otheruser", nil, state.NewSession().AddInstance(), "", logger)
  1415. require.NoError(t, err)
  1416. other.FeedbagLoader = emptyFeedbagLoader
  1417. assert.Equal(t, webAPICaps, other.Caps(), "one session's mood must not reach the next session's seed")
  1418. }
  1419. // An IM does not change its sender's presence, and the client shallow-merges the
  1420. // source user map onto the user object the buddy list rendered.
  1421. func TestSession_IncomingIMReportsSenderPresenceFromTheView(t *testing.T) {
  1422. newSession := func() *Session {
  1423. return &Session{
  1424. ScreenName: state.DisplayScreenName("me"),
  1425. Events: []string{"im", "presence"},
  1426. EventQueue: NewEventQueue(10),
  1427. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  1428. FeedbagLoader: emptyFeedbagLoader,
  1429. }
  1430. }
  1431. incomingIM := func(t *testing.T, sess *Session, from string) IMEvent {
  1432. t.Helper()
  1433. frags, err := wire.ICBMFragmentListASCII("hello")
  1434. require.NoError(t, err)
  1435. body := wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
  1436. ChannelID: wire.ICBMChannelIM,
  1437. TLVUserInfo: wire.TLVUserInfo{ScreenName: from},
  1438. }
  1439. body.Append(wire.NewTLVBE(wire.ICBMTLVAOLIMData, frags))
  1440. sess.handleIncomingIM(wire.SNACMessage{Body: body})
  1441. for _, event := range sess.EventQueue.GetAllEvents() {
  1442. if im, ok := event.Data.(IMEvent); ok {
  1443. return im
  1444. }
  1445. }
  1446. t.Fatal("no im event was pushed")
  1447. return IMEvent{}
  1448. }
  1449. t.Run("an away sender stays away", func(t *testing.T) {
  1450. sess := newSession()
  1451. away := wire.TLVUserInfo{ScreenName: "Mike Kelly"}
  1452. away.Append(wire.NewTLVBE(wire.OServiceUserInfoUserFlags, wire.OServiceUserFlagUnavailable))
  1453. buddyArrives(sess, away)
  1454. assert.Equal(t, "away", incomingIM(t, sess, "Mike Kelly").Source.State)
  1455. })
  1456. t.Run("a busy ICQ sender stays occupied", func(t *testing.T) {
  1457. sess := newSession()
  1458. sess.ScreenName = state.DisplayScreenName("100001")
  1459. busy := wire.TLVUserInfo{ScreenName: "100003"}
  1460. busy.Append(wire.NewTLVBE(wire.OServiceUserInfoStatus, wire.OServiceUserStatusBusy))
  1461. buddyArrives(sess, busy)
  1462. assert.Equal(t, "occupied", incomingIM(t, sess, "100003").Source.State)
  1463. })
  1464. t.Run("an online sender is online", func(t *testing.T) {
  1465. sess := newSession()
  1466. buddyArrives(sess, onlineBuddy("Mike Kelly"))
  1467. assert.Equal(t, "online", incomingIM(t, sess, "Mike Kelly").Source.State)
  1468. })
  1469. // A non-buddy raises no arrival, so there is no state to report.
  1470. t.Run("a sender with no presence carries no state", func(t *testing.T) {
  1471. sess := newSession()
  1472. assert.Empty(t, incomingIM(t, sess, "stranger").Source.State)
  1473. })
  1474. }
  1475. // userInfoWith builds the user info a buddy arrives with.
  1476. func userInfoWith(screenName string, tlvs ...wire.TLV) wire.TLVUserInfo {
  1477. info := wire.TLVUserInfo{ScreenName: screenName}
  1478. for _, tlv := range tlvs {
  1479. info.Append(tlv)
  1480. }
  1481. return info
  1482. }
  1483. func awayFlagTLV() wire.TLV {
  1484. return wire.NewTLVBE(wire.OServiceUserInfoUserFlags, wire.OServiceUserFlagUnavailable)
  1485. }
  1486. func statusTLV(mask uint32) wire.TLV {
  1487. return wire.NewTLVBE(wire.OServiceUserInfoStatus, mask)
  1488. }
  1489. func idleTLV(minutes uint16) wire.TLV {
  1490. return wire.NewTLVBE(wire.OServiceUserInfoIdleTime, minutes)
  1491. }
  1492. func TestBuddyWebState(t *testing.T) {
  1493. tests := []struct {
  1494. name string
  1495. info wire.TLVUserInfo
  1496. isAIMViewer bool
  1497. wantState string
  1498. wantIdle int
  1499. }{
  1500. {
  1501. name: "a plain arrival is online",
  1502. info: userInfoWith("buddy"),
  1503. isAIMViewer: true,
  1504. wantState: "online",
  1505. },
  1506. {
  1507. // A buddy cannot tell an invisible user from a signed-off one.
  1508. name: "invisible reads as offline",
  1509. info: userInfoWith("buddy", statusTLV(wire.OServiceUserStatusInvisible)),
  1510. isAIMViewer: true,
  1511. wantState: "offline",
  1512. },
  1513. {
  1514. name: "the unavailable flag is away",
  1515. info: userInfoWith("buddy", awayFlagTLV()),
  1516. isAIMViewer: true,
  1517. wantState: "away",
  1518. },
  1519. {
  1520. name: "the away status bit is away",
  1521. info: userInfoWith("buddy", statusTLV(wire.OServiceUserStatusAway)),
  1522. isAIMViewer: true,
  1523. wantState: "away",
  1524. },
  1525. {
  1526. // Busy and DND also raise the unavailable flag, so the status bits
  1527. // have to be read first or every busy user reports as away.
  1528. name: "busy reaches an ICQ viewer as occupied",
  1529. info: userInfoWith("buddy", statusTLV(wire.OServiceUserStatusBusy), awayFlagTLV()),
  1530. isAIMViewer: false,
  1531. wantState: "occupied",
  1532. },
  1533. {
  1534. name: "dnd reaches an ICQ viewer as dnd",
  1535. info: userInfoWith("buddy", statusTLV(wire.OServiceUserStatusDND), awayFlagTLV()),
  1536. isAIMViewer: false,
  1537. wantState: "dnd",
  1538. },
  1539. {
  1540. // AIM accounts have no vocabulary for busy or dnd.
  1541. name: "busy collapses to away for an AIM viewer",
  1542. info: userInfoWith("buddy", statusTLV(wire.OServiceUserStatusBusy), awayFlagTLV()),
  1543. isAIMViewer: true,
  1544. wantState: "away",
  1545. },
  1546. {
  1547. name: "dnd collapses to away for an AIM viewer",
  1548. info: userInfoWith("buddy", statusTLV(wire.OServiceUserStatusDND), awayFlagTLV()),
  1549. isAIMViewer: true,
  1550. wantState: "away",
  1551. },
  1552. {
  1553. name: "idle alone is idle",
  1554. info: userInfoWith("buddy", idleTLV(7)),
  1555. isAIMViewer: true,
  1556. wantState: "idle",
  1557. wantIdle: 7,
  1558. },
  1559. {
  1560. // Idle rides along in idleTime without taking over the state.
  1561. name: "idle does not displace away",
  1562. info: userInfoWith("buddy", awayFlagTLV(), idleTLV(12)),
  1563. isAIMViewer: true,
  1564. wantState: "away",
  1565. wantIdle: 12,
  1566. },
  1567. {
  1568. name: "idle does not displace occupied",
  1569. info: userInfoWith("buddy", statusTLV(wire.OServiceUserStatusBusy), awayFlagTLV(), idleTLV(3)),
  1570. isAIMViewer: false,
  1571. wantState: "occupied",
  1572. wantIdle: 3,
  1573. },
  1574. {
  1575. name: "zero idle minutes leave the buddy online",
  1576. info: userInfoWith("buddy", idleTLV(0)),
  1577. isAIMViewer: true,
  1578. wantState: "online",
  1579. },
  1580. }
  1581. for _, tt := range tests {
  1582. t.Run(tt.name, func(t *testing.T) {
  1583. gotState, gotIdle := buddyWebState(tt.info, tt.isAIMViewer)
  1584. assert.Equal(t, tt.wantState, gotState)
  1585. assert.Equal(t, tt.wantIdle, gotIdle)
  1586. })
  1587. }
  1588. }
  1589. // No locate query follows a presence record, so everything a roster payload
  1590. // needs has to survive the trip from the SNAC.
  1591. func TestBuddyPresenceFrom(t *testing.T) {
  1592. info := userInfoWith("Mike Kelly", idleTLV(4),
  1593. wire.NewTLVBE(wire.OServiceUserInfoSignonTOD, uint32(1700000000)),
  1594. wire.NewTLVBE(wire.OServiceUserInfoOscarCaps, wire.CapICQCh2Extended[:]),
  1595. wire.NewTLVBE(wire.OServiceUserInfoBARTInfo, []wire.BARTID{testIconBART, testStatusBART}),
  1596. )
  1597. got := buddyPresenceFrom(info, true)
  1598. assert.Equal(t, "Mike Kelly", got.DisplayID)
  1599. assert.Equal(t, "idle", got.State)
  1600. assert.Equal(t, 4, got.IdleTime)
  1601. assert.Equal(t, int64(1700000000), got.OnlineTime)
  1602. assert.Equal(t, "brb", got.StatusMsg)
  1603. assert.Equal(t, [][16]byte{wire.CapICQCh2Extended}, got.Caps)
  1604. assert.Equal(t, []byte{0xde, 0xad, 0xbe, 0xef}, got.IconHash)
  1605. assert.True(t, got.Online())
  1606. }
  1607. func TestSession_PresenceView(t *testing.T) {
  1608. newSession := func(events ...string) *Session {
  1609. return &Session{
  1610. ScreenName: state.DisplayScreenName("me"),
  1611. Events: events,
  1612. EventQueue: NewEventQueue(10),
  1613. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  1614. FeedbagLoader: emptyFeedbagLoader,
  1615. }
  1616. }
  1617. t.Run("an arrival records the buddy under their normalized aimId", func(t *testing.T) {
  1618. sess := newSession("presence")
  1619. buddyArrives(sess, onlineBuddy("Mike Kelly"))
  1620. got, ok := sess.BuddyPresence(state.NewIdentScreenName("MIKE KELLY"))
  1621. require.True(t, ok)
  1622. assert.Equal(t, "online", got.State)
  1623. assert.Equal(t, "Mike Kelly", got.DisplayID)
  1624. })
  1625. t.Run("a buddy never seen has no entry", func(t *testing.T) {
  1626. sess := newSession("presence")
  1627. _, ok := sess.BuddyPresence(state.NewIdentScreenName("stranger"))
  1628. assert.False(t, ok)
  1629. })
  1630. // A departure carries no TLV block, so everything but the display name goes.
  1631. t.Run("a departure marks the buddy offline and keeps their display name", func(t *testing.T) {
  1632. sess := newSession("presence")
  1633. buddyArrives(sess, bartBuddy("Mike Kelly", testIconBART, testStatusBART))
  1634. buddyDeparts(sess, "mikekelly")
  1635. got, ok := sess.BuddyPresence(state.NewIdentScreenName("mikekelly"))
  1636. require.True(t, ok)
  1637. assert.Equal(t, "offline", got.State)
  1638. assert.Equal(t, "Mike Kelly", got.DisplayID)
  1639. assert.Empty(t, got.StatusMsg)
  1640. assert.Empty(t, got.IconHash)
  1641. assert.False(t, got.Online())
  1642. })
  1643. t.Run("a later arrival replaces the earlier state", func(t *testing.T) {
  1644. sess := newSession("presence")
  1645. buddyArrives(sess, onlineBuddy("mikekelly"))
  1646. buddyArrives(sess, userInfoWith("mikekelly", awayFlagTLV()))
  1647. got, _ := sess.BuddyPresence(state.NewIdentScreenName("mikekelly"))
  1648. assert.Equal(t, "away", got.State)
  1649. })
  1650. // The roster reads this view, so a buddylist-only client still needs it.
  1651. t.Run("the view is recorded without a presence subscription", func(t *testing.T) {
  1652. sess := newSession("buddylist")
  1653. buddyArrives(sess, onlineBuddy("mikekelly"))
  1654. got, ok := sess.BuddyPresence(state.NewIdentScreenName("mikekelly"))
  1655. require.True(t, ok)
  1656. assert.Equal(t, "online", got.State)
  1657. assert.Empty(t, sess.EventQueue.GetAllEvents())
  1658. buddyDeparts(sess, "mikekelly")
  1659. got, _ = sess.BuddyPresence(state.NewIdentScreenName("mikekelly"))
  1660. assert.Equal(t, "offline", got.State)
  1661. assert.Empty(t, sess.EventQueue.GetAllEvents())
  1662. })
  1663. // A UIN viewer keeps ICQ's own vocabulary; an AIM viewer does not.
  1664. t.Run("the viewer's account type decides how busy is reported", func(t *testing.T) {
  1665. busy := userInfoWith("100003", statusTLV(wire.OServiceUserStatusBusy), awayFlagTLV())
  1666. aimViewer := newSession("presence")
  1667. buddyArrives(aimViewer, busy)
  1668. got, _ := aimViewer.BuddyPresence(state.NewIdentScreenName("100003"))
  1669. assert.Equal(t, "away", got.State)
  1670. icqViewer := newSession("presence")
  1671. icqViewer.ScreenName = state.DisplayScreenName("100001")
  1672. buddyArrives(icqViewer, busy)
  1673. got, _ = icqViewer.BuddyPresence(state.NewIdentScreenName("100003"))
  1674. assert.Equal(t, "occupied", got.State)
  1675. })
  1676. }
  1677. // Idle time and signon time have fields on the presence event and come from the
  1678. // same record the roster reads.
  1679. func TestSession_PresenceEventCarriesIdleAndOnlineTime(t *testing.T) {
  1680. sess := &Session{
  1681. ScreenName: state.DisplayScreenName("me"),
  1682. Events: []string{"presence"},
  1683. EventQueue: NewEventQueue(10),
  1684. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  1685. FeedbagLoader: emptyFeedbagLoader,
  1686. }
  1687. buddyArrives(sess, userInfoWith("mikekelly", idleTLV(9),
  1688. wire.NewTLVBE(wire.OServiceUserInfoSignonTOD, uint32(1700000000))))
  1689. events := sess.EventQueue.GetAllEvents()
  1690. require.Len(t, events, 1)
  1691. got := events[0].Data.(PresenceEvent)
  1692. assert.Equal(t, "idle", got.State)
  1693. assert.Equal(t, 9, got.IdleTime)
  1694. assert.Equal(t, int64(1700000000), got.OnlineTime)
  1695. }
  1696. // After un-watching a buddy, no arrival or departure for them reaches this
  1697. // session again, so a retained entry would serve its last-seen state forever.
  1698. func TestSession_ForgetBuddyPresence(t *testing.T) {
  1699. newSession := func() *Session {
  1700. return &Session{
  1701. ScreenName: state.DisplayScreenName("me"),
  1702. Events: []string{"presence", "im"},
  1703. EventQueue: NewEventQueue(10),
  1704. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  1705. FeedbagLoader: emptyFeedbagLoader,
  1706. }
  1707. }
  1708. t.Run("forgetting drops the entry rather than marking it offline", func(t *testing.T) {
  1709. sess := newSession()
  1710. buddyArrives(sess, onlineBuddy("Mike Kelly"))
  1711. sess.forgetBuddyPresence(state.NewIdentScreenName("mikekelly"))
  1712. // A miss, not an offline record: callers that can fall back to a live
  1713. // lookup have to tell the two apart.
  1714. _, ok := sess.BuddyPresence(state.NewIdentScreenName("mikekelly"))
  1715. assert.False(t, ok)
  1716. })
  1717. t.Run("forgetting an unknown buddy is a no-op", func(t *testing.T) {
  1718. sess := newSession()
  1719. sess.forgetBuddyPresence(state.NewIdentScreenName("stranger"))
  1720. _, ok := sess.BuddyPresence(state.NewIdentScreenName("stranger"))
  1721. assert.False(t, ok)
  1722. })
  1723. t.Run("a later arrival re-establishes the entry", func(t *testing.T) {
  1724. sess := newSession()
  1725. buddyArrives(sess, onlineBuddy("mikekelly"))
  1726. sess.forgetBuddyPresence(state.NewIdentScreenName("mikekelly"))
  1727. buddyArrives(sess, onlineBuddy("mikekelly"))
  1728. got, ok := sess.BuddyPresence(state.NewIdentScreenName("mikekelly"))
  1729. require.True(t, ok)
  1730. assert.Equal(t, "online", got.State)
  1731. })
  1732. // While watched a departure would have arrived; after un-watching none does.
  1733. t.Run("an IM from a forgotten buddy carries no state", func(t *testing.T) {
  1734. sess := newSession()
  1735. buddyArrives(sess, onlineBuddy("Mike Kelly"))
  1736. sess.forgetBuddyPresence(state.NewIdentScreenName("mikekelly"))
  1737. frags, err := wire.ICBMFragmentListASCII("hello")
  1738. require.NoError(t, err)
  1739. body := wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
  1740. ChannelID: wire.ICBMChannelIM,
  1741. TLVUserInfo: wire.TLVUserInfo{ScreenName: "Mike Kelly"},
  1742. }
  1743. body.Append(wire.NewTLVBE(wire.ICBMTLVAOLIMData, frags))
  1744. sess.handleIncomingIM(wire.SNACMessage{Body: body})
  1745. for _, event := range sess.EventQueue.GetAllEvents() {
  1746. if im, ok := event.Data.(IMEvent); ok {
  1747. assert.Empty(t, im.Source.State)
  1748. return
  1749. }
  1750. }
  1751. t.Fatal("no im event was pushed")
  1752. })
  1753. }
  1754. // A relayed delete names the items that went away, not whether the buddy left the
  1755. // roster, so only a buddy absent from the refreshed roster is forgotten.
  1756. func TestSession_RelayedFeedbagDeleteForgetsUnlistedBuddies(t *testing.T) {
  1757. newSession := func(roster ...string) *Session {
  1758. sess := &Session{
  1759. ScreenName: state.DisplayScreenName("me"),
  1760. Events: []string{"presence", "buddylist"},
  1761. EventQueue: NewEventQueue(10),
  1762. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  1763. FeedbagLoader: emptyFeedbagLoader,
  1764. }
  1765. sess.ctx = context.Background()
  1766. sess.FeedbagLoader = func(context.Context) ([]wire.FeedbagItem, error) {
  1767. items := make([]wire.FeedbagItem, 0, len(roster))
  1768. for i, name := range roster {
  1769. items = append(items, wire.FeedbagItem{
  1770. ItemID: uint16(i + 1), ClassID: wire.FeedbagClassIdBuddy, GroupID: 100, Name: name,
  1771. })
  1772. }
  1773. return items, nil
  1774. }
  1775. return sess
  1776. }
  1777. relayDelete := func(sess *Session, items ...wire.FeedbagItem) {
  1778. sess.handleFeedbagMessage(wire.SNACMessage{
  1779. Frame: wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagDeleteItem},
  1780. Body: wire.SNAC_0x13_0x0A_FeedbagDeleteItem{Items: items},
  1781. })
  1782. }
  1783. buddyItem := wire.FeedbagItem{ClassID: wire.FeedbagClassIdBuddy, Name: "mikekelly"}
  1784. t.Run("a buddy gone from the roster is forgotten", func(t *testing.T) {
  1785. sess := newSession()
  1786. buddyArrives(sess, onlineBuddy("Mike Kelly"))
  1787. relayDelete(sess, buddyItem)
  1788. _, ok := sess.BuddyPresence(state.NewIdentScreenName("mikekelly"))
  1789. assert.False(t, ok)
  1790. })
  1791. // The move case: a delete for the old group's item, then an insert.
  1792. t.Run("a buddy still on the roster keeps their entry", func(t *testing.T) {
  1793. sess := newSession("mikekelly")
  1794. buddyArrives(sess, onlineBuddy("Mike Kelly"))
  1795. relayDelete(sess, buddyItem)
  1796. got, ok := sess.BuddyPresence(state.NewIdentScreenName("mikekelly"))
  1797. require.True(t, ok)
  1798. assert.Equal(t, "online", got.State)
  1799. })
  1800. t.Run("a group row does not evict a like-named buddy", func(t *testing.T) {
  1801. sess := newSession()
  1802. buddyArrives(sess, onlineBuddy("keeper"))
  1803. relayDelete(sess, wire.FeedbagItem{ClassID: wire.FeedbagClassIdGroup, Name: "keeper"})
  1804. _, ok := sess.BuddyPresence(state.NewIdentScreenName("keeper"))
  1805. assert.True(t, ok)
  1806. })
  1807. // Without a roster the two cases are indistinguishable, so nothing is dropped.
  1808. t.Run("a roster lookup failure keeps the entry", func(t *testing.T) {
  1809. sess := newSession()
  1810. sess.FeedbagLoader = func(context.Context) ([]wire.FeedbagItem, error) {
  1811. return nil, io.ErrUnexpectedEOF
  1812. }
  1813. buddyArrives(sess, onlineBuddy("Mike Kelly"))
  1814. relayDelete(sess, buddyItem)
  1815. _, ok := sess.BuddyPresence(state.NewIdentScreenName("mikekelly"))
  1816. assert.True(t, ok)
  1817. })
  1818. }
  1819. // An insert or update leaves the roster membership intact, so it must not evict.
  1820. func TestSession_RelayedFeedbagUpdateKeepsPresence(t *testing.T) {
  1821. sess := &Session{
  1822. ScreenName: state.DisplayScreenName("me"),
  1823. Events: []string{"presence", "buddylist"},
  1824. EventQueue: NewEventQueue(10),
  1825. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  1826. FeedbagLoader: emptyFeedbagLoader,
  1827. }
  1828. buddyArrives(sess, onlineBuddy("Mike Kelly"))
  1829. sess.handleFeedbagMessage(wire.SNACMessage{
  1830. Frame: wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagUpdateItem},
  1831. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{Items: []wire.FeedbagItem{
  1832. {ClassID: wire.FeedbagClassIdBuddy, Name: "mikekelly"},
  1833. }},
  1834. })
  1835. got, ok := sess.BuddyPresence(state.NewIdentScreenName("mikekelly"))
  1836. require.True(t, ok)
  1837. assert.Equal(t, "online", got.State)
  1838. }
  1839. // The roster, its aliases and the membership check a relayed delete makes are three
  1840. // views of the same rows, so one feedbag change must cost one read.
  1841. func TestSession_FeedbagCacheServesEveryReadFromOneLoad(t *testing.T) {
  1842. var loads int
  1843. sess := &Session{
  1844. ScreenName: state.DisplayScreenName("me"),
  1845. Events: []string{"presence", "buddylist"},
  1846. EventQueue: NewEventQueue(10),
  1847. logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  1848. FeedbagLoader: emptyFeedbagLoader,
  1849. }
  1850. sess.ctx = context.Background()
  1851. sess.FeedbagLoader = func(context.Context) ([]wire.FeedbagItem, error) {
  1852. loads++
  1853. return aliasFeedbagItems(map[string]string{"keeper": "KEEPER"}), nil
  1854. }
  1855. buddyArrives(sess, onlineBuddy("keeper"))
  1856. buddyArrives(sess, onlineBuddy("gone"))
  1857. require.Equal(t, 1, loads, "arrivals resolve aliases off one load")
  1858. sess.handleFeedbagMessage(wire.SNACMessage{
  1859. Frame: wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagDeleteItem},
  1860. Body: wire.SNAC_0x13_0x0A_FeedbagDeleteItem{Items: []wire.FeedbagItem{
  1861. {ClassID: wire.FeedbagClassIdBuddy, Name: "gone"},
  1862. {ClassID: wire.FeedbagClassIdBuddy, Name: "keeper"},
  1863. }},
  1864. })
  1865. assert.Equal(t, 2, loads, "one reload serves the whole handler")
  1866. _, ok := sess.BuddyPresence(state.NewIdentScreenName("gone"))
  1867. assert.False(t, ok)
  1868. _, ok = sess.BuddyPresence(state.NewIdentScreenName("keeper"))
  1869. assert.True(t, ok)
  1870. assert.Equal(t, "KEEPER", sess.Aliases(context.Background())["keeper"])
  1871. _, err := sess.Feedbag(context.Background())
  1872. require.NoError(t, err)
  1873. assert.Equal(t, 2, loads)
  1874. }