feedbag_test.go 151 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099
  1. package foodgroup
  2. import (
  3. "bytes"
  4. "context"
  5. "fmt"
  6. "log/slog"
  7. "testing"
  8. "time"
  9. "github.com/mk6i/open-oscar-server/state"
  10. "github.com/mk6i/open-oscar-server/wire"
  11. "github.com/stretchr/testify/assert"
  12. "github.com/stretchr/testify/mock"
  13. )
  14. func TestFeedbagService_Query(t *testing.T) {
  15. cases := []struct {
  16. // name is the unit test name
  17. name string
  18. // instance is the session of the user adding to feedbag
  19. instance *state.SessionInstance
  20. // inputSNAC is the SNAC sent from the client to the server
  21. inputSNAC wire.SNACMessage
  22. // mockParams is the list of params sent to mocks that satisfy this
  23. // method's dependencies
  24. mockParams mockParams
  25. // expectOutput is the SNAC sent from the server to client
  26. expectOutput *wire.SNACMessage
  27. }{
  28. {
  29. name: "retrieve empty feedbag",
  30. instance: newTestInstance("me"),
  31. inputSNAC: wire.SNACMessage{
  32. Frame: wire.SNACFrame{
  33. FoodGroup: wire.Feedbag,
  34. SubGroup: wire.FeedbagInsertItem,
  35. RequestID: 1234,
  36. },
  37. },
  38. mockParams: mockParams{
  39. feedbagManagerParams: feedbagManagerParams{
  40. feedbagParams: feedbagParams{
  41. {
  42. screenName: state.NewIdentScreenName("me"),
  43. results: []wire.FeedbagItem{},
  44. },
  45. },
  46. feedbagLastModifiedParams: feedbagLastModifiedParams{},
  47. },
  48. },
  49. expectOutput: &wire.SNACMessage{
  50. Frame: wire.SNACFrame{
  51. FoodGroup: wire.Feedbag,
  52. SubGroup: wire.FeedbagReply,
  53. RequestID: 1234,
  54. },
  55. Body: wire.SNAC_0x13_0x06_FeedbagReply{
  56. Items: []wire.FeedbagItem{},
  57. },
  58. },
  59. },
  60. {
  61. name: "retrieve feedbag with items",
  62. instance: newTestInstance("me"),
  63. inputSNAC: wire.SNACMessage{
  64. Frame: wire.SNACFrame{
  65. FoodGroup: wire.Feedbag,
  66. SubGroup: wire.FeedbagInsertItem,
  67. RequestID: 1234,
  68. },
  69. },
  70. mockParams: mockParams{
  71. feedbagManagerParams: feedbagManagerParams{
  72. feedbagParams: feedbagParams{
  73. {
  74. screenName: state.NewIdentScreenName("me"),
  75. results: []wire.FeedbagItem{
  76. {
  77. Name: "buddy1",
  78. },
  79. {
  80. Name: "buddy2",
  81. },
  82. },
  83. },
  84. },
  85. feedbagLastModifiedParams: feedbagLastModifiedParams{
  86. {
  87. screenName: state.NewIdentScreenName("me"),
  88. result: time.UnixMilli(1696472198082),
  89. },
  90. },
  91. },
  92. },
  93. expectOutput: &wire.SNACMessage{
  94. Frame: wire.SNACFrame{
  95. FoodGroup: wire.Feedbag,
  96. SubGroup: wire.FeedbagReply,
  97. RequestID: 1234,
  98. },
  99. Body: wire.SNAC_0x13_0x06_FeedbagReply{
  100. Version: 0,
  101. Items: []wire.FeedbagItem{
  102. {
  103. Name: "buddy1",
  104. },
  105. {
  106. Name: "buddy2",
  107. },
  108. },
  109. LastUpdate: uint32(time.UnixMilli(1696472198082).Unix()),
  110. },
  111. },
  112. },
  113. }
  114. for _, tc := range cases {
  115. t.Run(tc.name, func(t *testing.T) {
  116. feedbagManager := newMockFeedbagManager(t)
  117. for _, params := range tc.mockParams.feedbagParams {
  118. feedbagManager.EXPECT().
  119. Feedbag(matchContext(), params.screenName).
  120. Return(params.results, nil)
  121. }
  122. for _, params := range tc.mockParams.feedbagLastModifiedParams {
  123. feedbagManager.EXPECT().
  124. FeedbagLastModified(matchContext(), params.screenName).
  125. Return(params.result, nil)
  126. }
  127. svc := FeedbagService{
  128. feedbagManager: feedbagManager,
  129. }
  130. outputSNAC, err := svc.Query(context.Background(), tc.instance, tc.inputSNAC.Frame)
  131. assert.NoError(t, err)
  132. assert.Equal(t, *tc.expectOutput, outputSNAC)
  133. })
  134. }
  135. }
  136. func TestFeedbagService_QueryIfModified(t *testing.T) {
  137. cases := []struct {
  138. // name is the unit test name
  139. name string
  140. // instance is the session of the user adding to feedbag
  141. instance *state.SessionInstance
  142. // inputSNAC is the SNAC sent from the client to the server
  143. inputSNAC wire.SNACMessage
  144. // mockParams is the list of params sent to mocks that satisfy this
  145. // method's dependencies
  146. mockParams mockParams
  147. // expectOutput is the SNAC sent from the server to client
  148. expectOutput *wire.SNACMessage
  149. }{
  150. {
  151. name: "retrieve empty feedbag",
  152. instance: newTestInstance("me"),
  153. inputSNAC: wire.SNACMessage{
  154. Frame: wire.SNACFrame{
  155. FoodGroup: wire.Feedbag,
  156. SubGroup: wire.FeedbagInsertItem,
  157. RequestID: 1234,
  158. },
  159. Body: wire.SNAC_0x13_0x05_FeedbagQueryIfModified{
  160. LastUpdate: uint32(time.UnixMilli(100000).Unix()),
  161. },
  162. },
  163. mockParams: mockParams{
  164. feedbagManagerParams: feedbagManagerParams{
  165. feedbagParams: feedbagParams{
  166. {
  167. screenName: state.NewIdentScreenName("me"),
  168. results: []wire.FeedbagItem{},
  169. },
  170. },
  171. },
  172. },
  173. expectOutput: &wire.SNACMessage{
  174. Frame: wire.SNACFrame{
  175. FoodGroup: wire.Feedbag,
  176. SubGroup: wire.FeedbagReply,
  177. RequestID: 1234,
  178. },
  179. Body: wire.SNAC_0x13_0x06_FeedbagReply{
  180. Items: []wire.FeedbagItem{},
  181. },
  182. },
  183. },
  184. {
  185. name: "retrieve feedbag with items",
  186. instance: newTestInstance("me"),
  187. inputSNAC: wire.SNACMessage{
  188. Frame: wire.SNACFrame{
  189. FoodGroup: wire.Feedbag,
  190. SubGroup: wire.FeedbagInsertItem,
  191. RequestID: 1234,
  192. },
  193. Body: wire.SNAC_0x13_0x05_FeedbagQueryIfModified{
  194. LastUpdate: uint32(time.UnixMilli(100000).Unix()),
  195. },
  196. },
  197. mockParams: mockParams{
  198. feedbagManagerParams: feedbagManagerParams{
  199. feedbagParams: feedbagParams{
  200. {
  201. screenName: state.NewIdentScreenName("me"),
  202. results: []wire.FeedbagItem{
  203. {
  204. Name: "buddy1",
  205. },
  206. {
  207. Name: "buddy2",
  208. },
  209. },
  210. },
  211. },
  212. feedbagLastModifiedParams: feedbagLastModifiedParams{
  213. {
  214. screenName: state.NewIdentScreenName("me"),
  215. result: time.UnixMilli(200000),
  216. },
  217. },
  218. },
  219. },
  220. expectOutput: &wire.SNACMessage{
  221. Frame: wire.SNACFrame{
  222. FoodGroup: wire.Feedbag,
  223. SubGroup: wire.FeedbagReply,
  224. RequestID: 1234,
  225. },
  226. Body: wire.SNAC_0x13_0x06_FeedbagReply{
  227. Version: 0,
  228. Items: []wire.FeedbagItem{
  229. {
  230. Name: "buddy1",
  231. },
  232. {
  233. Name: "buddy2",
  234. },
  235. },
  236. LastUpdate: uint32(time.UnixMilli(200000).Unix()),
  237. },
  238. },
  239. },
  240. {
  241. name: "retrieve not-modified response",
  242. instance: newTestInstance("me"),
  243. inputSNAC: wire.SNACMessage{
  244. Frame: wire.SNACFrame{
  245. FoodGroup: wire.Feedbag,
  246. SubGroup: wire.FeedbagInsertItem,
  247. RequestID: 1234,
  248. },
  249. Body: wire.SNAC_0x13_0x05_FeedbagQueryIfModified{
  250. LastUpdate: uint32(time.UnixMilli(200000).Unix()),
  251. },
  252. },
  253. mockParams: mockParams{
  254. feedbagManagerParams: feedbagManagerParams{
  255. feedbagParams: feedbagParams{
  256. {
  257. screenName: state.NewIdentScreenName("me"),
  258. results: []wire.FeedbagItem{
  259. {
  260. Name: "buddy1",
  261. },
  262. {
  263. Name: "buddy2",
  264. },
  265. },
  266. },
  267. },
  268. feedbagLastModifiedParams: feedbagLastModifiedParams{
  269. {
  270. screenName: state.NewIdentScreenName("me"),
  271. result: time.UnixMilli(100000),
  272. },
  273. },
  274. },
  275. },
  276. expectOutput: &wire.SNACMessage{
  277. Frame: wire.SNACFrame{
  278. FoodGroup: wire.Feedbag,
  279. SubGroup: wire.FeedbagReplyNotModified,
  280. RequestID: 1234,
  281. },
  282. Body: wire.SNAC_0x13_0x05_FeedbagQueryIfModified{
  283. LastUpdate: uint32(time.UnixMilli(100000).Unix()),
  284. Count: 2,
  285. },
  286. },
  287. },
  288. }
  289. for _, tc := range cases {
  290. t.Run(tc.name, func(t *testing.T) {
  291. //
  292. // initialize dependencies
  293. //
  294. feedbagManager := newMockFeedbagManager(t)
  295. for _, params := range tc.mockParams.feedbagParams {
  296. feedbagManager.EXPECT().
  297. Feedbag(matchContext(), params.screenName).
  298. Return(params.results, nil)
  299. }
  300. for _, params := range tc.mockParams.feedbagLastModifiedParams {
  301. feedbagManager.EXPECT().
  302. FeedbagLastModified(matchContext(), params.screenName).
  303. Return(params.result, nil)
  304. }
  305. //
  306. // send input SNAC
  307. //
  308. svc := FeedbagService{
  309. feedbagManager: feedbagManager,
  310. }
  311. outputSNAC, err := svc.QueryIfModified(context.Background(), tc.instance, tc.inputSNAC.Frame,
  312. tc.inputSNAC.Body.(wire.SNAC_0x13_0x05_FeedbagQueryIfModified))
  313. assert.NoError(t, err)
  314. //
  315. // verify output
  316. //
  317. assert.Equal(t, *tc.expectOutput, outputSNAC)
  318. })
  319. }
  320. }
  321. func TestFeedbagService_UpsertItem_AlInfoRejected(t *testing.T) {
  322. instance := newTestInstance("me")
  323. inFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagInsertItem, RequestID: 1234}
  324. items := []wire.FeedbagItem{
  325. {ClassID: wire.FeedbagClassIdAlInfo, Name: "linkeduser"},
  326. }
  327. // feedbagManager expects no FeedbagUpsert call since AlInfo items are rejected
  328. feedbagManager := newMockFeedbagManager(t)
  329. // messageRelayer expects no calls — handler returns early with error response
  330. messageRelayer := newMockMessageRelayer(t)
  331. svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, nil, nil, nil, nil, nil)
  332. output, err := svc.UpsertItem(context.Background(), instance, inFrame, items)
  333. assert.NoError(t, err)
  334. assert.Equal(t, &wire.SNACMessage{
  335. Frame: wire.SNACFrame{
  336. FoodGroup: wire.Feedbag,
  337. SubGroup: wire.FeedbagErr,
  338. RequestID: 1234,
  339. },
  340. Body: wire.SNACError{
  341. Code: wire.ErrorCodeInsufficientRights,
  342. },
  343. }, output)
  344. }
  345. func TestFeedbagService_DeleteItem_AlInfoIgnored(t *testing.T) {
  346. instance := newTestInstance("me")
  347. inFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagDeleteItem, RequestID: 1234}
  348. inBody := wire.SNAC_0x13_0x0A_FeedbagDeleteItem{
  349. Items: []wire.FeedbagItem{
  350. {ClassID: wire.FeedbagClassIdAlInfo, Name: "linkeduser"},
  351. },
  352. }
  353. feedbagManager := newMockFeedbagManager(t)
  354. feedbagManager.EXPECT().
  355. FeedbagDelete(matchContext(), state.NewIdentScreenName("me"), inBody.Items).
  356. Return(nil)
  357. messageRelayer := newMockMessageRelayer(t)
  358. messageRelayer.EXPECT().
  359. RelayToSelf(mock.Anything, mock.Anything, wire.SNACMessage{
  360. Frame: wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagStatus, RequestID: 1234},
  361. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{Results: []uint16{0x0000}},
  362. })
  363. messageRelayer.EXPECT().
  364. RelayToOtherInstances(mock.Anything, mock.Anything, wire.SNACMessage{
  365. Frame: wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagDeleteItem, RequestID: wire.ReqIDFromServer},
  366. Body: inBody,
  367. })
  368. buddyBroadcaster := newMockbuddyBroadcaster(t)
  369. buddyBroadcaster.EXPECT().
  370. BroadcastVisibility(mock.Anything, matchSession(state.NewIdentScreenName("me")), []state.IdentScreenName(nil), true).
  371. Return(nil)
  372. svc := FeedbagService{
  373. buddyBroadcaster: buddyBroadcaster,
  374. feedbagManager: feedbagManager,
  375. messageRelayer: messageRelayer,
  376. }
  377. output, err := svc.DeleteItem(context.Background(), instance, inFrame, inBody)
  378. assert.NoError(t, err)
  379. assert.Nil(t, output)
  380. }
  381. func TestFeedbagService_RightsQuery(t *testing.T) {
  382. svc := NewFeedbagService(nil, nil, nil, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
  383. outputSNAC := svc.RightsQuery(context.Background(), wire.SNACFrame{RequestID: 1234})
  384. expectSNAC := wire.SNACMessage{
  385. Frame: wire.SNACFrame{
  386. FoodGroup: wire.Feedbag,
  387. SubGroup: wire.FeedbagRightsReply,
  388. RequestID: 1234,
  389. },
  390. Body: wire.SNAC_0x13_0x03_FeedbagRightsReply{
  391. TLVRestBlock: wire.TLVRestBlock{
  392. TLVList: wire.TLVList{
  393. wire.NewTLVBE(wire.FeedbagRightsMaxItemAttrs, uint16(200)),
  394. wire.NewTLVBE(wire.FeedbagRightsMaxItemsByClass, []uint16{
  395. 61,
  396. 61,
  397. 100,
  398. 100,
  399. 1,
  400. 1,
  401. 50,
  402. 0x00,
  403. 0x00,
  404. 3,
  405. 0x00,
  406. 0x00,
  407. 0x00,
  408. 128,
  409. 255,
  410. 20,
  411. 200,
  412. 1,
  413. 0x00,
  414. 1,
  415. 200,
  416. 0x00,
  417. 0x00,
  418. 0x00,
  419. 4,
  420. }),
  421. wire.NewTLVBE(wire.FeedbagRightsMaxClientItems, uint16(200)),
  422. wire.NewTLVBE(wire.FeedbagRightsMaxItemNameLen, uint16(200)),
  423. wire.NewTLVBE(wire.FeedbagRightsMaxRecentBuddies, uint16(200)),
  424. wire.NewTLVBE(wire.FeedbagRightsInteractionBuddies, uint16(200)),
  425. wire.NewTLVBE(wire.FeedbagRightsInteractionHalfLife, uint16(200)),
  426. wire.NewTLVBE(wire.FeedbagRightsInteractionMaxScore, uint16(200)),
  427. wire.NewTLVBE(wire.FeedbagRightsMaxBuddiesPerGroup, uint16(200)),
  428. wire.NewTLVBE(wire.FeedbagRightsMaxMegaBots, uint16(200)),
  429. wire.NewTLVBE(wire.FeedbagRightsMaxSmartGroups, uint16(100)),
  430. },
  431. },
  432. },
  433. }
  434. assert.Equal(t, expectSNAC, outputSNAC)
  435. }
  436. func TestFeedbagService_UpsertItem(t *testing.T) {
  437. cases := []struct {
  438. // name is the unit test name
  439. name string
  440. // instance is the session of the user adding to feedbag
  441. instance *state.SessionInstance
  442. // inputSNAC is the SNAC sent from the client to the server
  443. inputSNAC wire.SNACMessage
  444. // mockParams is the list of params sent to mocks that satisfy this
  445. // method's dependencies
  446. mockParams mockParams
  447. // expectOutput is the SNAC sent from the server to client
  448. expectOutput *wire.SNACMessage
  449. // instanceMatch verifies the session state after completion
  450. instanceMatch func(instance *state.SessionInstance)
  451. // expectICBM is true when UpsertItem should call icbmSender
  452. expectICBM bool
  453. // wantICBMBody is the expected ICBM body (Cookie zeroed for comparison)
  454. wantICBMBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost
  455. }{
  456. {
  457. name: "add buddies",
  458. instance: newTestInstance("me"),
  459. inputSNAC: wire.SNACMessage{
  460. Frame: wire.SNACFrame{
  461. FoodGroup: wire.Feedbag,
  462. SubGroup: wire.FeedbagInsertItem,
  463. RequestID: 1234,
  464. },
  465. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  466. Items: []wire.FeedbagItem{
  467. {
  468. ClassID: wire.FeedbagClassIDPermit,
  469. Name: "buddy1",
  470. },
  471. {
  472. ClassID: wire.FeedbagClassIDPermit,
  473. Name: "buddy2",
  474. },
  475. },
  476. },
  477. },
  478. mockParams: mockParams{
  479. feedbagManagerParams: feedbagManagerParams{
  480. feedbagUpsertParams: feedbagUpsertParams{
  481. {
  482. screenName: state.NewIdentScreenName("me"),
  483. items: []wire.FeedbagItem{
  484. {
  485. ClassID: wire.FeedbagClassIDPermit,
  486. Name: "buddy1",
  487. },
  488. {
  489. ClassID: wire.FeedbagClassIDPermit,
  490. Name: "buddy2",
  491. },
  492. },
  493. },
  494. },
  495. },
  496. buddyBroadcasterParams: buddyBroadcasterParams{
  497. broadcastVisibilityParams: broadcastVisibilityParams{
  498. {
  499. from: state.NewIdentScreenName("me"),
  500. filter: []state.IdentScreenName{
  501. state.NewIdentScreenName("buddy1"),
  502. state.NewIdentScreenName("buddy2"),
  503. },
  504. },
  505. },
  506. },
  507. messageRelayerParams: messageRelayerParams{
  508. relayToOtherInstancesParams: relayToOtherInstancesParams{
  509. {
  510. screenName: state.NewIdentScreenName("me"),
  511. message: wire.SNACMessage{
  512. Frame: wire.SNACFrame{
  513. FoodGroup: wire.Feedbag,
  514. SubGroup: wire.FeedbagInsertItem,
  515. RequestID: wire.ReqIDFromServer,
  516. },
  517. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  518. Items: []wire.FeedbagItem{
  519. {
  520. ClassID: wire.FeedbagClassIDPermit,
  521. Name: "buddy1",
  522. },
  523. {
  524. ClassID: wire.FeedbagClassIDPermit,
  525. Name: "buddy2",
  526. },
  527. },
  528. },
  529. },
  530. },
  531. },
  532. relayToSelfParams: relayToSelfParams{
  533. {
  534. screenName: state.NewIdentScreenName("me"),
  535. message: wire.SNACMessage{
  536. Frame: wire.SNACFrame{
  537. FoodGroup: wire.Feedbag,
  538. SubGroup: wire.FeedbagStatus,
  539. RequestID: 1234,
  540. },
  541. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  542. Results: []uint16{0x0000, 0x0000},
  543. },
  544. },
  545. },
  546. },
  547. },
  548. },
  549. expectOutput: nil,
  550. },
  551. {
  552. name: "defer visibility during notify txn",
  553. instance: func() *state.SessionInstance {
  554. inst := newTestInstance("me")
  555. inst.BeginNotifyTxn()
  556. return inst
  557. }(),
  558. inputSNAC: wire.SNACMessage{
  559. Frame: wire.SNACFrame{
  560. FoodGroup: wire.Feedbag,
  561. SubGroup: wire.FeedbagInsertItem,
  562. RequestID: 1234,
  563. },
  564. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  565. Items: []wire.FeedbagItem{
  566. {ClassID: wire.FeedbagClassIDPermit, Name: "buddy1"},
  567. },
  568. },
  569. },
  570. mockParams: mockParams{
  571. feedbagManagerParams: feedbagManagerParams{
  572. feedbagUpsertParams: feedbagUpsertParams{
  573. {
  574. screenName: state.NewIdentScreenName("me"),
  575. items: []wire.FeedbagItem{
  576. {ClassID: wire.FeedbagClassIDPermit, Name: "buddy1"},
  577. },
  578. },
  579. },
  580. },
  581. messageRelayerParams: messageRelayerParams{
  582. relayToOtherInstancesParams: relayToOtherInstancesParams{
  583. {
  584. screenName: state.NewIdentScreenName("me"),
  585. message: wire.SNACMessage{
  586. Frame: wire.SNACFrame{
  587. FoodGroup: wire.Feedbag,
  588. SubGroup: wire.FeedbagInsertItem,
  589. RequestID: wire.ReqIDFromServer,
  590. },
  591. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  592. Items: []wire.FeedbagItem{
  593. {ClassID: wire.FeedbagClassIDPermit, Name: "buddy1"},
  594. },
  595. },
  596. },
  597. },
  598. },
  599. relayToSelfParams: relayToSelfParams{
  600. {
  601. screenName: state.NewIdentScreenName("me"),
  602. message: wire.SNACMessage{
  603. Frame: wire.SNACFrame{
  604. FoodGroup: wire.Feedbag,
  605. SubGroup: wire.FeedbagStatus,
  606. RequestID: 1234,
  607. },
  608. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  609. Results: []uint16{0x0000},
  610. },
  611. },
  612. },
  613. },
  614. },
  615. },
  616. instanceMatch: func(instance *state.SessionInstance) {
  617. assert.True(t, instance.InNotifyTxn())
  618. },
  619. expectOutput: nil,
  620. },
  621. {
  622. name: "add 2 ICQ buddies one that requires authorization",
  623. instance: newTestInstance("100001", sessOptUIN(100001)),
  624. inputSNAC: wire.SNACMessage{
  625. Frame: wire.SNACFrame{
  626. FoodGroup: wire.Feedbag,
  627. SubGroup: wire.FeedbagInsertItem,
  628. RequestID: 1234,
  629. },
  630. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  631. Items: []wire.FeedbagItem{
  632. {
  633. ClassID: wire.FeedbagClassIdBuddy,
  634. Name: "123400", // requires authorization
  635. },
  636. {
  637. ClassID: wire.FeedbagClassIdBuddy,
  638. Name: "123401", // does not require authorization
  639. },
  640. },
  641. },
  642. },
  643. mockParams: mockParams{
  644. feedbagManagerParams: feedbagManagerParams{
  645. feedbagUpsertParams: feedbagUpsertParams{
  646. {
  647. screenName: state.NewIdentScreenName("100001"),
  648. items: []wire.FeedbagItem{
  649. {
  650. ClassID: wire.FeedbagClassIdBuddy,
  651. Name: "123401",
  652. },
  653. },
  654. },
  655. },
  656. },
  657. sessionRetrieverParams: sessionRetrieverParams{
  658. retrieveSessionParams: retrieveSessionParams{
  659. {
  660. screenName: state.NewIdentScreenName("123401"),
  661. result: nil,
  662. },
  663. },
  664. },
  665. buddyBroadcasterParams: buddyBroadcasterParams{
  666. broadcastVisibilityParams: broadcastVisibilityParams{
  667. {
  668. from: state.NewIdentScreenName("100001"),
  669. filter: []state.IdentScreenName{
  670. state.NewIdentScreenName("123401"),
  671. },
  672. },
  673. },
  674. },
  675. messageRelayerParams: messageRelayerParams{
  676. relayToOtherInstancesParams: relayToOtherInstancesParams{
  677. {
  678. screenName: state.NewIdentScreenName("100001"),
  679. message: wire.SNACMessage{
  680. Frame: wire.SNACFrame{
  681. FoodGroup: wire.Feedbag,
  682. SubGroup: wire.FeedbagInsertItem,
  683. RequestID: wire.ReqIDFromServer,
  684. },
  685. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  686. Items: []wire.FeedbagItem{
  687. {
  688. ClassID: wire.FeedbagClassIdBuddy,
  689. Name: "123401",
  690. },
  691. },
  692. },
  693. },
  694. },
  695. },
  696. relayToSelfParams: relayToSelfParams{
  697. {
  698. screenName: state.NewIdentScreenName("100001"),
  699. message: wire.SNACMessage{
  700. Frame: wire.SNACFrame{
  701. FoodGroup: wire.Feedbag,
  702. SubGroup: wire.FeedbagStatus,
  703. RequestID: 1234,
  704. },
  705. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  706. Results: []uint16{0x000E, 0x0000},
  707. },
  708. },
  709. },
  710. },
  711. },
  712. contactPreAuthorizerParams: contactPreAuthorizerParams{
  713. requiresAuthorizationParams: requiresAuthorizationParams{
  714. {owner: state.NewIdentScreenName("123400"), requester: state.NewIdentScreenName("100001"), result: true},
  715. {owner: state.NewIdentScreenName("123401"), requester: state.NewIdentScreenName("100001"), result: false},
  716. },
  717. },
  718. buddyAddedNotifierDeduperParams: buddyAddedNotifierDeduperParams{
  719. hasBuddyAddedNotificationParams: hasBuddyAddedNotificationParams{
  720. {granter: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("123401"), result: false},
  721. },
  722. recordBuddyAddedNotificationParams: recordBuddyAddedNotificationParams{
  723. {granter: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("123401")},
  724. },
  725. },
  726. },
  727. expectOutput: nil,
  728. expectICBM: true,
  729. wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  730. ChannelID: wire.ICBMChannelICQ,
  731. ScreenName: "123401",
  732. TLVRestBlock: wire.TLVRestBlock{
  733. TLVList: wire.TLVList{
  734. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  735. UIN: 100001,
  736. MessageType: wire.ICBMMsgTypeAdded,
  737. }),
  738. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  739. },
  740. },
  741. },
  742. },
  743. {
  744. name: "add ICQ buddy auth-required but pre-authorized",
  745. instance: newTestInstance("me"),
  746. inputSNAC: wire.SNACMessage{
  747. Frame: wire.SNACFrame{
  748. FoodGroup: wire.Feedbag,
  749. SubGroup: wire.FeedbagInsertItem,
  750. RequestID: 1234,
  751. },
  752. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  753. Items: []wire.FeedbagItem{
  754. {
  755. ClassID: wire.FeedbagClassIdBuddy,
  756. Name: "123400",
  757. },
  758. },
  759. },
  760. },
  761. mockParams: mockParams{
  762. feedbagManagerParams: feedbagManagerParams{
  763. feedbagUpsertParams: feedbagUpsertParams{
  764. {
  765. screenName: state.NewIdentScreenName("me"),
  766. items: []wire.FeedbagItem{
  767. {
  768. ClassID: wire.FeedbagClassIdBuddy,
  769. Name: "123400",
  770. },
  771. },
  772. },
  773. },
  774. },
  775. sessionRetrieverParams: sessionRetrieverParams{
  776. retrieveSessionParams: retrieveSessionParams{
  777. {
  778. screenName: state.NewIdentScreenName("123400"),
  779. result: nil,
  780. },
  781. },
  782. },
  783. buddyBroadcasterParams: buddyBroadcasterParams{
  784. broadcastVisibilityParams: broadcastVisibilityParams{
  785. {
  786. from: state.NewIdentScreenName("me"),
  787. filter: []state.IdentScreenName{
  788. state.NewIdentScreenName("123400"),
  789. },
  790. },
  791. },
  792. },
  793. messageRelayerParams: messageRelayerParams{
  794. relayToOtherInstancesParams: relayToOtherInstancesParams{
  795. {
  796. screenName: state.NewIdentScreenName("me"),
  797. message: wire.SNACMessage{
  798. Frame: wire.SNACFrame{
  799. FoodGroup: wire.Feedbag,
  800. SubGroup: wire.FeedbagInsertItem,
  801. RequestID: wire.ReqIDFromServer,
  802. },
  803. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  804. Items: []wire.FeedbagItem{
  805. {
  806. ClassID: wire.FeedbagClassIdBuddy,
  807. Name: "123400",
  808. },
  809. },
  810. },
  811. },
  812. },
  813. },
  814. relayToSelfParams: relayToSelfParams{
  815. {
  816. screenName: state.NewIdentScreenName("me"),
  817. message: wire.SNACMessage{
  818. Frame: wire.SNACFrame{
  819. FoodGroup: wire.Feedbag,
  820. SubGroup: wire.FeedbagStatus,
  821. RequestID: 1234,
  822. },
  823. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  824. Results: []uint16{0x0000},
  825. },
  826. },
  827. },
  828. },
  829. },
  830. contactPreAuthorizerParams: contactPreAuthorizerParams{
  831. requiresAuthorizationParams: requiresAuthorizationParams{
  832. {owner: state.NewIdentScreenName("123400"), requester: state.NewIdentScreenName("me"), result: false},
  833. },
  834. },
  835. buddyAddedNotifierDeduperParams: buddyAddedNotifierDeduperParams{
  836. hasBuddyAddedNotificationParams: hasBuddyAddedNotificationParams{
  837. {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400"), result: false},
  838. },
  839. recordBuddyAddedNotificationParams: recordBuddyAddedNotificationParams{
  840. {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400")},
  841. },
  842. },
  843. },
  844. expectOutput: nil,
  845. expectICBM: true,
  846. wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  847. ChannelID: wire.ICBMChannelICQ,
  848. ScreenName: "123400",
  849. TLVRestBlock: wire.TLVRestBlock{
  850. TLVList: wire.TLVList{
  851. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  852. UIN: 0,
  853. MessageType: wire.ICBMMsgTypeAdded,
  854. }),
  855. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  856. },
  857. },
  858. },
  859. },
  860. {
  861. name: "disable typing events",
  862. instance: newTestInstance("me"),
  863. inputSNAC: wire.SNACMessage{
  864. Frame: wire.SNACFrame{
  865. FoodGroup: wire.Feedbag,
  866. SubGroup: wire.FeedbagInsertItem,
  867. RequestID: 1234,
  868. },
  869. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  870. Items: []wire.FeedbagItem{
  871. {
  872. ClassID: wire.FeedbagClassIdBuddyPrefs,
  873. TLVLBlock: wire.TLVLBlock{
  874. TLVList: wire.TLVList{
  875. wire.NewTLVBE(wire.FeedbagAttributesBuddyPrefs, uint32(wire.SNACFlagsExtendedInfo)),
  876. },
  877. },
  878. },
  879. },
  880. },
  881. },
  882. mockParams: mockParams{
  883. feedbagManagerParams: feedbagManagerParams{
  884. feedbagUpsertParams: feedbagUpsertParams{
  885. {
  886. screenName: state.NewIdentScreenName("me"),
  887. items: []wire.FeedbagItem{
  888. {
  889. ClassID: wire.FeedbagClassIdBuddyPrefs,
  890. TLVLBlock: wire.TLVLBlock{
  891. TLVList: wire.TLVList{
  892. wire.NewTLVBE(wire.FeedbagAttributesBuddyPrefs, uint32(wire.SNACFlagsExtendedInfo)),
  893. },
  894. },
  895. },
  896. },
  897. },
  898. },
  899. },
  900. messageRelayerParams: messageRelayerParams{
  901. relayToOtherInstancesParams: relayToOtherInstancesParams{
  902. {
  903. screenName: state.NewIdentScreenName("me"),
  904. message: wire.SNACMessage{
  905. Frame: wire.SNACFrame{
  906. FoodGroup: wire.Feedbag,
  907. SubGroup: wire.FeedbagInsertItem,
  908. RequestID: wire.ReqIDFromServer,
  909. },
  910. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  911. Items: []wire.FeedbagItem{
  912. {
  913. ClassID: wire.FeedbagClassIdBuddyPrefs,
  914. TLVLBlock: wire.TLVLBlock{
  915. TLVList: wire.TLVList{
  916. wire.NewTLVBE(wire.FeedbagAttributesBuddyPrefs, uint32(wire.SNACFlagsExtendedInfo)),
  917. },
  918. },
  919. },
  920. },
  921. },
  922. },
  923. },
  924. },
  925. relayToSelfParams: relayToSelfParams{
  926. {
  927. screenName: state.NewIdentScreenName("me"),
  928. message: wire.SNACMessage{
  929. Frame: wire.SNACFrame{
  930. FoodGroup: wire.Feedbag,
  931. SubGroup: wire.FeedbagStatus,
  932. RequestID: 1234,
  933. },
  934. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  935. Results: []uint16{0x0000},
  936. },
  937. },
  938. },
  939. },
  940. },
  941. },
  942. expectOutput: nil,
  943. },
  944. {
  945. name: "enable typing events",
  946. instance: newTestInstance("me"),
  947. inputSNAC: wire.SNACMessage{
  948. Frame: wire.SNACFrame{
  949. FoodGroup: wire.Feedbag,
  950. SubGroup: wire.FeedbagInsertItem,
  951. RequestID: 1234,
  952. },
  953. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  954. Items: []wire.FeedbagItem{
  955. {
  956. ClassID: wire.FeedbagClassIdBuddyPrefs,
  957. TLVLBlock: wire.TLVLBlock{
  958. TLVList: wire.SetBuddyPref(nil, wire.FeedbagBuddyPrefsDiscloseTyping, true),
  959. },
  960. },
  961. },
  962. },
  963. },
  964. mockParams: mockParams{
  965. feedbagManagerParams: feedbagManagerParams{
  966. feedbagUpsertParams: feedbagUpsertParams{
  967. {
  968. screenName: state.NewIdentScreenName("me"),
  969. items: []wire.FeedbagItem{
  970. {
  971. ClassID: wire.FeedbagClassIdBuddyPrefs,
  972. TLVLBlock: wire.TLVLBlock{
  973. TLVList: wire.SetBuddyPref(nil, wire.FeedbagBuddyPrefsDiscloseTyping, true),
  974. },
  975. },
  976. },
  977. },
  978. },
  979. },
  980. messageRelayerParams: messageRelayerParams{
  981. relayToOtherInstancesParams: relayToOtherInstancesParams{
  982. {
  983. screenName: state.NewIdentScreenName("me"),
  984. message: wire.SNACMessage{
  985. Frame: wire.SNACFrame{
  986. FoodGroup: wire.Feedbag,
  987. SubGroup: wire.FeedbagInsertItem,
  988. RequestID: wire.ReqIDFromServer,
  989. },
  990. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  991. Items: []wire.FeedbagItem{
  992. {
  993. ClassID: wire.FeedbagClassIdBuddyPrefs,
  994. TLVLBlock: wire.TLVLBlock{
  995. TLVList: wire.SetBuddyPref(nil, wire.FeedbagBuddyPrefsDiscloseTyping, true),
  996. },
  997. },
  998. },
  999. },
  1000. },
  1001. },
  1002. },
  1003. relayToSelfParams: relayToSelfParams{
  1004. {
  1005. screenName: state.NewIdentScreenName("me"),
  1006. message: wire.SNACMessage{
  1007. Frame: wire.SNACFrame{
  1008. FoodGroup: wire.Feedbag,
  1009. SubGroup: wire.FeedbagStatus,
  1010. RequestID: 1234,
  1011. },
  1012. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  1013. Results: []uint16{0x0000},
  1014. },
  1015. },
  1016. },
  1017. },
  1018. },
  1019. },
  1020. expectOutput: nil,
  1021. instanceMatch: func(instance *state.SessionInstance) {
  1022. assert.True(t, instance.TypingEventsEnabled())
  1023. },
  1024. },
  1025. {
  1026. name: "block buddies",
  1027. instance: newTestInstance("me"),
  1028. inputSNAC: wire.SNACMessage{
  1029. Frame: wire.SNACFrame{
  1030. FoodGroup: wire.Feedbag,
  1031. SubGroup: wire.FeedbagInsertItem,
  1032. RequestID: 1234,
  1033. },
  1034. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  1035. Items: []wire.FeedbagItem{
  1036. {
  1037. ClassID: wire.FeedbagClassIDDeny,
  1038. Name: "buddy1",
  1039. },
  1040. {
  1041. ClassID: wire.FeedbagClassIDDeny,
  1042. Name: "buddy2",
  1043. },
  1044. },
  1045. },
  1046. },
  1047. mockParams: mockParams{
  1048. feedbagManagerParams: feedbagManagerParams{
  1049. feedbagUpsertParams: feedbagUpsertParams{
  1050. {
  1051. screenName: state.NewIdentScreenName("me"),
  1052. items: []wire.FeedbagItem{
  1053. {
  1054. ClassID: wire.FeedbagClassIDDeny,
  1055. Name: "buddy1",
  1056. },
  1057. {
  1058. ClassID: wire.FeedbagClassIDDeny,
  1059. Name: "buddy2",
  1060. },
  1061. },
  1062. },
  1063. },
  1064. },
  1065. buddyBroadcasterParams: buddyBroadcasterParams{
  1066. broadcastVisibilityParams: broadcastVisibilityParams{
  1067. {
  1068. from: state.NewIdentScreenName("me"),
  1069. filter: []state.IdentScreenName{
  1070. state.NewIdentScreenName("buddy1"),
  1071. state.NewIdentScreenName("buddy2"),
  1072. },
  1073. },
  1074. },
  1075. },
  1076. messageRelayerParams: messageRelayerParams{
  1077. relayToOtherInstancesParams: relayToOtherInstancesParams{
  1078. {
  1079. screenName: state.NewIdentScreenName("me"),
  1080. message: wire.SNACMessage{
  1081. Frame: wire.SNACFrame{
  1082. FoodGroup: wire.Feedbag,
  1083. SubGroup: wire.FeedbagInsertItem,
  1084. RequestID: wire.ReqIDFromServer,
  1085. },
  1086. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  1087. Items: []wire.FeedbagItem{
  1088. {
  1089. ClassID: wire.FeedbagClassIDDeny,
  1090. Name: "buddy1",
  1091. },
  1092. {
  1093. ClassID: wire.FeedbagClassIDDeny,
  1094. Name: "buddy2",
  1095. },
  1096. },
  1097. },
  1098. },
  1099. },
  1100. },
  1101. relayToSelfParams: relayToSelfParams{
  1102. {
  1103. screenName: state.NewIdentScreenName("me"),
  1104. message: wire.SNACMessage{
  1105. Frame: wire.SNACFrame{
  1106. FoodGroup: wire.Feedbag,
  1107. SubGroup: wire.FeedbagStatus,
  1108. RequestID: 1234,
  1109. },
  1110. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  1111. Results: []uint16{0x0000, 0x0000},
  1112. },
  1113. },
  1114. },
  1115. },
  1116. },
  1117. },
  1118. expectOutput: nil,
  1119. },
  1120. {
  1121. name: "permit buddies",
  1122. instance: newTestInstance("me"),
  1123. inputSNAC: wire.SNACMessage{
  1124. Frame: wire.SNACFrame{
  1125. FoodGroup: wire.Feedbag,
  1126. SubGroup: wire.FeedbagInsertItem,
  1127. RequestID: 1234,
  1128. },
  1129. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  1130. Items: []wire.FeedbagItem{
  1131. {
  1132. ClassID: wire.FeedbagClassIDPermit,
  1133. Name: "buddy1",
  1134. },
  1135. {
  1136. ClassID: wire.FeedbagClassIDPermit,
  1137. Name: "buddy2",
  1138. },
  1139. },
  1140. },
  1141. },
  1142. mockParams: mockParams{
  1143. feedbagManagerParams: feedbagManagerParams{
  1144. feedbagUpsertParams: feedbagUpsertParams{
  1145. {
  1146. screenName: state.NewIdentScreenName("me"),
  1147. items: []wire.FeedbagItem{
  1148. {
  1149. ClassID: wire.FeedbagClassIDPermit,
  1150. Name: "buddy1",
  1151. },
  1152. {
  1153. ClassID: wire.FeedbagClassIDPermit,
  1154. Name: "buddy2",
  1155. },
  1156. },
  1157. },
  1158. },
  1159. },
  1160. buddyBroadcasterParams: buddyBroadcasterParams{
  1161. broadcastVisibilityParams: broadcastVisibilityParams{
  1162. {
  1163. from: state.NewIdentScreenName("me"),
  1164. filter: []state.IdentScreenName{
  1165. state.NewIdentScreenName("buddy1"),
  1166. state.NewIdentScreenName("buddy2"),
  1167. },
  1168. },
  1169. },
  1170. },
  1171. messageRelayerParams: messageRelayerParams{
  1172. relayToOtherInstancesParams: relayToOtherInstancesParams{
  1173. {
  1174. screenName: state.NewIdentScreenName("me"),
  1175. message: wire.SNACMessage{
  1176. Frame: wire.SNACFrame{
  1177. FoodGroup: wire.Feedbag,
  1178. SubGroup: wire.FeedbagInsertItem,
  1179. RequestID: wire.ReqIDFromServer,
  1180. },
  1181. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  1182. Items: []wire.FeedbagItem{
  1183. {
  1184. ClassID: wire.FeedbagClassIDPermit,
  1185. Name: "buddy1",
  1186. },
  1187. {
  1188. ClassID: wire.FeedbagClassIDPermit,
  1189. Name: "buddy2",
  1190. },
  1191. },
  1192. },
  1193. },
  1194. },
  1195. },
  1196. relayToSelfParams: relayToSelfParams{
  1197. {
  1198. screenName: state.NewIdentScreenName("me"),
  1199. message: wire.SNACMessage{
  1200. Frame: wire.SNACFrame{
  1201. FoodGroup: wire.Feedbag,
  1202. SubGroup: wire.FeedbagStatus,
  1203. RequestID: 1234,
  1204. },
  1205. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  1206. Results: []uint16{0x0000, 0x0000},
  1207. },
  1208. },
  1209. },
  1210. },
  1211. },
  1212. },
  1213. expectOutput: nil,
  1214. },
  1215. {
  1216. name: "set privacy mode",
  1217. instance: newTestInstance("me"),
  1218. inputSNAC: wire.SNACMessage{
  1219. Frame: wire.SNACFrame{
  1220. FoodGroup: wire.Feedbag,
  1221. SubGroup: wire.FeedbagInsertItem,
  1222. RequestID: 1234,
  1223. },
  1224. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  1225. Items: []wire.FeedbagItem{
  1226. {
  1227. ClassID: wire.FeedbagClassIdPdinfo,
  1228. },
  1229. },
  1230. },
  1231. },
  1232. mockParams: mockParams{
  1233. feedbagManagerParams: feedbagManagerParams{
  1234. feedbagUpsertParams: feedbagUpsertParams{
  1235. {
  1236. screenName: state.NewIdentScreenName("me"),
  1237. items: []wire.FeedbagItem{
  1238. {
  1239. ClassID: wire.FeedbagClassIdPdinfo,
  1240. },
  1241. },
  1242. },
  1243. },
  1244. },
  1245. buddyBroadcasterParams: buddyBroadcasterParams{
  1246. broadcastVisibilityParams: broadcastVisibilityParams{
  1247. {
  1248. from: state.NewIdentScreenName("me"),
  1249. filter: nil,
  1250. },
  1251. },
  1252. },
  1253. messageRelayerParams: messageRelayerParams{
  1254. relayToOtherInstancesParams: relayToOtherInstancesParams{
  1255. {
  1256. screenName: state.NewIdentScreenName("me"),
  1257. message: wire.SNACMessage{
  1258. Frame: wire.SNACFrame{
  1259. FoodGroup: wire.Feedbag,
  1260. SubGroup: wire.FeedbagInsertItem,
  1261. RequestID: wire.ReqIDFromServer,
  1262. },
  1263. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  1264. Items: []wire.FeedbagItem{
  1265. {
  1266. ClassID: wire.FeedbagClassIdPdinfo,
  1267. },
  1268. },
  1269. },
  1270. },
  1271. },
  1272. },
  1273. relayToSelfParams: relayToSelfParams{
  1274. {
  1275. screenName: state.NewIdentScreenName("me"),
  1276. message: wire.SNACMessage{
  1277. Frame: wire.SNACFrame{
  1278. FoodGroup: wire.Feedbag,
  1279. SubGroup: wire.FeedbagStatus,
  1280. RequestID: 1234,
  1281. },
  1282. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  1283. Results: []uint16{0x0000},
  1284. },
  1285. },
  1286. },
  1287. },
  1288. },
  1289. },
  1290. expectOutput: nil,
  1291. },
  1292. {
  1293. name: "user blocks themselves, receives error",
  1294. instance: newTestInstance("me"),
  1295. inputSNAC: wire.SNACMessage{
  1296. Frame: wire.SNACFrame{
  1297. FoodGroup: wire.Feedbag,
  1298. SubGroup: wire.FeedbagInsertItem,
  1299. RequestID: 1234,
  1300. },
  1301. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  1302. Items: []wire.FeedbagItem{
  1303. {
  1304. ClassID: wire.FeedbagClassIDDeny,
  1305. Name: "me",
  1306. },
  1307. },
  1308. },
  1309. },
  1310. expectOutput: &wire.SNACMessage{
  1311. Frame: wire.SNACFrame{
  1312. FoodGroup: wire.Feedbag,
  1313. SubGroup: wire.FeedbagErr,
  1314. RequestID: 1234,
  1315. },
  1316. Body: wire.SNACError{
  1317. Code: wire.ErrorCodeNotSupportedByHost,
  1318. },
  1319. },
  1320. },
  1321. {
  1322. name: "add icon hash to feedbag, icon doesn't exist in BART store, instruct client to upload icon",
  1323. instance: newTestInstance("me"),
  1324. inputSNAC: wire.SNACMessage{
  1325. Frame: wire.SNACFrame{
  1326. FoodGroup: wire.Feedbag,
  1327. SubGroup: wire.FeedbagInsertItem,
  1328. RequestID: 1234,
  1329. },
  1330. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  1331. Items: []wire.FeedbagItem{
  1332. {
  1333. Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
  1334. ClassID: wire.FeedbagClassIdBart,
  1335. TLVLBlock: wire.TLVLBlock{
  1336. TLVList: wire.TLVList{
  1337. wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
  1338. Flags: wire.BARTFlagsCustom,
  1339. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1340. }),
  1341. },
  1342. },
  1343. },
  1344. },
  1345. },
  1346. },
  1347. mockParams: mockParams{
  1348. bartItemManagerParams: bartItemManagerParams{
  1349. bartItemManagerRetrieveParams: bartItemManagerRetrieveParams{
  1350. {
  1351. itemHash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1352. result: []byte{}, // icon doesn't exist
  1353. },
  1354. },
  1355. },
  1356. feedbagManagerParams: feedbagManagerParams{
  1357. feedbagUpsertParams: feedbagUpsertParams{
  1358. {
  1359. screenName: state.NewIdentScreenName("me"),
  1360. items: []wire.FeedbagItem{
  1361. {
  1362. Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
  1363. ClassID: wire.FeedbagClassIdBart,
  1364. TLVLBlock: wire.TLVLBlock{
  1365. TLVList: wire.TLVList{
  1366. wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
  1367. Flags: wire.BARTFlagsCustom,
  1368. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1369. }),
  1370. },
  1371. },
  1372. },
  1373. },
  1374. },
  1375. },
  1376. },
  1377. messageRelayerParams: messageRelayerParams{
  1378. relayToScreenNameParams: relayToScreenNameParams{
  1379. {
  1380. screenName: state.NewIdentScreenName("me"),
  1381. message: wire.SNACMessage{
  1382. Frame: wire.SNACFrame{
  1383. FoodGroup: wire.OService,
  1384. SubGroup: wire.OServiceUserInfoUpdate,
  1385. },
  1386. Body: func(val any) bool {
  1387. snac, ok := val.(wire.SNAC_0x01_0x0F_OServiceUserInfoUpdate)
  1388. if !ok {
  1389. return false
  1390. }
  1391. bartID, exists := snac.UserInfo[0].Bytes(wire.OServiceUserInfoBARTInfo)
  1392. return assert.True(t, exists) &&
  1393. assert.Equal(t, "me", snac.UserInfo[0].ScreenName) &&
  1394. assert.True(t, bytes.Contains(bartID, []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'}), "user info BART hash doesn't match")
  1395. },
  1396. },
  1397. },
  1398. },
  1399. relayToOtherInstancesParams: relayToOtherInstancesParams{
  1400. {
  1401. screenName: state.NewIdentScreenName("me"),
  1402. message: wire.SNACMessage{
  1403. Frame: wire.SNACFrame{
  1404. FoodGroup: wire.Feedbag,
  1405. SubGroup: wire.FeedbagInsertItem,
  1406. RequestID: wire.ReqIDFromServer,
  1407. },
  1408. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  1409. Items: []wire.FeedbagItem{
  1410. {
  1411. Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
  1412. ClassID: wire.FeedbagClassIdBart,
  1413. TLVLBlock: wire.TLVLBlock{
  1414. TLVList: wire.TLVList{
  1415. wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
  1416. Flags: wire.BARTFlagsCustom,
  1417. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1418. }),
  1419. },
  1420. },
  1421. },
  1422. },
  1423. },
  1424. },
  1425. },
  1426. },
  1427. relayToSelfParams: relayToSelfParams{
  1428. {
  1429. screenName: state.NewIdentScreenName("me"),
  1430. message: wire.SNACMessage{
  1431. Frame: wire.SNACFrame{
  1432. FoodGroup: wire.OService,
  1433. SubGroup: wire.OServiceBartReply,
  1434. },
  1435. Body: wire.SNAC_0x01_0x21_OServiceBARTReply{
  1436. BARTID: wire.BARTID{
  1437. Type: wire.BARTTypesBuddyIcon,
  1438. BARTInfo: wire.BARTInfo{
  1439. Flags: wire.BARTFlagsCustom | wire.BARTFlagsUnknown,
  1440. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1441. },
  1442. },
  1443. },
  1444. },
  1445. },
  1446. {
  1447. screenName: state.NewIdentScreenName("me"),
  1448. message: wire.SNACMessage{
  1449. Frame: wire.SNACFrame{
  1450. FoodGroup: wire.Feedbag,
  1451. SubGroup: wire.FeedbagStatus,
  1452. RequestID: 1234,
  1453. },
  1454. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  1455. Results: []uint16{0x0000},
  1456. },
  1457. },
  1458. },
  1459. },
  1460. },
  1461. },
  1462. expectOutput: nil,
  1463. instanceMatch: func(instance *state.SessionInstance) {
  1464. have, hasIcon := instance.Session().BuddyIcon()
  1465. assert.True(t, hasIcon)
  1466. want := wire.BARTID{
  1467. Type: wire.BARTTypesBuddyIcon,
  1468. BARTInfo: wire.BARTInfo{
  1469. Flags: wire.BARTFlagsCustom | wire.BARTFlagsUnknown,
  1470. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1471. },
  1472. }
  1473. assert.Equal(t, want, have)
  1474. },
  1475. },
  1476. {
  1477. name: "add icon hash to feedbag, icon already exists in BART store, notify buddies about icon change",
  1478. instance: newTestInstance("me"),
  1479. inputSNAC: wire.SNACMessage{
  1480. Frame: wire.SNACFrame{
  1481. FoodGroup: wire.Feedbag,
  1482. SubGroup: wire.FeedbagInsertItem,
  1483. RequestID: 1234,
  1484. },
  1485. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  1486. Items: []wire.FeedbagItem{
  1487. {
  1488. Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
  1489. ClassID: wire.FeedbagClassIdBart,
  1490. TLVLBlock: wire.TLVLBlock{
  1491. TLVList: wire.TLVList{
  1492. wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
  1493. Flags: wire.BARTFlagsCustom,
  1494. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1495. }),
  1496. },
  1497. },
  1498. },
  1499. },
  1500. },
  1501. },
  1502. mockParams: mockParams{
  1503. bartItemManagerParams: bartItemManagerParams{
  1504. bartItemManagerRetrieveParams: bartItemManagerRetrieveParams{
  1505. {
  1506. itemHash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1507. result: []byte{'i', 'c', 'o', 'n', 'd', 'a', 't', 'a'},
  1508. err: nil,
  1509. },
  1510. },
  1511. },
  1512. feedbagManagerParams: feedbagManagerParams{
  1513. feedbagUpsertParams: feedbagUpsertParams{
  1514. {
  1515. screenName: state.NewIdentScreenName("me"),
  1516. items: []wire.FeedbagItem{
  1517. {
  1518. Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
  1519. ClassID: wire.FeedbagClassIdBart,
  1520. TLVLBlock: wire.TLVLBlock{
  1521. TLVList: wire.TLVList{
  1522. wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
  1523. Flags: wire.BARTFlagsCustom,
  1524. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1525. }),
  1526. },
  1527. },
  1528. },
  1529. },
  1530. },
  1531. },
  1532. adjacentUsersParams: adjacentUsersParams{},
  1533. feedbagParams: feedbagParams{},
  1534. },
  1535. messageRelayerParams: messageRelayerParams{
  1536. relayToScreenNameParams: relayToScreenNameParams{
  1537. {
  1538. screenName: state.NewIdentScreenName("me"),
  1539. message: wire.SNACMessage{
  1540. Frame: wire.SNACFrame{
  1541. FoodGroup: wire.OService,
  1542. SubGroup: wire.OServiceUserInfoUpdate,
  1543. },
  1544. Body: func(val any) bool {
  1545. snac, ok := val.(wire.SNAC_0x01_0x0F_OServiceUserInfoUpdate)
  1546. if !ok {
  1547. return false
  1548. }
  1549. bartID, exists := snac.UserInfo[0].Bytes(wire.OServiceUserInfoBARTInfo)
  1550. return assert.True(t, exists) &&
  1551. assert.Equal(t, "me", snac.UserInfo[0].ScreenName) &&
  1552. assert.True(t, bytes.Contains(bartID, []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'}), "user info BART hash doesn't match")
  1553. },
  1554. },
  1555. },
  1556. },
  1557. relayToOtherInstancesParams: relayToOtherInstancesParams{
  1558. {
  1559. screenName: state.NewIdentScreenName("me"),
  1560. message: wire.SNACMessage{
  1561. Frame: wire.SNACFrame{
  1562. FoodGroup: wire.Feedbag,
  1563. SubGroup: wire.FeedbagInsertItem,
  1564. RequestID: wire.ReqIDFromServer,
  1565. },
  1566. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  1567. Items: []wire.FeedbagItem{
  1568. {
  1569. Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
  1570. ClassID: wire.FeedbagClassIdBart,
  1571. TLVLBlock: wire.TLVLBlock{
  1572. TLVList: wire.TLVList{
  1573. wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
  1574. Flags: wire.BARTFlagsCustom,
  1575. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1576. }),
  1577. },
  1578. },
  1579. },
  1580. },
  1581. },
  1582. },
  1583. },
  1584. },
  1585. relayToSelfParams: relayToSelfParams{
  1586. {
  1587. screenName: state.NewIdentScreenName("me"),
  1588. message: wire.SNACMessage{
  1589. Frame: wire.SNACFrame{
  1590. FoodGroup: wire.OService,
  1591. SubGroup: wire.OServiceBartReply,
  1592. },
  1593. Body: wire.SNAC_0x01_0x21_OServiceBARTReply{
  1594. BARTID: wire.BARTID{
  1595. Type: wire.BARTTypesBuddyIcon,
  1596. BARTInfo: wire.BARTInfo{
  1597. Flags: wire.BARTFlagsCustom | wire.BARTFlagsKnown,
  1598. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1599. },
  1600. },
  1601. },
  1602. },
  1603. },
  1604. {
  1605. screenName: state.NewIdentScreenName("me"),
  1606. message: wire.SNACMessage{
  1607. Frame: wire.SNACFrame{
  1608. FoodGroup: wire.Feedbag,
  1609. SubGroup: wire.FeedbagStatus,
  1610. RequestID: 1234,
  1611. },
  1612. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  1613. Results: []uint16{0x0000},
  1614. },
  1615. },
  1616. },
  1617. },
  1618. },
  1619. buddyBroadcasterParams: buddyBroadcasterParams{
  1620. broadcastBuddyArrivedParams: broadcastBuddyArrivedParams{
  1621. {
  1622. screenName: state.DisplayScreenName("me"),
  1623. },
  1624. },
  1625. },
  1626. },
  1627. expectOutput: nil,
  1628. instanceMatch: func(instance *state.SessionInstance) {
  1629. have, hasIcon := instance.Session().BuddyIcon()
  1630. assert.True(t, hasIcon)
  1631. want := wire.BARTID{
  1632. Type: wire.BARTTypesBuddyIcon,
  1633. BARTInfo: wire.BARTInfo{
  1634. Flags: wire.BARTFlagsCustom | wire.BARTFlagsKnown,
  1635. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1636. },
  1637. }
  1638. assert.Equal(t, want, have)
  1639. },
  1640. },
  1641. {
  1642. name: "clear icon, notify buddies about icon change",
  1643. instance: newTestInstance("me"),
  1644. inputSNAC: wire.SNACMessage{
  1645. Frame: wire.SNACFrame{
  1646. FoodGroup: wire.Feedbag,
  1647. SubGroup: wire.FeedbagInsertItem,
  1648. RequestID: 1234,
  1649. },
  1650. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  1651. Items: []wire.FeedbagItem{
  1652. {
  1653. Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
  1654. ClassID: wire.FeedbagClassIdBart,
  1655. TLVLBlock: wire.TLVLBlock{
  1656. TLVList: wire.TLVList{
  1657. wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
  1658. Flags: wire.BARTFlagsKnown,
  1659. Hash: wire.GetClearIconHash(),
  1660. }),
  1661. },
  1662. },
  1663. },
  1664. },
  1665. },
  1666. },
  1667. mockParams: mockParams{
  1668. feedbagManagerParams: feedbagManagerParams{
  1669. feedbagUpsertParams: feedbagUpsertParams{
  1670. {
  1671. screenName: state.NewIdentScreenName("me"),
  1672. items: []wire.FeedbagItem{
  1673. {
  1674. Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
  1675. ClassID: wire.FeedbagClassIdBart,
  1676. TLVLBlock: wire.TLVLBlock{
  1677. TLVList: wire.TLVList{
  1678. wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
  1679. Flags: wire.BARTFlagsKnown,
  1680. Hash: wire.GetClearIconHash(),
  1681. }),
  1682. },
  1683. },
  1684. },
  1685. },
  1686. },
  1687. },
  1688. },
  1689. buddyBroadcasterParams: buddyBroadcasterParams{
  1690. broadcastBuddyArrivedParams: broadcastBuddyArrivedParams{
  1691. {
  1692. screenName: state.DisplayScreenName("me"),
  1693. },
  1694. },
  1695. },
  1696. messageRelayerParams: messageRelayerParams{
  1697. relayToOtherInstancesParams: relayToOtherInstancesParams{
  1698. {
  1699. screenName: state.NewIdentScreenName("me"),
  1700. message: wire.SNACMessage{
  1701. Frame: wire.SNACFrame{
  1702. FoodGroup: wire.Feedbag,
  1703. SubGroup: wire.FeedbagInsertItem,
  1704. RequestID: wire.ReqIDFromServer,
  1705. },
  1706. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  1707. Items: []wire.FeedbagItem{
  1708. {
  1709. Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
  1710. ClassID: wire.FeedbagClassIdBart,
  1711. TLVLBlock: wire.TLVLBlock{
  1712. TLVList: wire.TLVList{
  1713. wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
  1714. Hash: wire.GetClearIconHash(),
  1715. }),
  1716. },
  1717. },
  1718. },
  1719. },
  1720. },
  1721. },
  1722. },
  1723. },
  1724. relayToSelfParams: relayToSelfParams{
  1725. {
  1726. screenName: state.NewIdentScreenName("me"),
  1727. message: wire.SNACMessage{
  1728. Frame: wire.SNACFrame{
  1729. FoodGroup: wire.OService,
  1730. SubGroup: wire.OServiceBartReply,
  1731. },
  1732. Body: wire.SNAC_0x01_0x21_OServiceBARTReply{
  1733. BARTID: wire.BARTID{
  1734. Type: wire.BARTTypesBuddyIcon,
  1735. BARTInfo: wire.BARTInfo{
  1736. Flags: wire.BARTFlagsKnown,
  1737. Hash: wire.GetClearIconHash(),
  1738. },
  1739. },
  1740. },
  1741. },
  1742. },
  1743. {
  1744. screenName: state.NewIdentScreenName("me"),
  1745. message: wire.SNACMessage{
  1746. Frame: wire.SNACFrame{
  1747. FoodGroup: wire.Feedbag,
  1748. SubGroup: wire.FeedbagStatus,
  1749. RequestID: 1234,
  1750. },
  1751. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  1752. Results: []uint16{0x0000},
  1753. },
  1754. },
  1755. },
  1756. },
  1757. relayToScreenNameParams: relayToScreenNameParams{
  1758. {
  1759. screenName: state.NewIdentScreenName("me"),
  1760. message: wire.SNACMessage{
  1761. Frame: wire.SNACFrame{
  1762. FoodGroup: wire.OService,
  1763. SubGroup: wire.OServiceUserInfoUpdate,
  1764. },
  1765. Body: func(val any) bool {
  1766. snac, ok := val.(wire.SNAC_0x01_0x0F_OServiceUserInfoUpdate)
  1767. if !ok {
  1768. return false
  1769. }
  1770. bartID, exists := snac.UserInfo[0].Bytes(wire.OServiceUserInfoBARTInfo)
  1771. return assert.True(t, exists) &&
  1772. assert.Equal(t, "me", snac.UserInfo[0].ScreenName) &&
  1773. assert.True(t, bytes.Contains(bartID, wire.GetClearIconHash()), "user info BART hash doesn't match")
  1774. },
  1775. },
  1776. },
  1777. },
  1778. },
  1779. },
  1780. expectOutput: nil,
  1781. instanceMatch: func(instance *state.SessionInstance) {
  1782. bartInfo, hasIcon := instance.Session().BuddyIcon()
  1783. assert.True(t, hasIcon)
  1784. assert.Equal(t, wire.GetClearIconHash(), bartInfo.Hash)
  1785. },
  1786. },
  1787. {
  1788. name: "add non-icon to feedbag, icon doesn't exist in BART store, don't broadcast change",
  1789. instance: newTestInstance("me"),
  1790. inputSNAC: wire.SNACMessage{
  1791. Frame: wire.SNACFrame{
  1792. FoodGroup: wire.Feedbag,
  1793. SubGroup: wire.FeedbagInsertItem,
  1794. RequestID: 1234,
  1795. },
  1796. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  1797. Items: []wire.FeedbagItem{
  1798. {
  1799. Name: fmt.Sprintf("%d", wire.BARTTypesArriveSound),
  1800. ClassID: wire.FeedbagClassIdBart,
  1801. TLVLBlock: wire.TLVLBlock{
  1802. TLVList: wire.TLVList{
  1803. wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
  1804. Flags: wire.BARTFlagsCustom,
  1805. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1806. }),
  1807. },
  1808. },
  1809. },
  1810. },
  1811. },
  1812. },
  1813. mockParams: mockParams{
  1814. bartItemManagerParams: bartItemManagerParams{
  1815. bartItemManagerRetrieveParams: bartItemManagerRetrieveParams{
  1816. {
  1817. itemHash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1818. result: []byte{}, // icon doesn't exist
  1819. },
  1820. },
  1821. },
  1822. feedbagManagerParams: feedbagManagerParams{
  1823. feedbagUpsertParams: feedbagUpsertParams{
  1824. {
  1825. screenName: state.NewIdentScreenName("me"),
  1826. items: []wire.FeedbagItem{
  1827. {
  1828. Name: fmt.Sprintf("%d", wire.BARTTypesArriveSound),
  1829. ClassID: wire.FeedbagClassIdBart,
  1830. TLVLBlock: wire.TLVLBlock{
  1831. TLVList: wire.TLVList{
  1832. wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
  1833. Flags: wire.BARTFlagsCustom,
  1834. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1835. }),
  1836. },
  1837. },
  1838. },
  1839. },
  1840. },
  1841. },
  1842. },
  1843. messageRelayerParams: messageRelayerParams{
  1844. relayToOtherInstancesParams: relayToOtherInstancesParams{
  1845. {
  1846. screenName: state.NewIdentScreenName("me"),
  1847. message: wire.SNACMessage{
  1848. Frame: wire.SNACFrame{
  1849. FoodGroup: wire.Feedbag,
  1850. SubGroup: wire.FeedbagInsertItem,
  1851. RequestID: wire.ReqIDFromServer,
  1852. },
  1853. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  1854. Items: []wire.FeedbagItem{
  1855. {
  1856. Name: fmt.Sprintf("%d", wire.BARTTypesArriveSound),
  1857. ClassID: wire.FeedbagClassIdBart,
  1858. TLVLBlock: wire.TLVLBlock{
  1859. TLVList: wire.TLVList{
  1860. wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
  1861. Flags: wire.BARTFlagsCustom,
  1862. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1863. }),
  1864. },
  1865. },
  1866. },
  1867. },
  1868. },
  1869. },
  1870. },
  1871. },
  1872. relayToSelfParams: relayToSelfParams{
  1873. {
  1874. screenName: state.NewIdentScreenName("me"),
  1875. message: wire.SNACMessage{
  1876. Frame: wire.SNACFrame{
  1877. FoodGroup: wire.OService,
  1878. SubGroup: wire.OServiceBartReply,
  1879. },
  1880. Body: wire.SNAC_0x01_0x21_OServiceBARTReply{
  1881. BARTID: wire.BARTID{
  1882. Type: wire.BARTTypesArriveSound,
  1883. BARTInfo: wire.BARTInfo{
  1884. Flags: wire.BARTFlagsCustom | wire.BARTFlagsUnknown,
  1885. Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
  1886. },
  1887. },
  1888. },
  1889. },
  1890. },
  1891. {
  1892. screenName: state.NewIdentScreenName("me"),
  1893. message: wire.SNACMessage{
  1894. Frame: wire.SNACFrame{
  1895. FoodGroup: wire.Feedbag,
  1896. SubGroup: wire.FeedbagStatus,
  1897. RequestID: 1234,
  1898. },
  1899. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  1900. Results: []uint16{0x0000},
  1901. },
  1902. },
  1903. },
  1904. },
  1905. },
  1906. },
  1907. expectOutput: nil,
  1908. instanceMatch: func(instance *state.SessionInstance) {
  1909. _, hasIcon := instance.Session().BuddyIcon()
  1910. assert.False(t, hasIcon)
  1911. },
  1912. },
  1913. {
  1914. name: "add ICQ buddy online with feedbag: relay FeedbagBuddyAdded",
  1915. instance: newTestInstance("me"),
  1916. inputSNAC: wire.SNACMessage{
  1917. Frame: wire.SNACFrame{
  1918. FoodGroup: wire.Feedbag,
  1919. SubGroup: wire.FeedbagInsertItem,
  1920. RequestID: 1234,
  1921. },
  1922. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  1923. Items: []wire.FeedbagItem{
  1924. {
  1925. ClassID: wire.FeedbagClassIdBuddy,
  1926. Name: "123400",
  1927. },
  1928. },
  1929. },
  1930. },
  1931. mockParams: mockParams{
  1932. feedbagManagerParams: feedbagManagerParams{
  1933. feedbagUpsertParams: feedbagUpsertParams{
  1934. {
  1935. screenName: state.NewIdentScreenName("me"),
  1936. items: []wire.FeedbagItem{
  1937. {
  1938. ClassID: wire.FeedbagClassIdBuddy,
  1939. Name: "123400",
  1940. },
  1941. },
  1942. },
  1943. },
  1944. },
  1945. contactPreAuthorizerParams: contactPreAuthorizerParams{
  1946. requiresAuthorizationParams: requiresAuthorizationParams{
  1947. {owner: state.NewIdentScreenName("123400"), requester: state.NewIdentScreenName("me"), result: false},
  1948. },
  1949. },
  1950. buddyAddedNotifierDeduperParams: buddyAddedNotifierDeduperParams{
  1951. hasBuddyAddedNotificationParams: hasBuddyAddedNotificationParams{
  1952. {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400"), result: false},
  1953. },
  1954. recordBuddyAddedNotificationParams: recordBuddyAddedNotificationParams{
  1955. {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400")},
  1956. },
  1957. },
  1958. sessionRetrieverParams: sessionRetrieverParams{
  1959. retrieveSessionParams: retrieveSessionParams{
  1960. {
  1961. screenName: state.NewIdentScreenName("123400"),
  1962. result: func() *state.Session {
  1963. s := state.NewSession()
  1964. s.SetIdentScreenName(state.NewIdentScreenName("123400"))
  1965. s.SetUsesFeedbag()
  1966. return s
  1967. }(),
  1968. },
  1969. },
  1970. },
  1971. messageRelayerParams: messageRelayerParams{
  1972. relayToScreenNameParams: relayToScreenNameParams{
  1973. {
  1974. screenName: state.NewIdentScreenName("123400"),
  1975. message: wire.SNACMessage{
  1976. Frame: wire.SNACFrame{
  1977. FoodGroup: wire.Feedbag,
  1978. SubGroup: wire.FeedbagBuddyAdded,
  1979. Flags: wire.SNACFlagsExtendedInfo,
  1980. },
  1981. Body: wire.SNAC_0x13_0x1C_FeedbagBuddyAdded{
  1982. TLVLBlock: wire.TLVLBlock{
  1983. TLVList: wire.TLVList{
  1984. wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(4)),
  1985. },
  1986. },
  1987. ScreenName: "me",
  1988. },
  1989. },
  1990. },
  1991. },
  1992. relayToOtherInstancesParams: relayToOtherInstancesParams{
  1993. {
  1994. screenName: state.NewIdentScreenName("me"),
  1995. message: wire.SNACMessage{
  1996. Frame: wire.SNACFrame{
  1997. FoodGroup: wire.Feedbag,
  1998. SubGroup: wire.FeedbagInsertItem,
  1999. RequestID: wire.ReqIDFromServer,
  2000. },
  2001. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  2002. Items: []wire.FeedbagItem{
  2003. {
  2004. ClassID: wire.FeedbagClassIdBuddy,
  2005. Name: "123400",
  2006. },
  2007. },
  2008. },
  2009. },
  2010. },
  2011. },
  2012. relayToSelfParams: relayToSelfParams{
  2013. {
  2014. screenName: state.NewIdentScreenName("me"),
  2015. message: wire.SNACMessage{
  2016. Frame: wire.SNACFrame{
  2017. FoodGroup: wire.Feedbag,
  2018. SubGroup: wire.FeedbagStatus,
  2019. RequestID: 1234,
  2020. },
  2021. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  2022. Results: []uint16{0x0000},
  2023. },
  2024. },
  2025. },
  2026. },
  2027. },
  2028. buddyBroadcasterParams: buddyBroadcasterParams{
  2029. broadcastVisibilityParams: broadcastVisibilityParams{
  2030. {
  2031. from: state.NewIdentScreenName("me"),
  2032. filter: []state.IdentScreenName{
  2033. state.NewIdentScreenName("123400"),
  2034. },
  2035. },
  2036. },
  2037. },
  2038. },
  2039. expectOutput: nil,
  2040. },
  2041. {
  2042. name: "add ICQ buddy online with feedbag: skip FeedbagBuddyAdded when already sent",
  2043. instance: newTestInstance("me"),
  2044. inputSNAC: wire.SNACMessage{
  2045. Frame: wire.SNACFrame{
  2046. FoodGroup: wire.Feedbag,
  2047. SubGroup: wire.FeedbagInsertItem,
  2048. RequestID: 1234,
  2049. },
  2050. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  2051. Items: []wire.FeedbagItem{
  2052. {
  2053. ClassID: wire.FeedbagClassIdBuddy,
  2054. Name: "123400",
  2055. },
  2056. },
  2057. },
  2058. },
  2059. mockParams: mockParams{
  2060. feedbagManagerParams: feedbagManagerParams{
  2061. feedbagUpsertParams: feedbagUpsertParams{
  2062. {
  2063. screenName: state.NewIdentScreenName("me"),
  2064. items: []wire.FeedbagItem{
  2065. {
  2066. ClassID: wire.FeedbagClassIdBuddy,
  2067. Name: "123400",
  2068. },
  2069. },
  2070. },
  2071. },
  2072. },
  2073. contactPreAuthorizerParams: contactPreAuthorizerParams{
  2074. requiresAuthorizationParams: requiresAuthorizationParams{
  2075. {owner: state.NewIdentScreenName("123400"), requester: state.NewIdentScreenName("me"), result: false},
  2076. },
  2077. },
  2078. buddyAddedNotifierDeduperParams: buddyAddedNotifierDeduperParams{
  2079. hasBuddyAddedNotificationParams: hasBuddyAddedNotificationParams{
  2080. {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400"), result: true},
  2081. },
  2082. },
  2083. messageRelayerParams: messageRelayerParams{
  2084. relayToOtherInstancesParams: relayToOtherInstancesParams{
  2085. {
  2086. screenName: state.NewIdentScreenName("me"),
  2087. message: wire.SNACMessage{
  2088. Frame: wire.SNACFrame{
  2089. FoodGroup: wire.Feedbag,
  2090. SubGroup: wire.FeedbagInsertItem,
  2091. RequestID: wire.ReqIDFromServer,
  2092. },
  2093. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  2094. Items: []wire.FeedbagItem{
  2095. {
  2096. ClassID: wire.FeedbagClassIdBuddy,
  2097. Name: "123400",
  2098. },
  2099. },
  2100. },
  2101. },
  2102. },
  2103. },
  2104. relayToSelfParams: relayToSelfParams{
  2105. {
  2106. screenName: state.NewIdentScreenName("me"),
  2107. message: wire.SNACMessage{
  2108. Frame: wire.SNACFrame{
  2109. FoodGroup: wire.Feedbag,
  2110. SubGroup: wire.FeedbagStatus,
  2111. RequestID: 1234,
  2112. },
  2113. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  2114. Results: []uint16{0x0000},
  2115. },
  2116. },
  2117. },
  2118. },
  2119. },
  2120. buddyBroadcasterParams: buddyBroadcasterParams{
  2121. broadcastVisibilityParams: broadcastVisibilityParams{
  2122. {
  2123. from: state.NewIdentScreenName("me"),
  2124. filter: []state.IdentScreenName{
  2125. state.NewIdentScreenName("123400"),
  2126. },
  2127. },
  2128. },
  2129. },
  2130. },
  2131. expectOutput: nil,
  2132. },
  2133. {
  2134. name: "add ICQ buddy online without feedbag: send legacy ICBM added",
  2135. instance: newTestInstance("me"),
  2136. inputSNAC: wire.SNACMessage{
  2137. Frame: wire.SNACFrame{
  2138. FoodGroup: wire.Feedbag,
  2139. SubGroup: wire.FeedbagInsertItem,
  2140. RequestID: 1234,
  2141. },
  2142. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  2143. Items: []wire.FeedbagItem{
  2144. {
  2145. ClassID: wire.FeedbagClassIdBuddy,
  2146. Name: "123400",
  2147. },
  2148. },
  2149. },
  2150. },
  2151. mockParams: mockParams{
  2152. feedbagManagerParams: feedbagManagerParams{
  2153. feedbagUpsertParams: feedbagUpsertParams{
  2154. {
  2155. screenName: state.NewIdentScreenName("me"),
  2156. items: []wire.FeedbagItem{
  2157. {
  2158. ClassID: wire.FeedbagClassIdBuddy,
  2159. Name: "123400",
  2160. },
  2161. },
  2162. },
  2163. },
  2164. },
  2165. contactPreAuthorizerParams: contactPreAuthorizerParams{
  2166. requiresAuthorizationParams: requiresAuthorizationParams{
  2167. {owner: state.NewIdentScreenName("123400"), requester: state.NewIdentScreenName("me"), result: false},
  2168. },
  2169. },
  2170. buddyAddedNotifierDeduperParams: buddyAddedNotifierDeduperParams{
  2171. hasBuddyAddedNotificationParams: hasBuddyAddedNotificationParams{
  2172. {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400"), result: false},
  2173. },
  2174. recordBuddyAddedNotificationParams: recordBuddyAddedNotificationParams{
  2175. {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400")},
  2176. },
  2177. },
  2178. sessionRetrieverParams: sessionRetrieverParams{
  2179. retrieveSessionParams: retrieveSessionParams{
  2180. {
  2181. screenName: state.NewIdentScreenName("123400"),
  2182. result: func() *state.Session {
  2183. s := state.NewSession()
  2184. s.SetIdentScreenName(state.NewIdentScreenName("123400"))
  2185. return s
  2186. }(),
  2187. },
  2188. },
  2189. },
  2190. messageRelayerParams: messageRelayerParams{
  2191. relayToOtherInstancesParams: relayToOtherInstancesParams{
  2192. {
  2193. screenName: state.NewIdentScreenName("me"),
  2194. message: wire.SNACMessage{
  2195. Frame: wire.SNACFrame{
  2196. FoodGroup: wire.Feedbag,
  2197. SubGroup: wire.FeedbagInsertItem,
  2198. RequestID: wire.ReqIDFromServer,
  2199. },
  2200. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  2201. Items: []wire.FeedbagItem{
  2202. {
  2203. ClassID: wire.FeedbagClassIdBuddy,
  2204. Name: "123400",
  2205. },
  2206. },
  2207. },
  2208. },
  2209. },
  2210. },
  2211. relayToSelfParams: relayToSelfParams{
  2212. {
  2213. screenName: state.NewIdentScreenName("me"),
  2214. message: wire.SNACMessage{
  2215. Frame: wire.SNACFrame{
  2216. FoodGroup: wire.Feedbag,
  2217. SubGroup: wire.FeedbagStatus,
  2218. RequestID: 1234,
  2219. },
  2220. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  2221. Results: []uint16{0x0000},
  2222. },
  2223. },
  2224. },
  2225. },
  2226. },
  2227. buddyBroadcasterParams: buddyBroadcasterParams{
  2228. broadcastVisibilityParams: broadcastVisibilityParams{
  2229. {
  2230. from: state.NewIdentScreenName("me"),
  2231. filter: []state.IdentScreenName{
  2232. state.NewIdentScreenName("123400"),
  2233. },
  2234. },
  2235. },
  2236. },
  2237. },
  2238. expectOutput: nil,
  2239. expectICBM: true,
  2240. wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  2241. ChannelID: wire.ICBMChannelICQ,
  2242. ScreenName: "123400",
  2243. TLVRestBlock: wire.TLVRestBlock{
  2244. TLVList: wire.TLVList{
  2245. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  2246. UIN: 0,
  2247. MessageType: wire.ICBMMsgTypeAdded,
  2248. }),
  2249. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  2250. },
  2251. },
  2252. },
  2253. },
  2254. {
  2255. name: "ICQ user adds AIM buddy: expect ICQ user to preauthorize AIM user",
  2256. instance: newTestInstance("100777", sessOptUIN(100777)),
  2257. inputSNAC: wire.SNACMessage{
  2258. Frame: wire.SNACFrame{
  2259. FoodGroup: wire.Feedbag,
  2260. SubGroup: wire.FeedbagInsertItem,
  2261. RequestID: 1234,
  2262. },
  2263. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  2264. Items: []wire.FeedbagItem{
  2265. {
  2266. ClassID: wire.FeedbagClassIdBuddy,
  2267. Name: "buddyaim",
  2268. },
  2269. },
  2270. },
  2271. },
  2272. mockParams: mockParams{
  2273. contactPreAuthorizerParams: contactPreAuthorizerParams{
  2274. recordPreAuthParams: recordPreAuthParams{
  2275. {
  2276. owner: state.NewIdentScreenName("100777"),
  2277. buddy: state.NewIdentScreenName("buddyaim"),
  2278. },
  2279. },
  2280. },
  2281. feedbagManagerParams: feedbagManagerParams{
  2282. feedbagUpsertParams: feedbagUpsertParams{
  2283. {
  2284. screenName: state.NewIdentScreenName("100777"),
  2285. items: []wire.FeedbagItem{
  2286. {
  2287. ClassID: wire.FeedbagClassIdBuddy,
  2288. Name: "buddyaim",
  2289. },
  2290. },
  2291. },
  2292. },
  2293. },
  2294. messageRelayerParams: messageRelayerParams{
  2295. relayToOtherInstancesParams: relayToOtherInstancesParams{
  2296. {
  2297. screenName: state.NewIdentScreenName("100777"),
  2298. message: wire.SNACMessage{
  2299. Frame: wire.SNACFrame{
  2300. FoodGroup: wire.Feedbag,
  2301. SubGroup: wire.FeedbagInsertItem,
  2302. RequestID: wire.ReqIDFromServer,
  2303. },
  2304. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  2305. Items: []wire.FeedbagItem{
  2306. {
  2307. ClassID: wire.FeedbagClassIdBuddy,
  2308. Name: "buddyaim",
  2309. },
  2310. },
  2311. },
  2312. },
  2313. },
  2314. },
  2315. relayToSelfParams: relayToSelfParams{
  2316. {
  2317. screenName: state.NewIdentScreenName("100777"),
  2318. message: wire.SNACMessage{
  2319. Frame: wire.SNACFrame{
  2320. FoodGroup: wire.Feedbag,
  2321. SubGroup: wire.FeedbagStatus,
  2322. RequestID: 1234,
  2323. },
  2324. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  2325. Results: []uint16{0x0000},
  2326. },
  2327. },
  2328. },
  2329. },
  2330. },
  2331. buddyBroadcasterParams: buddyBroadcasterParams{
  2332. broadcastVisibilityParams: broadcastVisibilityParams{
  2333. {
  2334. from: state.NewIdentScreenName("100777"),
  2335. filter: []state.IdentScreenName{
  2336. state.NewIdentScreenName("buddyaim"),
  2337. },
  2338. },
  2339. },
  2340. },
  2341. },
  2342. expectOutput: nil,
  2343. },
  2344. {
  2345. name: "AIM user adds ICQ buddy pending auth: expect AIM user to send auth request to ICQ user",
  2346. instance: newTestInstance("myaim"),
  2347. inputSNAC: wire.SNACMessage{
  2348. Frame: wire.SNACFrame{
  2349. FoodGroup: wire.Feedbag,
  2350. SubGroup: wire.FeedbagInsertItem,
  2351. RequestID: 1234,
  2352. },
  2353. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  2354. Items: []wire.FeedbagItem{
  2355. {
  2356. ClassID: wire.FeedbagClassIdBuddy,
  2357. Name: "990011",
  2358. },
  2359. },
  2360. },
  2361. },
  2362. mockParams: mockParams{
  2363. contactPreAuthorizerParams: contactPreAuthorizerParams{
  2364. requiresAuthorizationParams: requiresAuthorizationParams{
  2365. {
  2366. owner: state.NewIdentScreenName("990011"),
  2367. requester: state.NewIdentScreenName("myaim"),
  2368. result: true,
  2369. },
  2370. },
  2371. },
  2372. feedbagManagerParams: feedbagManagerParams{
  2373. feedbagUpsertParams: feedbagUpsertParams{
  2374. {
  2375. screenName: state.NewIdentScreenName("myaim"),
  2376. items: []wire.FeedbagItem{
  2377. {
  2378. ClassID: wire.FeedbagClassIdBuddy,
  2379. Name: "990011",
  2380. TLVLBlock: wire.TLVLBlock{
  2381. TLVList: wire.TLVList{
  2382. wire.NewTLVBE(wire.FeedbagAttributesPending, []byte{}),
  2383. },
  2384. },
  2385. },
  2386. },
  2387. },
  2388. },
  2389. },
  2390. messageRelayerParams: messageRelayerParams{
  2391. relayToOtherInstancesParams: relayToOtherInstancesParams{
  2392. {
  2393. screenName: state.NewIdentScreenName("myaim"),
  2394. message: wire.SNACMessage{
  2395. Frame: wire.SNACFrame{
  2396. FoodGroup: wire.Feedbag,
  2397. SubGroup: wire.FeedbagInsertItem,
  2398. RequestID: wire.ReqIDFromServer,
  2399. },
  2400. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  2401. Items: []wire.FeedbagItem{
  2402. {
  2403. ClassID: wire.FeedbagClassIdBuddy,
  2404. Name: "990011",
  2405. TLVLBlock: wire.TLVLBlock{
  2406. TLVList: wire.TLVList{
  2407. wire.NewTLVBE(wire.FeedbagAttributesPending, []byte{}),
  2408. },
  2409. },
  2410. },
  2411. },
  2412. },
  2413. },
  2414. },
  2415. },
  2416. relayToSelfParams: relayToSelfParams{
  2417. {
  2418. screenName: state.NewIdentScreenName("myaim"),
  2419. message: wire.SNACMessage{
  2420. Frame: wire.SNACFrame{
  2421. FoodGroup: wire.Feedbag,
  2422. SubGroup: wire.FeedbagStatus,
  2423. RequestID: 1234,
  2424. },
  2425. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  2426. Results: []uint16{0x0000},
  2427. },
  2428. },
  2429. },
  2430. },
  2431. },
  2432. buddyBroadcasterParams: buddyBroadcasterParams{
  2433. broadcastVisibilityParams: broadcastVisibilityParams{
  2434. {
  2435. from: state.NewIdentScreenName("myaim"),
  2436. filter: []state.IdentScreenName{
  2437. state.NewIdentScreenName("990011"),
  2438. },
  2439. },
  2440. },
  2441. },
  2442. },
  2443. expectOutput: nil,
  2444. expectICBM: true,
  2445. wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  2446. ChannelID: wire.ICBMChannelICQ,
  2447. ScreenName: "990011",
  2448. TLVRestBlock: wire.TLVRestBlock{
  2449. TLVList: wire.TLVList{
  2450. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  2451. UIN: 0,
  2452. MessageType: wire.ICBMMsgTypeAuthReq,
  2453. Message: "\xFE\xFE\xFE\xFE1\xFE",
  2454. }),
  2455. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  2456. },
  2457. },
  2458. },
  2459. },
  2460. {
  2461. // ICQ Lite re-sends a FeedbagUpsert with FeedbagAttributesPending still
  2462. // set after the user clicks OK on the "you were added" notification that
  2463. // arrives when the contact grants authorization. IServerd handles this by
  2464. // stripping SSI_TLV_AUTH from the item before the DB insert (ssi_db.cpp
  2465. // ssi_db_add_item lines 304-308). We do the same: when the client sends
  2466. // a pending-tagged item but RequiresAuthorization returns false (auth was
  2467. // already granted), strip the tag and treat the item as a normal add.
  2468. name: "ICQ user re-upserts ICQ buddy with pending tag after authorization already granted: strip pending tag",
  2469. instance: newTestInstance("100001", sessOptUIN(100001)),
  2470. inputSNAC: wire.SNACMessage{
  2471. Frame: wire.SNACFrame{
  2472. FoodGroup: wire.Feedbag,
  2473. SubGroup: wire.FeedbagInsertItem,
  2474. RequestID: 1234,
  2475. },
  2476. Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
  2477. Items: []wire.FeedbagItem{
  2478. {
  2479. ClassID: wire.FeedbagClassIdBuddy,
  2480. Name: "990011",
  2481. TLVLBlock: wire.TLVLBlock{
  2482. TLVList: wire.TLVList{
  2483. wire.NewTLVBE(wire.FeedbagAttributesPending, []byte{}),
  2484. },
  2485. },
  2486. },
  2487. },
  2488. },
  2489. },
  2490. mockParams: mockParams{
  2491. contactPreAuthorizerParams: contactPreAuthorizerParams{
  2492. requiresAuthorizationParams: requiresAuthorizationParams{
  2493. {
  2494. owner: state.NewIdentScreenName("990011"),
  2495. requester: state.NewIdentScreenName("100001"),
  2496. result: false, // already authorized
  2497. },
  2498. },
  2499. },
  2500. feedbagManagerParams: feedbagManagerParams{
  2501. feedbagUpsertParams: feedbagUpsertParams{
  2502. {
  2503. screenName: state.NewIdentScreenName("100001"),
  2504. // pending TLV must be stripped before storage
  2505. items: []wire.FeedbagItem{
  2506. {
  2507. ClassID: wire.FeedbagClassIdBuddy,
  2508. Name: "990011",
  2509. TLVLBlock: wire.TLVLBlock{
  2510. TLVList: wire.TLVList{},
  2511. },
  2512. },
  2513. },
  2514. },
  2515. },
  2516. },
  2517. sessionRetrieverParams: sessionRetrieverParams{
  2518. retrieveSessionParams: retrieveSessionParams{
  2519. {
  2520. screenName: state.NewIdentScreenName("990011"),
  2521. result: nil,
  2522. },
  2523. },
  2524. },
  2525. buddyAddedNotifierDeduperParams: buddyAddedNotifierDeduperParams{
  2526. hasBuddyAddedNotificationParams: hasBuddyAddedNotificationParams{
  2527. {granter: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("990011"), result: false},
  2528. },
  2529. recordBuddyAddedNotificationParams: recordBuddyAddedNotificationParams{
  2530. {granter: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("990011")},
  2531. },
  2532. },
  2533. messageRelayerParams: messageRelayerParams{
  2534. relayToOtherInstancesParams: relayToOtherInstancesParams{
  2535. {
  2536. screenName: state.NewIdentScreenName("100001"),
  2537. message: wire.SNACMessage{
  2538. Frame: wire.SNACFrame{
  2539. FoodGroup: wire.Feedbag,
  2540. SubGroup: wire.FeedbagInsertItem,
  2541. RequestID: wire.ReqIDFromServer,
  2542. },
  2543. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  2544. Items: []wire.FeedbagItem{
  2545. {
  2546. ClassID: wire.FeedbagClassIdBuddy,
  2547. Name: "990011",
  2548. TLVLBlock: wire.TLVLBlock{
  2549. TLVList: wire.TLVList{},
  2550. },
  2551. },
  2552. },
  2553. },
  2554. },
  2555. },
  2556. },
  2557. relayToSelfParams: relayToSelfParams{
  2558. {
  2559. screenName: state.NewIdentScreenName("100001"),
  2560. message: wire.SNACMessage{
  2561. Frame: wire.SNACFrame{
  2562. FoodGroup: wire.Feedbag,
  2563. SubGroup: wire.FeedbagStatus,
  2564. RequestID: 1234,
  2565. },
  2566. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  2567. Results: []uint16{0x0000},
  2568. },
  2569. },
  2570. },
  2571. },
  2572. },
  2573. buddyBroadcasterParams: buddyBroadcasterParams{
  2574. broadcastVisibilityParams: broadcastVisibilityParams{
  2575. {
  2576. from: state.NewIdentScreenName("100001"),
  2577. filter: []state.IdentScreenName{
  2578. state.NewIdentScreenName("990011"),
  2579. },
  2580. },
  2581. },
  2582. },
  2583. },
  2584. expectOutput: nil,
  2585. expectICBM: true,
  2586. wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  2587. ChannelID: wire.ICBMChannelICQ,
  2588. ScreenName: "990011",
  2589. TLVRestBlock: wire.TLVRestBlock{
  2590. TLVList: wire.TLVList{
  2591. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  2592. UIN: 100001,
  2593. MessageType: wire.ICBMMsgTypeAdded,
  2594. }),
  2595. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  2596. },
  2597. },
  2598. },
  2599. },
  2600. }
  2601. for _, tc := range cases {
  2602. t.Run(tc.name, func(t *testing.T) {
  2603. feedbagManager := newMockFeedbagManager(t)
  2604. for _, params := range tc.mockParams.feedbagUpsertParams {
  2605. feedbagManager.EXPECT().
  2606. FeedbagUpsert(matchContext(), params.screenName, params.items).
  2607. Return(nil)
  2608. }
  2609. messageRelayer := newMockMessageRelayer(t)
  2610. for _, params := range tc.mockParams.relayToScreenNameParams {
  2611. if matcherFn, ok := params.message.Body.(func(val any) bool); ok {
  2612. messageRelayer.EXPECT().
  2613. RelayToScreenName(matchContext(), params.screenName, mock.MatchedBy(func(message wire.SNACMessage) bool {
  2614. return params.message.Frame == message.Frame &&
  2615. matcherFn(message.Body)
  2616. }))
  2617. } else {
  2618. messageRelayer.EXPECT().
  2619. RelayToScreenName(matchContext(), params.screenName, params.message)
  2620. }
  2621. }
  2622. for _, params := range tc.mockParams.relayToOtherInstancesParams {
  2623. messageRelayer.EXPECT().
  2624. RelayToOtherInstances(mock.Anything, mock.Anything, params.message)
  2625. }
  2626. for _, params := range tc.mockParams.relayToSelfParams {
  2627. messageRelayer.EXPECT().
  2628. RelayToSelf(mock.Anything, mock.Anything, params.message)
  2629. }
  2630. bartItemManager := newMockBARTItemManager(t)
  2631. for _, params := range tc.mockParams.bartItemManagerRetrieveParams {
  2632. bartItemManager.EXPECT().
  2633. BARTItem(matchContext(), params.itemHash).
  2634. Return(params.result, nil)
  2635. }
  2636. buddyUpdateBroadcaster := newMockbuddyBroadcaster(t)
  2637. for _, params := range tc.mockParams.broadcastBuddyArrivedParams {
  2638. buddyUpdateBroadcaster.EXPECT().
  2639. BroadcastBuddyArrived(mock.Anything, state.NewIdentScreenName(params.screenName.String()), mock.MatchedBy(func(userInfo wire.TLVUserInfo) bool {
  2640. return userInfo.ScreenName == params.screenName.String()
  2641. })).
  2642. Return(params.err)
  2643. }
  2644. for _, params := range tc.mockParams.broadcastVisibilityParams {
  2645. buddyUpdateBroadcaster.EXPECT().
  2646. BroadcastVisibility(mock.Anything, matchSession(params.from), params.filter, true).
  2647. Return(params.err)
  2648. }
  2649. contactPreAuth := newMockContactPreAuthorizer(t)
  2650. for _, params := range tc.mockParams.recordPreAuthParams {
  2651. contactPreAuth.EXPECT().RecordPreAuth(matchContext(), params.owner, params.buddy).Return(params.err)
  2652. }
  2653. for _, params := range tc.mockParams.requiresAuthorizationParams {
  2654. contactPreAuth.EXPECT().RequiresAuthorization(matchContext(), params.owner, params.requester).Return(params.result, params.err)
  2655. }
  2656. buddyAddedDeduper := newMockBuddyAddedNotifierDeduper(t)
  2657. for _, params := range tc.mockParams.hasBuddyAddedNotificationParams {
  2658. buddyAddedDeduper.EXPECT().
  2659. HasBuddyAddedNotification(matchContext(), params.granter, params.requester).
  2660. Return(params.result, params.err)
  2661. }
  2662. for _, params := range tc.mockParams.recordBuddyAddedNotificationParams {
  2663. buddyAddedDeduper.EXPECT().
  2664. RecordBuddyAddedNotification(matchContext(), params.granter, params.requester).
  2665. Return(params.err)
  2666. }
  2667. sessionRetriever := newMockSessionRetriever(t)
  2668. for _, params := range tc.mockParams.retrieveSessionParams {
  2669. sessionRetriever.EXPECT().
  2670. RetrieveSession(params.screenName).
  2671. Return(params.result)
  2672. }
  2673. icbmSender := func(ctx context.Context, instance *state.SessionInstance, inFrame wire.SNACFrame, inBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost) (*wire.SNACMessage, error) {
  2674. if !tc.expectICBM {
  2675. t.Fatalf("unexpected icbmSender call")
  2676. }
  2677. wantBody := tc.wantICBMBody
  2678. wantBody.Cookie = 0
  2679. haveBody := inBody
  2680. haveBody.Cookie = 0
  2681. assert.Equal(t, wantBody, haveBody)
  2682. return nil, nil
  2683. }
  2684. svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, bartItemManager, nil, sessionRetriever, contactPreAuth, nil, buddyAddedDeduper)
  2685. svc.buddyBroadcaster = buddyUpdateBroadcaster
  2686. svc.icbmSender = icbmSender
  2687. output, err := svc.UpsertItem(context.Background(), tc.instance, tc.inputSNAC.Frame,
  2688. tc.inputSNAC.Body.(wire.SNAC_0x13_0x08_FeedbagInsertItem).Items)
  2689. assert.NoError(t, err)
  2690. assert.Equal(t, tc.expectOutput, output)
  2691. if tc.instanceMatch != nil {
  2692. tc.instanceMatch(tc.instance)
  2693. }
  2694. })
  2695. }
  2696. }
  2697. func TestFeedbagService_DeleteItem(t *testing.T) {
  2698. cases := []struct {
  2699. // name is the unit test name
  2700. name string
  2701. // instance is the session of the user adding to feedbag
  2702. instance *state.SessionInstance
  2703. // inputSNAC is the SNAC sent from the client to the server
  2704. inputSNAC wire.SNACMessage
  2705. // mockParams is the list of params sent to mocks that satisfy this
  2706. // method's dependencies
  2707. mockParams mockParams
  2708. // expectOutput is the SNAC sent from the server to client
  2709. expectOutput *wire.SNACMessage
  2710. // checkInstance validates instance state after the call
  2711. checkInstance func(*testing.T, *state.SessionInstance)
  2712. }{
  2713. {
  2714. name: "delete buddies",
  2715. instance: newTestInstance("me"),
  2716. inputSNAC: wire.SNACMessage{
  2717. Frame: wire.SNACFrame{
  2718. FoodGroup: wire.Feedbag,
  2719. SubGroup: wire.FeedbagDeleteItem,
  2720. RequestID: 1234,
  2721. },
  2722. Body: wire.SNAC_0x13_0x0A_FeedbagDeleteItem{
  2723. Items: []wire.FeedbagItem{
  2724. {
  2725. ClassID: wire.FeedbagClassIdBuddy,
  2726. Name: "buddy1",
  2727. },
  2728. {
  2729. ClassID: wire.FeedbagClassIdBuddy,
  2730. Name: "buddy2",
  2731. },
  2732. {
  2733. ClassID: wire.FeedbagClassIdGroup,
  2734. Name: "group",
  2735. },
  2736. },
  2737. },
  2738. },
  2739. mockParams: mockParams{
  2740. feedbagManagerParams: feedbagManagerParams{
  2741. feedbagDeleteParams: feedbagDeleteParams{
  2742. {
  2743. screenName: state.NewIdentScreenName("me"),
  2744. items: []wire.FeedbagItem{
  2745. {
  2746. ClassID: wire.FeedbagClassIdBuddy,
  2747. Name: "buddy1",
  2748. },
  2749. {
  2750. ClassID: wire.FeedbagClassIdBuddy,
  2751. Name: "buddy2",
  2752. },
  2753. {
  2754. ClassID: wire.FeedbagClassIdGroup,
  2755. Name: "group",
  2756. },
  2757. },
  2758. },
  2759. },
  2760. },
  2761. buddyBroadcasterParams: buddyBroadcasterParams{
  2762. broadcastVisibilityParams: broadcastVisibilityParams{
  2763. {
  2764. from: state.NewIdentScreenName("me"),
  2765. filter: []state.IdentScreenName{
  2766. state.NewIdentScreenName("buddy1"),
  2767. state.NewIdentScreenName("buddy2"),
  2768. },
  2769. },
  2770. },
  2771. },
  2772. messageRelayerParams: messageRelayerParams{
  2773. relayToOtherInstancesParams: relayToOtherInstancesParams{
  2774. {
  2775. screenName: state.NewIdentScreenName("me"),
  2776. message: wire.SNACMessage{
  2777. Frame: wire.SNACFrame{
  2778. FoodGroup: wire.Feedbag,
  2779. SubGroup: wire.FeedbagDeleteItem,
  2780. RequestID: wire.ReqIDFromServer,
  2781. },
  2782. Body: wire.SNAC_0x13_0x0A_FeedbagDeleteItem{
  2783. Items: []wire.FeedbagItem{
  2784. {
  2785. ClassID: wire.FeedbagClassIdBuddy,
  2786. Name: "buddy1",
  2787. },
  2788. {
  2789. ClassID: wire.FeedbagClassIdBuddy,
  2790. Name: "buddy2",
  2791. },
  2792. {
  2793. ClassID: wire.FeedbagClassIdGroup,
  2794. Name: "group",
  2795. },
  2796. },
  2797. },
  2798. },
  2799. },
  2800. },
  2801. relayToSelfParams: relayToSelfParams{
  2802. {
  2803. screenName: state.NewIdentScreenName("me"),
  2804. message: wire.SNACMessage{
  2805. Frame: wire.SNACFrame{
  2806. FoodGroup: wire.Feedbag,
  2807. SubGroup: wire.FeedbagStatus,
  2808. RequestID: 1234,
  2809. },
  2810. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  2811. Results: []uint16{0x0000, 0x0000, 0x0000},
  2812. },
  2813. },
  2814. },
  2815. },
  2816. },
  2817. },
  2818. expectOutput: nil,
  2819. },
  2820. {
  2821. name: "defer visibility during notify txn",
  2822. instance: func() *state.SessionInstance {
  2823. inst := newTestInstance("me")
  2824. inst.BeginNotifyTxn()
  2825. return inst
  2826. }(),
  2827. inputSNAC: wire.SNACMessage{
  2828. Frame: wire.SNACFrame{
  2829. FoodGroup: wire.Feedbag,
  2830. SubGroup: wire.FeedbagDeleteItem,
  2831. RequestID: 1234,
  2832. },
  2833. Body: wire.SNAC_0x13_0x0A_FeedbagDeleteItem{
  2834. Items: []wire.FeedbagItem{
  2835. {ClassID: wire.FeedbagClassIdBuddy, Name: "buddy1"},
  2836. },
  2837. },
  2838. },
  2839. mockParams: mockParams{
  2840. feedbagManagerParams: feedbagManagerParams{
  2841. feedbagDeleteParams: feedbagDeleteParams{
  2842. {
  2843. screenName: state.NewIdentScreenName("me"),
  2844. items: []wire.FeedbagItem{
  2845. {ClassID: wire.FeedbagClassIdBuddy, Name: "buddy1"},
  2846. },
  2847. },
  2848. },
  2849. },
  2850. messageRelayerParams: messageRelayerParams{
  2851. relayToOtherInstancesParams: relayToOtherInstancesParams{
  2852. {
  2853. screenName: state.NewIdentScreenName("me"),
  2854. message: wire.SNACMessage{
  2855. Frame: wire.SNACFrame{
  2856. FoodGroup: wire.Feedbag,
  2857. SubGroup: wire.FeedbagDeleteItem,
  2858. RequestID: wire.ReqIDFromServer,
  2859. },
  2860. Body: wire.SNAC_0x13_0x0A_FeedbagDeleteItem{
  2861. Items: []wire.FeedbagItem{
  2862. {ClassID: wire.FeedbagClassIdBuddy, Name: "buddy1"},
  2863. },
  2864. },
  2865. },
  2866. },
  2867. },
  2868. relayToSelfParams: relayToSelfParams{
  2869. {
  2870. screenName: state.NewIdentScreenName("me"),
  2871. message: wire.SNACMessage{
  2872. Frame: wire.SNACFrame{
  2873. FoodGroup: wire.Feedbag,
  2874. SubGroup: wire.FeedbagStatus,
  2875. RequestID: 1234,
  2876. },
  2877. Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
  2878. Results: []uint16{0x0000},
  2879. },
  2880. },
  2881. },
  2882. },
  2883. },
  2884. },
  2885. expectOutput: nil,
  2886. checkInstance: func(t *testing.T, instance *state.SessionInstance) {
  2887. assert.True(t, instance.InNotifyTxn())
  2888. },
  2889. },
  2890. }
  2891. for _, tc := range cases {
  2892. t.Run(tc.name, func(t *testing.T) {
  2893. feedbagManager := newMockFeedbagManager(t)
  2894. for _, params := range tc.mockParams.feedbagDeleteParams {
  2895. feedbagManager.EXPECT().
  2896. FeedbagDelete(matchContext(), params.screenName, params.items).
  2897. Return(nil)
  2898. }
  2899. buddyUpdateBroadcast := newMockbuddyBroadcaster(t)
  2900. for _, params := range tc.mockParams.broadcastVisibilityParams {
  2901. buddyUpdateBroadcast.EXPECT().
  2902. BroadcastVisibility(mock.Anything, matchSession(params.from), params.filter, true).
  2903. Return(params.err)
  2904. }
  2905. messageRelayer := newMockMessageRelayer(t)
  2906. for _, params := range tc.mockParams.relayToOtherInstancesParams {
  2907. messageRelayer.EXPECT().
  2908. RelayToOtherInstances(mock.Anything, mock.Anything, params.message)
  2909. }
  2910. for _, params := range tc.mockParams.relayToSelfParams {
  2911. messageRelayer.EXPECT().
  2912. RelayToSelf(mock.Anything, mock.Anything, params.message)
  2913. }
  2914. svc := FeedbagService{
  2915. buddyBroadcaster: buddyUpdateBroadcast,
  2916. feedbagManager: feedbagManager,
  2917. messageRelayer: messageRelayer,
  2918. }
  2919. output, err := svc.DeleteItem(context.Background(), tc.instance, tc.inputSNAC.Frame,
  2920. tc.inputSNAC.Body.(wire.SNAC_0x13_0x0A_FeedbagDeleteItem))
  2921. assert.NoError(t, err)
  2922. assert.Equal(t, output, tc.expectOutput)
  2923. if tc.checkInstance != nil {
  2924. tc.checkInstance(t, tc.instance)
  2925. }
  2926. })
  2927. }
  2928. }
  2929. func TestFeedbagService_Use(t *testing.T) {
  2930. tests := []struct {
  2931. // name is the name of the test
  2932. name string
  2933. // instance is the user's session
  2934. instance *state.SessionInstance
  2935. // mockParams is the list of params sent to mocks that satisfy this
  2936. // method's dependencies
  2937. mockParams mockParams
  2938. // checkSession validates session and instance state after the call
  2939. checkSession func(*testing.T, *state.SessionInstance)
  2940. // wantErr indicates an error is expected
  2941. wantErr error
  2942. }{
  2943. {
  2944. name: "enable user's feedbag, no feedbag buddy params item",
  2945. instance: newTestInstance("me"),
  2946. mockParams: mockParams{
  2947. feedbagManagerParams: feedbagManagerParams{
  2948. useParams: useParams{
  2949. {
  2950. screenName: state.NewIdentScreenName("me"),
  2951. },
  2952. },
  2953. feedbagParams: feedbagParams{
  2954. {
  2955. screenName: state.NewIdentScreenName("me"),
  2956. },
  2957. },
  2958. },
  2959. },
  2960. checkSession: func(t *testing.T, instance *state.SessionInstance) {
  2961. assert.True(t, instance.ContactsInit())
  2962. assert.True(t, instance.Session().UsesFeedbag())
  2963. assert.False(t, instance.Session().TypingEventsEnabled())
  2964. },
  2965. },
  2966. {
  2967. name: "enable user's feedbag and set typing events disabled",
  2968. instance: newTestInstance("me"),
  2969. mockParams: mockParams{
  2970. feedbagManagerParams: feedbagManagerParams{
  2971. useParams: useParams{
  2972. {
  2973. screenName: state.NewIdentScreenName("me"),
  2974. },
  2975. },
  2976. feedbagParams: feedbagParams{
  2977. {
  2978. screenName: state.NewIdentScreenName("me"),
  2979. results: []wire.FeedbagItem{
  2980. {
  2981. ClassID: wire.FeedbagClassIdBuddyPrefs,
  2982. TLVLBlock: wire.TLVLBlock{
  2983. TLVList: wire.SetBuddyPref(nil, wire.FeedbagBuddyPrefsDiscloseTyping, false),
  2984. },
  2985. },
  2986. },
  2987. },
  2988. },
  2989. },
  2990. },
  2991. checkSession: func(t *testing.T, instance *state.SessionInstance) {
  2992. assert.True(t, instance.ContactsInit())
  2993. assert.True(t, instance.Session().UsesFeedbag())
  2994. assert.False(t, instance.Session().TypingEventsEnabled())
  2995. },
  2996. },
  2997. {
  2998. name: "enable user's feedbag and set typing events enabled",
  2999. instance: newTestInstance("me"),
  3000. mockParams: mockParams{
  3001. feedbagManagerParams: feedbagManagerParams{
  3002. useParams: useParams{
  3003. {
  3004. screenName: state.NewIdentScreenName("me"),
  3005. },
  3006. },
  3007. feedbagParams: feedbagParams{
  3008. {
  3009. screenName: state.NewIdentScreenName("me"),
  3010. results: []wire.FeedbagItem{
  3011. {
  3012. ClassID: wire.FeedbagClassIdBuddyPrefs,
  3013. TLVLBlock: wire.TLVLBlock{
  3014. TLVList: wire.SetBuddyPref(nil, wire.FeedbagBuddyPrefsDiscloseTyping, true),
  3015. },
  3016. },
  3017. },
  3018. },
  3019. },
  3020. },
  3021. },
  3022. checkSession: func(t *testing.T, instance *state.SessionInstance) {
  3023. assert.True(t, instance.ContactsInit())
  3024. assert.True(t, instance.Session().UsesFeedbag())
  3025. assert.True(t, instance.Session().TypingEventsEnabled())
  3026. },
  3027. },
  3028. {
  3029. name: "ICQ Lite order: feedbag use after ClientOnline broadcasts presence",
  3030. instance: newTestInstance("me", sessOptSignonComplete),
  3031. mockParams: mockParams{
  3032. feedbagManagerParams: feedbagManagerParams{
  3033. useParams: useParams{
  3034. {
  3035. screenName: state.NewIdentScreenName("me"),
  3036. },
  3037. },
  3038. feedbagParams: feedbagParams{
  3039. {
  3040. screenName: state.NewIdentScreenName("me"),
  3041. },
  3042. },
  3043. },
  3044. buddyBroadcasterParams: buddyBroadcasterParams{
  3045. broadcastVisibilityParams: broadcastVisibilityParams{
  3046. {
  3047. from: state.NewIdentScreenName("me"),
  3048. filter: nil,
  3049. doSendDepartures: false,
  3050. },
  3051. },
  3052. },
  3053. },
  3054. checkSession: func(t *testing.T, instance *state.SessionInstance) {
  3055. assert.True(t, instance.ContactsInit())
  3056. assert.True(t, instance.Session().UsesFeedbag())
  3057. },
  3058. },
  3059. {
  3060. name: "ICQ Lite order: feedbag use after ClientOnline, BroadcastVisibility fails",
  3061. instance: newTestInstance("me", sessOptSignonComplete),
  3062. mockParams: mockParams{
  3063. feedbagManagerParams: feedbagManagerParams{
  3064. useParams: useParams{
  3065. {
  3066. screenName: state.NewIdentScreenName("me"),
  3067. },
  3068. },
  3069. feedbagParams: feedbagParams{
  3070. {
  3071. screenName: state.NewIdentScreenName("me"),
  3072. },
  3073. },
  3074. },
  3075. buddyBroadcasterParams: buddyBroadcasterParams{
  3076. broadcastVisibilityParams: broadcastVisibilityParams{
  3077. {
  3078. from: state.NewIdentScreenName("me"),
  3079. filter: nil,
  3080. doSendDepartures: false,
  3081. err: assert.AnError,
  3082. },
  3083. },
  3084. },
  3085. },
  3086. wantErr: assert.AnError,
  3087. checkSession: func(t *testing.T, instance *state.SessionInstance) {
  3088. assert.True(t, instance.ContactsInit())
  3089. assert.True(t, instance.Session().UsesFeedbag())
  3090. },
  3091. },
  3092. }
  3093. for _, tt := range tests {
  3094. t.Run(tt.name, func(t *testing.T) {
  3095. feedbagManager := newMockFeedbagManager(t)
  3096. for _, params := range tt.mockParams.useParams {
  3097. feedbagManager.EXPECT().
  3098. UseFeedbag(matchContext(), params.screenName).
  3099. Return(nil)
  3100. }
  3101. for _, params := range tt.mockParams.feedbagParams {
  3102. feedbagManager.EXPECT().
  3103. Feedbag(matchContext(), params.screenName).
  3104. Return(params.results, nil)
  3105. }
  3106. buddyUpdateBroadcaster := newMockbuddyBroadcaster(t)
  3107. for _, params := range tt.mockParams.broadcastVisibilityParams {
  3108. buddyUpdateBroadcaster.EXPECT().
  3109. BroadcastVisibility(matchContext(), matchSession(params.from), params.filter, params.doSendDepartures).
  3110. Return(params.err)
  3111. }
  3112. svc := NewFeedbagService(slog.Default(), nil, feedbagManager, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
  3113. svc.buddyBroadcaster = buddyUpdateBroadcaster
  3114. haveErr := svc.Use(context.Background(), tt.instance)
  3115. assert.ErrorIs(t, haveErr, tt.wantErr)
  3116. if tt.checkSession != nil {
  3117. tt.checkSession(t, tt.instance)
  3118. }
  3119. })
  3120. }
  3121. }
  3122. func TestFeedbagService_RequestAuthorizeToHost(t *testing.T) {
  3123. authReqSender := state.User{
  3124. ICQInfo: state.ICQInfo{
  3125. Basic: state.ICQBasicInfo{
  3126. Nickname: "CoolNickname",
  3127. FirstName: "Alice",
  3128. LastName: "Smith",
  3129. EmailAddress: "alice@example.com",
  3130. },
  3131. },
  3132. }
  3133. tests := []struct {
  3134. // name is the unit test name
  3135. name string
  3136. // instance is the client session
  3137. instance *state.SessionInstance
  3138. // inSNAC is the SNAC message sent by the client
  3139. inSNAC wire.SNACMessage
  3140. // buddySess is the online session for the recipient, or nil if offline
  3141. buddySess *state.Session
  3142. // mockParams is the list of params sent to mocks that satisfy this
  3143. // method's dependencies
  3144. mockParams mockParams
  3145. // wantErr is the expected error
  3146. wantErr error
  3147. // expectOutput is the expected SNAC passed to icbmSender
  3148. expectOutput wire.SNACMessage
  3149. // expectICBM is true when RequestAuthorizeToHost should route via icbmSender
  3150. expectICBM bool
  3151. }{
  3152. {
  3153. name: "recipient is online with feedbag, relay authorization request",
  3154. instance: newTestInstance("100001", sessOptUIN(100001)),
  3155. inSNAC: wire.SNACMessage{
  3156. Frame: wire.SNACFrame{
  3157. FoodGroup: wire.Feedbag,
  3158. SubGroup: wire.FeedbagRequestAuthorizeToHost,
  3159. RequestID: 1234,
  3160. },
  3161. Body: wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost{
  3162. ScreenName: "100002",
  3163. Reason: "please add me.",
  3164. },
  3165. },
  3166. buddySess: func() *state.Session {
  3167. s := state.NewSession()
  3168. s.SetIdentScreenName(state.NewIdentScreenName("100002"))
  3169. s.SetUsesFeedbag()
  3170. return s
  3171. }(),
  3172. mockParams: mockParams{
  3173. sessionRetrieverParams: sessionRetrieverParams{
  3174. retrieveSessionParams: retrieveSessionParams{
  3175. {screenName: state.NewIdentScreenName("100002")},
  3176. },
  3177. },
  3178. messageRelayerParams: messageRelayerParams{
  3179. relayToScreenNameParams: relayToScreenNameParams{
  3180. {
  3181. screenName: state.NewIdentScreenName("100002"),
  3182. message: wire.SNACMessage{
  3183. Frame: wire.SNACFrame{
  3184. FoodGroup: wire.Feedbag,
  3185. SubGroup: wire.FeedbagRequestAuthorizeToClient,
  3186. Flags: wire.SNACFlagsExtendedInfo,
  3187. },
  3188. Body: wire.SNAC_0x13_0x19_FeedbagRequestAuthorizeToClient{
  3189. TLVLBlock: wire.TLVLBlock{
  3190. TLVList: wire.TLVList{
  3191. wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
  3192. },
  3193. },
  3194. ScreenName: "100001",
  3195. Reason: "please add me.",
  3196. },
  3197. },
  3198. },
  3199. },
  3200. },
  3201. },
  3202. expectICBM: false,
  3203. },
  3204. {
  3205. name: "ICQ 5 authorization failure workaround: remove periods following first from reason",
  3206. instance: newTestInstance("100001", sessOptUIN(100001)),
  3207. inSNAC: wire.SNACMessage{
  3208. Frame: wire.SNACFrame{
  3209. FoodGroup: wire.Feedbag,
  3210. SubGroup: wire.FeedbagRequestAuthorizeToHost,
  3211. RequestID: 1234,
  3212. },
  3213. Body: wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost{
  3214. ScreenName: "100002",
  3215. Reason: "Please authorize my request and add me to your Contact List. yuki.tanaka ICQ#: 123405",
  3216. },
  3217. },
  3218. buddySess: func() *state.Session {
  3219. s := state.NewSession()
  3220. s.SetIdentScreenName(state.NewIdentScreenName("100002"))
  3221. s.SetUsesFeedbag()
  3222. return s
  3223. }(),
  3224. mockParams: mockParams{
  3225. sessionRetrieverParams: sessionRetrieverParams{
  3226. retrieveSessionParams: retrieveSessionParams{
  3227. {screenName: state.NewIdentScreenName("100002")},
  3228. },
  3229. },
  3230. messageRelayerParams: messageRelayerParams{
  3231. relayToScreenNameParams: relayToScreenNameParams{
  3232. {
  3233. screenName: state.NewIdentScreenName("100002"),
  3234. message: wire.SNACMessage{
  3235. Frame: wire.SNACFrame{
  3236. FoodGroup: wire.Feedbag,
  3237. SubGroup: wire.FeedbagRequestAuthorizeToClient,
  3238. Flags: wire.SNACFlagsExtendedInfo,
  3239. },
  3240. Body: wire.SNAC_0x13_0x19_FeedbagRequestAuthorizeToClient{
  3241. TLVLBlock: wire.TLVLBlock{
  3242. TLVList: wire.TLVList{
  3243. wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
  3244. },
  3245. },
  3246. ScreenName: "100001",
  3247. Reason: "Please authorize my request and add me to your Contact List. yukitanaka ICQ#: 123405",
  3248. },
  3249. },
  3250. },
  3251. },
  3252. },
  3253. },
  3254. expectICBM: false,
  3255. },
  3256. {
  3257. name: "recipient is offline, send authorization request via ICBM",
  3258. instance: newTestInstance("100001", sessOptUIN(100001)),
  3259. inSNAC: wire.SNACMessage{
  3260. Frame: wire.SNACFrame{
  3261. FoodGroup: wire.Feedbag,
  3262. SubGroup: wire.FeedbagRequestAuthorizeToHost,
  3263. RequestID: 1234,
  3264. },
  3265. Body: wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost{
  3266. ScreenName: "100002",
  3267. Reason: "please add me",
  3268. },
  3269. },
  3270. buddySess: nil,
  3271. mockParams: mockParams{
  3272. sessionRetrieverParams: sessionRetrieverParams{
  3273. retrieveSessionParams: retrieveSessionParams{
  3274. {screenName: state.NewIdentScreenName("100002")},
  3275. },
  3276. },
  3277. contactPreAuthorizerParams: contactPreAuthorizerParams{
  3278. requiresAuthorizationParams: requiresAuthorizationParams{
  3279. {owner: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("100002"), result: false},
  3280. },
  3281. },
  3282. userManagerParams: userManagerParams{
  3283. getUserParams: getUserParams{
  3284. {screenName: state.NewIdentScreenName("100001"), result: &authReqSender, err: nil},
  3285. },
  3286. },
  3287. },
  3288. expectOutput: wire.SNACMessage{
  3289. Frame: wire.SNACFrame{
  3290. FoodGroup: wire.ICBM,
  3291. SubGroup: wire.ICBMChannelMsgToHost,
  3292. },
  3293. Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  3294. ChannelID: wire.ICBMChannelICQ,
  3295. ScreenName: "100002",
  3296. TLVRestBlock: wire.TLVRestBlock{
  3297. TLVList: wire.TLVList{
  3298. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  3299. UIN: 100001,
  3300. MessageType: wire.ICBMMsgTypeAuthReq,
  3301. Message: fmt.Sprintf("%s\xFE%s\xFE%s\xFE%s\xFE%d\xFE%s",
  3302. authReqSender.ICQInfo.Basic.Nickname,
  3303. authReqSender.ICQInfo.Basic.FirstName,
  3304. authReqSender.ICQInfo.Basic.LastName,
  3305. authReqSender.ICQInfo.Basic.EmailAddress,
  3306. 1,
  3307. utf8ToLatin1("please add me"),
  3308. ),
  3309. }),
  3310. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  3311. },
  3312. },
  3313. },
  3314. },
  3315. expectICBM: true,
  3316. },
  3317. {
  3318. name: "recipient is online without feedbag, send authorization request via ICBM",
  3319. instance: newTestInstance("100001", sessOptUIN(100001)),
  3320. inSNAC: wire.SNACMessage{
  3321. Frame: wire.SNACFrame{
  3322. FoodGroup: wire.Feedbag,
  3323. SubGroup: wire.FeedbagRequestAuthorizeToHost,
  3324. RequestID: 1234,
  3325. },
  3326. Body: wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost{
  3327. ScreenName: "100002",
  3328. Reason: "please add me",
  3329. },
  3330. },
  3331. buddySess: func() *state.Session {
  3332. s := state.NewSession()
  3333. s.SetIdentScreenName(state.NewIdentScreenName("100002"))
  3334. return s
  3335. }(),
  3336. mockParams: mockParams{
  3337. sessionRetrieverParams: sessionRetrieverParams{
  3338. retrieveSessionParams: retrieveSessionParams{
  3339. {screenName: state.NewIdentScreenName("100002")},
  3340. },
  3341. },
  3342. contactPreAuthorizerParams: contactPreAuthorizerParams{
  3343. requiresAuthorizationParams: requiresAuthorizationParams{
  3344. {owner: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("100002"), result: false},
  3345. },
  3346. },
  3347. userManagerParams: userManagerParams{
  3348. getUserParams: getUserParams{
  3349. {screenName: state.NewIdentScreenName("100001"), result: &authReqSender, err: nil},
  3350. },
  3351. },
  3352. },
  3353. expectOutput: wire.SNACMessage{
  3354. Frame: wire.SNACFrame{
  3355. FoodGroup: wire.ICBM,
  3356. SubGroup: wire.ICBMChannelMsgToHost,
  3357. },
  3358. Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  3359. ChannelID: wire.ICBMChannelICQ,
  3360. ScreenName: "100002",
  3361. TLVRestBlock: wire.TLVRestBlock{
  3362. TLVList: wire.TLVList{
  3363. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  3364. UIN: 100001,
  3365. MessageType: wire.ICBMMsgTypeAuthReq,
  3366. Message: fmt.Sprintf("%s\xFE%s\xFE%s\xFE%s\xFE%d\xFE%s",
  3367. authReqSender.ICQInfo.Basic.Nickname,
  3368. authReqSender.ICQInfo.Basic.FirstName,
  3369. authReqSender.ICQInfo.Basic.LastName,
  3370. authReqSender.ICQInfo.Basic.EmailAddress,
  3371. 1,
  3372. utf8ToLatin1("please add me"),
  3373. ),
  3374. }),
  3375. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  3376. },
  3377. },
  3378. },
  3379. },
  3380. expectICBM: true,
  3381. },
  3382. {
  3383. name: "recipient is offline, sender requires pre-authorization, send request with authorized=0",
  3384. instance: newTestInstance("100001", sessOptUIN(100001)),
  3385. inSNAC: wire.SNACMessage{
  3386. Frame: wire.SNACFrame{
  3387. FoodGroup: wire.Feedbag,
  3388. SubGroup: wire.FeedbagRequestAuthorizeToHost,
  3389. RequestID: 1234,
  3390. },
  3391. Body: wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost{
  3392. ScreenName: "100002",
  3393. Reason: "please add me",
  3394. },
  3395. },
  3396. buddySess: nil,
  3397. mockParams: mockParams{
  3398. sessionRetrieverParams: sessionRetrieverParams{
  3399. retrieveSessionParams: retrieveSessionParams{
  3400. {screenName: state.NewIdentScreenName("100002")},
  3401. },
  3402. },
  3403. contactPreAuthorizerParams: contactPreAuthorizerParams{
  3404. requiresAuthorizationParams: requiresAuthorizationParams{
  3405. {owner: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("100002"), result: true},
  3406. },
  3407. },
  3408. userManagerParams: userManagerParams{
  3409. getUserParams: getUserParams{
  3410. {screenName: state.NewIdentScreenName("100001"), result: &authReqSender, err: nil},
  3411. },
  3412. },
  3413. },
  3414. expectOutput: wire.SNACMessage{
  3415. Frame: wire.SNACFrame{
  3416. FoodGroup: wire.ICBM,
  3417. SubGroup: wire.ICBMChannelMsgToHost,
  3418. },
  3419. Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  3420. ChannelID: wire.ICBMChannelICQ,
  3421. ScreenName: "100002",
  3422. TLVRestBlock: wire.TLVRestBlock{
  3423. TLVList: wire.TLVList{
  3424. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  3425. UIN: 100001,
  3426. MessageType: wire.ICBMMsgTypeAuthReq,
  3427. Message: fmt.Sprintf("%s\xFE%s\xFE%s\xFE%s\xFE%d\xFE%s",
  3428. authReqSender.ICQInfo.Basic.Nickname,
  3429. authReqSender.ICQInfo.Basic.FirstName,
  3430. authReqSender.ICQInfo.Basic.LastName,
  3431. authReqSender.ICQInfo.Basic.EmailAddress,
  3432. 0,
  3433. utf8ToLatin1("please add me"),
  3434. ),
  3435. }),
  3436. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  3437. },
  3438. },
  3439. },
  3440. },
  3441. expectICBM: true,
  3442. },
  3443. {
  3444. name: "icbmSender returns error",
  3445. instance: newTestInstance("100001", sessOptUIN(100001)),
  3446. inSNAC: wire.SNACMessage{
  3447. Frame: wire.SNACFrame{
  3448. FoodGroup: wire.Feedbag,
  3449. SubGroup: wire.FeedbagRequestAuthorizeToHost,
  3450. RequestID: 1234,
  3451. },
  3452. Body: wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost{
  3453. ScreenName: "100002",
  3454. Reason: "please add me",
  3455. },
  3456. },
  3457. buddySess: nil,
  3458. mockParams: mockParams{
  3459. sessionRetrieverParams: sessionRetrieverParams{
  3460. retrieveSessionParams: retrieveSessionParams{
  3461. {screenName: state.NewIdentScreenName("100002")},
  3462. },
  3463. },
  3464. contactPreAuthorizerParams: contactPreAuthorizerParams{
  3465. requiresAuthorizationParams: requiresAuthorizationParams{
  3466. {owner: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("100002"), result: false},
  3467. },
  3468. },
  3469. userManagerParams: userManagerParams{
  3470. getUserParams: getUserParams{
  3471. {screenName: state.NewIdentScreenName("100001"), result: &authReqSender, err: nil},
  3472. },
  3473. },
  3474. },
  3475. expectOutput: wire.SNACMessage{
  3476. Frame: wire.SNACFrame{
  3477. FoodGroup: wire.ICBM,
  3478. SubGroup: wire.ICBMChannelMsgToHost,
  3479. },
  3480. Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  3481. ChannelID: wire.ICBMChannelICQ,
  3482. ScreenName: "100002",
  3483. TLVRestBlock: wire.TLVRestBlock{
  3484. TLVList: wire.TLVList{
  3485. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  3486. UIN: 100001,
  3487. MessageType: wire.ICBMMsgTypeAuthReq,
  3488. Message: fmt.Sprintf("%s\xFE%s\xFE%s\xFE%s\xFE%d\xFE%s",
  3489. authReqSender.ICQInfo.Basic.Nickname,
  3490. authReqSender.ICQInfo.Basic.FirstName,
  3491. authReqSender.ICQInfo.Basic.LastName,
  3492. authReqSender.ICQInfo.Basic.EmailAddress,
  3493. 1,
  3494. utf8ToLatin1("please add me"),
  3495. ),
  3496. }),
  3497. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  3498. },
  3499. },
  3500. },
  3501. },
  3502. wantErr: assert.AnError,
  3503. expectICBM: true,
  3504. },
  3505. }
  3506. for _, tt := range tests {
  3507. t.Run(tt.name, func(t *testing.T) {
  3508. sessionRetriever := newMockSessionRetriever(t)
  3509. for _, params := range tt.mockParams.retrieveSessionParams {
  3510. sessionRetriever.EXPECT().RetrieveSession(params.screenName).Return(tt.buddySess)
  3511. }
  3512. messageRelayer := newMockMessageRelayer(t)
  3513. for _, params := range tt.mockParams.relayToScreenNameParams {
  3514. messageRelayer.EXPECT().RelayToScreenName(matchContext(), params.screenName, params.message)
  3515. }
  3516. icbmSender := func(ctx context.Context, instance *state.SessionInstance, inFrame wire.SNACFrame, inBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost) (*wire.SNACMessage, error) {
  3517. if !tt.expectICBM {
  3518. t.Fatalf("unexpected icbmSender call")
  3519. }
  3520. assert.Equal(t, tt.expectOutput.Frame, inFrame)
  3521. assert.Equal(t, tt.instance, instance)
  3522. wantBody := tt.expectOutput.Body.(wire.SNAC_0x04_0x06_ICBMChannelMsgToHost)
  3523. assert.Equal(t, wantBody, inBody)
  3524. return nil, tt.wantErr
  3525. }
  3526. contactPreAuth := newMockContactPreAuthorizer(t)
  3527. for _, params := range tt.mockParams.requiresAuthorizationParams {
  3528. contactPreAuth.EXPECT().
  3529. RequiresAuthorization(matchContext(), params.owner, params.requester).
  3530. Return(params.result, params.err)
  3531. }
  3532. userManager := newMockUserManager(t)
  3533. for _, params := range tt.mockParams.userManagerParams.getUserParams {
  3534. userManager.EXPECT().
  3535. User(matchContext(), params.screenName).
  3536. Return(params.result, params.err)
  3537. }
  3538. svc := NewFeedbagService(slog.Default(), messageRelayer, nil, nil, nil, sessionRetriever, contactPreAuth, userManager, newMockBuddyAddedNotifierDeduper(t))
  3539. svc.icbmSender = icbmSender
  3540. haveErr := svc.RequestAuthorizeToHost(
  3541. context.Background(),
  3542. tt.instance,
  3543. tt.inSNAC.Frame,
  3544. tt.inSNAC.Body.(wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost),
  3545. )
  3546. assert.ErrorIs(t, haveErr, tt.wantErr)
  3547. })
  3548. }
  3549. }
  3550. func TestFeedbagService_RespondAuthorizeToHost(t *testing.T) {
  3551. wantICBMFrame := wire.SNACFrame{
  3552. FoodGroup: wire.ICBM,
  3553. SubGroup: wire.ICBMChannelMsgToHost,
  3554. }
  3555. granter := state.NewIdentScreenName("100001")
  3556. requester := state.NewIdentScreenName("100003")
  3557. tests := []struct {
  3558. // name is the unit test name
  3559. name string
  3560. // granterSess is the session instance of the user who accepts / rejects authorization
  3561. granterSess *state.SessionInstance
  3562. // requesterSess is the session instance of the user who requested authorization
  3563. requesterSess *state.Session
  3564. // bodyIn is the SNAC body sent by the client
  3565. bodyIn wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost
  3566. // mockParams is the list of params sent to mocks that satisfy this
  3567. // method's dependencies
  3568. mockParams mockParams
  3569. // expectICBM is true when the response is sent via ICBM rather than Feebdag SNACs
  3570. expectICBM bool
  3571. // wantHostSNAC is the expected ICBM body when expectICBM is true
  3572. wantHostSNAC wire.SNAC_0x04_0x06_ICBMChannelMsgToHost
  3573. // wantErr is the expected error
  3574. wantErr error
  3575. }{
  3576. {
  3577. name: "requester offline: requester receives auth OK",
  3578. granterSess: newTestInstance(state.DisplayScreenName(granter.String()), sessOptUIN(granter.UIN())),
  3579. requesterSess: nil, // offline
  3580. bodyIn: wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost{
  3581. ScreenName: requester.String(),
  3582. Accepted: 1,
  3583. },
  3584. mockParams: mockParams{
  3585. contactPreAuthorizerParams: contactPreAuthorizerParams{
  3586. recordPreAuthParams: recordPreAuthParams{
  3587. {owner: granter, buddy: requester},
  3588. },
  3589. },
  3590. },
  3591. expectICBM: true,
  3592. wantHostSNAC: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  3593. ChannelID: wire.ICBMChannelICQ,
  3594. ScreenName: requester.String(),
  3595. TLVRestBlock: wire.TLVRestBlock{
  3596. TLVList: wire.TLVList{
  3597. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  3598. UIN: granter.UIN(),
  3599. MessageType: wire.ICBMMsgTypeAuthOK,
  3600. }),
  3601. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  3602. },
  3603. },
  3604. },
  3605. },
  3606. {
  3607. name: "requester offline: requester receives auth deny",
  3608. granterSess: newTestInstance(state.DisplayScreenName(granter.String()), sessOptUIN(granter.UIN())),
  3609. requesterSess: nil, // offline
  3610. bodyIn: wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost{
  3611. ScreenName: requester.String(),
  3612. Accepted: 0,
  3613. Reason: "I don't know you!",
  3614. },
  3615. expectICBM: true,
  3616. wantHostSNAC: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  3617. ChannelID: wire.ICBMChannelICQ,
  3618. ScreenName: requester.String(),
  3619. TLVRestBlock: wire.TLVRestBlock{
  3620. TLVList: wire.TLVList{
  3621. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  3622. UIN: granter.UIN(),
  3623. MessageType: wire.ICBMMsgTypeAuthDeny,
  3624. Message: "I don't know you!",
  3625. }),
  3626. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  3627. },
  3628. },
  3629. },
  3630. },
  3631. {
  3632. name: "requester online: requester is pre-authorized",
  3633. granterSess: newTestInstance(state.DisplayScreenName(granter.String()), sessOptUIN(granter.UIN())),
  3634. requesterSess: func() *state.Session {
  3635. s := state.NewSession()
  3636. s.SetIdentScreenName(requester)
  3637. s.SetUsesFeedbag()
  3638. return s
  3639. }(),
  3640. bodyIn: wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost{
  3641. ScreenName: requester.String(),
  3642. Accepted: 1,
  3643. Reason: "welcome",
  3644. },
  3645. mockParams: mockParams{
  3646. contactPreAuthorizerParams: contactPreAuthorizerParams{
  3647. recordPreAuthParams: recordPreAuthParams{
  3648. {owner: granter, buddy: requester},
  3649. },
  3650. },
  3651. feedbagManagerParams: feedbagManagerParams{
  3652. feedbagParams: feedbagParams{
  3653. {screenName: requester, results: []wire.FeedbagItem{}},
  3654. },
  3655. },
  3656. relationshipFetcherParams: relationshipFetcherParams{
  3657. relationshipParams: relationshipParams{
  3658. {me: granter, them: requester, result: state.Relationship{}},
  3659. },
  3660. },
  3661. messageRelayerParams: messageRelayerParams{
  3662. relayToScreenNameParams: relayToScreenNameParams{
  3663. {
  3664. screenName: requester,
  3665. message: wire.SNACMessage{
  3666. Frame: wire.SNACFrame{
  3667. FoodGroup: wire.Feedbag,
  3668. SubGroup: wire.FeedbagPreAuthorizedBuddy,
  3669. },
  3670. Body: wire.SNAC_0x13_0x15_FeedbagPreAuthorizedBuddy{
  3671. ScreenName: granter.String(),
  3672. Message: "welcome",
  3673. Flags: 0,
  3674. },
  3675. },
  3676. },
  3677. },
  3678. },
  3679. },
  3680. },
  3681. {
  3682. name: "requester online: pending auth is finalized",
  3683. granterSess: newTestInstance(state.DisplayScreenName(granter.String()), sessOptUIN(granter.UIN())),
  3684. requesterSess: func() *state.Session {
  3685. s := state.NewSession()
  3686. s.SetIdentScreenName(requester)
  3687. s.SetUsesFeedbag()
  3688. return s
  3689. }(),
  3690. bodyIn: wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost{
  3691. ScreenName: requester.String(),
  3692. Accepted: 1,
  3693. },
  3694. mockParams: mockParams{
  3695. contactPreAuthorizerParams: contactPreAuthorizerParams{
  3696. recordPreAuthParams: recordPreAuthParams{
  3697. {owner: granter, buddy: requester},
  3698. },
  3699. },
  3700. feedbagManagerParams: feedbagManagerParams{
  3701. feedbagParams: feedbagParams{
  3702. {
  3703. screenName: requester,
  3704. results: []wire.FeedbagItem{
  3705. {
  3706. ClassID: wire.FeedbagClassIdBuddy,
  3707. Name: granter.String(),
  3708. TLVLBlock: wire.TLVLBlock{
  3709. TLVList: wire.TLVList{
  3710. wire.NewTLVBE(wire.FeedbagAttributesPending, []byte{}),
  3711. },
  3712. },
  3713. },
  3714. },
  3715. },
  3716. },
  3717. feedbagUpsertParams: feedbagUpsertParams{
  3718. // slices.DeleteFunc returns an empty non-nil slice after removing the pending tag
  3719. {
  3720. screenName: requester,
  3721. items: []wire.FeedbagItem{
  3722. {ClassID: wire.FeedbagClassIdBuddy, Name: granter.String(), TLVLBlock: wire.TLVLBlock{TLVList: wire.TLVList{}}},
  3723. },
  3724. },
  3725. },
  3726. },
  3727. sessionRetrieverParams: sessionRetrieverParams{
  3728. retrieveSessionParams: retrieveSessionParams{
  3729. {
  3730. screenName: granter,
  3731. result: func() *state.Session {
  3732. s := state.NewSession()
  3733. s.SetIdentScreenName(granter)
  3734. s.SetUsesFeedbag()
  3735. s.AddInstance()
  3736. return s
  3737. }(),
  3738. },
  3739. },
  3740. },
  3741. messageRelayerParams: messageRelayerParams{
  3742. relayToScreenNameParams: relayToScreenNameParams{
  3743. {
  3744. screenName: granter,
  3745. message: wire.SNACMessage{
  3746. Frame: wire.SNACFrame{
  3747. FoodGroup: wire.Feedbag,
  3748. SubGroup: wire.FeedbagBuddyAdded,
  3749. Flags: wire.SNACFlagsExtendedInfo,
  3750. },
  3751. Body: wire.SNAC_0x13_0x1C_FeedbagBuddyAdded{
  3752. TLVLBlock: wire.TLVLBlock{
  3753. TLVList: wire.TLVList{
  3754. wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(4)),
  3755. },
  3756. },
  3757. ScreenName: requester.String(),
  3758. },
  3759. },
  3760. },
  3761. {
  3762. screenName: requester,
  3763. message: wire.SNACMessage{
  3764. Frame: wire.SNACFrame{
  3765. FoodGroup: wire.Feedbag,
  3766. SubGroup: wire.FeedbagUpdateItem,
  3767. },
  3768. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  3769. Items: []wire.FeedbagItem{
  3770. {ClassID: wire.FeedbagClassIdBuddy, Name: granter.String(), TLVLBlock: wire.TLVLBlock{TLVList: wire.TLVList{}}},
  3771. },
  3772. },
  3773. },
  3774. },
  3775. {
  3776. screenName: requester,
  3777. message: wire.SNACMessage{
  3778. Frame: wire.SNACFrame{
  3779. FoodGroup: wire.Feedbag,
  3780. SubGroup: wire.FeedbagRespondAuthorizeToClient,
  3781. Flags: wire.SNACFlagsExtendedInfo,
  3782. },
  3783. Body: wire.SNAC_0x13_0x1B_FeedbagRespondAuthorizeToClient{
  3784. TLVLBlock: wire.TLVLBlock{
  3785. TLVList: wire.TLVList{
  3786. wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
  3787. },
  3788. },
  3789. ScreenName: granter.String(),
  3790. Accepted: 1,
  3791. },
  3792. },
  3793. },
  3794. },
  3795. },
  3796. buddyBroadcasterParams: buddyBroadcasterParams{
  3797. broadcastVisibilityParams: broadcastVisibilityParams{
  3798. {
  3799. from: granter,
  3800. filter: []state.IdentScreenName{requester},
  3801. doSendDepartures: false,
  3802. },
  3803. },
  3804. },
  3805. },
  3806. },
  3807. {
  3808. name: "requester online, granter offline: pending auth is finalized",
  3809. granterSess: newTestInstance(state.DisplayScreenName(granter.String()), sessOptUIN(granter.UIN())),
  3810. bodyIn: wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost{
  3811. ScreenName: requester.String(),
  3812. Accepted: 1,
  3813. },
  3814. requesterSess: func() *state.Session {
  3815. s := state.NewSession()
  3816. s.SetIdentScreenName(requester)
  3817. s.SetUsesFeedbag()
  3818. return s
  3819. }(),
  3820. mockParams: mockParams{
  3821. contactPreAuthorizerParams: contactPreAuthorizerParams{
  3822. recordPreAuthParams: recordPreAuthParams{
  3823. {owner: granter, buddy: requester},
  3824. },
  3825. },
  3826. feedbagManagerParams: feedbagManagerParams{
  3827. feedbagParams: feedbagParams{
  3828. {
  3829. screenName: requester,
  3830. results: []wire.FeedbagItem{
  3831. {
  3832. ClassID: wire.FeedbagClassIdBuddy,
  3833. Name: granter.String(),
  3834. TLVLBlock: wire.TLVLBlock{
  3835. TLVList: wire.TLVList{
  3836. wire.NewTLVBE(wire.FeedbagAttributesPending, []byte{}),
  3837. },
  3838. },
  3839. },
  3840. },
  3841. },
  3842. },
  3843. feedbagUpsertParams: feedbagUpsertParams{
  3844. {
  3845. screenName: requester,
  3846. items: []wire.FeedbagItem{
  3847. {ClassID: wire.FeedbagClassIdBuddy, Name: granter.String(), TLVLBlock: wire.TLVLBlock{TLVList: wire.TLVList{}}},
  3848. },
  3849. },
  3850. },
  3851. },
  3852. sessionRetrieverParams: sessionRetrieverParams{
  3853. retrieveSessionParams: retrieveSessionParams{
  3854. {screenName: granter, result: nil},
  3855. },
  3856. },
  3857. messageRelayerParams: messageRelayerParams{
  3858. relayToScreenNameParams: relayToScreenNameParams{
  3859. {
  3860. screenName: requester,
  3861. message: wire.SNACMessage{
  3862. Frame: wire.SNACFrame{
  3863. FoodGroup: wire.Feedbag,
  3864. SubGroup: wire.FeedbagUpdateItem,
  3865. },
  3866. Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
  3867. Items: []wire.FeedbagItem{
  3868. {ClassID: wire.FeedbagClassIdBuddy, Name: granter.String(), TLVLBlock: wire.TLVLBlock{TLVList: wire.TLVList{}}},
  3869. },
  3870. },
  3871. },
  3872. },
  3873. {
  3874. screenName: requester,
  3875. message: wire.SNACMessage{
  3876. Frame: wire.SNACFrame{
  3877. FoodGroup: wire.Feedbag,
  3878. SubGroup: wire.FeedbagRespondAuthorizeToClient,
  3879. Flags: wire.SNACFlagsExtendedInfo,
  3880. },
  3881. Body: wire.SNAC_0x13_0x1B_FeedbagRespondAuthorizeToClient{
  3882. TLVLBlock: wire.TLVLBlock{
  3883. TLVList: wire.TLVList{
  3884. wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
  3885. },
  3886. },
  3887. ScreenName: granter.String(),
  3888. Accepted: 1,
  3889. },
  3890. },
  3891. },
  3892. },
  3893. },
  3894. },
  3895. expectICBM: true,
  3896. wantHostSNAC: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  3897. ChannelID: wire.ICBMChannelICQ,
  3898. ScreenName: granter.String(),
  3899. TLVRestBlock: wire.TLVRestBlock{
  3900. TLVList: wire.TLVList{
  3901. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  3902. UIN: requester.UIN(),
  3903. MessageType: wire.ICBMMsgTypeAdded,
  3904. }),
  3905. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  3906. },
  3907. },
  3908. },
  3909. },
  3910. {
  3911. name: "requester online: requester is denied",
  3912. granterSess: newTestInstance(state.DisplayScreenName(granter.String()), sessOptUIN(granter.UIN())),
  3913. bodyIn: wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost{
  3914. ScreenName: requester.String(),
  3915. Accepted: 0,
  3916. Reason: "I don't know you!",
  3917. },
  3918. requesterSess: func() *state.Session {
  3919. s := state.NewSession()
  3920. s.SetIdentScreenName(requester)
  3921. s.SetUsesFeedbag()
  3922. return s
  3923. }(),
  3924. mockParams: mockParams{
  3925. messageRelayerParams: messageRelayerParams{
  3926. relayToScreenNameParams: relayToScreenNameParams{
  3927. {
  3928. screenName: requester,
  3929. message: wire.SNACMessage{
  3930. Frame: wire.SNACFrame{
  3931. FoodGroup: wire.Feedbag,
  3932. SubGroup: wire.FeedbagRespondAuthorizeToClient,
  3933. Flags: wire.SNACFlagsExtendedInfo,
  3934. },
  3935. Body: wire.SNAC_0x13_0x1B_FeedbagRespondAuthorizeToClient{
  3936. TLVLBlock: wire.TLVLBlock{
  3937. TLVList: wire.TLVList{
  3938. wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
  3939. },
  3940. },
  3941. ScreenName: granter.String(),
  3942. Accepted: 0,
  3943. Reason: "I don't know you!",
  3944. },
  3945. },
  3946. },
  3947. },
  3948. },
  3949. },
  3950. },
  3951. }
  3952. for _, tt := range tests {
  3953. t.Run(tt.name, func(t *testing.T) {
  3954. sessionRetriever := newMockSessionRetriever(t)
  3955. sessionRetriever.EXPECT().
  3956. RetrieveSession(state.NewIdentScreenName(tt.bodyIn.ScreenName)).
  3957. Return(tt.requesterSess)
  3958. for _, params := range tt.mockParams.retrieveSessionParams {
  3959. sessionRetriever.EXPECT().RetrieveSession(params.screenName).Return(params.result)
  3960. }
  3961. contactPreAuth := newMockContactPreAuthorizer(t)
  3962. for _, params := range tt.mockParams.recordPreAuthParams {
  3963. contactPreAuth.EXPECT().RecordPreAuth(matchContext(), params.owner, params.buddy).Return(params.err)
  3964. }
  3965. messageRelayer := newMockMessageRelayer(t)
  3966. for _, params := range tt.mockParams.relayToScreenNameParams {
  3967. messageRelayer.EXPECT().RelayToScreenName(matchContext(), params.screenName, params.message)
  3968. }
  3969. feedbagManager := newMockFeedbagManager(t)
  3970. for _, params := range tt.mockParams.feedbagParams {
  3971. feedbagManager.EXPECT().Feedbag(matchContext(), params.screenName).Return(params.results, params.err)
  3972. }
  3973. for _, params := range tt.mockParams.feedbagUpsertParams {
  3974. feedbagManager.EXPECT().FeedbagUpsert(matchContext(), params.screenName, params.items).Return(nil)
  3975. }
  3976. relationshipFetcher := newMockRelationshipFetcher(t)
  3977. for _, params := range tt.mockParams.relationshipParams {
  3978. relationshipFetcher.EXPECT().Relationship(matchContext(), params.me, params.them).Return(params.result, params.err)
  3979. }
  3980. buddyBroadcaster := newMockbuddyBroadcaster(t)
  3981. for _, params := range tt.mockParams.broadcastVisibilityParams {
  3982. buddyBroadcaster.EXPECT().
  3983. BroadcastVisibility(mock.Anything, matchSession(params.from), params.filter, params.doSendDepartures).
  3984. Return(params.err)
  3985. }
  3986. var icbmCallCount int
  3987. icbmSender := func(ctx context.Context, instance *state.SessionInstance, inFrame wire.SNACFrame, inBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost) (*wire.SNACMessage, error) {
  3988. icbmCallCount++
  3989. if !tt.expectICBM {
  3990. t.Fatalf("unexpected icbmSender call")
  3991. }
  3992. assert.Equal(t, wantICBMFrame, inFrame)
  3993. wantBody := tt.wantHostSNAC
  3994. wantBody.Cookie = 0
  3995. haveBody := inBody
  3996. haveBody.Cookie = 0
  3997. assert.Equal(t, wantBody, haveBody)
  3998. return nil, tt.wantErr
  3999. }
  4000. svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, relationshipFetcher, sessionRetriever, contactPreAuth, nil, newMockBuddyAddedNotifierDeduper(t))
  4001. svc.buddyBroadcaster = buddyBroadcaster
  4002. svc.icbmSender = icbmSender
  4003. haveErr := svc.RespondAuthorizeToHost(context.Background(), tt.granterSess.IdentScreenName(), wire.SNACFrame{}, tt.bodyIn)
  4004. assert.ErrorIs(t, tt.wantErr, haveErr)
  4005. if tt.expectICBM {
  4006. assert.Equal(t, 1, icbmCallCount, "expected icbmSender to be called exactly once")
  4007. } else {
  4008. assert.Equal(t, 0, icbmCallCount, "expected icbmSender not to be called")
  4009. }
  4010. })
  4011. }
  4012. }
  4013. func TestFeedbagService_PreAuthorizeBuddy(t *testing.T) {
  4014. alice := newTestInstance("100001", sessOptUIN(100001))
  4015. buddySN := state.NewIdentScreenName("100002")
  4016. wantICBMFrame := wire.SNACFrame{
  4017. FoodGroup: wire.ICBM,
  4018. SubGroup: wire.ICBMChannelMsgToHost,
  4019. }
  4020. wantICBMBody := wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  4021. ChannelID: wire.ICBMChannelICQ,
  4022. ScreenName: buddySN.String(),
  4023. TLVRestBlock: wire.TLVRestBlock{
  4024. TLVList: wire.TLVList{
  4025. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  4026. UIN: 100001,
  4027. MessageType: wire.ICBMMsgTypeAuthOK,
  4028. }),
  4029. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  4030. },
  4031. },
  4032. }
  4033. tests := []struct {
  4034. // name is the unit test name
  4035. name string
  4036. // inFrame is the SNAC frame sent by the client
  4037. inFrame wire.SNACFrame
  4038. // inBody is the SNAC body sent by the client
  4039. inBody wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy
  4040. // buddySess is the online session for the pre-authorized buddy, or nil
  4041. // if the buddy is offline
  4042. buddySess *state.Session
  4043. // mockParams is the list of params sent to mocks that satisfy this
  4044. // method's dependencies
  4045. mockParams mockParams
  4046. // wantOut is the SNAC sent from the server to the client
  4047. wantOut *wire.SNACMessage
  4048. // wantErr is the expected error
  4049. wantErr error
  4050. // expectICBM is true when PreAuthorizeBuddy should send SNAC(0x04,0x06) auth OK
  4051. expectICBM bool
  4052. }{
  4053. {
  4054. name: "rejects self with FeedbagErr",
  4055. inFrame: wire.SNACFrame{RequestID: 0xabc},
  4056. inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{ScreenName: "100001"},
  4057. wantOut: &wire.SNACMessage{
  4058. Frame: wire.SNACFrame{
  4059. FoodGroup: wire.Feedbag,
  4060. SubGroup: wire.FeedbagErr,
  4061. RequestID: 0xabc,
  4062. },
  4063. Body: wire.SNACError{
  4064. Code: wire.ErrorCodeNotSupportedByHost,
  4065. },
  4066. },
  4067. expectICBM: false,
  4068. },
  4069. {
  4070. name: "unknown buddy user",
  4071. inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{ScreenName: buddySN.String()},
  4072. mockParams: mockParams{
  4073. sessionRetrieverParams: sessionRetrieverParams{
  4074. retrieveSessionParams: retrieveSessionParams{
  4075. {
  4076. screenName: buddySN,
  4077. result: nil,
  4078. },
  4079. },
  4080. },
  4081. contactPreAuthorizerParams: contactPreAuthorizerParams{
  4082. recordPreAuthParams: recordPreAuthParams{
  4083. {
  4084. owner: alice.IdentScreenName(),
  4085. buddy: buddySN,
  4086. err: state.ErrNoUser,
  4087. },
  4088. },
  4089. },
  4090. },
  4091. expectICBM: false,
  4092. },
  4093. {
  4094. name: "RecordPreAuth error",
  4095. inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{ScreenName: buddySN.String()},
  4096. mockParams: mockParams{
  4097. sessionRetrieverParams: sessionRetrieverParams{
  4098. retrieveSessionParams: retrieveSessionParams{
  4099. {
  4100. screenName: buddySN,
  4101. result: nil,
  4102. },
  4103. },
  4104. },
  4105. contactPreAuthorizerParams: contactPreAuthorizerParams{
  4106. recordPreAuthParams: recordPreAuthParams{
  4107. {
  4108. owner: alice.IdentScreenName(),
  4109. buddy: buddySN,
  4110. err: assert.AnError,
  4111. },
  4112. },
  4113. },
  4114. },
  4115. wantErr: assert.AnError,
  4116. expectICBM: false,
  4117. },
  4118. {
  4119. name: "offline buddy: records grant, sends ICBM auth OK",
  4120. inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{
  4121. ScreenName: buddySN.String(),
  4122. Message: "hi",
  4123. },
  4124. mockParams: mockParams{
  4125. contactPreAuthorizerParams: contactPreAuthorizerParams{
  4126. recordPreAuthParams: recordPreAuthParams{
  4127. {
  4128. owner: alice.IdentScreenName(),
  4129. buddy: buddySN,
  4130. },
  4131. },
  4132. },
  4133. sessionRetrieverParams: sessionRetrieverParams{
  4134. retrieveSessionParams: retrieveSessionParams{
  4135. {
  4136. screenName: buddySN,
  4137. result: nil,
  4138. },
  4139. },
  4140. },
  4141. },
  4142. expectICBM: true,
  4143. },
  4144. {
  4145. name: "online no feedbag: sends ICBM auth OK",
  4146. inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{ScreenName: buddySN.String()},
  4147. buddySess: func() *state.Session {
  4148. s := state.NewSession()
  4149. s.SetIdentScreenName(buddySN)
  4150. return s
  4151. }(),
  4152. mockParams: mockParams{
  4153. contactPreAuthorizerParams: contactPreAuthorizerParams{
  4154. recordPreAuthParams: recordPreAuthParams{
  4155. {
  4156. owner: alice.IdentScreenName(),
  4157. buddy: buddySN,
  4158. },
  4159. },
  4160. },
  4161. sessionRetrieverParams: sessionRetrieverParams{
  4162. retrieveSessionParams: retrieveSessionParams{
  4163. {
  4164. screenName: buddySN,
  4165. },
  4166. },
  4167. },
  4168. feedbagManagerParams: feedbagManagerParams{
  4169. feedbagParams: feedbagParams{
  4170. {
  4171. screenName: buddySN,
  4172. results: []wire.FeedbagItem{},
  4173. },
  4174. },
  4175. },
  4176. },
  4177. expectICBM: true,
  4178. },
  4179. {
  4180. name: "online feedbag YouBlock: no relay",
  4181. inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{
  4182. ScreenName: buddySN.String(),
  4183. Message: "note",
  4184. },
  4185. buddySess: func() *state.Session {
  4186. s := state.NewSession()
  4187. s.SetIdentScreenName(buddySN)
  4188. s.SetUsesFeedbag()
  4189. return s
  4190. }(),
  4191. mockParams: mockParams{
  4192. contactPreAuthorizerParams: contactPreAuthorizerParams{
  4193. recordPreAuthParams: recordPreAuthParams{
  4194. {
  4195. owner: alice.IdentScreenName(),
  4196. buddy: buddySN,
  4197. },
  4198. },
  4199. },
  4200. sessionRetrieverParams: sessionRetrieverParams{
  4201. retrieveSessionParams: retrieveSessionParams{
  4202. {
  4203. screenName: buddySN,
  4204. },
  4205. },
  4206. },
  4207. feedbagManagerParams: feedbagManagerParams{
  4208. feedbagParams: feedbagParams{
  4209. {
  4210. screenName: buddySN,
  4211. results: []wire.FeedbagItem{},
  4212. },
  4213. },
  4214. },
  4215. relationshipFetcherParams: relationshipFetcherParams{
  4216. relationshipParams: relationshipParams{
  4217. {
  4218. me: alice.IdentScreenName(),
  4219. them: buddySN,
  4220. result: state.Relationship{BlocksYou: true},
  4221. },
  4222. },
  4223. },
  4224. },
  4225. expectICBM: false,
  4226. },
  4227. {
  4228. name: "online feedbag relays PreAuthorizedBuddy",
  4229. inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{
  4230. ScreenName: buddySN.String(),
  4231. Message: "added you",
  4232. },
  4233. buddySess: func() *state.Session {
  4234. s := state.NewSession()
  4235. s.SetIdentScreenName(buddySN)
  4236. s.SetUsesFeedbag()
  4237. return s
  4238. }(),
  4239. mockParams: mockParams{
  4240. contactPreAuthorizerParams: contactPreAuthorizerParams{
  4241. recordPreAuthParams: recordPreAuthParams{
  4242. {
  4243. owner: alice.IdentScreenName(),
  4244. buddy: buddySN,
  4245. },
  4246. },
  4247. },
  4248. sessionRetrieverParams: sessionRetrieverParams{
  4249. retrieveSessionParams: retrieveSessionParams{
  4250. {
  4251. screenName: buddySN,
  4252. },
  4253. },
  4254. },
  4255. feedbagManagerParams: feedbagManagerParams{
  4256. feedbagParams: feedbagParams{
  4257. {
  4258. screenName: buddySN,
  4259. results: []wire.FeedbagItem{},
  4260. },
  4261. },
  4262. },
  4263. relationshipFetcherParams: relationshipFetcherParams{
  4264. relationshipParams: relationshipParams{
  4265. {
  4266. me: alice.IdentScreenName(),
  4267. them: buddySN,
  4268. result: state.Relationship{BlocksYou: false},
  4269. },
  4270. },
  4271. },
  4272. messageRelayerParams: messageRelayerParams{
  4273. relayToScreenNameParams: relayToScreenNameParams{
  4274. {
  4275. screenName: buddySN,
  4276. message: wire.SNACMessage{
  4277. Frame: wire.SNACFrame{
  4278. FoodGroup: wire.Feedbag,
  4279. SubGroup: wire.FeedbagPreAuthorizedBuddy,
  4280. },
  4281. Body: wire.SNAC_0x13_0x15_FeedbagPreAuthorizedBuddy{
  4282. ScreenName: "100001",
  4283. Message: "added you",
  4284. Flags: 0,
  4285. },
  4286. },
  4287. },
  4288. },
  4289. },
  4290. },
  4291. expectICBM: false,
  4292. },
  4293. }
  4294. for _, tt := range tests {
  4295. t.Run(tt.name, func(t *testing.T) {
  4296. contactPreAuth := newMockContactPreAuthorizer(t)
  4297. for _, params := range tt.mockParams.recordPreAuthParams {
  4298. contactPreAuth.EXPECT().RecordPreAuth(matchContext(), params.owner, params.buddy).Return(params.err)
  4299. }
  4300. sessionRetriever := newMockSessionRetriever(t)
  4301. for _, params := range tt.mockParams.retrieveSessionParams {
  4302. sessionRetriever.EXPECT().RetrieveSession(params.screenName).Return(tt.buddySess)
  4303. }
  4304. feedbagManager := newMockFeedbagManager(t)
  4305. for _, params := range tt.mockParams.feedbagParams {
  4306. feedbagManager.EXPECT().
  4307. Feedbag(matchContext(), params.screenName).
  4308. Return(params.results, params.err)
  4309. }
  4310. relationshipFetcher := newMockRelationshipFetcher(t)
  4311. for _, params := range tt.mockParams.relationshipParams {
  4312. relationshipFetcher.EXPECT().Relationship(matchContext(), params.me, params.them).Return(params.result, params.err)
  4313. }
  4314. messageRelayer := newMockMessageRelayer(t)
  4315. for _, params := range tt.mockParams.relayToScreenNameParams {
  4316. messageRelayer.EXPECT().RelayToScreenName(matchContext(), params.screenName, params.message)
  4317. }
  4318. icbmSender := func(ctx context.Context, instance *state.SessionInstance, inFrame wire.SNACFrame, inBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost) (*wire.SNACMessage, error) {
  4319. if !tt.expectICBM {
  4320. t.Fatalf("unexpected icbmSender call")
  4321. }
  4322. assert.Equal(t, wantICBMFrame, inFrame)
  4323. assert.Equal(t, alice.IdentScreenName(), instance.IdentScreenName())
  4324. assert.Equal(t, wantICBMBody.ChannelID, inBody.ChannelID)
  4325. assert.Equal(t, wantICBMBody.ScreenName, inBody.ScreenName)
  4326. assert.Equal(t, wantICBMBody.TLVRestBlock, inBody.TLVRestBlock)
  4327. assert.NotZero(t, inBody.Cookie)
  4328. return nil, nil
  4329. }
  4330. svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, relationshipFetcher, sessionRetriever, contactPreAuth, nil, newMockBuddyAddedNotifierDeduper(t))
  4331. svc.icbmSender = icbmSender
  4332. out, err := svc.PreAuthorizeBuddy(context.Background(), alice, tt.inFrame, tt.inBody)
  4333. assert.ErrorIs(t, err, tt.wantErr)
  4334. assert.Equal(t, tt.wantOut, out)
  4335. })
  4336. }
  4337. }
  4338. func TestUtf8ToLatin1(t *testing.T) {
  4339. tests := []struct {
  4340. name string
  4341. input string
  4342. want string
  4343. }{
  4344. {
  4345. name: "pure ASCII string returned unchanged",
  4346. input: "hello world",
  4347. want: "hello world",
  4348. },
  4349. {
  4350. name: "Latin-1 characters converted to single bytes",
  4351. input: "caf\u00e9", // é = U+00E9
  4352. want: "caf\xe9",
  4353. },
  4354. {
  4355. name: "non-Latin-1 character replaced with question mark",
  4356. input: "price: \u20ac", // € = U+20AC (> 0xFF)
  4357. want: "price: ?",
  4358. },
  4359. {
  4360. name: "mixed input: ASCII and Latin-1 kept, non-Latin-1 replaced",
  4361. input: "r\u00e9sum\u00e9 \u20ac100", // résumé €100
  4362. want: "r\xe9sum\xe9 ?100",
  4363. },
  4364. }
  4365. for _, tt := range tests {
  4366. t.Run(tt.name, func(t *testing.T) {
  4367. assert.Equal(t, tt.want, utf8ToLatin1(tt.input))
  4368. })
  4369. }
  4370. }
  4371. func TestFeedbagBuddyPref(t *testing.T) {
  4372. tests := []struct {
  4373. name string
  4374. itemType uint16
  4375. list wire.TLVList
  4376. wantValue bool
  4377. }{
  4378. {
  4379. name: "offline messages disabled",
  4380. itemType: wire.FeedbagBuddyPrefsAcceptOfflineIM,
  4381. list: wire.TLVList{
  4382. {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0, 0, 24, 64}},
  4383. {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0, 0, 24, 64}},
  4384. {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0, 0, 17}},
  4385. {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0, 0, 1}},
  4386. },
  4387. wantValue: false,
  4388. },
  4389. {
  4390. name: "offline messages disabled, extra padding",
  4391. itemType: wire.FeedbagBuddyPrefsAcceptOfflineIM,
  4392. list: wire.TLVList{
  4393. {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0, 0, 24, 64}},
  4394. {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0, 0, 24, 64}},
  4395. {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0, 0, 17, 0, 0}},
  4396. {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0, 0, 1, 0, 0}},
  4397. },
  4398. wantValue: false,
  4399. },
  4400. {
  4401. name: "offline messages enabled",
  4402. itemType: wire.FeedbagBuddyPrefsAcceptOfflineIM,
  4403. list: wire.TLVList{
  4404. {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0, 0, 24, 64}},
  4405. {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0, 0, 24, 64}},
  4406. {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0, 0, 17}},
  4407. {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0, 0, 17}},
  4408. },
  4409. wantValue: true,
  4410. },
  4411. {
  4412. name: "offline messages enabled, extra padding",
  4413. itemType: wire.FeedbagBuddyPrefsAcceptOfflineIM,
  4414. list: wire.TLVList{
  4415. {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0, 0, 24, 64}},
  4416. {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0, 0, 24, 64}},
  4417. {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0, 0, 17, 0, 0}},
  4418. {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0, 0, 17, 0, 0}},
  4419. },
  4420. wantValue: true,
  4421. },
  4422. {
  4423. name: "typing events enabled, with padding",
  4424. itemType: wire.FeedbagBuddyPrefsAcceptOfflineIM,
  4425. list: wire.TLVList{
  4426. {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0, 64, 24, 64}},
  4427. {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0, 64, 24, 64}},
  4428. {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0, 0, 17}},
  4429. {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0, 0, 17}},
  4430. },
  4431. wantValue: true,
  4432. },
  4433. {
  4434. name: "typing events enabled, without padding",
  4435. itemType: 22,
  4436. list: wire.TLVList{
  4437. {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{64, 24, 64}},
  4438. {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{64, 24, 64}},
  4439. {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{17}},
  4440. {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{17}},
  4441. },
  4442. wantValue: true,
  4443. },
  4444. {
  4445. name: "typing events disabled, with padding",
  4446. itemType: 22,
  4447. list: wire.TLVList{
  4448. {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0, 64, 24, 64}},
  4449. {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0, 0, 24, 64}},
  4450. {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0, 0, 17}},
  4451. {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0, 0, 17}},
  4452. },
  4453. wantValue: false,
  4454. },
  4455. {
  4456. name: "typing events disabled, without padding",
  4457. itemType: 22,
  4458. list: wire.TLVList{
  4459. {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{64, 24, 64}},
  4460. {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{24, 64}},
  4461. {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{17}},
  4462. {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{17}},
  4463. },
  4464. wantValue: false,
  4465. },
  4466. {
  4467. name: "show friendly IMs enabled (dupe of disclose radio)",
  4468. itemType: 32,
  4469. list: wire.TLVList{
  4470. {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0x00, 0x00, 0x00, 0x00}},
  4471. {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0x00, 0x00, 0x00, 0x00}},
  4472. {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0x80, 0x00, 0x00, 0x00}},
  4473. {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0x80, 0x00, 0x00, 0x00}},
  4474. },
  4475. wantValue: true,
  4476. },
  4477. {
  4478. name: "disclose radio enabled (dupe of show friendly IMs)",
  4479. itemType: 33,
  4480. list: wire.TLVList{
  4481. {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0x00, 0x00, 0x00, 0x00}},
  4482. {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0x00, 0x00, 0x00, 0x00}},
  4483. {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0x80, 0x00, 0x00, 0x00}},
  4484. {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0x80, 0x00, 0x00, 0x00}},
  4485. },
  4486. wantValue: true,
  4487. },
  4488. {
  4489. name: "show capabilities enabled",
  4490. itemType: 34,
  4491. list: wire.TLVList{
  4492. {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0x00, 0x00, 0x00, 0x00}},
  4493. {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0x00, 0x00, 0x00, 0x00}},
  4494. {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0x40, 0x00, 0x00, 0x00}},
  4495. {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0x40, 0x00, 0x00, 0x00}},
  4496. },
  4497. wantValue: true,
  4498. },
  4499. }
  4500. for _, tt := range tests {
  4501. t.Run(tt.name, func(t *testing.T) {
  4502. assert.Equal(t, tt.wantValue, wire.BuddyPref(tt.list, tt.itemType))
  4503. })
  4504. }
  4505. }
  4506. func TestFeedbagService_StartCluster(t *testing.T) {
  4507. instance := newTestInstance("me")
  4508. inFrame := wire.SNACFrame{
  4509. FoodGroup: wire.Feedbag,
  4510. SubGroup: wire.FeedbagStartCluster,
  4511. RequestID: 1234,
  4512. }
  4513. inBody := wire.SNAC_0x13_0x11_FeedbagStartCluster{
  4514. TLVRestBlock: wire.TLVRestBlock{
  4515. TLVList: wire.TLVList{
  4516. wire.NewTLVBE(0x01, uint16(100)),
  4517. },
  4518. },
  4519. }
  4520. messageRelayer := newMockMessageRelayer(t)
  4521. messageRelayer.EXPECT().
  4522. RelayToOtherInstances(matchContext(), instance, wire.SNACMessage{
  4523. Frame: inFrame,
  4524. Body: inBody,
  4525. })
  4526. svc := NewFeedbagService(slog.Default(), messageRelayer, nil, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
  4527. svc.StartCluster(context.Background(), instance, inFrame, inBody)
  4528. assert.True(t, instance.InNotifyTxn())
  4529. }
  4530. func TestFeedbagService_EndCluster(t *testing.T) {
  4531. endFrame := wire.SNACFrame{
  4532. FoodGroup: wire.Feedbag,
  4533. SubGroup: wire.FeedbagEndCluster,
  4534. RequestID: 1234,
  4535. }
  4536. endRelay := wire.SNACMessage{
  4537. Frame: endFrame,
  4538. Body: wire.SNAC_0x13_0x12_FeedbagEndCluster{},
  4539. }
  4540. cases := []struct {
  4541. name string
  4542. instance *state.SessionInstance
  4543. broadcastVisibilityParams broadcastVisibilityParams
  4544. }{
  4545. {
  4546. name: "open txn without accumulated notify skips broadcast",
  4547. instance: func() *state.SessionInstance {
  4548. inst := newTestInstance("me")
  4549. inst.BeginNotifyTxn()
  4550. return inst
  4551. }(),
  4552. },
  4553. {
  4554. name: "broadcasts accumulated screen names",
  4555. instance: func() *state.SessionInstance {
  4556. inst := newTestInstance("me")
  4557. inst.BeginNotifyTxn()
  4558. _ = inst.NotifyTxn(state.NewIdentScreenName("buddy1"))
  4559. return inst
  4560. }(),
  4561. broadcastVisibilityParams: broadcastVisibilityParams{
  4562. {
  4563. from: state.NewIdentScreenName("me"),
  4564. filter: []state.IdentScreenName{
  4565. state.NewIdentScreenName("buddy1"),
  4566. },
  4567. },
  4568. },
  4569. },
  4570. {
  4571. name: "broadcasts after notify without name filter",
  4572. instance: func() *state.SessionInstance {
  4573. inst := newTestInstance("me")
  4574. inst.BeginNotifyTxn()
  4575. _ = inst.NotifyTxn()
  4576. return inst
  4577. }(),
  4578. broadcastVisibilityParams: broadcastVisibilityParams{
  4579. {
  4580. from: state.NewIdentScreenName("me"),
  4581. filter: nil,
  4582. },
  4583. },
  4584. },
  4585. }
  4586. for _, tc := range cases {
  4587. t.Run(tc.name, func(t *testing.T) {
  4588. messageRelayer := newMockMessageRelayer(t)
  4589. messageRelayer.EXPECT().
  4590. RelayToOtherInstances(matchContext(), tc.instance, endRelay)
  4591. buddyBroadcaster := newMockbuddyBroadcaster(t)
  4592. for _, params := range tc.broadcastVisibilityParams {
  4593. buddyBroadcaster.EXPECT().
  4594. BroadcastVisibility(matchContext(), matchSession(params.from), params.filter, true).
  4595. Return(params.err)
  4596. }
  4597. svc := NewFeedbagService(slog.Default(), messageRelayer, nil, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
  4598. svc.buddyBroadcaster = buddyBroadcaster
  4599. err := svc.EndCluster(context.Background(), tc.instance, endFrame)
  4600. assert.NoError(t, err)
  4601. assert.False(t, tc.instance.InNotifyTxn())
  4602. })
  4603. }
  4604. }
  4605. func TestFeedbagService_notifyTxnCluster(t *testing.T) {
  4606. me := state.NewIdentScreenName("me")
  4607. buddy1 := state.NewIdentScreenName("buddy1")
  4608. startFrame := wire.SNACFrame{
  4609. FoodGroup: wire.Feedbag,
  4610. SubGroup: wire.FeedbagStartCluster,
  4611. RequestID: 1,
  4612. }
  4613. startBody := wire.SNAC_0x13_0x11_FeedbagStartCluster{}
  4614. endFrame := wire.SNACFrame{
  4615. FoodGroup: wire.Feedbag,
  4616. SubGroup: wire.FeedbagEndCluster,
  4617. RequestID: 2,
  4618. }
  4619. upsertFrame := wire.SNACFrame{
  4620. FoodGroup: wire.Feedbag,
  4621. SubGroup: wire.FeedbagInsertItem,
  4622. RequestID: 3,
  4623. }
  4624. upsertItems := []wire.FeedbagItem{
  4625. {ClassID: wire.FeedbagClassIDPermit, Name: "buddy1"},
  4626. }
  4627. t.Run("upsert defers visibility until end cluster", func(t *testing.T) {
  4628. instance := newTestInstance("me")
  4629. messageRelayer := newMockMessageRelayer(t)
  4630. messageRelayer.EXPECT().
  4631. RelayToOtherInstances(matchContext(), instance, mock.Anything).
  4632. Times(3)
  4633. messageRelayer.EXPECT().
  4634. RelayToSelf(matchContext(), instance, mock.Anything).
  4635. Once()
  4636. feedbagManager := newMockFeedbagManager(t)
  4637. feedbagManager.EXPECT().
  4638. FeedbagUpsert(matchContext(), me, upsertItems).
  4639. Return(nil)
  4640. buddyBroadcaster := newMockbuddyBroadcaster(t)
  4641. buddyBroadcaster.EXPECT().
  4642. BroadcastVisibility(matchContext(), matchSession(me), []state.IdentScreenName{buddy1}, true).
  4643. Return(nil).
  4644. Once()
  4645. svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
  4646. svc.buddyBroadcaster = buddyBroadcaster
  4647. svc.StartCluster(context.Background(), instance, startFrame, startBody)
  4648. assert.True(t, instance.InNotifyTxn())
  4649. _, err := svc.UpsertItem(context.Background(), instance, upsertFrame, upsertItems)
  4650. assert.NoError(t, err)
  4651. assert.True(t, instance.InNotifyTxn())
  4652. err = svc.EndCluster(context.Background(), instance, endFrame)
  4653. assert.NoError(t, err)
  4654. assert.False(t, instance.InNotifyTxn())
  4655. })
  4656. t.Run("delete defers visibility until end cluster", func(t *testing.T) {
  4657. instance := newTestInstance("me")
  4658. deleteBody := wire.SNAC_0x13_0x0A_FeedbagDeleteItem{
  4659. Items: []wire.FeedbagItem{
  4660. {ClassID: wire.FeedbagClassIdBuddy, Name: "buddy1"},
  4661. },
  4662. }
  4663. messageRelayer := newMockMessageRelayer(t)
  4664. messageRelayer.EXPECT().
  4665. RelayToOtherInstances(matchContext(), instance, mock.Anything).
  4666. Times(3)
  4667. messageRelayer.EXPECT().
  4668. RelayToSelf(matchContext(), instance, mock.Anything).
  4669. Once()
  4670. feedbagManager := newMockFeedbagManager(t)
  4671. feedbagManager.EXPECT().
  4672. FeedbagDelete(matchContext(), me, deleteBody.Items).
  4673. Return(nil)
  4674. buddyBroadcaster := newMockbuddyBroadcaster(t)
  4675. buddyBroadcaster.EXPECT().
  4676. BroadcastVisibility(matchContext(), matchSession(me), []state.IdentScreenName{buddy1}, true).
  4677. Return(nil).
  4678. Once()
  4679. svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
  4680. svc.buddyBroadcaster = buddyBroadcaster
  4681. svc.StartCluster(context.Background(), instance, startFrame, startBody)
  4682. _, err := svc.DeleteItem(context.Background(), instance, upsertFrame, deleteBody)
  4683. assert.NoError(t, err)
  4684. err = svc.EndCluster(context.Background(), instance, endFrame)
  4685. assert.NoError(t, err)
  4686. })
  4687. t.Run("pdinfo upsert defers broadcast all until end cluster", func(t *testing.T) {
  4688. instance := newTestInstance("me")
  4689. pdinfoItems := []wire.FeedbagItem{{ClassID: wire.FeedbagClassIdPdinfo}}
  4690. messageRelayer := newMockMessageRelayer(t)
  4691. messageRelayer.EXPECT().
  4692. RelayToOtherInstances(matchContext(), instance, mock.Anything).
  4693. Times(3)
  4694. messageRelayer.EXPECT().
  4695. RelayToSelf(matchContext(), instance, mock.Anything).
  4696. Once()
  4697. feedbagManager := newMockFeedbagManager(t)
  4698. feedbagManager.EXPECT().
  4699. FeedbagUpsert(matchContext(), me, pdinfoItems).
  4700. Return(nil)
  4701. buddyBroadcaster := newMockbuddyBroadcaster(t)
  4702. buddyBroadcaster.EXPECT().
  4703. BroadcastVisibility(
  4704. matchContext(),
  4705. matchSession(me),
  4706. mock.MatchedBy(func(filter []state.IdentScreenName) bool { return len(filter) == 0 }),
  4707. true,
  4708. ).
  4709. Return(nil).
  4710. Once()
  4711. svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
  4712. svc.buddyBroadcaster = buddyBroadcaster
  4713. svc.StartCluster(context.Background(), instance, startFrame, startBody)
  4714. _, err := svc.UpsertItem(context.Background(), instance, upsertFrame, pdinfoItems)
  4715. assert.NoError(t, err)
  4716. err = svc.EndCluster(context.Background(), instance, endFrame)
  4717. assert.NoError(t, err)
  4718. })
  4719. }
  4720. func TestFeedbagService_ForwardICQAuthEvents(t *testing.T) {
  4721. sender := newTestInstance("100001", sessOptUIN(100001))
  4722. recipient := state.NewIdentScreenName("100002")
  4723. tests := []struct {
  4724. // name is the unit test name
  4725. name string
  4726. // authMsg is the ICQ channel-4 message to forward
  4727. authMsg wire.ICBMCh4Message
  4728. // buddySess is the online session for the recipient, or nil if offline
  4729. buddySess *state.Session
  4730. // mockParams is the list of params sent to mocks that satisfy this
  4731. // method's dependencies
  4732. mockParams mockParams
  4733. // expectICBM is true when ForwardICQAuthEvents should route via icbmSender
  4734. expectICBM bool
  4735. // wantICBMBody is the expected ICBM body sent via icbmSender (when expectICBM is true)
  4736. wantICBMBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost
  4737. // wantErr is the expected error
  4738. wantErr error
  4739. }{
  4740. {
  4741. name: "auth OK - feedbag recipient receives PreAuthorizedBuddy SNAC",
  4742. authMsg: wire.ICBMCh4Message{
  4743. MessageType: wire.ICBMMsgTypeAuthOK,
  4744. },
  4745. buddySess: func() *state.Session {
  4746. s := state.NewSession()
  4747. s.SetIdentScreenName(recipient)
  4748. s.SetUsesFeedbag()
  4749. return s
  4750. }(),
  4751. mockParams: mockParams{
  4752. sessionRetrieverParams: sessionRetrieverParams{
  4753. retrieveSessionParams: retrieveSessionParams{
  4754. {screenName: recipient},
  4755. },
  4756. },
  4757. contactPreAuthorizerParams: contactPreAuthorizerParams{
  4758. recordPreAuthParams: recordPreAuthParams{
  4759. {owner: sender.IdentScreenName(), buddy: recipient},
  4760. },
  4761. },
  4762. feedbagManagerParams: feedbagManagerParams{
  4763. feedbagParams: feedbagParams{
  4764. {screenName: recipient, results: []wire.FeedbagItem{}},
  4765. },
  4766. },
  4767. relationshipFetcherParams: relationshipFetcherParams{
  4768. relationshipParams: relationshipParams{
  4769. {me: sender.IdentScreenName(), them: recipient, result: state.Relationship{}},
  4770. },
  4771. },
  4772. messageRelayerParams: messageRelayerParams{
  4773. relayToScreenNameParams: relayToScreenNameParams{
  4774. {
  4775. screenName: recipient,
  4776. message: wire.SNACMessage{
  4777. Frame: wire.SNACFrame{
  4778. FoodGroup: wire.Feedbag,
  4779. SubGroup: wire.FeedbagPreAuthorizedBuddy,
  4780. },
  4781. Body: wire.SNAC_0x13_0x15_FeedbagPreAuthorizedBuddy{
  4782. ScreenName: sender.DisplayScreenName().String(),
  4783. Flags: 0,
  4784. },
  4785. },
  4786. },
  4787. },
  4788. },
  4789. },
  4790. },
  4791. {
  4792. name: "auth OK - offline recipient receives legacy ICQ auth OK",
  4793. authMsg: wire.ICBMCh4Message{
  4794. MessageType: wire.ICBMMsgTypeAuthOK,
  4795. },
  4796. mockParams: mockParams{
  4797. sessionRetrieverParams: sessionRetrieverParams{
  4798. retrieveSessionParams: retrieveSessionParams{
  4799. {screenName: recipient},
  4800. },
  4801. },
  4802. contactPreAuthorizerParams: contactPreAuthorizerParams{
  4803. recordPreAuthParams: recordPreAuthParams{
  4804. {owner: sender.IdentScreenName(), buddy: recipient},
  4805. },
  4806. },
  4807. },
  4808. expectICBM: true,
  4809. wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  4810. ChannelID: wire.ICBMChannelICQ,
  4811. ScreenName: recipient.String(),
  4812. TLVRestBlock: wire.TLVRestBlock{
  4813. TLVList: wire.TLVList{
  4814. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  4815. UIN: sender.UIN(),
  4816. MessageType: wire.ICBMMsgTypeAuthOK,
  4817. }),
  4818. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  4819. },
  4820. },
  4821. },
  4822. },
  4823. {
  4824. name: "auth deny - feedbag recipient receives RespondAuthorizeToClient SNAC",
  4825. authMsg: wire.ICBMCh4Message{
  4826. MessageType: wire.ICBMMsgTypeAuthDeny,
  4827. Message: "no thanks",
  4828. },
  4829. buddySess: func() *state.Session {
  4830. s := state.NewSession()
  4831. s.SetIdentScreenName(recipient)
  4832. s.SetUsesFeedbag()
  4833. return s
  4834. }(),
  4835. mockParams: mockParams{
  4836. sessionRetrieverParams: sessionRetrieverParams{
  4837. retrieveSessionParams: retrieveSessionParams{
  4838. {screenName: recipient},
  4839. },
  4840. },
  4841. messageRelayerParams: messageRelayerParams{
  4842. relayToScreenNameParams: relayToScreenNameParams{
  4843. {
  4844. screenName: recipient,
  4845. message: wire.SNACMessage{
  4846. Frame: wire.SNACFrame{
  4847. FoodGroup: wire.Feedbag,
  4848. SubGroup: wire.FeedbagRespondAuthorizeToClient,
  4849. Flags: wire.SNACFlagsExtendedInfo,
  4850. },
  4851. Body: wire.SNAC_0x13_0x1B_FeedbagRespondAuthorizeToClient{
  4852. TLVLBlock: wire.TLVLBlock{
  4853. TLVList: wire.TLVList{
  4854. wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
  4855. },
  4856. },
  4857. ScreenName: sender.DisplayScreenName().String(),
  4858. Accepted: 0,
  4859. Reason: "no thanks",
  4860. },
  4861. },
  4862. },
  4863. },
  4864. },
  4865. },
  4866. },
  4867. {
  4868. name: "auth deny - offline recipient receives legacy ICQ auth deny",
  4869. authMsg: wire.ICBMCh4Message{
  4870. MessageType: wire.ICBMMsgTypeAuthDeny,
  4871. Message: "no thanks",
  4872. },
  4873. mockParams: mockParams{
  4874. sessionRetrieverParams: sessionRetrieverParams{
  4875. retrieveSessionParams: retrieveSessionParams{
  4876. {screenName: recipient},
  4877. },
  4878. },
  4879. },
  4880. expectICBM: true,
  4881. wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
  4882. ChannelID: wire.ICBMChannelICQ,
  4883. ScreenName: recipient.String(),
  4884. TLVRestBlock: wire.TLVRestBlock{
  4885. TLVList: wire.TLVList{
  4886. wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
  4887. UIN: sender.UIN(),
  4888. MessageType: wire.ICBMMsgTypeAuthDeny,
  4889. Message: "no thanks",
  4890. }),
  4891. wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
  4892. },
  4893. },
  4894. },
  4895. },
  4896. {
  4897. name: "added - relays FeedbagBuddyAdded SNAC to recipient",
  4898. authMsg: wire.ICBMCh4Message{
  4899. MessageType: wire.ICBMMsgTypeAdded,
  4900. },
  4901. mockParams: mockParams{
  4902. messageRelayerParams: messageRelayerParams{
  4903. relayToScreenNameParams: relayToScreenNameParams{
  4904. {
  4905. screenName: recipient,
  4906. message: wire.SNACMessage{
  4907. Frame: wire.SNACFrame{
  4908. FoodGroup: wire.Feedbag,
  4909. SubGroup: wire.FeedbagBuddyAdded,
  4910. Flags: wire.SNACFlagsExtendedInfo,
  4911. },
  4912. Body: wire.SNAC_0x13_0x1C_FeedbagBuddyAdded{
  4913. TLVLBlock: wire.TLVLBlock{
  4914. TLVList: wire.TLVList{
  4915. wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(4)),
  4916. },
  4917. },
  4918. ScreenName: sender.IdentScreenName().String(),
  4919. },
  4920. },
  4921. },
  4922. },
  4923. },
  4924. },
  4925. },
  4926. {
  4927. name: "auth req - relays FeedbagRequestAuthorizeToClient SNAC to recipient",
  4928. authMsg: wire.ICBMCh4Message{
  4929. MessageType: wire.ICBMMsgTypeAuthReq,
  4930. Message: "11111111\xFE\xFE\xFE\xFE1\xFEplease add me",
  4931. },
  4932. mockParams: mockParams{
  4933. messageRelayerParams: messageRelayerParams{
  4934. relayToScreenNameParams: relayToScreenNameParams{
  4935. {
  4936. screenName: recipient,
  4937. message: wire.SNACMessage{
  4938. Frame: wire.SNACFrame{
  4939. FoodGroup: wire.Feedbag,
  4940. SubGroup: wire.FeedbagRequestAuthorizeToClient,
  4941. Flags: wire.SNACFlagsExtendedInfo,
  4942. },
  4943. Body: wire.SNAC_0x13_0x19_FeedbagRequestAuthorizeToClient{
  4944. TLVLBlock: wire.TLVLBlock{
  4945. TLVList: wire.TLVList{
  4946. wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
  4947. },
  4948. },
  4949. ScreenName: sender.IdentScreenName().String(),
  4950. Reason: "please add me",
  4951. },
  4952. },
  4953. },
  4954. },
  4955. },
  4956. },
  4957. },
  4958. {
  4959. name: "unknown message type - logs warning and returns nil",
  4960. authMsg: wire.ICBMCh4Message{
  4961. MessageType: 0xFF,
  4962. },
  4963. },
  4964. }
  4965. for _, tt := range tests {
  4966. t.Run(tt.name, func(t *testing.T) {
  4967. sessionRetriever := newMockSessionRetriever(t)
  4968. for _, params := range tt.mockParams.retrieveSessionParams {
  4969. sessionRetriever.EXPECT().RetrieveSession(params.screenName).Return(tt.buddySess)
  4970. }
  4971. contactPreAuth := newMockContactPreAuthorizer(t)
  4972. for _, params := range tt.mockParams.recordPreAuthParams {
  4973. contactPreAuth.EXPECT().RecordPreAuth(matchContext(), params.owner, params.buddy).Return(params.err)
  4974. }
  4975. feedbagManager := newMockFeedbagManager(t)
  4976. for _, params := range tt.mockParams.feedbagParams {
  4977. feedbagManager.EXPECT().Feedbag(matchContext(), params.screenName).Return(params.results, params.err)
  4978. }
  4979. relationshipFetcher := newMockRelationshipFetcher(t)
  4980. for _, params := range tt.mockParams.relationshipParams {
  4981. relationshipFetcher.EXPECT().Relationship(matchContext(), params.me, params.them).Return(params.result, params.err)
  4982. }
  4983. messageRelayer := newMockMessageRelayer(t)
  4984. for _, params := range tt.mockParams.relayToScreenNameParams {
  4985. messageRelayer.EXPECT().RelayToScreenName(matchContext(), params.screenName, params.message)
  4986. }
  4987. icbmSender := func(ctx context.Context, instance *state.SessionInstance, inFrame wire.SNACFrame, inBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost) (*wire.SNACMessage, error) {
  4988. if !tt.expectICBM {
  4989. t.Fatalf("unexpected icbmSender call")
  4990. }
  4991. assert.Equal(t, wire.SNACFrame{FoodGroup: wire.ICBM, SubGroup: wire.ICBMChannelMsgToHost}, inFrame)
  4992. assert.Equal(t, sender.IdentScreenName(), instance.IdentScreenName())
  4993. wantBody := tt.wantICBMBody
  4994. wantBody.Cookie = 0
  4995. haveBody := inBody
  4996. haveBody.Cookie = 0
  4997. assert.Equal(t, wantBody, haveBody)
  4998. return nil, tt.wantErr
  4999. }
  5000. svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, relationshipFetcher, sessionRetriever, contactPreAuth, nil, newMockBuddyAddedNotifierDeduper(t))
  5001. svc.icbmSender = icbmSender
  5002. err := svc.ForwardICQAuthEvents(context.Background(), sender.IdentScreenName(), recipient, tt.authMsg)
  5003. assert.ErrorIs(t, err, tt.wantErr)
  5004. })
  5005. }
  5006. }