| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099 |
- package foodgroup
- import (
- "bytes"
- "context"
- "fmt"
- "log/slog"
- "testing"
- "time"
- "github.com/mk6i/open-oscar-server/state"
- "github.com/mk6i/open-oscar-server/wire"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/mock"
- )
- func TestFeedbagService_Query(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // instance is the session of the user adding to feedbag
- instance *state.SessionInstance
- // inputSNAC is the SNAC sent from the client to the server
- inputSNAC wire.SNACMessage
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- // expectOutput is the SNAC sent from the server to client
- expectOutput *wire.SNACMessage
- }{
- {
- name: "retrieve empty feedbag",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("me"),
- results: []wire.FeedbagItem{},
- },
- },
- feedbagLastModifiedParams: feedbagLastModifiedParams{},
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagReply,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x06_FeedbagReply{
- Items: []wire.FeedbagItem{},
- },
- },
- },
- {
- name: "retrieve feedbag with items",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("me"),
- results: []wire.FeedbagItem{
- {
- Name: "buddy1",
- },
- {
- Name: "buddy2",
- },
- },
- },
- },
- feedbagLastModifiedParams: feedbagLastModifiedParams{
- {
- screenName: state.NewIdentScreenName("me"),
- result: time.UnixMilli(1696472198082),
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagReply,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x06_FeedbagReply{
- Version: 0,
- Items: []wire.FeedbagItem{
- {
- Name: "buddy1",
- },
- {
- Name: "buddy2",
- },
- },
- LastUpdate: uint32(time.UnixMilli(1696472198082).Unix()),
- },
- },
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- feedbagManager := newMockFeedbagManager(t)
- for _, params := range tc.mockParams.feedbagParams {
- feedbagManager.EXPECT().
- Feedbag(matchContext(), params.screenName).
- Return(params.results, nil)
- }
- for _, params := range tc.mockParams.feedbagLastModifiedParams {
- feedbagManager.EXPECT().
- FeedbagLastModified(matchContext(), params.screenName).
- Return(params.result, nil)
- }
- svc := FeedbagService{
- feedbagManager: feedbagManager,
- }
- outputSNAC, err := svc.Query(context.Background(), tc.instance, tc.inputSNAC.Frame)
- assert.NoError(t, err)
- assert.Equal(t, *tc.expectOutput, outputSNAC)
- })
- }
- }
- func TestFeedbagService_QueryIfModified(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // instance is the session of the user adding to feedbag
- instance *state.SessionInstance
- // inputSNAC is the SNAC sent from the client to the server
- inputSNAC wire.SNACMessage
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- // expectOutput is the SNAC sent from the server to client
- expectOutput *wire.SNACMessage
- }{
- {
- name: "retrieve empty feedbag",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x05_FeedbagQueryIfModified{
- LastUpdate: uint32(time.UnixMilli(100000).Unix()),
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("me"),
- results: []wire.FeedbagItem{},
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagReply,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x06_FeedbagReply{
- Items: []wire.FeedbagItem{},
- },
- },
- },
- {
- name: "retrieve feedbag with items",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x05_FeedbagQueryIfModified{
- LastUpdate: uint32(time.UnixMilli(100000).Unix()),
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("me"),
- results: []wire.FeedbagItem{
- {
- Name: "buddy1",
- },
- {
- Name: "buddy2",
- },
- },
- },
- },
- feedbagLastModifiedParams: feedbagLastModifiedParams{
- {
- screenName: state.NewIdentScreenName("me"),
- result: time.UnixMilli(200000),
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagReply,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x06_FeedbagReply{
- Version: 0,
- Items: []wire.FeedbagItem{
- {
- Name: "buddy1",
- },
- {
- Name: "buddy2",
- },
- },
- LastUpdate: uint32(time.UnixMilli(200000).Unix()),
- },
- },
- },
- {
- name: "retrieve not-modified response",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x05_FeedbagQueryIfModified{
- LastUpdate: uint32(time.UnixMilli(200000).Unix()),
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("me"),
- results: []wire.FeedbagItem{
- {
- Name: "buddy1",
- },
- {
- Name: "buddy2",
- },
- },
- },
- },
- feedbagLastModifiedParams: feedbagLastModifiedParams{
- {
- screenName: state.NewIdentScreenName("me"),
- result: time.UnixMilli(100000),
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagReplyNotModified,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x05_FeedbagQueryIfModified{
- LastUpdate: uint32(time.UnixMilli(100000).Unix()),
- Count: 2,
- },
- },
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- //
- // initialize dependencies
- //
- feedbagManager := newMockFeedbagManager(t)
- for _, params := range tc.mockParams.feedbagParams {
- feedbagManager.EXPECT().
- Feedbag(matchContext(), params.screenName).
- Return(params.results, nil)
- }
- for _, params := range tc.mockParams.feedbagLastModifiedParams {
- feedbagManager.EXPECT().
- FeedbagLastModified(matchContext(), params.screenName).
- Return(params.result, nil)
- }
- //
- // send input SNAC
- //
- svc := FeedbagService{
- feedbagManager: feedbagManager,
- }
- outputSNAC, err := svc.QueryIfModified(context.Background(), tc.instance, tc.inputSNAC.Frame,
- tc.inputSNAC.Body.(wire.SNAC_0x13_0x05_FeedbagQueryIfModified))
- assert.NoError(t, err)
- //
- // verify output
- //
- assert.Equal(t, *tc.expectOutput, outputSNAC)
- })
- }
- }
- func TestFeedbagService_UpsertItem_AlInfoRejected(t *testing.T) {
- instance := newTestInstance("me")
- inFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagInsertItem, RequestID: 1234}
- items := []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIdAlInfo, Name: "linkeduser"},
- }
- // feedbagManager expects no FeedbagUpsert call since AlInfo items are rejected
- feedbagManager := newMockFeedbagManager(t)
- // messageRelayer expects no calls — handler returns early with error response
- messageRelayer := newMockMessageRelayer(t)
- svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, nil, nil, nil, nil, nil)
- output, err := svc.UpsertItem(context.Background(), instance, inFrame, items)
- assert.NoError(t, err)
- assert.Equal(t, &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeInsufficientRights,
- },
- }, output)
- }
- func TestFeedbagService_DeleteItem_AlInfoIgnored(t *testing.T) {
- instance := newTestInstance("me")
- inFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagDeleteItem, RequestID: 1234}
- inBody := wire.SNAC_0x13_0x0A_FeedbagDeleteItem{
- Items: []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIdAlInfo, Name: "linkeduser"},
- },
- }
- feedbagManager := newMockFeedbagManager(t)
- feedbagManager.EXPECT().
- FeedbagDelete(matchContext(), state.NewIdentScreenName("me"), inBody.Items).
- Return(nil)
- messageRelayer := newMockMessageRelayer(t)
- messageRelayer.EXPECT().
- RelayToSelf(mock.Anything, mock.Anything, wire.SNACMessage{
- Frame: wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagStatus, RequestID: 1234},
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{Results: []uint16{0x0000}},
- })
- messageRelayer.EXPECT().
- RelayToOtherInstances(mock.Anything, mock.Anything, wire.SNACMessage{
- Frame: wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagDeleteItem, RequestID: wire.ReqIDFromServer},
- Body: inBody,
- })
- buddyBroadcaster := newMockbuddyBroadcaster(t)
- buddyBroadcaster.EXPECT().
- BroadcastVisibility(mock.Anything, matchSession(state.NewIdentScreenName("me")), []state.IdentScreenName(nil), true).
- Return(nil)
- svc := FeedbagService{
- buddyBroadcaster: buddyBroadcaster,
- feedbagManager: feedbagManager,
- messageRelayer: messageRelayer,
- }
- output, err := svc.DeleteItem(context.Background(), instance, inFrame, inBody)
- assert.NoError(t, err)
- assert.Nil(t, output)
- }
- func TestFeedbagService_RightsQuery(t *testing.T) {
- svc := NewFeedbagService(nil, nil, nil, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
- outputSNAC := svc.RightsQuery(context.Background(), wire.SNACFrame{RequestID: 1234})
- expectSNAC := wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRightsReply,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x03_FeedbagRightsReply{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagRightsMaxItemAttrs, uint16(200)),
- wire.NewTLVBE(wire.FeedbagRightsMaxItemsByClass, []uint16{
- 61,
- 61,
- 100,
- 100,
- 1,
- 1,
- 50,
- 0x00,
- 0x00,
- 3,
- 0x00,
- 0x00,
- 0x00,
- 128,
- 255,
- 20,
- 200,
- 1,
- 0x00,
- 1,
- 200,
- 0x00,
- 0x00,
- 0x00,
- 4,
- }),
- wire.NewTLVBE(wire.FeedbagRightsMaxClientItems, uint16(200)),
- wire.NewTLVBE(wire.FeedbagRightsMaxItemNameLen, uint16(200)),
- wire.NewTLVBE(wire.FeedbagRightsMaxRecentBuddies, uint16(200)),
- wire.NewTLVBE(wire.FeedbagRightsInteractionBuddies, uint16(200)),
- wire.NewTLVBE(wire.FeedbagRightsInteractionHalfLife, uint16(200)),
- wire.NewTLVBE(wire.FeedbagRightsInteractionMaxScore, uint16(200)),
- wire.NewTLVBE(wire.FeedbagRightsMaxBuddiesPerGroup, uint16(200)),
- wire.NewTLVBE(wire.FeedbagRightsMaxMegaBots, uint16(200)),
- wire.NewTLVBE(wire.FeedbagRightsMaxSmartGroups, uint16(100)),
- },
- },
- },
- }
- assert.Equal(t, expectSNAC, outputSNAC)
- }
- func TestFeedbagService_UpsertItem(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // instance is the session of the user adding to feedbag
- instance *state.SessionInstance
- // inputSNAC is the SNAC sent from the client to the server
- inputSNAC wire.SNACMessage
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- // expectOutput is the SNAC sent from the server to client
- expectOutput *wire.SNACMessage
- // instanceMatch verifies the session state after completion
- instanceMatch func(instance *state.SessionInstance)
- // expectICBM is true when UpsertItem should call icbmSender
- expectICBM bool
- // wantICBMBody is the expected ICBM body (Cookie zeroed for comparison)
- wantICBMBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost
- }{
- {
- name: "add buddies",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIDPermit,
- Name: "buddy1",
- },
- {
- ClassID: wire.FeedbagClassIDPermit,
- Name: "buddy2",
- },
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIDPermit,
- Name: "buddy1",
- },
- {
- ClassID: wire.FeedbagClassIDPermit,
- Name: "buddy2",
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("me"),
- filter: []state.IdentScreenName{
- state.NewIdentScreenName("buddy1"),
- state.NewIdentScreenName("buddy2"),
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIDPermit,
- Name: "buddy1",
- },
- {
- ClassID: wire.FeedbagClassIDPermit,
- Name: "buddy2",
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000, 0x0000},
- },
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "defer visibility during notify txn",
- instance: func() *state.SessionInstance {
- inst := newTestInstance("me")
- inst.BeginNotifyTxn()
- return inst
- }(),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIDPermit, Name: "buddy1"},
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIDPermit, Name: "buddy1"},
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIDPermit, Name: "buddy1"},
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- },
- instanceMatch: func(instance *state.SessionInstance) {
- assert.True(t, instance.InNotifyTxn())
- },
- expectOutput: nil,
- },
- {
- name: "add 2 ICQ buddies one that requires authorization",
- instance: newTestInstance("100001", sessOptUIN(100001)),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123400", // requires authorization
- },
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123401", // does not require authorization
- },
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("100001"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123401",
- },
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("123401"),
- result: nil,
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("100001"),
- filter: []state.IdentScreenName{
- state.NewIdentScreenName("123401"),
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("100001"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123401",
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("100001"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x000E, 0x0000},
- },
- },
- },
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- requiresAuthorizationParams: requiresAuthorizationParams{
- {owner: state.NewIdentScreenName("123400"), requester: state.NewIdentScreenName("100001"), result: true},
- {owner: state.NewIdentScreenName("123401"), requester: state.NewIdentScreenName("100001"), result: false},
- },
- },
- buddyAddedNotifierDeduperParams: buddyAddedNotifierDeduperParams{
- hasBuddyAddedNotificationParams: hasBuddyAddedNotificationParams{
- {granter: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("123401"), result: false},
- },
- recordBuddyAddedNotificationParams: recordBuddyAddedNotificationParams{
- {granter: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("123401")},
- },
- },
- },
- expectOutput: nil,
- expectICBM: true,
- wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "123401",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAdded,
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- {
- name: "add ICQ buddy auth-required but pre-authorized",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123400",
- },
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123400",
- },
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("123400"),
- result: nil,
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("me"),
- filter: []state.IdentScreenName{
- state.NewIdentScreenName("123400"),
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123400",
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- requiresAuthorizationParams: requiresAuthorizationParams{
- {owner: state.NewIdentScreenName("123400"), requester: state.NewIdentScreenName("me"), result: false},
- },
- },
- buddyAddedNotifierDeduperParams: buddyAddedNotifierDeduperParams{
- hasBuddyAddedNotificationParams: hasBuddyAddedNotificationParams{
- {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400"), result: false},
- },
- recordBuddyAddedNotificationParams: recordBuddyAddedNotificationParams{
- {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400")},
- },
- },
- },
- expectOutput: nil,
- expectICBM: true,
- wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "123400",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 0,
- MessageType: wire.ICBMMsgTypeAdded,
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- {
- name: "disable typing events",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBuddyPrefs, uint32(wire.SNACFlagsExtendedInfo)),
- },
- },
- },
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBuddyPrefs, uint32(wire.SNACFlagsExtendedInfo)),
- },
- },
- },
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBuddyPrefs, uint32(wire.SNACFlagsExtendedInfo)),
- },
- },
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "enable typing events",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.SetBuddyPref(nil, wire.FeedbagBuddyPrefsDiscloseTyping, true),
- },
- },
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.SetBuddyPref(nil, wire.FeedbagBuddyPrefsDiscloseTyping, true),
- },
- },
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.SetBuddyPref(nil, wire.FeedbagBuddyPrefsDiscloseTyping, true),
- },
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- },
- expectOutput: nil,
- instanceMatch: func(instance *state.SessionInstance) {
- assert.True(t, instance.TypingEventsEnabled())
- },
- },
- {
- name: "block buddies",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIDDeny,
- Name: "buddy1",
- },
- {
- ClassID: wire.FeedbagClassIDDeny,
- Name: "buddy2",
- },
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIDDeny,
- Name: "buddy1",
- },
- {
- ClassID: wire.FeedbagClassIDDeny,
- Name: "buddy2",
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("me"),
- filter: []state.IdentScreenName{
- state.NewIdentScreenName("buddy1"),
- state.NewIdentScreenName("buddy2"),
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIDDeny,
- Name: "buddy1",
- },
- {
- ClassID: wire.FeedbagClassIDDeny,
- Name: "buddy2",
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000, 0x0000},
- },
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "permit buddies",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIDPermit,
- Name: "buddy1",
- },
- {
- ClassID: wire.FeedbagClassIDPermit,
- Name: "buddy2",
- },
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIDPermit,
- Name: "buddy1",
- },
- {
- ClassID: wire.FeedbagClassIDPermit,
- Name: "buddy2",
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("me"),
- filter: []state.IdentScreenName{
- state.NewIdentScreenName("buddy1"),
- state.NewIdentScreenName("buddy2"),
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIDPermit,
- Name: "buddy1",
- },
- {
- ClassID: wire.FeedbagClassIDPermit,
- Name: "buddy2",
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000, 0x0000},
- },
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "set privacy mode",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdPdinfo,
- },
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdPdinfo,
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("me"),
- filter: nil,
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdPdinfo,
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "user blocks themselves, receives error",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIDDeny,
- Name: "me",
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeNotSupportedByHost,
- },
- },
- },
- {
- name: "add icon hash to feedbag, icon doesn't exist in BART store, instruct client to upload icon",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
- ClassID: wire.FeedbagClassIdBart,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
- Flags: wire.BARTFlagsCustom,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- }),
- },
- },
- },
- },
- },
- },
- mockParams: mockParams{
- bartItemManagerParams: bartItemManagerParams{
- bartItemManagerRetrieveParams: bartItemManagerRetrieveParams{
- {
- itemHash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- result: []byte{}, // icon doesn't exist
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
- ClassID: wire.FeedbagClassIdBart,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
- Flags: wire.BARTFlagsCustom,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- }),
- },
- },
- },
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.OService,
- SubGroup: wire.OServiceUserInfoUpdate,
- },
- Body: func(val any) bool {
- snac, ok := val.(wire.SNAC_0x01_0x0F_OServiceUserInfoUpdate)
- if !ok {
- return false
- }
- bartID, exists := snac.UserInfo[0].Bytes(wire.OServiceUserInfoBARTInfo)
- return assert.True(t, exists) &&
- assert.Equal(t, "me", snac.UserInfo[0].ScreenName) &&
- assert.True(t, bytes.Contains(bartID, []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'}), "user info BART hash doesn't match")
- },
- },
- },
- },
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
- ClassID: wire.FeedbagClassIdBart,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
- Flags: wire.BARTFlagsCustom,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.OService,
- SubGroup: wire.OServiceBartReply,
- },
- Body: wire.SNAC_0x01_0x21_OServiceBARTReply{
- BARTID: wire.BARTID{
- Type: wire.BARTTypesBuddyIcon,
- BARTInfo: wire.BARTInfo{
- Flags: wire.BARTFlagsCustom | wire.BARTFlagsUnknown,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- },
- },
- },
- },
- },
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- },
- expectOutput: nil,
- instanceMatch: func(instance *state.SessionInstance) {
- have, hasIcon := instance.Session().BuddyIcon()
- assert.True(t, hasIcon)
- want := wire.BARTID{
- Type: wire.BARTTypesBuddyIcon,
- BARTInfo: wire.BARTInfo{
- Flags: wire.BARTFlagsCustom | wire.BARTFlagsUnknown,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- },
- }
- assert.Equal(t, want, have)
- },
- },
- {
- name: "add icon hash to feedbag, icon already exists in BART store, notify buddies about icon change",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
- ClassID: wire.FeedbagClassIdBart,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
- Flags: wire.BARTFlagsCustom,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- }),
- },
- },
- },
- },
- },
- },
- mockParams: mockParams{
- bartItemManagerParams: bartItemManagerParams{
- bartItemManagerRetrieveParams: bartItemManagerRetrieveParams{
- {
- itemHash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- result: []byte{'i', 'c', 'o', 'n', 'd', 'a', 't', 'a'},
- err: nil,
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
- ClassID: wire.FeedbagClassIdBart,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
- Flags: wire.BARTFlagsCustom,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- }),
- },
- },
- },
- },
- },
- },
- adjacentUsersParams: adjacentUsersParams{},
- feedbagParams: feedbagParams{},
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.OService,
- SubGroup: wire.OServiceUserInfoUpdate,
- },
- Body: func(val any) bool {
- snac, ok := val.(wire.SNAC_0x01_0x0F_OServiceUserInfoUpdate)
- if !ok {
- return false
- }
- bartID, exists := snac.UserInfo[0].Bytes(wire.OServiceUserInfoBARTInfo)
- return assert.True(t, exists) &&
- assert.Equal(t, "me", snac.UserInfo[0].ScreenName) &&
- assert.True(t, bytes.Contains(bartID, []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'}), "user info BART hash doesn't match")
- },
- },
- },
- },
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
- ClassID: wire.FeedbagClassIdBart,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
- Flags: wire.BARTFlagsCustom,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.OService,
- SubGroup: wire.OServiceBartReply,
- },
- Body: wire.SNAC_0x01_0x21_OServiceBARTReply{
- BARTID: wire.BARTID{
- Type: wire.BARTTypesBuddyIcon,
- BARTInfo: wire.BARTInfo{
- Flags: wire.BARTFlagsCustom | wire.BARTFlagsKnown,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- },
- },
- },
- },
- },
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastBuddyArrivedParams: broadcastBuddyArrivedParams{
- {
- screenName: state.DisplayScreenName("me"),
- },
- },
- },
- },
- expectOutput: nil,
- instanceMatch: func(instance *state.SessionInstance) {
- have, hasIcon := instance.Session().BuddyIcon()
- assert.True(t, hasIcon)
- want := wire.BARTID{
- Type: wire.BARTTypesBuddyIcon,
- BARTInfo: wire.BARTInfo{
- Flags: wire.BARTFlagsCustom | wire.BARTFlagsKnown,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- },
- }
- assert.Equal(t, want, have)
- },
- },
- {
- name: "clear icon, notify buddies about icon change",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
- ClassID: wire.FeedbagClassIdBart,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
- Flags: wire.BARTFlagsKnown,
- Hash: wire.GetClearIconHash(),
- }),
- },
- },
- },
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
- ClassID: wire.FeedbagClassIdBart,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
- Flags: wire.BARTFlagsKnown,
- Hash: wire.GetClearIconHash(),
- }),
- },
- },
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastBuddyArrivedParams: broadcastBuddyArrivedParams{
- {
- screenName: state.DisplayScreenName("me"),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- Name: fmt.Sprintf("%d", wire.BARTTypesBuddyIcon),
- ClassID: wire.FeedbagClassIdBart,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
- Hash: wire.GetClearIconHash(),
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.OService,
- SubGroup: wire.OServiceBartReply,
- },
- Body: wire.SNAC_0x01_0x21_OServiceBARTReply{
- BARTID: wire.BARTID{
- Type: wire.BARTTypesBuddyIcon,
- BARTInfo: wire.BARTInfo{
- Flags: wire.BARTFlagsKnown,
- Hash: wire.GetClearIconHash(),
- },
- },
- },
- },
- },
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.OService,
- SubGroup: wire.OServiceUserInfoUpdate,
- },
- Body: func(val any) bool {
- snac, ok := val.(wire.SNAC_0x01_0x0F_OServiceUserInfoUpdate)
- if !ok {
- return false
- }
- bartID, exists := snac.UserInfo[0].Bytes(wire.OServiceUserInfoBARTInfo)
- return assert.True(t, exists) &&
- assert.Equal(t, "me", snac.UserInfo[0].ScreenName) &&
- assert.True(t, bytes.Contains(bartID, wire.GetClearIconHash()), "user info BART hash doesn't match")
- },
- },
- },
- },
- },
- },
- expectOutput: nil,
- instanceMatch: func(instance *state.SessionInstance) {
- bartInfo, hasIcon := instance.Session().BuddyIcon()
- assert.True(t, hasIcon)
- assert.Equal(t, wire.GetClearIconHash(), bartInfo.Hash)
- },
- },
- {
- name: "add non-icon to feedbag, icon doesn't exist in BART store, don't broadcast change",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- Name: fmt.Sprintf("%d", wire.BARTTypesArriveSound),
- ClassID: wire.FeedbagClassIdBart,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
- Flags: wire.BARTFlagsCustom,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- }),
- },
- },
- },
- },
- },
- },
- mockParams: mockParams{
- bartItemManagerParams: bartItemManagerParams{
- bartItemManagerRetrieveParams: bartItemManagerRetrieveParams{
- {
- itemHash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- result: []byte{}, // icon doesn't exist
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- Name: fmt.Sprintf("%d", wire.BARTTypesArriveSound),
- ClassID: wire.FeedbagClassIdBart,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
- Flags: wire.BARTFlagsCustom,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- }),
- },
- },
- },
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- Name: fmt.Sprintf("%d", wire.BARTTypesArriveSound),
- ClassID: wire.FeedbagClassIdBart,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesBartInfo, wire.BARTInfo{
- Flags: wire.BARTFlagsCustom,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.OService,
- SubGroup: wire.OServiceBartReply,
- },
- Body: wire.SNAC_0x01_0x21_OServiceBARTReply{
- BARTID: wire.BARTID{
- Type: wire.BARTTypesArriveSound,
- BARTInfo: wire.BARTInfo{
- Flags: wire.BARTFlagsCustom | wire.BARTFlagsUnknown,
- Hash: []byte{'t', 'h', 'e', 'h', 'a', 's', 'h'},
- },
- },
- },
- },
- },
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- },
- expectOutput: nil,
- instanceMatch: func(instance *state.SessionInstance) {
- _, hasIcon := instance.Session().BuddyIcon()
- assert.False(t, hasIcon)
- },
- },
- {
- name: "add ICQ buddy online with feedbag: relay FeedbagBuddyAdded",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123400",
- },
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123400",
- },
- },
- },
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- requiresAuthorizationParams: requiresAuthorizationParams{
- {owner: state.NewIdentScreenName("123400"), requester: state.NewIdentScreenName("me"), result: false},
- },
- },
- buddyAddedNotifierDeduperParams: buddyAddedNotifierDeduperParams{
- hasBuddyAddedNotificationParams: hasBuddyAddedNotificationParams{
- {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400"), result: false},
- },
- recordBuddyAddedNotificationParams: recordBuddyAddedNotificationParams{
- {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400")},
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("123400"),
- result: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(state.NewIdentScreenName("123400"))
- s.SetUsesFeedbag()
- return s
- }(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: state.NewIdentScreenName("123400"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagBuddyAdded,
- Flags: wire.SNACFlagsExtendedInfo,
- },
- Body: wire.SNAC_0x13_0x1C_FeedbagBuddyAdded{
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(4)),
- },
- },
- ScreenName: "me",
- },
- },
- },
- },
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123400",
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("me"),
- filter: []state.IdentScreenName{
- state.NewIdentScreenName("123400"),
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "add ICQ buddy online with feedbag: skip FeedbagBuddyAdded when already sent",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123400",
- },
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123400",
- },
- },
- },
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- requiresAuthorizationParams: requiresAuthorizationParams{
- {owner: state.NewIdentScreenName("123400"), requester: state.NewIdentScreenName("me"), result: false},
- },
- },
- buddyAddedNotifierDeduperParams: buddyAddedNotifierDeduperParams{
- hasBuddyAddedNotificationParams: hasBuddyAddedNotificationParams{
- {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400"), result: true},
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123400",
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("me"),
- filter: []state.IdentScreenName{
- state.NewIdentScreenName("123400"),
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "add ICQ buddy online without feedbag: send legacy ICBM added",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123400",
- },
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123400",
- },
- },
- },
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- requiresAuthorizationParams: requiresAuthorizationParams{
- {owner: state.NewIdentScreenName("123400"), requester: state.NewIdentScreenName("me"), result: false},
- },
- },
- buddyAddedNotifierDeduperParams: buddyAddedNotifierDeduperParams{
- hasBuddyAddedNotificationParams: hasBuddyAddedNotificationParams{
- {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400"), result: false},
- },
- recordBuddyAddedNotificationParams: recordBuddyAddedNotificationParams{
- {granter: state.NewIdentScreenName("me"), requester: state.NewIdentScreenName("123400")},
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("123400"),
- result: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(state.NewIdentScreenName("123400"))
- return s
- }(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "123400",
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("me"),
- filter: []state.IdentScreenName{
- state.NewIdentScreenName("123400"),
- },
- },
- },
- },
- },
- expectOutput: nil,
- expectICBM: true,
- wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "123400",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 0,
- MessageType: wire.ICBMMsgTypeAdded,
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- {
- name: "ICQ user adds AIM buddy: expect ICQ user to preauthorize AIM user",
- instance: newTestInstance("100777", sessOptUIN(100777)),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "buddyaim",
- },
- },
- },
- },
- mockParams: mockParams{
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {
- owner: state.NewIdentScreenName("100777"),
- buddy: state.NewIdentScreenName("buddyaim"),
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("100777"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "buddyaim",
- },
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("100777"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "buddyaim",
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("100777"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("100777"),
- filter: []state.IdentScreenName{
- state.NewIdentScreenName("buddyaim"),
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "AIM user adds ICQ buddy pending auth: expect AIM user to send auth request to ICQ user",
- instance: newTestInstance("myaim"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "990011",
- },
- },
- },
- },
- mockParams: mockParams{
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- requiresAuthorizationParams: requiresAuthorizationParams{
- {
- owner: state.NewIdentScreenName("990011"),
- requester: state.NewIdentScreenName("myaim"),
- result: true,
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("myaim"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "990011",
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesPending, []byte{}),
- },
- },
- },
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("myaim"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "990011",
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesPending, []byte{}),
- },
- },
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("myaim"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("myaim"),
- filter: []state.IdentScreenName{
- state.NewIdentScreenName("990011"),
- },
- },
- },
- },
- },
- expectOutput: nil,
- expectICBM: true,
- wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "990011",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 0,
- MessageType: wire.ICBMMsgTypeAuthReq,
- Message: "\xFE\xFE\xFE\xFE1\xFE",
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- {
- // ICQ Lite re-sends a FeedbagUpsert with FeedbagAttributesPending still
- // set after the user clicks OK on the "you were added" notification that
- // arrives when the contact grants authorization. IServerd handles this by
- // stripping SSI_TLV_AUTH from the item before the DB insert (ssi_db.cpp
- // ssi_db_add_item lines 304-308). We do the same: when the client sends
- // a pending-tagged item but RequiresAuthorization returns false (auth was
- // already granted), strip the tag and treat the item as a normal add.
- name: "ICQ user re-upserts ICQ buddy with pending tag after authorization already granted: strip pending tag",
- instance: newTestInstance("100001", sessOptUIN(100001)),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x08_FeedbagInsertItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "990011",
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesPending, []byte{}),
- },
- },
- },
- },
- },
- },
- mockParams: mockParams{
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- requiresAuthorizationParams: requiresAuthorizationParams{
- {
- owner: state.NewIdentScreenName("990011"),
- requester: state.NewIdentScreenName("100001"),
- result: false, // already authorized
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: state.NewIdentScreenName("100001"),
- // pending TLV must be stripped before storage
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "990011",
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{},
- },
- },
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("990011"),
- result: nil,
- },
- },
- },
- buddyAddedNotifierDeduperParams: buddyAddedNotifierDeduperParams{
- hasBuddyAddedNotificationParams: hasBuddyAddedNotificationParams{
- {granter: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("990011"), result: false},
- },
- recordBuddyAddedNotificationParams: recordBuddyAddedNotificationParams{
- {granter: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("990011")},
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("100001"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "990011",
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{},
- },
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("100001"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("100001"),
- filter: []state.IdentScreenName{
- state.NewIdentScreenName("990011"),
- },
- },
- },
- },
- },
- expectOutput: nil,
- expectICBM: true,
- wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "990011",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAdded,
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- feedbagManager := newMockFeedbagManager(t)
- for _, params := range tc.mockParams.feedbagUpsertParams {
- feedbagManager.EXPECT().
- FeedbagUpsert(matchContext(), params.screenName, params.items).
- Return(nil)
- }
- messageRelayer := newMockMessageRelayer(t)
- for _, params := range tc.mockParams.relayToScreenNameParams {
- if matcherFn, ok := params.message.Body.(func(val any) bool); ok {
- messageRelayer.EXPECT().
- RelayToScreenName(matchContext(), params.screenName, mock.MatchedBy(func(message wire.SNACMessage) bool {
- return params.message.Frame == message.Frame &&
- matcherFn(message.Body)
- }))
- } else {
- messageRelayer.EXPECT().
- RelayToScreenName(matchContext(), params.screenName, params.message)
- }
- }
- for _, params := range tc.mockParams.relayToOtherInstancesParams {
- messageRelayer.EXPECT().
- RelayToOtherInstances(mock.Anything, mock.Anything, params.message)
- }
- for _, params := range tc.mockParams.relayToSelfParams {
- messageRelayer.EXPECT().
- RelayToSelf(mock.Anything, mock.Anything, params.message)
- }
- bartItemManager := newMockBARTItemManager(t)
- for _, params := range tc.mockParams.bartItemManagerRetrieveParams {
- bartItemManager.EXPECT().
- BARTItem(matchContext(), params.itemHash).
- Return(params.result, nil)
- }
- buddyUpdateBroadcaster := newMockbuddyBroadcaster(t)
- for _, params := range tc.mockParams.broadcastBuddyArrivedParams {
- buddyUpdateBroadcaster.EXPECT().
- BroadcastBuddyArrived(mock.Anything, state.NewIdentScreenName(params.screenName.String()), mock.MatchedBy(func(userInfo wire.TLVUserInfo) bool {
- return userInfo.ScreenName == params.screenName.String()
- })).
- Return(params.err)
- }
- for _, params := range tc.mockParams.broadcastVisibilityParams {
- buddyUpdateBroadcaster.EXPECT().
- BroadcastVisibility(mock.Anything, matchSession(params.from), params.filter, true).
- Return(params.err)
- }
- contactPreAuth := newMockContactPreAuthorizer(t)
- for _, params := range tc.mockParams.recordPreAuthParams {
- contactPreAuth.EXPECT().RecordPreAuth(matchContext(), params.owner, params.buddy).Return(params.err)
- }
- for _, params := range tc.mockParams.requiresAuthorizationParams {
- contactPreAuth.EXPECT().RequiresAuthorization(matchContext(), params.owner, params.requester).Return(params.result, params.err)
- }
- buddyAddedDeduper := newMockBuddyAddedNotifierDeduper(t)
- for _, params := range tc.mockParams.hasBuddyAddedNotificationParams {
- buddyAddedDeduper.EXPECT().
- HasBuddyAddedNotification(matchContext(), params.granter, params.requester).
- Return(params.result, params.err)
- }
- for _, params := range tc.mockParams.recordBuddyAddedNotificationParams {
- buddyAddedDeduper.EXPECT().
- RecordBuddyAddedNotification(matchContext(), params.granter, params.requester).
- Return(params.err)
- }
- sessionRetriever := newMockSessionRetriever(t)
- for _, params := range tc.mockParams.retrieveSessionParams {
- sessionRetriever.EXPECT().
- RetrieveSession(params.screenName).
- Return(params.result)
- }
- icbmSender := func(ctx context.Context, instance *state.SessionInstance, inFrame wire.SNACFrame, inBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost) (*wire.SNACMessage, error) {
- if !tc.expectICBM {
- t.Fatalf("unexpected icbmSender call")
- }
- wantBody := tc.wantICBMBody
- wantBody.Cookie = 0
- haveBody := inBody
- haveBody.Cookie = 0
- assert.Equal(t, wantBody, haveBody)
- return nil, nil
- }
- svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, bartItemManager, nil, sessionRetriever, contactPreAuth, nil, buddyAddedDeduper)
- svc.buddyBroadcaster = buddyUpdateBroadcaster
- svc.icbmSender = icbmSender
- output, err := svc.UpsertItem(context.Background(), tc.instance, tc.inputSNAC.Frame,
- tc.inputSNAC.Body.(wire.SNAC_0x13_0x08_FeedbagInsertItem).Items)
- assert.NoError(t, err)
- assert.Equal(t, tc.expectOutput, output)
- if tc.instanceMatch != nil {
- tc.instanceMatch(tc.instance)
- }
- })
- }
- }
- func TestFeedbagService_DeleteItem(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // instance is the session of the user adding to feedbag
- instance *state.SessionInstance
- // inputSNAC is the SNAC sent from the client to the server
- inputSNAC wire.SNACMessage
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- // expectOutput is the SNAC sent from the server to client
- expectOutput *wire.SNACMessage
- // checkInstance validates instance state after the call
- checkInstance func(*testing.T, *state.SessionInstance)
- }{
- {
- name: "delete buddies",
- instance: newTestInstance("me"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagDeleteItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0A_FeedbagDeleteItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "buddy1",
- },
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "buddy2",
- },
- {
- ClassID: wire.FeedbagClassIdGroup,
- Name: "group",
- },
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagDeleteParams: feedbagDeleteParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "buddy1",
- },
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "buddy2",
- },
- {
- ClassID: wire.FeedbagClassIdGroup,
- Name: "group",
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("me"),
- filter: []state.IdentScreenName{
- state.NewIdentScreenName("buddy1"),
- state.NewIdentScreenName("buddy2"),
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagDeleteItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x0A_FeedbagDeleteItem{
- Items: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "buddy1",
- },
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: "buddy2",
- },
- {
- ClassID: wire.FeedbagClassIdGroup,
- Name: "group",
- },
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000, 0x0000, 0x0000},
- },
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "defer visibility during notify txn",
- instance: func() *state.SessionInstance {
- inst := newTestInstance("me")
- inst.BeginNotifyTxn()
- return inst
- }(),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagDeleteItem,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0A_FeedbagDeleteItem{
- Items: []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIdBuddy, Name: "buddy1"},
- },
- },
- },
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- feedbagDeleteParams: feedbagDeleteParams{
- {
- screenName: state.NewIdentScreenName("me"),
- items: []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIdBuddy, Name: "buddy1"},
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToOtherInstancesParams: relayToOtherInstancesParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagDeleteItem,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x13_0x0A_FeedbagDeleteItem{
- Items: []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIdBuddy, Name: "buddy1"},
- },
- },
- },
- },
- },
- relayToSelfParams: relayToSelfParams{
- {
- screenName: state.NewIdentScreenName("me"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStatus,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x0E_FeedbagStatus{
- Results: []uint16{0x0000},
- },
- },
- },
- },
- },
- },
- expectOutput: nil,
- checkInstance: func(t *testing.T, instance *state.SessionInstance) {
- assert.True(t, instance.InNotifyTxn())
- },
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- feedbagManager := newMockFeedbagManager(t)
- for _, params := range tc.mockParams.feedbagDeleteParams {
- feedbagManager.EXPECT().
- FeedbagDelete(matchContext(), params.screenName, params.items).
- Return(nil)
- }
- buddyUpdateBroadcast := newMockbuddyBroadcaster(t)
- for _, params := range tc.mockParams.broadcastVisibilityParams {
- buddyUpdateBroadcast.EXPECT().
- BroadcastVisibility(mock.Anything, matchSession(params.from), params.filter, true).
- Return(params.err)
- }
- messageRelayer := newMockMessageRelayer(t)
- for _, params := range tc.mockParams.relayToOtherInstancesParams {
- messageRelayer.EXPECT().
- RelayToOtherInstances(mock.Anything, mock.Anything, params.message)
- }
- for _, params := range tc.mockParams.relayToSelfParams {
- messageRelayer.EXPECT().
- RelayToSelf(mock.Anything, mock.Anything, params.message)
- }
- svc := FeedbagService{
- buddyBroadcaster: buddyUpdateBroadcast,
- feedbagManager: feedbagManager,
- messageRelayer: messageRelayer,
- }
- output, err := svc.DeleteItem(context.Background(), tc.instance, tc.inputSNAC.Frame,
- tc.inputSNAC.Body.(wire.SNAC_0x13_0x0A_FeedbagDeleteItem))
- assert.NoError(t, err)
- assert.Equal(t, output, tc.expectOutput)
- if tc.checkInstance != nil {
- tc.checkInstance(t, tc.instance)
- }
- })
- }
- }
- func TestFeedbagService_Use(t *testing.T) {
- tests := []struct {
- // name is the name of the test
- name string
- // instance is the user's session
- instance *state.SessionInstance
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- // checkSession validates session and instance state after the call
- checkSession func(*testing.T, *state.SessionInstance)
- // wantErr indicates an error is expected
- wantErr error
- }{
- {
- name: "enable user's feedbag, no feedbag buddy params item",
- instance: newTestInstance("me"),
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- useParams: useParams{
- {
- screenName: state.NewIdentScreenName("me"),
- },
- },
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("me"),
- },
- },
- },
- },
- checkSession: func(t *testing.T, instance *state.SessionInstance) {
- assert.True(t, instance.ContactsInit())
- assert.True(t, instance.Session().UsesFeedbag())
- assert.False(t, instance.Session().TypingEventsEnabled())
- },
- },
- {
- name: "enable user's feedbag and set typing events disabled",
- instance: newTestInstance("me"),
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- useParams: useParams{
- {
- screenName: state.NewIdentScreenName("me"),
- },
- },
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("me"),
- results: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.SetBuddyPref(nil, wire.FeedbagBuddyPrefsDiscloseTyping, false),
- },
- },
- },
- },
- },
- },
- },
- checkSession: func(t *testing.T, instance *state.SessionInstance) {
- assert.True(t, instance.ContactsInit())
- assert.True(t, instance.Session().UsesFeedbag())
- assert.False(t, instance.Session().TypingEventsEnabled())
- },
- },
- {
- name: "enable user's feedbag and set typing events enabled",
- instance: newTestInstance("me"),
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- useParams: useParams{
- {
- screenName: state.NewIdentScreenName("me"),
- },
- },
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("me"),
- results: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.SetBuddyPref(nil, wire.FeedbagBuddyPrefsDiscloseTyping, true),
- },
- },
- },
- },
- },
- },
- },
- checkSession: func(t *testing.T, instance *state.SessionInstance) {
- assert.True(t, instance.ContactsInit())
- assert.True(t, instance.Session().UsesFeedbag())
- assert.True(t, instance.Session().TypingEventsEnabled())
- },
- },
- {
- name: "ICQ Lite order: feedbag use after ClientOnline broadcasts presence",
- instance: newTestInstance("me", sessOptSignonComplete),
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- useParams: useParams{
- {
- screenName: state.NewIdentScreenName("me"),
- },
- },
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("me"),
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("me"),
- filter: nil,
- doSendDepartures: false,
- },
- },
- },
- },
- checkSession: func(t *testing.T, instance *state.SessionInstance) {
- assert.True(t, instance.ContactsInit())
- assert.True(t, instance.Session().UsesFeedbag())
- },
- },
- {
- name: "ICQ Lite order: feedbag use after ClientOnline, BroadcastVisibility fails",
- instance: newTestInstance("me", sessOptSignonComplete),
- mockParams: mockParams{
- feedbagManagerParams: feedbagManagerParams{
- useParams: useParams{
- {
- screenName: state.NewIdentScreenName("me"),
- },
- },
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("me"),
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("me"),
- filter: nil,
- doSendDepartures: false,
- err: assert.AnError,
- },
- },
- },
- },
- wantErr: assert.AnError,
- checkSession: func(t *testing.T, instance *state.SessionInstance) {
- assert.True(t, instance.ContactsInit())
- assert.True(t, instance.Session().UsesFeedbag())
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- feedbagManager := newMockFeedbagManager(t)
- for _, params := range tt.mockParams.useParams {
- feedbagManager.EXPECT().
- UseFeedbag(matchContext(), params.screenName).
- Return(nil)
- }
- for _, params := range tt.mockParams.feedbagParams {
- feedbagManager.EXPECT().
- Feedbag(matchContext(), params.screenName).
- Return(params.results, nil)
- }
- buddyUpdateBroadcaster := newMockbuddyBroadcaster(t)
- for _, params := range tt.mockParams.broadcastVisibilityParams {
- buddyUpdateBroadcaster.EXPECT().
- BroadcastVisibility(matchContext(), matchSession(params.from), params.filter, params.doSendDepartures).
- Return(params.err)
- }
- svc := NewFeedbagService(slog.Default(), nil, feedbagManager, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
- svc.buddyBroadcaster = buddyUpdateBroadcaster
- haveErr := svc.Use(context.Background(), tt.instance)
- assert.ErrorIs(t, haveErr, tt.wantErr)
- if tt.checkSession != nil {
- tt.checkSession(t, tt.instance)
- }
- })
- }
- }
- func TestFeedbagService_RequestAuthorizeToHost(t *testing.T) {
- authReqSender := state.User{
- ICQInfo: state.ICQInfo{
- Basic: state.ICQBasicInfo{
- Nickname: "CoolNickname",
- FirstName: "Alice",
- LastName: "Smith",
- EmailAddress: "alice@example.com",
- },
- },
- }
- tests := []struct {
- // name is the unit test name
- name string
- // instance is the client session
- instance *state.SessionInstance
- // inSNAC is the SNAC message sent by the client
- inSNAC wire.SNACMessage
- // buddySess is the online session for the recipient, or nil if offline
- buddySess *state.Session
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- // wantErr is the expected error
- wantErr error
- // expectOutput is the expected SNAC passed to icbmSender
- expectOutput wire.SNACMessage
- // expectICBM is true when RequestAuthorizeToHost should route via icbmSender
- expectICBM bool
- }{
- {
- name: "recipient is online with feedbag, relay authorization request",
- instance: newTestInstance("100001", sessOptUIN(100001)),
- inSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRequestAuthorizeToHost,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost{
- ScreenName: "100002",
- Reason: "please add me.",
- },
- },
- buddySess: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(state.NewIdentScreenName("100002"))
- s.SetUsesFeedbag()
- return s
- }(),
- mockParams: mockParams{
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {screenName: state.NewIdentScreenName("100002")},
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: state.NewIdentScreenName("100002"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRequestAuthorizeToClient,
- Flags: wire.SNACFlagsExtendedInfo,
- },
- Body: wire.SNAC_0x13_0x19_FeedbagRequestAuthorizeToClient{
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
- },
- },
- ScreenName: "100001",
- Reason: "please add me.",
- },
- },
- },
- },
- },
- },
- expectICBM: false,
- },
- {
- name: "ICQ 5 authorization failure workaround: remove periods following first from reason",
- instance: newTestInstance("100001", sessOptUIN(100001)),
- inSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRequestAuthorizeToHost,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost{
- ScreenName: "100002",
- Reason: "Please authorize my request and add me to your Contact List. yuki.tanaka ICQ#: 123405",
- },
- },
- buddySess: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(state.NewIdentScreenName("100002"))
- s.SetUsesFeedbag()
- return s
- }(),
- mockParams: mockParams{
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {screenName: state.NewIdentScreenName("100002")},
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: state.NewIdentScreenName("100002"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRequestAuthorizeToClient,
- Flags: wire.SNACFlagsExtendedInfo,
- },
- Body: wire.SNAC_0x13_0x19_FeedbagRequestAuthorizeToClient{
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
- },
- },
- ScreenName: "100001",
- Reason: "Please authorize my request and add me to your Contact List. yukitanaka ICQ#: 123405",
- },
- },
- },
- },
- },
- },
- expectICBM: false,
- },
- {
- name: "recipient is offline, send authorization request via ICBM",
- instance: newTestInstance("100001", sessOptUIN(100001)),
- inSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRequestAuthorizeToHost,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost{
- ScreenName: "100002",
- Reason: "please add me",
- },
- },
- buddySess: nil,
- mockParams: mockParams{
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {screenName: state.NewIdentScreenName("100002")},
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- requiresAuthorizationParams: requiresAuthorizationParams{
- {owner: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("100002"), result: false},
- },
- },
- userManagerParams: userManagerParams{
- getUserParams: getUserParams{
- {screenName: state.NewIdentScreenName("100001"), result: &authReqSender, err: nil},
- },
- },
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToHost,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "100002",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAuthReq,
- Message: fmt.Sprintf("%s\xFE%s\xFE%s\xFE%s\xFE%d\xFE%s",
- authReqSender.ICQInfo.Basic.Nickname,
- authReqSender.ICQInfo.Basic.FirstName,
- authReqSender.ICQInfo.Basic.LastName,
- authReqSender.ICQInfo.Basic.EmailAddress,
- 1,
- utf8ToLatin1("please add me"),
- ),
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- expectICBM: true,
- },
- {
- name: "recipient is online without feedbag, send authorization request via ICBM",
- instance: newTestInstance("100001", sessOptUIN(100001)),
- inSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRequestAuthorizeToHost,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost{
- ScreenName: "100002",
- Reason: "please add me",
- },
- },
- buddySess: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(state.NewIdentScreenName("100002"))
- return s
- }(),
- mockParams: mockParams{
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {screenName: state.NewIdentScreenName("100002")},
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- requiresAuthorizationParams: requiresAuthorizationParams{
- {owner: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("100002"), result: false},
- },
- },
- userManagerParams: userManagerParams{
- getUserParams: getUserParams{
- {screenName: state.NewIdentScreenName("100001"), result: &authReqSender, err: nil},
- },
- },
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToHost,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "100002",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAuthReq,
- Message: fmt.Sprintf("%s\xFE%s\xFE%s\xFE%s\xFE%d\xFE%s",
- authReqSender.ICQInfo.Basic.Nickname,
- authReqSender.ICQInfo.Basic.FirstName,
- authReqSender.ICQInfo.Basic.LastName,
- authReqSender.ICQInfo.Basic.EmailAddress,
- 1,
- utf8ToLatin1("please add me"),
- ),
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- expectICBM: true,
- },
- {
- name: "recipient is offline, sender requires pre-authorization, send request with authorized=0",
- instance: newTestInstance("100001", sessOptUIN(100001)),
- inSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRequestAuthorizeToHost,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost{
- ScreenName: "100002",
- Reason: "please add me",
- },
- },
- buddySess: nil,
- mockParams: mockParams{
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {screenName: state.NewIdentScreenName("100002")},
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- requiresAuthorizationParams: requiresAuthorizationParams{
- {owner: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("100002"), result: true},
- },
- },
- userManagerParams: userManagerParams{
- getUserParams: getUserParams{
- {screenName: state.NewIdentScreenName("100001"), result: &authReqSender, err: nil},
- },
- },
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToHost,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "100002",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAuthReq,
- Message: fmt.Sprintf("%s\xFE%s\xFE%s\xFE%s\xFE%d\xFE%s",
- authReqSender.ICQInfo.Basic.Nickname,
- authReqSender.ICQInfo.Basic.FirstName,
- authReqSender.ICQInfo.Basic.LastName,
- authReqSender.ICQInfo.Basic.EmailAddress,
- 0,
- utf8ToLatin1("please add me"),
- ),
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- expectICBM: true,
- },
- {
- name: "icbmSender returns error",
- instance: newTestInstance("100001", sessOptUIN(100001)),
- inSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRequestAuthorizeToHost,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost{
- ScreenName: "100002",
- Reason: "please add me",
- },
- },
- buddySess: nil,
- mockParams: mockParams{
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {screenName: state.NewIdentScreenName("100002")},
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- requiresAuthorizationParams: requiresAuthorizationParams{
- {owner: state.NewIdentScreenName("100001"), requester: state.NewIdentScreenName("100002"), result: false},
- },
- },
- userManagerParams: userManagerParams{
- getUserParams: getUserParams{
- {screenName: state.NewIdentScreenName("100001"), result: &authReqSender, err: nil},
- },
- },
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToHost,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "100002",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAuthReq,
- Message: fmt.Sprintf("%s\xFE%s\xFE%s\xFE%s\xFE%d\xFE%s",
- authReqSender.ICQInfo.Basic.Nickname,
- authReqSender.ICQInfo.Basic.FirstName,
- authReqSender.ICQInfo.Basic.LastName,
- authReqSender.ICQInfo.Basic.EmailAddress,
- 1,
- utf8ToLatin1("please add me"),
- ),
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- wantErr: assert.AnError,
- expectICBM: true,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- sessionRetriever := newMockSessionRetriever(t)
- for _, params := range tt.mockParams.retrieveSessionParams {
- sessionRetriever.EXPECT().RetrieveSession(params.screenName).Return(tt.buddySess)
- }
- messageRelayer := newMockMessageRelayer(t)
- for _, params := range tt.mockParams.relayToScreenNameParams {
- messageRelayer.EXPECT().RelayToScreenName(matchContext(), params.screenName, params.message)
- }
- icbmSender := func(ctx context.Context, instance *state.SessionInstance, inFrame wire.SNACFrame, inBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost) (*wire.SNACMessage, error) {
- if !tt.expectICBM {
- t.Fatalf("unexpected icbmSender call")
- }
- assert.Equal(t, tt.expectOutput.Frame, inFrame)
- assert.Equal(t, tt.instance, instance)
- wantBody := tt.expectOutput.Body.(wire.SNAC_0x04_0x06_ICBMChannelMsgToHost)
- assert.Equal(t, wantBody, inBody)
- return nil, tt.wantErr
- }
- contactPreAuth := newMockContactPreAuthorizer(t)
- for _, params := range tt.mockParams.requiresAuthorizationParams {
- contactPreAuth.EXPECT().
- RequiresAuthorization(matchContext(), params.owner, params.requester).
- Return(params.result, params.err)
- }
- userManager := newMockUserManager(t)
- for _, params := range tt.mockParams.userManagerParams.getUserParams {
- userManager.EXPECT().
- User(matchContext(), params.screenName).
- Return(params.result, params.err)
- }
- svc := NewFeedbagService(slog.Default(), messageRelayer, nil, nil, nil, sessionRetriever, contactPreAuth, userManager, newMockBuddyAddedNotifierDeduper(t))
- svc.icbmSender = icbmSender
- haveErr := svc.RequestAuthorizeToHost(
- context.Background(),
- tt.instance,
- tt.inSNAC.Frame,
- tt.inSNAC.Body.(wire.SNAC_0x13_0x18_FeedbagRequestAuthorizationToHost),
- )
- assert.ErrorIs(t, haveErr, tt.wantErr)
- })
- }
- }
- func TestFeedbagService_RespondAuthorizeToHost(t *testing.T) {
- wantICBMFrame := wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToHost,
- }
- granter := state.NewIdentScreenName("100001")
- requester := state.NewIdentScreenName("100003")
- tests := []struct {
- // name is the unit test name
- name string
- // granterSess is the session instance of the user who accepts / rejects authorization
- granterSess *state.SessionInstance
- // requesterSess is the session instance of the user who requested authorization
- requesterSess *state.Session
- // bodyIn is the SNAC body sent by the client
- bodyIn wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- // expectICBM is true when the response is sent via ICBM rather than Feebdag SNACs
- expectICBM bool
- // wantHostSNAC is the expected ICBM body when expectICBM is true
- wantHostSNAC wire.SNAC_0x04_0x06_ICBMChannelMsgToHost
- // wantErr is the expected error
- wantErr error
- }{
- {
- name: "requester offline: requester receives auth OK",
- granterSess: newTestInstance(state.DisplayScreenName(granter.String()), sessOptUIN(granter.UIN())),
- requesterSess: nil, // offline
- bodyIn: wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost{
- ScreenName: requester.String(),
- Accepted: 1,
- },
- mockParams: mockParams{
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {owner: granter, buddy: requester},
- },
- },
- },
- expectICBM: true,
- wantHostSNAC: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: requester.String(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: granter.UIN(),
- MessageType: wire.ICBMMsgTypeAuthOK,
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- {
- name: "requester offline: requester receives auth deny",
- granterSess: newTestInstance(state.DisplayScreenName(granter.String()), sessOptUIN(granter.UIN())),
- requesterSess: nil, // offline
- bodyIn: wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost{
- ScreenName: requester.String(),
- Accepted: 0,
- Reason: "I don't know you!",
- },
- expectICBM: true,
- wantHostSNAC: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: requester.String(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: granter.UIN(),
- MessageType: wire.ICBMMsgTypeAuthDeny,
- Message: "I don't know you!",
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- {
- name: "requester online: requester is pre-authorized",
- granterSess: newTestInstance(state.DisplayScreenName(granter.String()), sessOptUIN(granter.UIN())),
- requesterSess: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(requester)
- s.SetUsesFeedbag()
- return s
- }(),
- bodyIn: wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost{
- ScreenName: requester.String(),
- Accepted: 1,
- Reason: "welcome",
- },
- mockParams: mockParams{
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {owner: granter, buddy: requester},
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {screenName: requester, results: []wire.FeedbagItem{}},
- },
- },
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {me: granter, them: requester, result: state.Relationship{}},
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: requester,
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagPreAuthorizedBuddy,
- },
- Body: wire.SNAC_0x13_0x15_FeedbagPreAuthorizedBuddy{
- ScreenName: granter.String(),
- Message: "welcome",
- Flags: 0,
- },
- },
- },
- },
- },
- },
- },
- {
- name: "requester online: pending auth is finalized",
- granterSess: newTestInstance(state.DisplayScreenName(granter.String()), sessOptUIN(granter.UIN())),
- requesterSess: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(requester)
- s.SetUsesFeedbag()
- return s
- }(),
- bodyIn: wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost{
- ScreenName: requester.String(),
- Accepted: 1,
- },
- mockParams: mockParams{
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {owner: granter, buddy: requester},
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: requester,
- results: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: granter.String(),
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesPending, []byte{}),
- },
- },
- },
- },
- },
- },
- feedbagUpsertParams: feedbagUpsertParams{
- // slices.DeleteFunc returns an empty non-nil slice after removing the pending tag
- {
- screenName: requester,
- items: []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIdBuddy, Name: granter.String(), TLVLBlock: wire.TLVLBlock{TLVList: wire.TLVList{}}},
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {
- screenName: granter,
- result: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(granter)
- s.SetUsesFeedbag()
- s.AddInstance()
- return s
- }(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: granter,
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagBuddyAdded,
- Flags: wire.SNACFlagsExtendedInfo,
- },
- Body: wire.SNAC_0x13_0x1C_FeedbagBuddyAdded{
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(4)),
- },
- },
- ScreenName: requester.String(),
- },
- },
- },
- {
- screenName: requester,
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagUpdateItem,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIdBuddy, Name: granter.String(), TLVLBlock: wire.TLVLBlock{TLVList: wire.TLVList{}}},
- },
- },
- },
- },
- {
- screenName: requester,
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRespondAuthorizeToClient,
- Flags: wire.SNACFlagsExtendedInfo,
- },
- Body: wire.SNAC_0x13_0x1B_FeedbagRespondAuthorizeToClient{
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
- },
- },
- ScreenName: granter.String(),
- Accepted: 1,
- },
- },
- },
- },
- },
- buddyBroadcasterParams: buddyBroadcasterParams{
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: granter,
- filter: []state.IdentScreenName{requester},
- doSendDepartures: false,
- },
- },
- },
- },
- },
- {
- name: "requester online, granter offline: pending auth is finalized",
- granterSess: newTestInstance(state.DisplayScreenName(granter.String()), sessOptUIN(granter.UIN())),
- bodyIn: wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost{
- ScreenName: requester.String(),
- Accepted: 1,
- },
- requesterSess: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(requester)
- s.SetUsesFeedbag()
- return s
- }(),
- mockParams: mockParams{
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {owner: granter, buddy: requester},
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: requester,
- results: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddy,
- Name: granter.String(),
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagAttributesPending, []byte{}),
- },
- },
- },
- },
- },
- },
- feedbagUpsertParams: feedbagUpsertParams{
- {
- screenName: requester,
- items: []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIdBuddy, Name: granter.String(), TLVLBlock: wire.TLVLBlock{TLVList: wire.TLVList{}}},
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {screenName: granter, result: nil},
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: requester,
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagUpdateItem,
- },
- Body: wire.SNAC_0x13_0x09_FeedbagUpdateItem{
- Items: []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIdBuddy, Name: granter.String(), TLVLBlock: wire.TLVLBlock{TLVList: wire.TLVList{}}},
- },
- },
- },
- },
- {
- screenName: requester,
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRespondAuthorizeToClient,
- Flags: wire.SNACFlagsExtendedInfo,
- },
- Body: wire.SNAC_0x13_0x1B_FeedbagRespondAuthorizeToClient{
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
- },
- },
- ScreenName: granter.String(),
- Accepted: 1,
- },
- },
- },
- },
- },
- },
- expectICBM: true,
- wantHostSNAC: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: granter.String(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: requester.UIN(),
- MessageType: wire.ICBMMsgTypeAdded,
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- {
- name: "requester online: requester is denied",
- granterSess: newTestInstance(state.DisplayScreenName(granter.String()), sessOptUIN(granter.UIN())),
- bodyIn: wire.SNAC_0x13_0x1A_FeedbagRespondAuthorizeToHost{
- ScreenName: requester.String(),
- Accepted: 0,
- Reason: "I don't know you!",
- },
- requesterSess: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(requester)
- s.SetUsesFeedbag()
- return s
- }(),
- mockParams: mockParams{
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: requester,
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRespondAuthorizeToClient,
- Flags: wire.SNACFlagsExtendedInfo,
- },
- Body: wire.SNAC_0x13_0x1B_FeedbagRespondAuthorizeToClient{
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
- },
- },
- ScreenName: granter.String(),
- Accepted: 0,
- Reason: "I don't know you!",
- },
- },
- },
- },
- },
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- sessionRetriever := newMockSessionRetriever(t)
- sessionRetriever.EXPECT().
- RetrieveSession(state.NewIdentScreenName(tt.bodyIn.ScreenName)).
- Return(tt.requesterSess)
- for _, params := range tt.mockParams.retrieveSessionParams {
- sessionRetriever.EXPECT().RetrieveSession(params.screenName).Return(params.result)
- }
- contactPreAuth := newMockContactPreAuthorizer(t)
- for _, params := range tt.mockParams.recordPreAuthParams {
- contactPreAuth.EXPECT().RecordPreAuth(matchContext(), params.owner, params.buddy).Return(params.err)
- }
- messageRelayer := newMockMessageRelayer(t)
- for _, params := range tt.mockParams.relayToScreenNameParams {
- messageRelayer.EXPECT().RelayToScreenName(matchContext(), params.screenName, params.message)
- }
- feedbagManager := newMockFeedbagManager(t)
- for _, params := range tt.mockParams.feedbagParams {
- feedbagManager.EXPECT().Feedbag(matchContext(), params.screenName).Return(params.results, params.err)
- }
- for _, params := range tt.mockParams.feedbagUpsertParams {
- feedbagManager.EXPECT().FeedbagUpsert(matchContext(), params.screenName, params.items).Return(nil)
- }
- relationshipFetcher := newMockRelationshipFetcher(t)
- for _, params := range tt.mockParams.relationshipParams {
- relationshipFetcher.EXPECT().Relationship(matchContext(), params.me, params.them).Return(params.result, params.err)
- }
- buddyBroadcaster := newMockbuddyBroadcaster(t)
- for _, params := range tt.mockParams.broadcastVisibilityParams {
- buddyBroadcaster.EXPECT().
- BroadcastVisibility(mock.Anything, matchSession(params.from), params.filter, params.doSendDepartures).
- Return(params.err)
- }
- var icbmCallCount int
- icbmSender := func(ctx context.Context, instance *state.SessionInstance, inFrame wire.SNACFrame, inBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost) (*wire.SNACMessage, error) {
- icbmCallCount++
- if !tt.expectICBM {
- t.Fatalf("unexpected icbmSender call")
- }
- assert.Equal(t, wantICBMFrame, inFrame)
- wantBody := tt.wantHostSNAC
- wantBody.Cookie = 0
- haveBody := inBody
- haveBody.Cookie = 0
- assert.Equal(t, wantBody, haveBody)
- return nil, tt.wantErr
- }
- svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, relationshipFetcher, sessionRetriever, contactPreAuth, nil, newMockBuddyAddedNotifierDeduper(t))
- svc.buddyBroadcaster = buddyBroadcaster
- svc.icbmSender = icbmSender
- haveErr := svc.RespondAuthorizeToHost(context.Background(), tt.granterSess.IdentScreenName(), wire.SNACFrame{}, tt.bodyIn)
- assert.ErrorIs(t, tt.wantErr, haveErr)
- if tt.expectICBM {
- assert.Equal(t, 1, icbmCallCount, "expected icbmSender to be called exactly once")
- } else {
- assert.Equal(t, 0, icbmCallCount, "expected icbmSender not to be called")
- }
- })
- }
- }
- func TestFeedbagService_PreAuthorizeBuddy(t *testing.T) {
- alice := newTestInstance("100001", sessOptUIN(100001))
- buddySN := state.NewIdentScreenName("100002")
- wantICBMFrame := wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToHost,
- }
- wantICBMBody := wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: buddySN.String(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAuthOK,
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- }
- tests := []struct {
- // name is the unit test name
- name string
- // inFrame is the SNAC frame sent by the client
- inFrame wire.SNACFrame
- // inBody is the SNAC body sent by the client
- inBody wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy
- // buddySess is the online session for the pre-authorized buddy, or nil
- // if the buddy is offline
- buddySess *state.Session
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- // wantOut is the SNAC sent from the server to the client
- wantOut *wire.SNACMessage
- // wantErr is the expected error
- wantErr error
- // expectICBM is true when PreAuthorizeBuddy should send SNAC(0x04,0x06) auth OK
- expectICBM bool
- }{
- {
- name: "rejects self with FeedbagErr",
- inFrame: wire.SNACFrame{RequestID: 0xabc},
- inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{ScreenName: "100001"},
- wantOut: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagErr,
- RequestID: 0xabc,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeNotSupportedByHost,
- },
- },
- expectICBM: false,
- },
- {
- name: "unknown buddy user",
- inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{ScreenName: buddySN.String()},
- mockParams: mockParams{
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {
- screenName: buddySN,
- result: nil,
- },
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {
- owner: alice.IdentScreenName(),
- buddy: buddySN,
- err: state.ErrNoUser,
- },
- },
- },
- },
- expectICBM: false,
- },
- {
- name: "RecordPreAuth error",
- inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{ScreenName: buddySN.String()},
- mockParams: mockParams{
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {
- screenName: buddySN,
- result: nil,
- },
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {
- owner: alice.IdentScreenName(),
- buddy: buddySN,
- err: assert.AnError,
- },
- },
- },
- },
- wantErr: assert.AnError,
- expectICBM: false,
- },
- {
- name: "offline buddy: records grant, sends ICBM auth OK",
- inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{
- ScreenName: buddySN.String(),
- Message: "hi",
- },
- mockParams: mockParams{
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {
- owner: alice.IdentScreenName(),
- buddy: buddySN,
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {
- screenName: buddySN,
- result: nil,
- },
- },
- },
- },
- expectICBM: true,
- },
- {
- name: "online no feedbag: sends ICBM auth OK",
- inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{ScreenName: buddySN.String()},
- buddySess: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(buddySN)
- return s
- }(),
- mockParams: mockParams{
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {
- owner: alice.IdentScreenName(),
- buddy: buddySN,
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {
- screenName: buddySN,
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: buddySN,
- results: []wire.FeedbagItem{},
- },
- },
- },
- },
- expectICBM: true,
- },
- {
- name: "online feedbag YouBlock: no relay",
- inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{
- ScreenName: buddySN.String(),
- Message: "note",
- },
- buddySess: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(buddySN)
- s.SetUsesFeedbag()
- return s
- }(),
- mockParams: mockParams{
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {
- owner: alice.IdentScreenName(),
- buddy: buddySN,
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {
- screenName: buddySN,
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: buddySN,
- results: []wire.FeedbagItem{},
- },
- },
- },
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: alice.IdentScreenName(),
- them: buddySN,
- result: state.Relationship{BlocksYou: true},
- },
- },
- },
- },
- expectICBM: false,
- },
- {
- name: "online feedbag relays PreAuthorizedBuddy",
- inBody: wire.SNAC_0x13_0x14_FeedbagPreAuthorizeBuddy{
- ScreenName: buddySN.String(),
- Message: "added you",
- },
- buddySess: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(buddySN)
- s.SetUsesFeedbag()
- return s
- }(),
- mockParams: mockParams{
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {
- owner: alice.IdentScreenName(),
- buddy: buddySN,
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {
- screenName: buddySN,
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: buddySN,
- results: []wire.FeedbagItem{},
- },
- },
- },
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: alice.IdentScreenName(),
- them: buddySN,
- result: state.Relationship{BlocksYou: false},
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: buddySN,
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagPreAuthorizedBuddy,
- },
- Body: wire.SNAC_0x13_0x15_FeedbagPreAuthorizedBuddy{
- ScreenName: "100001",
- Message: "added you",
- Flags: 0,
- },
- },
- },
- },
- },
- },
- expectICBM: false,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- contactPreAuth := newMockContactPreAuthorizer(t)
- for _, params := range tt.mockParams.recordPreAuthParams {
- contactPreAuth.EXPECT().RecordPreAuth(matchContext(), params.owner, params.buddy).Return(params.err)
- }
- sessionRetriever := newMockSessionRetriever(t)
- for _, params := range tt.mockParams.retrieveSessionParams {
- sessionRetriever.EXPECT().RetrieveSession(params.screenName).Return(tt.buddySess)
- }
- feedbagManager := newMockFeedbagManager(t)
- for _, params := range tt.mockParams.feedbagParams {
- feedbagManager.EXPECT().
- Feedbag(matchContext(), params.screenName).
- Return(params.results, params.err)
- }
- relationshipFetcher := newMockRelationshipFetcher(t)
- for _, params := range tt.mockParams.relationshipParams {
- relationshipFetcher.EXPECT().Relationship(matchContext(), params.me, params.them).Return(params.result, params.err)
- }
- messageRelayer := newMockMessageRelayer(t)
- for _, params := range tt.mockParams.relayToScreenNameParams {
- messageRelayer.EXPECT().RelayToScreenName(matchContext(), params.screenName, params.message)
- }
- icbmSender := func(ctx context.Context, instance *state.SessionInstance, inFrame wire.SNACFrame, inBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost) (*wire.SNACMessage, error) {
- if !tt.expectICBM {
- t.Fatalf("unexpected icbmSender call")
- }
- assert.Equal(t, wantICBMFrame, inFrame)
- assert.Equal(t, alice.IdentScreenName(), instance.IdentScreenName())
- assert.Equal(t, wantICBMBody.ChannelID, inBody.ChannelID)
- assert.Equal(t, wantICBMBody.ScreenName, inBody.ScreenName)
- assert.Equal(t, wantICBMBody.TLVRestBlock, inBody.TLVRestBlock)
- assert.NotZero(t, inBody.Cookie)
- return nil, nil
- }
- svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, relationshipFetcher, sessionRetriever, contactPreAuth, nil, newMockBuddyAddedNotifierDeduper(t))
- svc.icbmSender = icbmSender
- out, err := svc.PreAuthorizeBuddy(context.Background(), alice, tt.inFrame, tt.inBody)
- assert.ErrorIs(t, err, tt.wantErr)
- assert.Equal(t, tt.wantOut, out)
- })
- }
- }
- func TestUtf8ToLatin1(t *testing.T) {
- tests := []struct {
- name string
- input string
- want string
- }{
- {
- name: "pure ASCII string returned unchanged",
- input: "hello world",
- want: "hello world",
- },
- {
- name: "Latin-1 characters converted to single bytes",
- input: "caf\u00e9", // é = U+00E9
- want: "caf\xe9",
- },
- {
- name: "non-Latin-1 character replaced with question mark",
- input: "price: \u20ac", // € = U+20AC (> 0xFF)
- want: "price: ?",
- },
- {
- name: "mixed input: ASCII and Latin-1 kept, non-Latin-1 replaced",
- input: "r\u00e9sum\u00e9 \u20ac100", // résumé €100
- want: "r\xe9sum\xe9 ?100",
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- assert.Equal(t, tt.want, utf8ToLatin1(tt.input))
- })
- }
- }
- func TestFeedbagBuddyPref(t *testing.T) {
- tests := []struct {
- name string
- itemType uint16
- list wire.TLVList
- wantValue bool
- }{
- {
- name: "offline messages disabled",
- itemType: wire.FeedbagBuddyPrefsAcceptOfflineIM,
- list: wire.TLVList{
- {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0, 0, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0, 0, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0, 0, 17}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0, 0, 1}},
- },
- wantValue: false,
- },
- {
- name: "offline messages disabled, extra padding",
- itemType: wire.FeedbagBuddyPrefsAcceptOfflineIM,
- list: wire.TLVList{
- {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0, 0, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0, 0, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0, 0, 17, 0, 0}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0, 0, 1, 0, 0}},
- },
- wantValue: false,
- },
- {
- name: "offline messages enabled",
- itemType: wire.FeedbagBuddyPrefsAcceptOfflineIM,
- list: wire.TLVList{
- {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0, 0, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0, 0, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0, 0, 17}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0, 0, 17}},
- },
- wantValue: true,
- },
- {
- name: "offline messages enabled, extra padding",
- itemType: wire.FeedbagBuddyPrefsAcceptOfflineIM,
- list: wire.TLVList{
- {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0, 0, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0, 0, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0, 0, 17, 0, 0}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0, 0, 17, 0, 0}},
- },
- wantValue: true,
- },
- {
- name: "typing events enabled, with padding",
- itemType: wire.FeedbagBuddyPrefsAcceptOfflineIM,
- list: wire.TLVList{
- {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0, 64, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0, 64, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0, 0, 17}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0, 0, 17}},
- },
- wantValue: true,
- },
- {
- name: "typing events enabled, without padding",
- itemType: 22,
- list: wire.TLVList{
- {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{64, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{64, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{17}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{17}},
- },
- wantValue: true,
- },
- {
- name: "typing events disabled, with padding",
- itemType: 22,
- list: wire.TLVList{
- {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0, 64, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0, 0, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0, 0, 17}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0, 0, 17}},
- },
- wantValue: false,
- },
- {
- name: "typing events disabled, without padding",
- itemType: 22,
- list: wire.TLVList{
- {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{64, 24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{24, 64}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{17}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{17}},
- },
- wantValue: false,
- },
- {
- name: "show friendly IMs enabled (dupe of disclose radio)",
- itemType: 32,
- list: wire.TLVList{
- {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0x00, 0x00, 0x00, 0x00}},
- {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0x00, 0x00, 0x00, 0x00}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0x80, 0x00, 0x00, 0x00}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0x80, 0x00, 0x00, 0x00}},
- },
- wantValue: true,
- },
- {
- name: "disclose radio enabled (dupe of show friendly IMs)",
- itemType: 33,
- list: wire.TLVList{
- {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0x00, 0x00, 0x00, 0x00}},
- {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0x00, 0x00, 0x00, 0x00}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0x80, 0x00, 0x00, 0x00}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0x80, 0x00, 0x00, 0x00}},
- },
- wantValue: true,
- },
- {
- name: "show capabilities enabled",
- itemType: 34,
- list: wire.TLVList{
- {Tag: wire.FeedbagAttributesBuddyPrefsValid, Value: []byte{0x00, 0x00, 0x00, 0x00}},
- {Tag: wire.FeedbagAttributesBuddyPrefs, Value: []byte{0x00, 0x00, 0x00, 0x00}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2Valid, Value: []byte{0x40, 0x00, 0x00, 0x00}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0x40, 0x00, 0x00, 0x00}},
- },
- wantValue: true,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- assert.Equal(t, tt.wantValue, wire.BuddyPref(tt.list, tt.itemType))
- })
- }
- }
- func TestFeedbagService_StartCluster(t *testing.T) {
- instance := newTestInstance("me")
- inFrame := wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStartCluster,
- RequestID: 1234,
- }
- inBody := wire.SNAC_0x13_0x11_FeedbagStartCluster{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(0x01, uint16(100)),
- },
- },
- }
- messageRelayer := newMockMessageRelayer(t)
- messageRelayer.EXPECT().
- RelayToOtherInstances(matchContext(), instance, wire.SNACMessage{
- Frame: inFrame,
- Body: inBody,
- })
- svc := NewFeedbagService(slog.Default(), messageRelayer, nil, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
- svc.StartCluster(context.Background(), instance, inFrame, inBody)
- assert.True(t, instance.InNotifyTxn())
- }
- func TestFeedbagService_EndCluster(t *testing.T) {
- endFrame := wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagEndCluster,
- RequestID: 1234,
- }
- endRelay := wire.SNACMessage{
- Frame: endFrame,
- Body: wire.SNAC_0x13_0x12_FeedbagEndCluster{},
- }
- cases := []struct {
- name string
- instance *state.SessionInstance
- broadcastVisibilityParams broadcastVisibilityParams
- }{
- {
- name: "open txn without accumulated notify skips broadcast",
- instance: func() *state.SessionInstance {
- inst := newTestInstance("me")
- inst.BeginNotifyTxn()
- return inst
- }(),
- },
- {
- name: "broadcasts accumulated screen names",
- instance: func() *state.SessionInstance {
- inst := newTestInstance("me")
- inst.BeginNotifyTxn()
- _ = inst.NotifyTxn(state.NewIdentScreenName("buddy1"))
- return inst
- }(),
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("me"),
- filter: []state.IdentScreenName{
- state.NewIdentScreenName("buddy1"),
- },
- },
- },
- },
- {
- name: "broadcasts after notify without name filter",
- instance: func() *state.SessionInstance {
- inst := newTestInstance("me")
- inst.BeginNotifyTxn()
- _ = inst.NotifyTxn()
- return inst
- }(),
- broadcastVisibilityParams: broadcastVisibilityParams{
- {
- from: state.NewIdentScreenName("me"),
- filter: nil,
- },
- },
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- messageRelayer := newMockMessageRelayer(t)
- messageRelayer.EXPECT().
- RelayToOtherInstances(matchContext(), tc.instance, endRelay)
- buddyBroadcaster := newMockbuddyBroadcaster(t)
- for _, params := range tc.broadcastVisibilityParams {
- buddyBroadcaster.EXPECT().
- BroadcastVisibility(matchContext(), matchSession(params.from), params.filter, true).
- Return(params.err)
- }
- svc := NewFeedbagService(slog.Default(), messageRelayer, nil, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
- svc.buddyBroadcaster = buddyBroadcaster
- err := svc.EndCluster(context.Background(), tc.instance, endFrame)
- assert.NoError(t, err)
- assert.False(t, tc.instance.InNotifyTxn())
- })
- }
- }
- func TestFeedbagService_notifyTxnCluster(t *testing.T) {
- me := state.NewIdentScreenName("me")
- buddy1 := state.NewIdentScreenName("buddy1")
- startFrame := wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagStartCluster,
- RequestID: 1,
- }
- startBody := wire.SNAC_0x13_0x11_FeedbagStartCluster{}
- endFrame := wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagEndCluster,
- RequestID: 2,
- }
- upsertFrame := wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagInsertItem,
- RequestID: 3,
- }
- upsertItems := []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIDPermit, Name: "buddy1"},
- }
- t.Run("upsert defers visibility until end cluster", func(t *testing.T) {
- instance := newTestInstance("me")
- messageRelayer := newMockMessageRelayer(t)
- messageRelayer.EXPECT().
- RelayToOtherInstances(matchContext(), instance, mock.Anything).
- Times(3)
- messageRelayer.EXPECT().
- RelayToSelf(matchContext(), instance, mock.Anything).
- Once()
- feedbagManager := newMockFeedbagManager(t)
- feedbagManager.EXPECT().
- FeedbagUpsert(matchContext(), me, upsertItems).
- Return(nil)
- buddyBroadcaster := newMockbuddyBroadcaster(t)
- buddyBroadcaster.EXPECT().
- BroadcastVisibility(matchContext(), matchSession(me), []state.IdentScreenName{buddy1}, true).
- Return(nil).
- Once()
- svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
- svc.buddyBroadcaster = buddyBroadcaster
- svc.StartCluster(context.Background(), instance, startFrame, startBody)
- assert.True(t, instance.InNotifyTxn())
- _, err := svc.UpsertItem(context.Background(), instance, upsertFrame, upsertItems)
- assert.NoError(t, err)
- assert.True(t, instance.InNotifyTxn())
- err = svc.EndCluster(context.Background(), instance, endFrame)
- assert.NoError(t, err)
- assert.False(t, instance.InNotifyTxn())
- })
- t.Run("delete defers visibility until end cluster", func(t *testing.T) {
- instance := newTestInstance("me")
- deleteBody := wire.SNAC_0x13_0x0A_FeedbagDeleteItem{
- Items: []wire.FeedbagItem{
- {ClassID: wire.FeedbagClassIdBuddy, Name: "buddy1"},
- },
- }
- messageRelayer := newMockMessageRelayer(t)
- messageRelayer.EXPECT().
- RelayToOtherInstances(matchContext(), instance, mock.Anything).
- Times(3)
- messageRelayer.EXPECT().
- RelayToSelf(matchContext(), instance, mock.Anything).
- Once()
- feedbagManager := newMockFeedbagManager(t)
- feedbagManager.EXPECT().
- FeedbagDelete(matchContext(), me, deleteBody.Items).
- Return(nil)
- buddyBroadcaster := newMockbuddyBroadcaster(t)
- buddyBroadcaster.EXPECT().
- BroadcastVisibility(matchContext(), matchSession(me), []state.IdentScreenName{buddy1}, true).
- Return(nil).
- Once()
- svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
- svc.buddyBroadcaster = buddyBroadcaster
- svc.StartCluster(context.Background(), instance, startFrame, startBody)
- _, err := svc.DeleteItem(context.Background(), instance, upsertFrame, deleteBody)
- assert.NoError(t, err)
- err = svc.EndCluster(context.Background(), instance, endFrame)
- assert.NoError(t, err)
- })
- t.Run("pdinfo upsert defers broadcast all until end cluster", func(t *testing.T) {
- instance := newTestInstance("me")
- pdinfoItems := []wire.FeedbagItem{{ClassID: wire.FeedbagClassIdPdinfo}}
- messageRelayer := newMockMessageRelayer(t)
- messageRelayer.EXPECT().
- RelayToOtherInstances(matchContext(), instance, mock.Anything).
- Times(3)
- messageRelayer.EXPECT().
- RelayToSelf(matchContext(), instance, mock.Anything).
- Once()
- feedbagManager := newMockFeedbagManager(t)
- feedbagManager.EXPECT().
- FeedbagUpsert(matchContext(), me, pdinfoItems).
- Return(nil)
- buddyBroadcaster := newMockbuddyBroadcaster(t)
- buddyBroadcaster.EXPECT().
- BroadcastVisibility(
- matchContext(),
- matchSession(me),
- mock.MatchedBy(func(filter []state.IdentScreenName) bool { return len(filter) == 0 }),
- true,
- ).
- Return(nil).
- Once()
- svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, nil, nil, nil, nil, newMockBuddyAddedNotifierDeduper(t))
- svc.buddyBroadcaster = buddyBroadcaster
- svc.StartCluster(context.Background(), instance, startFrame, startBody)
- _, err := svc.UpsertItem(context.Background(), instance, upsertFrame, pdinfoItems)
- assert.NoError(t, err)
- err = svc.EndCluster(context.Background(), instance, endFrame)
- assert.NoError(t, err)
- })
- }
- func TestFeedbagService_ForwardICQAuthEvents(t *testing.T) {
- sender := newTestInstance("100001", sessOptUIN(100001))
- recipient := state.NewIdentScreenName("100002")
- tests := []struct {
- // name is the unit test name
- name string
- // authMsg is the ICQ channel-4 message to forward
- authMsg wire.ICBMCh4Message
- // buddySess is the online session for the recipient, or nil if offline
- buddySess *state.Session
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- // expectICBM is true when ForwardICQAuthEvents should route via icbmSender
- expectICBM bool
- // wantICBMBody is the expected ICBM body sent via icbmSender (when expectICBM is true)
- wantICBMBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost
- // wantErr is the expected error
- wantErr error
- }{
- {
- name: "auth OK - feedbag recipient receives PreAuthorizedBuddy SNAC",
- authMsg: wire.ICBMCh4Message{
- MessageType: wire.ICBMMsgTypeAuthOK,
- },
- buddySess: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(recipient)
- s.SetUsesFeedbag()
- return s
- }(),
- mockParams: mockParams{
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {screenName: recipient},
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {owner: sender.IdentScreenName(), buddy: recipient},
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {screenName: recipient, results: []wire.FeedbagItem{}},
- },
- },
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {me: sender.IdentScreenName(), them: recipient, result: state.Relationship{}},
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: recipient,
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagPreAuthorizedBuddy,
- },
- Body: wire.SNAC_0x13_0x15_FeedbagPreAuthorizedBuddy{
- ScreenName: sender.DisplayScreenName().String(),
- Flags: 0,
- },
- },
- },
- },
- },
- },
- },
- {
- name: "auth OK - offline recipient receives legacy ICQ auth OK",
- authMsg: wire.ICBMCh4Message{
- MessageType: wire.ICBMMsgTypeAuthOK,
- },
- mockParams: mockParams{
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {screenName: recipient},
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {owner: sender.IdentScreenName(), buddy: recipient},
- },
- },
- },
- expectICBM: true,
- wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: recipient.String(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: sender.UIN(),
- MessageType: wire.ICBMMsgTypeAuthOK,
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- {
- name: "auth deny - feedbag recipient receives RespondAuthorizeToClient SNAC",
- authMsg: wire.ICBMCh4Message{
- MessageType: wire.ICBMMsgTypeAuthDeny,
- Message: "no thanks",
- },
- buddySess: func() *state.Session {
- s := state.NewSession()
- s.SetIdentScreenName(recipient)
- s.SetUsesFeedbag()
- return s
- }(),
- mockParams: mockParams{
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {screenName: recipient},
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: recipient,
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRespondAuthorizeToClient,
- Flags: wire.SNACFlagsExtendedInfo,
- },
- Body: wire.SNAC_0x13_0x1B_FeedbagRespondAuthorizeToClient{
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
- },
- },
- ScreenName: sender.DisplayScreenName().String(),
- Accepted: 0,
- Reason: "no thanks",
- },
- },
- },
- },
- },
- },
- },
- {
- name: "auth deny - offline recipient receives legacy ICQ auth deny",
- authMsg: wire.ICBMCh4Message{
- MessageType: wire.ICBMMsgTypeAuthDeny,
- Message: "no thanks",
- },
- mockParams: mockParams{
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams: retrieveSessionParams{
- {screenName: recipient},
- },
- },
- },
- expectICBM: true,
- wantICBMBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: recipient.String(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: sender.UIN(),
- MessageType: wire.ICBMMsgTypeAuthDeny,
- Message: "no thanks",
- }),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- {
- name: "added - relays FeedbagBuddyAdded SNAC to recipient",
- authMsg: wire.ICBMCh4Message{
- MessageType: wire.ICBMMsgTypeAdded,
- },
- mockParams: mockParams{
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: recipient,
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagBuddyAdded,
- Flags: wire.SNACFlagsExtendedInfo,
- },
- Body: wire.SNAC_0x13_0x1C_FeedbagBuddyAdded{
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(4)),
- },
- },
- ScreenName: sender.IdentScreenName().String(),
- },
- },
- },
- },
- },
- },
- },
- {
- name: "auth req - relays FeedbagRequestAuthorizeToClient SNAC to recipient",
- authMsg: wire.ICBMCh4Message{
- MessageType: wire.ICBMMsgTypeAuthReq,
- Message: "11111111\xFE\xFE\xFE\xFE1\xFEplease add me",
- },
- mockParams: mockParams{
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: recipient,
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.Feedbag,
- SubGroup: wire.FeedbagRequestAuthorizeToClient,
- Flags: wire.SNACFlagsExtendedInfo,
- },
- Body: wire.SNAC_0x13_0x19_FeedbagRequestAuthorizeToClient{
- TLVLBlock: wire.TLVLBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.FeedbagTLVVersion, uint16(2)),
- },
- },
- ScreenName: sender.IdentScreenName().String(),
- Reason: "please add me",
- },
- },
- },
- },
- },
- },
- },
- {
- name: "unknown message type - logs warning and returns nil",
- authMsg: wire.ICBMCh4Message{
- MessageType: 0xFF,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- sessionRetriever := newMockSessionRetriever(t)
- for _, params := range tt.mockParams.retrieveSessionParams {
- sessionRetriever.EXPECT().RetrieveSession(params.screenName).Return(tt.buddySess)
- }
- contactPreAuth := newMockContactPreAuthorizer(t)
- for _, params := range tt.mockParams.recordPreAuthParams {
- contactPreAuth.EXPECT().RecordPreAuth(matchContext(), params.owner, params.buddy).Return(params.err)
- }
- feedbagManager := newMockFeedbagManager(t)
- for _, params := range tt.mockParams.feedbagParams {
- feedbagManager.EXPECT().Feedbag(matchContext(), params.screenName).Return(params.results, params.err)
- }
- relationshipFetcher := newMockRelationshipFetcher(t)
- for _, params := range tt.mockParams.relationshipParams {
- relationshipFetcher.EXPECT().Relationship(matchContext(), params.me, params.them).Return(params.result, params.err)
- }
- messageRelayer := newMockMessageRelayer(t)
- for _, params := range tt.mockParams.relayToScreenNameParams {
- messageRelayer.EXPECT().RelayToScreenName(matchContext(), params.screenName, params.message)
- }
- icbmSender := func(ctx context.Context, instance *state.SessionInstance, inFrame wire.SNACFrame, inBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost) (*wire.SNACMessage, error) {
- if !tt.expectICBM {
- t.Fatalf("unexpected icbmSender call")
- }
- assert.Equal(t, wire.SNACFrame{FoodGroup: wire.ICBM, SubGroup: wire.ICBMChannelMsgToHost}, inFrame)
- assert.Equal(t, sender.IdentScreenName(), instance.IdentScreenName())
- wantBody := tt.wantICBMBody
- wantBody.Cookie = 0
- haveBody := inBody
- haveBody.Cookie = 0
- assert.Equal(t, wantBody, haveBody)
- return nil, tt.wantErr
- }
- svc := NewFeedbagService(slog.Default(), messageRelayer, feedbagManager, nil, relationshipFetcher, sessionRetriever, contactPreAuth, nil, newMockBuddyAddedNotifierDeduper(t))
- svc.icbmSender = icbmSender
- err := svc.ForwardICQAuthEvents(context.Background(), sender.IdentScreenName(), recipient, tt.authMsg)
- assert.ErrorIs(t, err, tt.wantErr)
- })
- }
- }
|