| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912 |
- package foodgroup
- import (
- "context"
- "errors"
- "io"
- "log/slog"
- "net"
- "net/netip"
- "sync"
- "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 TestICBMService_ChannelMsgToHost(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // instance is the session of the user sending the message
- instance *state.SessionInstance
- // inputSNAC is the SNAC frame sent from the server to the recipient
- // client
- inputSNAC wire.SNACMessage
- // expectOutput is the expected return SNAC value.
- expectOutput *wire.SNACMessage
- // wantErr is the expected error (nil for success)
- wantErr error
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- // expectForwardICQAuthEvents indicates whether ChannelMsgToHost should
- // delegate ICQ channel-4 auth events to forwardICQAuthEvents.
- expectForwardICQAuthEvents bool
- // expectForwardRecipient is the expected recipient passed to
- // forwardICQAuthEvents when expectForwardICQAuthEvents is true.
- expectForwardRecipient state.IdentScreenName
- // expectForwardAuthMsg is the expected auth message passed to
- // forwardICQAuthEvents when expectForwardICQAuthEvents is true.
- expectForwardAuthMsg wire.ICBMCh4Message
- // timeNow returns the current time
- timeNow func() time.Time
- }{
- {
- name: "transmit message from sender to recipient, ack message back to sender",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10), sessOptWantTypingEvents),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptWarning(20), sessOptSignonComplete).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- ChannelID: wire.ICBMChannelIM,
- TLVUserInfo: newTestInstance("sender-screen-name", sessOptWarning(10)).Session().TLVUserInfo(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- {
- Tag: wire.ICBMTLVWantEvents,
- Value: []byte{},
- },
- },
- },
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVRequestHostAck,
- Value: []byte{},
- },
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMHostAck,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x0C_ICBMHostAck{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- },
- },
- },
- {
- name: "transmit message from sender to recipient, don't ack message back to sender",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10), sessOptWantTypingEvents),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptWarning(20), sessOptSignonComplete).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- ChannelID: wire.ICBMChannelIM,
- TLVUserInfo: newTestInstance("sender-screen-name", sessOptWarning(10)).Session().TLVUserInfo(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- {
- Tag: wire.ICBMTLVWantEvents,
- Value: []byte{},
- },
- },
- },
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "transmit message from sender to recipient, don't ack message back to sender, don't want typing events",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptWarning(20), sessOptSignonComplete).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- ChannelID: wire.ICBMChannelIM,
- TLVUserInfo: newTestInstance("sender-screen-name", sessOptWarning(10)).Session().TLVUserInfo(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- },
- },
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "strip store directive from message relayed to online recipient",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptWarning(20), sessOptSignonComplete).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- ChannelID: wire.ICBMChannelIM,
- TLVUserInfo: newTestInstance("sender-screen-name", sessOptWarning(10)).Session().TLVUserInfo(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3, 4}),
- },
- },
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3, 4}),
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "don't transmit message from sender to recipient because sender has blocked recipient",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: true,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{},
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{},
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVRequestHostAck,
- Value: []byte{},
- },
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeInLocalPermitDeny,
- },
- },
- },
- {
- name: "don't transmit message from sender to recipient because recipient has blocked sender",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: true,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{},
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{},
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVRequestHostAck,
- Value: []byte{},
- },
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeNotLoggedOn,
- },
- },
- },
- {
- name: "don't transmit message from sender to recipient because recipient doesn't exist",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: nil,
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{},
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVRequestHostAck,
- Value: []byte{},
- },
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeNotLoggedOn,
- },
- },
- },
- {
- name: "send offline message to ICQ recipient",
- instance: newTestInstance("11111111", sessOptUIN(11111111)),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "22222222",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- },
- expectOutput: nil,
- timeNow: func() time.Time {
- return time.Date(2020, time.August, 1, 0, 0, 0, 0, time.UTC)
- },
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("11111111"),
- them: state.NewIdentScreenName("22222222"),
- result: state.Relationship{
- User: state.NewIdentScreenName("22222222"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("22222222"),
- result: nil,
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{},
- },
- offlineMessageManagerParams: offlineMessageManagerParams{
- saveMessageParams: saveMessageParams{
- {
- offlineMessageIn: state.OfflineMessage{
- Message: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "22222222",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- },
- },
- },
- Recipient: state.NewIdentScreenName("22222222"),
- Sender: state.NewIdentScreenName("11111111"),
- Sent: time.Date(2020, time.August, 1, 0, 0, 0, 0, time.UTC),
- },
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("22222222"),
- results: []wire.FeedbagItem{},
- },
- },
- },
- },
- },
- {
- name: "send offline message to recipient with accept offline IM flag set",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVRequestHostAck, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3, 4}),
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMHostAck,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x0C_ICBMHostAck{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- },
- },
- timeNow: func() time.Time {
- return time.Date(2020, time.August, 1, 0, 0, 0, 0, time.UTC)
- },
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: nil,
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{},
- },
- offlineMessageManagerParams: offlineMessageManagerParams{
- saveMessageParams: saveMessageParams{
- {
- offlineMessageIn: state.OfflineMessage{
- Message: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVRequestHostAck, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3, 4}),
- },
- },
- },
- Recipient: state.NewIdentScreenName("recipient-screen-name"),
- Sender: state.NewIdentScreenName("sender-screen-name"),
- Sent: time.Date(2020, time.August, 1, 0, 0, 0, 0, time.UTC),
- },
- countOut: 1,
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- results: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: 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}},
- },
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "reject offline message when recipient has opted out of offline messages",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVRequestHostAck, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3, 4}),
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeNotLoggedOn,
- },
- },
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: nil,
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{},
- },
- offlineMessageManagerParams: offlineMessageManagerParams{
- saveMessageParams: saveMessageParams{},
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- results: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: 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}},
- },
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "send offline message when offline IM preference is not valid",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVRequestHostAck, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3, 4}),
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMHostAck,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x0C_ICBMHostAck{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- },
- },
- timeNow: func() time.Time {
- return time.Date(2020, time.August, 1, 0, 0, 0, 0, time.UTC)
- },
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: nil,
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{},
- },
- offlineMessageManagerParams: offlineMessageManagerParams{
- saveMessageParams: saveMessageParams{
- {
- offlineMessageIn: state.OfflineMessage{
- Message: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVRequestHostAck, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3, 4}),
- },
- },
- },
- Recipient: state.NewIdentScreenName("recipient-screen-name"),
- Sender: state.NewIdentScreenName("sender-screen-name"),
- Sent: time.Date(2020, time.August, 1, 0, 0, 0, 0, time.UTC),
- },
- countOut: 1,
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- results: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: 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, 7}},
- {Tag: wire.FeedbagAttributesBuddyPrefs2, Value: []byte{0, 0, 17}},
- },
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "send rendezvous request for file transfer, expect IP TLV override",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10),
- sessRemoteAddr(netip.AddrPortFrom(netip.MustParseAddr("129.168.0.1"), 0))),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptWarning(20), sessOptSignonComplete).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- ChannelID: wire.ICBMChannelRendezvous,
- TLVUserInfo: newTestInstance("sender-screen-name", sessOptWarning(10)).Session().TLVUserInfo(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVData, wire.ICBMCh2Fragment{
- Type: wire.ICBMRdvMessagePropose,
- Capability: wire.CapFileTransfer,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMRdvTLVTagsPort, uint16(4000)),
- wire.NewTLVBE(wire.ICBMRdvTLVTagsRequesterIP, net.ParseIP("129.168.0.1").To4()),
- wire.NewTLVBE(wire.ICBMRdvTLVTagsVerifiedIP, net.ParseIP("129.168.0.1").To4()),
- },
- },
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelRendezvous,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVData, wire.ICBMCh2Fragment{
- Type: wire.ICBMRdvMessagePropose,
- Capability: wire.CapFileTransfer,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMRdvTLVTagsPort, uint16(4000)),
- wire.NewTLVBE(wire.ICBMRdvTLVTagsRequesterIP, net.ParseIP("127.0.0.1").To4()),
- },
- },
- }),
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "send rendezvous rejection for file transfer, expect no IP TLV override",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10),
- sessRemoteAddr(netip.AddrPortFrom(netip.MustParseAddr("129.168.0.1"), 0))),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptWarning(20), sessOptSignonComplete).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- ChannelID: wire.ICBMChannelRendezvous,
- TLVUserInfo: newTestInstance("sender-screen-name", sessOptWarning(10)).Session().TLVUserInfo(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVData, wire.ICBMCh2Fragment{
- Type: wire.ICBMRdvMessageCancel,
- Capability: wire.CapFileTransfer,
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelRendezvous,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVData, wire.ICBMCh2Fragment{
- Type: wire.ICBMRdvMessageCancel,
- Capability: wire.CapFileTransfer,
- }),
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "send rendezvous request for file transfer without IP in session, expect no IP TLV override",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptWarning(20), sessOptSignonComplete).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- ChannelID: wire.ICBMChannelRendezvous,
- TLVUserInfo: newTestInstance("sender-screen-name", sessOptWarning(10)).Session().TLVUserInfo(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVData, wire.ICBMCh2Fragment{
- Type: wire.ICBMRdvMessagePropose,
- Capability: wire.CapFileTransfer,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMRdvTLVTagsPort, uint16(4000)),
- wire.NewTLVBE(wire.ICBMRdvTLVTagsRequesterIP, net.ParseIP("127.0.0.1").To4()),
- },
- },
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelRendezvous,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVData, wire.ICBMCh2Fragment{
- Type: wire.ICBMRdvMessagePropose,
- Capability: wire.CapFileTransfer,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMRdvTLVTagsPort, uint16(4000)),
- wire.NewTLVBE(wire.ICBMRdvTLVTagsRequesterIP, net.ParseIP("127.0.0.1").To4()),
- },
- },
- }),
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "relay Xtraz XStatus message",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptWarning(20), sessOptSignonComplete).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- ChannelID: wire.ICBMChannelRendezvous,
- TLVUserInfo: newTestInstance("sender-screen-name", sessOptWarning(10)).Session().TLVUserInfo(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVData, wire.ICBMCh2Fragment{
- Type: wire.ICBMRdvMessagePropose,
- Capability: wire.CapXtrazScript,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(0x2711, []byte("xtraz-xml-payload")),
- },
- },
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelRendezvous,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVData, wire.ICBMCh2Fragment{
- Type: wire.ICBMRdvMessagePropose,
- Capability: wire.CapXtrazScript,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(0x2711, []byte("xtraz-xml-payload")),
- },
- },
- }),
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "transmit message to recipient with all sessions inactive - use RelayToScreenName",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptWarning(20), sessOptAllInactive).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- ChannelID: wire.ICBMChannelIM,
- TLVUserInfo: newTestInstance("sender-screen-name", sessOptWarning(10)).Session().TLVUserInfo(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- },
- },
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "transmit message to recipient with some active sessions - use RelayToScreenNameActiveOnly",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptWarning(20), sessOptSomeActive, sessOptSignonComplete).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- ChannelID: wire.ICBMChannelIM,
- TLVUserInfo: newTestInstance("sender-screen-name", sessOptWarning(10)).Session().TLVUserInfo(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- },
- },
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "transmit message to recipient with closed session - use RelayToScreenName",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptWarning(20), sessOptClosed).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- ChannelID: wire.ICBMChannelIM,
- TLVUserInfo: newTestInstance("sender-screen-name", sessOptWarning(10)).Session().TLVUserInfo(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- },
- },
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "transmit message to recipient with mixed session states - use RelayToScreenNameActiveOnly",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptWarning(20), sessOptMixedStates, sessOptSignonComplete).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- ChannelID: wire.ICBMChannelIM,
- TLVUserInfo: newTestInstance("sender-screen-name", sessOptWarning(10)).Session().TLVUserInfo(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- },
- },
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- {
- Tag: wire.ICBMTLVData,
- Value: []byte{1, 2, 3, 4},
- },
- },
- },
- },
- },
- expectOutput: nil,
- },
- {
- name: "send offline message when inbox is full, return ICBM error with subcode",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVRequestHostAck, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3, 4}),
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeNotLoggedOn,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ErrorTLVErrorSubcode, wire.ICBMSubErrOfflineIMExceedMax),
- },
- },
- },
- },
- wantErr: nil,
- timeNow: func() time.Time {
- return time.Date(2020, time.August, 1, 0, 0, 0, 0, time.UTC)
- },
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: nil,
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{},
- },
- offlineMessageManagerParams: offlineMessageManagerParams{
- saveMessageParams: saveMessageParams{
- {
- offlineMessageIn: state.OfflineMessage{
- Message: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVRequestHostAck, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3, 4}),
- },
- },
- },
- Recipient: state.NewIdentScreenName("recipient-screen-name"),
- Sender: state.NewIdentScreenName("sender-screen-name"),
- Sent: time.Date(2020, time.August, 1, 0, 0, 0, 0, time.UTC),
- },
- err: state.ErrOfflineInboxFull,
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- results: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: 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}},
- },
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "send offline message when SaveMessage returns generic error",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVRequestHostAck, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3, 4}),
- },
- },
- },
- },
- expectOutput: nil,
- wantErr: assert.AnError,
- timeNow: func() time.Time {
- return time.Date(2020, time.August, 1, 0, 0, 0, 0, time.UTC)
- },
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: nil,
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{},
- },
- offlineMessageManagerParams: offlineMessageManagerParams{
- saveMessageParams: saveMessageParams{
- {
- offlineMessageIn: state.OfflineMessage{
- Message: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVRequestHostAck, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3, 4}),
- },
- },
- },
- Recipient: state.NewIdentScreenName("recipient-screen-name"),
- Sender: state.NewIdentScreenName("sender-screen-name"),
- Sent: time.Date(2020, time.August, 1, 0, 0, 0, 0, time.UTC),
- },
- err: assert.AnError,
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- results: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: 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}},
- },
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "send offline message when SaveMessage returns ErrNoUser, return ICBM error",
- instance: newTestInstance("sender-screen-name", sessOptWarning(10)),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVRequestHostAck, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3, 4}),
- },
- },
- },
- },
- expectOutput: &wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeNotLoggedOn,
- },
- },
- wantErr: nil,
- timeNow: func() time.Time {
- return time.Date(2020, time.August, 1, 0, 0, 0, 0, time.UTC)
- },
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: nil,
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{},
- },
- offlineMessageManagerParams: offlineMessageManagerParams{
- saveMessageParams: saveMessageParams{
- {
- offlineMessageIn: state.OfflineMessage{
- Message: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "recipient-screen-name",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVRequestHostAck, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVStore, []byte{}),
- wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3, 4}),
- },
- },
- },
- Recipient: state.NewIdentScreenName("recipient-screen-name"),
- Sender: state.NewIdentScreenName("sender-screen-name"),
- Sent: time.Date(2020, time.August, 1, 0, 0, 0, 0, time.UTC),
- },
- err: state.ErrNoUser,
- },
- },
- },
- feedbagManagerParams: feedbagManagerParams{
- feedbagParams: feedbagParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- results: []wire.FeedbagItem{
- {
- ClassID: wire.FeedbagClassIdBuddyPrefs,
- TLVLBlock: wire.TLVLBlock{
- TLVList: 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}},
- },
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "ICQ channel feedbag ch4: auth_ok",
- instance: newTestInstance("100001", sessOptUIN(100001)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("100001"),
- them: state.NewIdentScreenName("200002"),
- result: state.Relationship{
- User: state.NewIdentScreenName("200002"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("200002"),
- result: newTestInstance("200002", sessOptFeedbagEnabled, sessOptSignonComplete).Session(),
- },
- },
- },
- },
- expectForwardICQAuthEvents: true,
- expectForwardRecipient: state.NewIdentScreenName("200002"),
- expectForwardAuthMsg: wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAuthOK,
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{},
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "200002",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAuthOK,
- }),
- },
- },
- },
- },
- expectOutput: nil,
- wantErr: nil,
- },
- {
- name: "ICQ channel non-feedbag ch4: auth_ok",
- instance: newTestInstance("100001", sessOptUIN(100001)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("100001"),
- them: state.NewIdentScreenName("200002"),
- result: state.Relationship{
- User: state.NewIdentScreenName("200002"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("200002"),
- result: newTestInstance("200002", sessOptSignonComplete).Session(),
- },
- },
- },
- contactPreAuthorizerParams: contactPreAuthorizerParams{
- recordPreAuthParams: recordPreAuthParams{
- {owner: state.NewIdentScreenName("100001"), buddy: state.NewIdentScreenName("200002")},
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("200002"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- ChannelID: wire.ICBMChannelICQ,
- TLVUserInfo: newTestInstance("100001", sessOptUIN(100001)).Session().TLVUserInfo(),
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAuthOK,
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{},
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "200002",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAuthOK,
- }),
- },
- },
- },
- },
- expectOutput: nil,
- wantErr: nil,
- },
- {
- name: "ICQ channel feedbag ch4: auth_deny",
- instance: newTestInstance("100001", sessOptUIN(100001)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("100001"),
- them: state.NewIdentScreenName("200002"),
- result: state.Relationship{
- User: state.NewIdentScreenName("200002"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("200002"),
- result: newTestInstance("200002", sessOptFeedbagEnabled, sessOptSignonComplete).Session(),
- },
- },
- },
- },
- expectForwardICQAuthEvents: true,
- expectForwardRecipient: state.NewIdentScreenName("200002"),
- expectForwardAuthMsg: wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAuthDeny,
- Message: "no thanks",
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{},
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "200002",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAuthDeny,
- Message: "no thanks",
- }),
- },
- },
- },
- },
- expectOutput: nil,
- wantErr: nil,
- },
- {
- name: "ICQ channel feedbag ch4: added",
- instance: newTestInstance("100001", sessOptUIN(100001)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("100001"),
- them: state.NewIdentScreenName("200002"),
- result: state.Relationship{
- User: state.NewIdentScreenName("200002"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("200002"),
- result: newTestInstance("200002", sessOptFeedbagEnabled, sessOptSignonComplete).Session(),
- },
- },
- },
- },
- expectForwardICQAuthEvents: true,
- expectForwardRecipient: state.NewIdentScreenName("200002"),
- expectForwardAuthMsg: wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAdded,
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{},
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "200002",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAdded,
- }),
- },
- },
- },
- },
- expectOutput: nil,
- wantErr: nil,
- },
- {
- name: "ICQ channel feedbag ch4: auth_req",
- instance: newTestInstance("100001", sessOptUIN(100001)),
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("100001"),
- them: state.NewIdentScreenName("200002"),
- result: state.Relationship{
- User: state.NewIdentScreenName("200002"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("200002"),
- result: newTestInstance("200002", sessOptFeedbagEnabled, sessOptSignonComplete).Session(),
- },
- },
- },
- },
- expectForwardICQAuthEvents: true,
- expectForwardRecipient: state.NewIdentScreenName("200002"),
- expectForwardAuthMsg: wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAuthReq,
- Message: "hi",
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{},
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelICQ,
- ScreenName: "200002",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVLE(wire.ICBMTLVData, wire.ICBMCh4Message{
- UIN: 100001,
- MessageType: wire.ICBMMsgTypeAuthReq,
- Message: "hi",
- }),
- },
- },
- },
- },
- expectOutput: nil,
- wantErr: nil,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- discardLogger := slog.New(slog.NewTextHandler(io.Discard, nil))
- relationshipFetcher := newMockRelationshipFetcher(t)
- for _, item := range tc.mockParams.relationshipParams {
- relationshipFetcher.EXPECT().
- Relationship(matchContext(), item.me, item.them).
- Return(item.result, item.err)
- }
- sessionRetriever := newMockSessionRetriever(t)
- for _, item := range tc.mockParams.retrieveSessionParams {
- sessionRetriever.EXPECT().
- RetrieveSession(item.screenName).
- Return(item.result)
- }
- messageRelayer := newMockMessageRelayer(t)
- for _, item := range tc.mockParams.relayToScreenNameParams {
- messageRelayer.EXPECT().
- RelayToScreenName(mock.Anything, item.screenName, item.message)
- }
- for _, item := range tc.mockParams.relayToScreenNameActiveOnlyParams {
- messageRelayer.EXPECT().
- RelayToScreenNameActiveOnly(mock.Anything, item.screenName, item.message)
- }
- offlineMessageManager := newMockOfflineMessageManager(t)
- for _, params := range tc.mockParams.saveMessageParams {
- offlineMessageManager.EXPECT().
- SaveMessage(matchContext(), params.offlineMessageIn).
- Return(params.countOut, params.err)
- }
- feedbagManager := newMockFeedbagManager(t)
- for _, params := range tc.mockParams.feedbagParams {
- feedbagManager.EXPECT().
- Feedbag(matchContext(), params.screenName).
- Return(params.results, params.err)
- }
- for _, params := range tc.mockParams.feedbagUpsertParams {
- feedbagManager.EXPECT().
- FeedbagUpsert(matchContext(), params.screenName, params.items).
- Return(nil)
- }
- buddyBroadcaster := newMockbuddyBroadcaster(t)
- for _, params := range tc.mockParams.broadcastBuddyArrivedParams {
- buddyBroadcaster.EXPECT().
- BroadcastBuddyArrived(matchContext(), state.NewIdentScreenName(params.screenName.String()), mock.Anything).
- Return(params.err)
- }
- for _, params := range tc.mockParams.broadcastVisibilityParams {
- buddyBroadcaster.EXPECT().
- BroadcastVisibility(mock.Anything, matchSession(params.from), params.filter, params.doSendDepartures).
- Return(params.err)
- }
- contactPreAuth := newMockContactPreAuthorizer(t)
- for _, params := range tc.mockParams.recordPreAuthParams {
- contactPreAuth.EXPECT().
- RecordPreAuth(matchContext(), params.owner, params.buddy).
- Return(params.err)
- }
- svc := ICBMService{
- relationshipFetcher: relationshipFetcher,
- messageRelayer: messageRelayer,
- offlineMessageSaver: offlineMessageManager,
- sessionRetriever: sessionRetriever,
- timeNow: tc.timeNow,
- convoTracker: newConvoTracker(),
- feedbagManager: feedbagManager,
- contactPreAuthorizer: contactPreAuth,
- buddyBroadcaster: buddyBroadcaster,
- logger: discardLogger,
- }
- var forwardCalled bool
- svc.forwardICQAuthEvents = func(ctx context.Context, sender state.IdentScreenName, recipient state.IdentScreenName, authMsg wire.ICBMCh4Message) error {
- forwardCalled = true
- assert.Equal(t, tc.instance.IdentScreenName(), sender)
- assert.Equal(t, tc.expectForwardRecipient, recipient)
- assert.Equal(t, tc.expectForwardAuthMsg, authMsg)
- return nil
- }
- outputSNAC, err := svc.ChannelMsgToHost(context.Background(), tc.instance, tc.inputSNAC.Frame,
- tc.inputSNAC.Body.(wire.SNAC_0x04_0x06_ICBMChannelMsgToHost))
- assert.ErrorIs(t, err, tc.wantErr)
- assert.Equal(t, tc.expectOutput, outputSNAC)
- assert.Equal(t, tc.expectForwardICQAuthEvents, forwardCalled)
- })
- }
- }
- func TestICBMService_ClientEvent(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // senderScreenName is the screen name of the user sending the event
- senderScreenName state.DisplayScreenName
- // inputSNAC is the SNAC sent by the sender client
- inputSNAC wire.SNACMessage
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- // expectError indicates whether an error is expected
- expectError bool
- }{
- {
- name: "transmit typing event (event=2) from sender to recipient",
- senderScreenName: "sender-screen-name",
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMClientEvent,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x14_ICBMClientEvent{
- Cookie: 12345678,
- ChannelID: 42,
- ScreenName: "sender-screen-name",
- Event: 2, // typing
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x14_ICBMClientEvent{
- Cookie: 12345678,
- ChannelID: 42,
- ScreenName: "recipient-screen-name",
- Event: 2, // typing
- },
- },
- },
- {
- name: "transmit text typed event (event=1) from sender to recipient",
- senderScreenName: "sender-screen-name",
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMClientEvent,
- RequestID: 5678,
- },
- Body: wire.SNAC_0x04_0x14_ICBMClientEvent{
- Cookie: 87654321,
- ChannelID: 1,
- ScreenName: "sender-screen-name",
- Event: 1, // text typed
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 5678,
- },
- Body: wire.SNAC_0x04_0x14_ICBMClientEvent{
- Cookie: 87654321,
- ChannelID: 1,
- ScreenName: "recipient-screen-name",
- Event: 1, // text typed
- },
- },
- },
- {
- name: "transmit stopped typing event (event=0) from sender to recipient",
- senderScreenName: "sender-screen-name",
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMClientEvent,
- RequestID: 9999,
- },
- Body: wire.SNAC_0x04_0x14_ICBMClientEvent{
- Cookie: 98765432,
- ChannelID: 5,
- ScreenName: "sender-screen-name",
- Event: 0, // stopped typing
- },
- },
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 9999,
- },
- Body: wire.SNAC_0x04_0x14_ICBMClientEvent{
- Cookie: 98765432,
- ChannelID: 5,
- ScreenName: "recipient-screen-name",
- Event: 0, // stopped typing
- },
- },
- },
- {
- name: "don't transmit typing event because sender has blocked recipient",
- senderScreenName: "sender-screen-name",
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: true,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{},
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x14_ICBMClientEvent{
- Cookie: 12345678,
- ChannelID: 42,
- ScreenName: "recipient-screen-name",
- Event: 2, // typing
- },
- },
- },
- {
- name: "don't transmit typing event because recipient has blocked sender",
- senderScreenName: "sender-screen-name",
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: true,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{},
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x14_ICBMClientEvent{
- Cookie: 12345678,
- ChannelID: 42,
- ScreenName: "recipient-screen-name",
- Event: 2, // typing
- },
- },
- },
- {
- name: "return error when relationship fetcher fails",
- senderScreenName: "sender-screen-name",
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{},
- err: errors.New("database connection failed"),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameActiveOnlyParams: relayToScreenNameActiveOnlyParams{},
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x14_ICBMClientEvent{
- Cookie: 12345678,
- ChannelID: 42,
- ScreenName: "recipient-screen-name",
- Event: 2, // typing
- },
- },
- expectError: true,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- relationshipFetcher := newMockRelationshipFetcher(t)
- for _, item := range tc.mockParams.relationshipParams {
- relationshipFetcher.EXPECT().
- Relationship(matchContext(), item.me, item.them).
- Return(item.result, item.err)
- }
- messageRelayer := newMockMessageRelayer(t)
- for _, item := range tc.mockParams.relayToScreenNameActiveOnlyParams {
- messageRelayer.EXPECT().
- RelayToScreenNameActiveOnly(matchContext(), item.screenName, item.message)
- }
- senderSession := newTestInstance(tc.senderScreenName)
- svc := ICBMService{
- relationshipFetcher: relationshipFetcher,
- messageRelayer: messageRelayer,
- }
- err := svc.ClientEvent(context.Background(), senderSession, tc.inputSNAC.Frame,
- tc.inputSNAC.Body.(wire.SNAC_0x04_0x14_ICBMClientEvent))
- if tc.expectError {
- assert.Error(t, err)
- } else {
- assert.NoError(t, err)
- }
- })
- }
- }
- func TestICBMService_EvilRequest(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // senderScreenName is the session of the user sending the EvilRequest
- instance *state.SessionInstance
- // msgsReceived is the # of messages received from the warned user
- msgsReceived int
- // inputSNAC is the SNAC sent by the sender client
- inputSNAC wire.SNACMessage
- // expectOutput is the SNAC sent from the server to client
- expectOutput wire.SNACMessage
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- // waitForWarnMsg indicates whether to wait for session warn signal
- waitForWarnMsg bool
- }{
- {
- name: "transmit anonymous warning from sender to recipient",
- instance: newTestInstance("sender-screen-name"),
- msgsReceived: 1,
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x08_ICBMEvilRequest{
- SendAs: 1, // make it anonymous
- ScreenName: "recipient-screen-name",
- },
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMEvilReply,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x09_ICBMEvilReply{
- EvilDeltaApplied: 30,
- UpdatedEvilValue: 30,
- },
- },
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptCannedSignonTime).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.OService,
- SubGroup: wire.OServiceEvilNotification,
- },
- Body: wire.SNAC_0x01_0x10_OServiceEvilNotification{
- NewEvil: evilDeltaAnon,
- },
- },
- },
- },
- },
- },
- waitForWarnMsg: true,
- },
- {
- name: "transmit non-anonymous warning from sender to recipient",
- instance: newTestInstance("sender-screen-name", sessOptWarning(110)),
- msgsReceived: 1,
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x08_ICBMEvilRequest{
- SendAs: 0, // make it identified
- ScreenName: "recipient-screen-name",
- },
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMEvilReply,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x09_ICBMEvilReply{
- EvilDeltaApplied: 100,
- UpdatedEvilValue: 100,
- },
- },
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptCannedSignonTime).Session(),
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.OService,
- SubGroup: wire.OServiceEvilNotification,
- },
- Body: wire.SNAC_0x01_0x10_OServiceEvilNotification{
- NewEvil: evilDelta,
- Snitcher: &struct {
- wire.TLVUserInfo
- }{
- wire.TLVUserInfo{
- ScreenName: "sender-screen-name",
- WarningLevel: 110,
- },
- },
- },
- },
- },
- },
- },
- },
- waitForWarnMsg: true,
- },
- {
- name: "don't transmit non-anonymous warning from sender to recipient because sender has blocked recipient",
- instance: newTestInstance("sender-screen-name"),
- msgsReceived: 1,
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x08_ICBMEvilRequest{
- SendAs: 0, // make it identified
- ScreenName: "recipient-screen-name",
- },
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeNotLoggedOn,
- },
- },
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: true,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- },
- },
- {
- name: "don't transmit non-anonymous warning from sender to recipient because recipient has blocked sender",
- instance: newTestInstance("sender-screen-name"),
- msgsReceived: 1,
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x08_ICBMEvilRequest{
- SendAs: 0, // make it identified
- ScreenName: "recipient-screen-name",
- },
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeNotLoggedOn,
- },
- },
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: true,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- },
- },
- {
- name: "can't warn bots",
- instance: newTestInstance("sender-screen-name"),
- msgsReceived: 1,
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x08_ICBMEvilRequest{
- SendAs: 0, // make it identified
- ScreenName: "recipient-screen-name",
- },
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeRequestDenied,
- },
- },
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: newTestInstance("recipient-screen-name", sessOptBot).Session(),
- },
- },
- },
- },
- },
- {
- name: "don't let users warn themselves",
- instance: newTestInstance("sender-screen-name"),
- msgsReceived: 1,
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x08_ICBMEvilRequest{
- SendAs: 0, // make it identified
- ScreenName: "sender-screen-name",
- },
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeNotSupportedByHost,
- },
- },
- },
- {
- name: "don't transmit non-anonymous warning from sender to recipient because recipient is offline",
- instance: newTestInstance("sender-screen-name"),
- msgsReceived: 1,
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: nil,
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x08_ICBMEvilRequest{
- SendAs: 0, // make it identified
- ScreenName: "recipient-screen-name",
- },
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeNotLoggedOn,
- },
- },
- },
- {
- name: "don't transmit anonymous warning from sender to recipient because recipient is offline",
- instance: newTestInstance("sender-screen-name"),
- msgsReceived: 1,
- mockParams: mockParams{
- relationshipFetcherParams: relationshipFetcherParams{
- relationshipParams: relationshipParams{
- {
- me: state.NewIdentScreenName("sender-screen-name"),
- them: state.NewIdentScreenName("recipient-screen-name"),
- result: state.Relationship{
- User: state.NewIdentScreenName("recipient-screen-name"),
- BlocksYou: false,
- YouBlock: false,
- IsOnTheirList: false,
- IsOnYourList: false,
- },
- },
- },
- },
- sessionRetrieverParams: sessionRetrieverParams{
- retrieveSessionParams{
- {
- screenName: state.NewIdentScreenName("recipient-screen-name"),
- result: nil,
- },
- },
- },
- },
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x08_ICBMEvilRequest{
- SendAs: 1, // make it anonymous
- ScreenName: "recipient-screen-name",
- },
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMErr,
- RequestID: 1234,
- },
- Body: wire.SNACError{
- Code: wire.ErrorCodeNotLoggedOn,
- },
- },
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- relationshipFetcher := newMockRelationshipFetcher(t)
- for _, item := range tc.mockParams.relationshipParams {
- relationshipFetcher.EXPECT().
- Relationship(matchContext(), item.me, item.them).
- Return(item.result, item.err)
- }
- sessionRetriever := newMockSessionRetriever(t)
- for _, item := range tc.mockParams.retrieveSessionParams {
- sessionRetriever.EXPECT().
- RetrieveSession(item.screenName).
- Return(item.result)
- }
- messageRelayer := newMockMessageRelayer(t)
- for _, item := range tc.mockParams.relayToScreenNameParams {
- messageRelayer.EXPECT().
- RelayToScreenName(mock.Anything, item.screenName, item.message)
- }
- for _, item := range tc.mockParams.relayToScreenNameActiveOnlyParams {
- messageRelayer.EXPECT().
- RelayToScreenNameActiveOnly(mock.Anything, item.screenName, item.message)
- }
- offlineMessageManager := newMockOfflineMessageManager(t)
- for _, params := range tc.mockParams.saveMessageParams {
- offlineMessageManager.EXPECT().
- SaveMessage(matchContext(), params.offlineMessageIn).
- Return(params.countOut, params.err)
- }
- svc := ICBMService{
- relationshipFetcher: relationshipFetcher,
- messageRelayer: messageRelayer,
- offlineMessageSaver: offlineMessageManager,
- sessionRetriever: sessionRetriever,
- convoTracker: newConvoTracker(),
- snacRateLimits: wire.DefaultSNACRateLimits(),
- }
- for i := 0; i < tc.msgsReceived; i++ {
- svc.convoTracker.trackConvo(time.Now(),
- state.NewIdentScreenName(tc.inputSNAC.Body.(wire.SNAC_0x04_0x08_ICBMEvilRequest).ScreenName),
- tc.instance.IdentScreenName())
- }
- var wg sync.WaitGroup
- if tc.waitForWarnMsg {
- wg.Add(1)
- go func() {
- defer wg.Done()
- for _, sess := range tc.mockParams.retrieveSessionParams {
- <-sess.result.WarningCh()
- }
- }()
- }
- outputSNAC, err := svc.EvilRequest(context.Background(), tc.instance, tc.inputSNAC.Frame,
- tc.inputSNAC.Body.(wire.SNAC_0x04_0x08_ICBMEvilRequest))
- assert.NoError(t, err)
- assert.Equal(t, tc.expectOutput, outputSNAC)
- wg.Wait()
- })
- }
- }
- func TestICBMService_ParameterQuery(t *testing.T) {
- svc := NewICBMService(nil, nil, nil, nil, nil, nil, nil, nil, wire.DefaultSNACRateLimits(), slog.Default())
- have := svc.ParameterQuery(context.TODO(), wire.SNACFrame{RequestID: 1234})
- want := wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMParameterReply,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x05_ICBMParameterReply{
- MaxSlots: 100,
- ICBMFlags: 3,
- MaxIncomingICBMLen: 512,
- MaxSourceEvil: 999,
- MaxDestinationEvil: 999,
- MinInterICBMInterval: 0,
- },
- }
- assert.Equal(t, want, have)
- }
- func TestICBMService_ClientErr(t *testing.T) {
- instance := newTestInstance("theScreenName")
- inBody := wire.SNAC_0x04_0x0B_ICBMClientErr{
- Cookie: 1234,
- ChannelID: wire.ICBMChannelMIME,
- ScreenName: "recipientScreenName",
- Code: 10,
- ErrInfo: []byte{1, 2, 3, 4},
- }
- expect := wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMClientErr,
- RequestID: 1234,
- },
- Body: wire.SNAC_0x04_0x0B_ICBMClientErr{
- Cookie: inBody.Cookie,
- ChannelID: inBody.ChannelID,
- ScreenName: instance.DisplayScreenName().String(),
- Code: inBody.Code,
- ErrInfo: inBody.ErrInfo,
- },
- }
- messageRelayer := newMockMessageRelayer(t)
- messageRelayer.EXPECT().
- RelayToScreenName(mock.Anything, state.NewIdentScreenName("recipientScreenName"), expect)
- svc := NewICBMService(nil, messageRelayer, nil, nil, nil, nil, nil, nil, wire.DefaultSNACRateLimits(), slog.Default())
- err := svc.ClientErr(context.Background(), instance, wire.SNACFrame{RequestID: 1234}, inBody)
- assert.NoError(t, err)
- }
- func TestICBMService_OfflineRetrieve(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // senderInstance is the session of the user retrieving messages
- senderInstance *state.SessionInstance
- // inputSNAC is the input frame (RequestID checked on reply)
- inputSNAC wire.SNACMessage
- // expectOutput is the expected return SNAC value.
- expectOutput wire.SNACMessage
- // wantErr is the expected error (nil for success)
- wantErr error
- // mockParams is the list of params sent to mocks that satisfy this method's dependencies
- mockParams mockParams
- }{
- {
- name: "relays stored messages and replies",
- senderInstance: newTestInstance("recipient"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{RequestID: 42},
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMOfflineRetrieveReply,
- RequestID: 42,
- },
- Body: wire.SNAC_0x04_0x17_ICBMOfflineRetrieveReply{},
- },
- wantErr: nil,
- mockParams: mockParams{
- offlineMessageManagerParams: offlineMessageManagerParams{
- retrieveMessagesParams: retrieveMessagesParams{
- {
- recipIn: state.NewIdentScreenName("recipient"),
- messagesOut: []state.OfflineMessage{
- {
- Message: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- Cookie: 1234,
- ChannelID: wire.ICBMChannelIM,
- TLVRestBlock: wire.TLVRestBlock{TLVList: []wire.TLV{wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3})}},
- },
- Recipient: state.NewIdentScreenName("recipient"),
- Sender: state.NewIdentScreenName("sender"),
- Sent: time.Unix(1700000000, 0).UTC(),
- },
- },
- },
- },
- deleteMessagesParams: deleteMessagesParams{
- {
- recipIn: state.NewIdentScreenName("recipient"),
- err: nil,
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: state.NewIdentScreenName("recipient"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: func() wire.SNAC_0x04_0x07_ICBMChannelMsgToClient {
- msg := wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- Cookie: 1234,
- ChannelID: wire.ICBMChannelIM,
- TLVUserInfo: wire.TLVUserInfo{
- ScreenName: "sender",
- },
- TLVRestBlock: wire.TLVRestBlock{},
- }
- msg.Append(wire.NewTLVBE(wire.ICBMTLVData, []byte{1, 2, 3}))
- msg.Append(wire.NewTLVBE(wire.ICBMTLVSendTime, uint32(time.Unix(1700000000, 0).UTC().Unix())))
- return msg
- }(),
- },
- },
- },
- },
- },
- },
- {
- name: "no stored messages returns reply without relays or deletes",
- senderInstance: newTestInstance("recipient"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{RequestID: 55},
- },
- expectOutput: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMOfflineRetrieveReply,
- RequestID: 55,
- },
- Body: wire.SNAC_0x04_0x17_ICBMOfflineRetrieveReply{},
- },
- wantErr: nil,
- mockParams: mockParams{
- offlineMessageManagerParams: offlineMessageManagerParams{
- retrieveMessagesParams: retrieveMessagesParams{
- {
- recipIn: state.NewIdentScreenName("recipient"),
- messagesOut: []state.OfflineMessage{},
- err: nil,
- },
- },
- deleteMessagesParams: deleteMessagesParams{},
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{},
- },
- },
- },
- {
- name: "delete messages error after relay",
- senderInstance: newTestInstance("recipient"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{RequestID: 99},
- },
- expectOutput: wire.SNACMessage{},
- wantErr: assert.AnError,
- mockParams: mockParams{
- offlineMessageManagerParams: offlineMessageManagerParams{
- retrieveMessagesParams: retrieveMessagesParams{
- {
- recipIn: state.NewIdentScreenName("recipient"),
- messagesOut: []state.OfflineMessage{
- {
- Message: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- Cookie: 4321,
- ChannelID: wire.ICBMChannelIM,
- TLVRestBlock: wire.TLVRestBlock{TLVList: []wire.TLV{wire.NewTLVBE(wire.ICBMTLVData, []byte{9, 8, 7})}},
- },
- Recipient: state.NewIdentScreenName("recipient"),
- Sender: state.NewIdentScreenName("sender"),
- Sent: time.Unix(1700001234, 0).UTC(),
- },
- },
- },
- },
- deleteMessagesParams: deleteMessagesParams{
- {
- recipIn: state.NewIdentScreenName("recipient"),
- err: assert.AnError,
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{
- {
- screenName: state.NewIdentScreenName("recipient"),
- message: wire.SNACMessage{
- Frame: wire.SNACFrame{
- FoodGroup: wire.ICBM,
- SubGroup: wire.ICBMChannelMsgToClient,
- RequestID: wire.ReqIDFromServer,
- },
- Body: func() wire.SNAC_0x04_0x07_ICBMChannelMsgToClient {
- msg := wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{
- Cookie: 4321,
- ChannelID: wire.ICBMChannelIM,
- TLVUserInfo: wire.TLVUserInfo{
- ScreenName: "sender",
- },
- TLVRestBlock: wire.TLVRestBlock{},
- }
- msg.Append(wire.NewTLVBE(wire.ICBMTLVData, []byte{9, 8, 7}))
- msg.Append(wire.NewTLVBE(wire.ICBMTLVSendTime, uint32(time.Unix(1700001234, 0).UTC().Unix())))
- return msg
- }(),
- },
- },
- },
- },
- },
- },
- {
- name: "propagates retrieve error",
- senderInstance: newTestInstance("recipient"),
- inputSNAC: wire.SNACMessage{
- Frame: wire.SNACFrame{RequestID: 7},
- },
- expectOutput: wire.SNACMessage{},
- wantErr: assert.AnError,
- mockParams: mockParams{
- offlineMessageManagerParams: offlineMessageManagerParams{
- retrieveMessagesParams: retrieveMessagesParams{
- {
- recipIn: state.NewIdentScreenName("recipient"),
- messagesOut: nil,
- err: assert.AnError,
- },
- },
- },
- messageRelayerParams: messageRelayerParams{
- relayToScreenNameParams: relayToScreenNameParams{},
- },
- },
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- offlineMessageManager := newMockOfflineMessageManager(t)
- for _, params := range tc.mockParams.retrieveMessagesParams {
- offlineMessageManager.EXPECT().
- RetrieveMessages(matchContext(), params.recipIn).
- Return(params.messagesOut, params.err)
- }
- for _, params := range tc.mockParams.deleteMessagesParams {
- offlineMessageManager.EXPECT().
- DeleteMessages(matchContext(), params.recipIn).
- Return(params.err)
- }
- messageRelayer := newMockMessageRelayer(t)
- for _, item := range tc.mockParams.relayToScreenNameParams {
- messageRelayer.EXPECT().
- RelayToScreenName(mock.Anything, item.screenName, item.message)
- }
- svc := ICBMService{
- messageRelayer: messageRelayer,
- offlineMessageManager: offlineMessageManager,
- }
- out, err := svc.OfflineRetrieve(context.Background(), tc.senderInstance, tc.inputSNAC.Frame)
- assert.Equal(t, tc.expectOutput, out)
- assert.ErrorIs(t, err, tc.wantErr)
- })
- }
- }
- func TestRingBuffer(t *testing.T) {
- t.Run("new ringBuffer should have zero values", func(t *testing.T) {
- rb := &ringBuffer{}
- // Test val() on empty ringBuffer - should return zero time
- result := rb.val()
- zeroTime := time.Time{}
- assert.Equal(t, zeroTime, result)
- })
- t.Run("val() should return current time", func(t *testing.T) {
- now := time.Now()
- rb := &ringBuffer{
- cur: 1,
- vals: [3]time.Time{
- now.Add(-2 * time.Hour),
- now.Add(-1 * time.Hour),
- now,
- },
- }
- result := rb.val()
- assert.Equal(t, rb.vals[1], result)
- })
- t.Run("set() should store time and advance cursor", func(t *testing.T) {
- rb := &ringBuffer{cur: 0}
- newTime := time.Now()
- // Set the time
- rb.set(newTime)
- // After set, cursor should advance to position 1
- // We can verify this by setting another time and checking that it's stored at position 1
- secondTime := time.Now().Add(time.Hour)
- rb.set(secondTime)
- // Now cursor should be at position 2, so val() should return the time at position 2
- // But since we only set 2 times, position 2 should still be the zero time
- zeroTime := time.Time{}
- assert.Equal(t, zeroTime, rb.val())
- })
- t.Run("set() should wrap around after reaching end of array", func(t *testing.T) {
- rb := &ringBuffer{cur: 2}
- newTime := time.Now()
- // Set the time at position 2
- rb.set(newTime)
- // Cursor should wrap around to position 0
- // We can verify this by setting another time and checking behavior
- rb.set(time.Now().Add(time.Hour))
- // Now cursor should be at position 1, so val() should return the time at position 1
- // But since we only set 2 times, position 1 should still be the zero time
- zeroTime := time.Time{}
- assert.Equal(t, zeroTime, rb.val())
- })
- t.Run("set() should handle multiple insertions correctly", func(t *testing.T) {
- rb := &ringBuffer{}
- // Insert 3 times
- time1 := time.Now()
- time2 := time.Now().Add(time.Hour)
- time3 := time.Now().Add(2 * time.Hour)
- rb.set(time1)
- rb.set(time2)
- rb.set(time3)
- // After 3 insertions, cursor should be at position 0
- // So val() should return the time at position 0
- // This should be time1 since it was the first time set
- assert.Equal(t, time1, rb.val())
- })
- t.Run("set() should overwrite existing values in order", func(t *testing.T) {
- rb := &ringBuffer{}
- // Set 3 times to fill the buffer
- rb.set(time.Now())
- rb.set(time.Now().Add(time.Hour))
- rb.set(time.Now().Add(2 * time.Hour))
- // After 3 sets, cursor is at position 0, val() returns first time
- firstTime := rb.val()
- assert.False(t, firstTime.IsZero())
- // Set a 4th time - should overwrite position 0
- fourthTime := time.Now().Add(3 * time.Hour)
- rb.set(fourthTime)
- // Now cursor is at position 1, val() returns second time
- secondTime := rb.val()
- assert.False(t, secondTime.IsZero())
- // Set a 5th time - should overwrite position 1
- fifthTime := time.Now().Add(4 * time.Hour)
- rb.set(fifthTime)
- // Now cursor is at position 2, val() returns third time
- thirdTime := rb.val()
- assert.False(t, thirdTime.IsZero())
- // Set a 6th time - should overwrite position 2
- sixthTime := time.Now().Add(5 * time.Hour)
- rb.set(sixthTime)
- // Now cursor wraps around to position 0, val() returns fourth time
- assert.Equal(t, fourthTime, rb.val())
- })
- t.Run("val() should return correct time after multiple operations", func(t *testing.T) {
- rb := &ringBuffer{}
- // Insert times and verify val() returns correct current time
- time1 := time.Now()
- time2 := time.Now().Add(time.Hour)
- rb.set(time1)
- rb.set(time2)
- // After 2 sets, cursor is at position 2
- // So val() should return the time at position 2
- // But since we only set 2 times, position 2 should still be the zero time
- zeroTime := time.Time{}
- assert.Equal(t, zeroTime, rb.val())
- // Set one more to wrap around
- time3 := time.Now().Add(2 * time.Hour)
- rb.set(time3)
- // Now cursor is at position 0, so val() should return the time at position 0
- // This should be time1
- assert.Equal(t, time1, rb.val())
- })
- t.Run("ringBuffer should maintain circular behavior over many operations", func(t *testing.T) {
- rb := &ringBuffer{}
- // Perform many operations to test circular behavior
- for i := 0; i < 10; i++ {
- rb.set(time.Now().Add(time.Duration(i) * time.Hour))
- }
- // After 10 operations, cursor should be at position 1 (10 % 3 = 1)
- // So val() should return the time at position 1
- // This should be the 8th time set (at position 1)
- // We can't compare exact times since they're set in a loop, so just verify it's not zero
- assert.False(t, rb.val().IsZero())
- // Set one more to advance cursor to position 2
- rb.set(time.Now().Add(10 * time.Hour))
- // Now cursor is at position 2, so val() should return the time at position 2
- // This should be the 9th time set (at position 2)
- assert.False(t, rb.val().IsZero())
- // Set one more to wrap around to position 0
- rb.set(time.Now().Add(11 * time.Hour))
- // Now cursor is at position 0, so val() should return the time at position 0
- // This should be the 10th time set (at position 0)
- assert.False(t, rb.val().IsZero())
- })
- t.Run("ringBuffer should cycle through all positions correctly", func(t *testing.T) {
- rb := &ringBuffer{}
- // Test cycling through all 3 positions
- times := []time.Time{
- time.Now(),
- time.Now().Add(time.Hour),
- time.Now().Add(2 * time.Hour),
- }
- // Set all 3 times
- for _, t := range times {
- rb.set(t)
- }
- // After 3 sets, cursor should be at position 0
- // So val() should return the time at position 0
- assert.Equal(t, times[0], rb.val())
- // Set one more to advance cursor to position 1
- nextTime := time.Now().Add(3 * time.Hour)
- rb.set(nextTime)
- // Now cursor is at position 1, so val() should return the time at position 1
- // This should be the second time since it was stored at position 1
- assert.Equal(t, times[1], rb.val())
- })
- }
- func TestConvoTracker(t *testing.T) {
- ct := newConvoTracker()
- sender := state.NewIdentScreenName("sender")
- recip := state.NewIdentScreenName("recipient")
- now := time.Now()
- // can't warn until a message is sent
- assert.False(t, ct.trackWarn(now, recip, sender))
- // can warn 1st time
- ct.trackConvo(now, sender, recip)
- assert.True(t, ct.trackWarn(now, recip, sender))
- // can't warn 2nd time until 2nd message is sent
- assert.False(t, ct.trackWarn(now, recip, sender))
- // can warn 2nd time
- now = now.Add(1 * time.Second)
- ct.trackConvo(now, sender, recip)
- assert.True(t, ct.trackWarn(now, recip, sender))
- // can't warn 3rd time until 3rd message is sent
- assert.False(t, ct.trackWarn(now, recip, sender))
- // can warn 3rd time
- now = now.Add(1 * time.Second)
- ct.trackConvo(now, sender, recip)
- assert.True(t, ct.trackWarn(now, recip, sender))
- // can't warn 4th time
- now = now.Add(1 * time.Second)
- ct.trackConvo(now, sender, recip)
- assert.False(t, ct.trackWarn(now, recip, sender))
- // let an hour pass, we should be able to warn again
- now = now.Add(1 * time.Hour)
- ct.trackConvo(now, sender, recip)
- assert.True(t, ct.trackWarn(now, recip, sender))
- }
- func TestICBMService_UpdateWarnLevel(t *testing.T) {
- t.Run("happy path", func(t *testing.T) {
- now := time.Now()
- instance := newTestInstance("screen-name")
- warnCh := make(chan uint16)
- mockBuddyBroadcaster := newMockbuddyBroadcaster(t)
- mockBuddyBroadcaster.EXPECT().
- BroadcastBuddyArrived(mock.Anything, instance.IdentScreenName(), mock.MatchedBy(func(userInfo wire.TLVUserInfo) bool {
- return userInfo.ScreenName == instance.IdentScreenName().String()
- })).
- Run(func(ctx context.Context, screenName state.IdentScreenName, userInfo wire.TLVUserInfo) {
- warnCh <- userInfo.WarningLevel
- }).Return(nil)
- u := &state.User{}
- userManager := newMockUserManager(t)
- userManager.EXPECT().
- User(matchContext(), instance.IdentScreenName()).
- Return(u, nil)
- userManager.EXPECT().
- SetWarnLevel(matchContext(), instance.IdentScreenName(), now, uint16(100)).
- Return(nil)
- userManager.EXPECT().
- SetWarnLevel(matchContext(), instance.IdentScreenName(), now, uint16(50)).
- Return(nil)
- userManager.EXPECT().
- SetWarnLevel(matchContext(), instance.IdentScreenName(), now, uint16(30)).
- Return(nil)
- userManager.EXPECT().
- SetWarnLevel(matchContext(), instance.IdentScreenName(), now, uint16(0)).
- Return(nil)
- svc := ICBMService{
- buddyBroadcaster: mockBuddyBroadcaster,
- interval: 1 * time.Millisecond,
- logger: slog.Default(),
- snacRateLimits: wire.DefaultSNACRateLimits(),
- timeNow: func() time.Time { return now },
- userManager: userManager,
- }
- ctx, cancel := context.WithCancel(context.Background())
- defer cancel()
- var wg sync.WaitGroup
- wg.Add(1)
- go func() {
- defer wg.Done()
- svc.UpdateWarnLevel(ctx, instance) // do a sync test here?
- }()
- ok, _ := instance.Session().ScaleWarningAndRateLimit(100, 3)
- assert.True(t, ok)
- assert.Equal(t, uint16(100), <-warnCh)
- assert.Equal(t, uint16(50), <-warnCh)
- assert.Equal(t, uint16(0), <-warnCh)
- ok, _ = instance.Session().ScaleWarningAndRateLimit(100, 3)
- assert.True(t, ok)
- assert.Equal(t, uint16(100), <-warnCh)
- assert.Equal(t, uint16(50), <-warnCh)
- assert.Equal(t, uint16(0), <-warnCh)
- instance.Session().ScaleWarningAndRateLimit(30, 3)
- assert.Equal(t, uint16(30), <-warnCh)
- assert.Equal(t, uint16(0), <-warnCh)
- cancel()
- wg.Wait()
- })
- }
- func TestICBMService_RestoreWarningLevel(t *testing.T) {
- tests := []struct {
- name string
- lastWarnUpdate time.Duration
- lastWarnLevel uint16
- expectedWarn uint16
- }{
- {
- name: "decays warning when last update is before interval boundary",
- lastWarnUpdate: -15*time.Millisecond - 1*time.Millisecond,
- lastWarnLevel: 250,
- expectedWarn: 100,
- },
- {
- name: "decays warning when last update is after interval boundary",
- lastWarnUpdate: -15*time.Millisecond + 1*time.Millisecond,
- lastWarnLevel: 250,
- expectedWarn: 150,
- },
- {
- name: "decays warning when last update is exactly on interval boundary",
- lastWarnUpdate: -15 * time.Millisecond,
- lastWarnLevel: 250,
- expectedWarn: 100,
- },
- {
- name: "resets warning to zero when time is exactly at decay period",
- lastWarnUpdate: -25 * time.Millisecond,
- lastWarnLevel: 250,
- expectedWarn: 0,
- },
- {
- name: "resets warning to zero when time far decay period",
- lastWarnUpdate: -1 * time.Second,
- lastWarnLevel: 250,
- expectedWarn: 0,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- now := time.Now()
- instance := newTestInstance("screen-name")
- u := &state.User{
- LastWarnUpdate: now.Add(tt.lastWarnUpdate),
- LastWarnLevel: tt.lastWarnLevel,
- }
- userManager := newMockUserManager(t)
- userManager.EXPECT().
- User(matchContext(), instance.IdentScreenName()).
- Return(u, nil)
- svc := ICBMService{
- logger: slog.Default(),
- interval: 5 * time.Millisecond,
- snacRateLimits: wire.DefaultSNACRateLimits(),
- timeNow: func() time.Time { return now },
- userManager: userManager,
- }
- ctx, cancel := context.WithCancel(context.Background())
- defer cancel()
- statesBefore := instance.RateLimitStates()
- err := svc.RestoreWarningLevel(ctx, instance)
- assert.NoError(t, err)
- assert.Equal(t, tt.expectedWarn, instance.Warning())
- statesAfter := instance.RateLimitStates()
- if tt.expectedWarn > 0 {
- // make sure the rate limits changed
- assert.NotEqual(t, statesBefore, statesAfter)
- } else {
- // make sure the rate limits have been restored
- assert.Equal(t, statesBefore, statesAfter)
- }
- })
- }
- }
- func TestICBMService_RestoreWarningLevel_ErrorCases(t *testing.T) {
- t.Run("user does not exist", func(t *testing.T) {
- instance := newTestInstance("screen-name")
- userManager := newMockUserManager(t)
- userManager.EXPECT().
- User(matchContext(), instance.IdentScreenName()).
- Return(nil, nil)
- svc := ICBMService{
- logger: slog.Default(),
- interval: 5 * time.Millisecond,
- snacRateLimits: wire.DefaultSNACRateLimits(),
- timeNow: time.Now,
- userManager: userManager,
- }
- err := svc.RestoreWarningLevel(context.Background(), instance)
- assert.ErrorIs(t, err, state.ErrNoUser)
- })
- t.Run("user manager returns error", func(t *testing.T) {
- instance := newTestInstance("screen-name")
- expectedErr := errors.New("database connection failed")
- userManager := newMockUserManager(t)
- userManager.EXPECT().
- User(matchContext(), instance.IdentScreenName()).
- Return(nil, expectedErr)
- svc := ICBMService{
- logger: slog.Default(),
- interval: 5 * time.Millisecond,
- snacRateLimits: wire.DefaultSNACRateLimits(),
- timeNow: time.Now,
- userManager: userManager,
- }
- err := svc.RestoreWarningLevel(context.Background(), instance)
- assert.Error(t, err)
- // When user is nil, it returns ErrNoUser regardless of the error
- assert.ErrorIs(t, err, expectedErr)
- })
- t.Run("user exists with zero warning level", func(t *testing.T) {
- instance := newTestInstance("screen-name")
- u := &state.User{
- LastWarnUpdate: time.Now().Add(-10 * time.Millisecond),
- LastWarnLevel: 0, // No warning level
- }
- userManager := newMockUserManager(t)
- userManager.EXPECT().
- User(matchContext(), instance.IdentScreenName()).
- Return(u, nil)
- svc := ICBMService{
- logger: slog.Default(),
- interval: 5 * time.Millisecond,
- snacRateLimits: wire.DefaultSNACRateLimits(),
- timeNow: time.Now,
- userManager: userManager,
- }
- err := svc.RestoreWarningLevel(context.Background(), instance)
- assert.NoError(t, err)
- assert.Equal(t, uint16(0), instance.Warning())
- })
- }
- func Test_calcWarningLevelChange(t *testing.T) {
- t.Run("active warn level, last modified between intervals", func(t *testing.T) {
- now := time.Now()
- interval := 5 * time.Millisecond
- lastWarn := now.Add(-15 * time.Millisecond).Add(-1 * time.Millisecond)
- warnDelta := calcElapsedWarningLevel(lastWarn, now, interval)
- assert.Equal(t, int16(-150), warnDelta)
- })
- t.Run("active warn level, last modified between intervals", func(t *testing.T) {
- now := time.Now()
- interval := 5 * time.Millisecond
- lastWarn := now.Add(-15 * time.Millisecond).Add(1 * time.Millisecond)
- warnDelta := calcElapsedWarningLevel(lastWarn, now, interval)
- assert.Equal(t, int16(-100), warnDelta)
- })
- t.Run("active warn level, last modified exactly on interval", func(t *testing.T) {
- now := time.Now()
- interval := 5 * time.Millisecond
- lastWarn := now.Add(-15 * time.Millisecond)
- warnDelta := calcElapsedWarningLevel(lastWarn, now, interval)
- assert.Equal(t, int16(-150), warnDelta)
- })
- t.Run("resolved warn level", func(t *testing.T) {
- now := time.Now()
- interval := 5 * time.Millisecond
- lastWarn := now.Add(-25 * time.Millisecond)
- warnDelta := calcElapsedWarningLevel(lastWarn, now, interval)
- assert.Equal(t, int16(-250), warnDelta)
- })
- t.Run("resolved warn level - time past exceeds maximum window", func(t *testing.T) {
- now := time.Now()
- interval := 5 * time.Millisecond
- lastWarn := now.Add(-200 * time.Millisecond)
- warnDelta := calcElapsedWarningLevel(lastWarn, now, interval)
- assert.Equal(t, int16(-2000), warnDelta)
- })
- }
- func Test_calcRefreshInterval(t *testing.T) {
- t.Run("active warn level, last modified between intervals", func(t *testing.T) {
- now := time.Now()
- interval := 5 * time.Millisecond
- lastWarn := now.Add(-15 * time.Millisecond).Add(-1 * time.Millisecond)
- newInterval := timeTillNextInterval(lastWarn, now, interval)
- assert.Equal(t, 4*time.Millisecond, newInterval)
- })
- t.Run("active warn level, last modified between intervals", func(t *testing.T) {
- now := time.Now()
- interval := 5 * time.Millisecond
- lastWarn := now.Add(-15 * time.Millisecond).Add(1 * time.Millisecond)
- newInterval := timeTillNextInterval(lastWarn, now, interval)
- assert.Equal(t, 1*time.Millisecond, newInterval)
- })
- t.Run("active warn level, last modified exactly on interval", func(t *testing.T) {
- now := time.Now()
- interval := 5 * time.Millisecond
- lastWarn := now.Add(-15 * time.Millisecond)
- newInterval := timeTillNextInterval(lastWarn, now, interval)
- assert.Equal(t, 5*time.Millisecond, newInterval)
- })
- t.Run("resolved warn level", func(t *testing.T) {
- now := time.Now()
- interval := 5 * time.Millisecond
- lastWarn := now.Add(-25 * time.Millisecond)
- newInterval := timeTillNextInterval(lastWarn, now, interval)
- assert.Equal(t, interval, newInterval)
- })
- t.Run("resolved warn level - time past exceeds maximum window", func(t *testing.T) {
- now := time.Now()
- interval := 5 * time.Millisecond
- lastWarn := now.Add(-200 * time.Millisecond)
- newInterval := timeTillNextInterval(lastWarn, now, interval)
- assert.Equal(t, interval, newInterval)
- })
- }
- func TestStripHTML(t *testing.T) {
- tests := []struct {
- name string
- input []byte
- expected []byte
- }{
- {
- name: "simple HTML tags",
- input: []byte("<HTML><BODY>Hello World</BODY></HTML>"),
- expected: []byte("Hello World"),
- },
- {
- name: "BR tag to newline",
- input: []byte("Line 1<BR>Line 2"),
- expected: []byte("Line 1\nLine 2"),
- },
- {
- name: "lowercase br tag",
- input: []byte("Line 1<br>Line 2"),
- expected: []byte("Line 1\nLine 2"),
- },
- {
- name: "self-closing br tag",
- input: []byte("Line 1<br/>Line 2"),
- expected: []byte("Line 1\nLine 2"),
- },
- {
- name: "HTML entities",
- input: []byte("<test> & "quoted""),
- expected: []byte("<test> & \"quoted\""),
- },
- {
- name: "FONT tags with attributes",
- input: []byte(`<FONT FACE="Arial" SIZE="3">Text</FONT>`),
- expected: []byte("Text"),
- },
- {
- name: "mixed formatting",
- input: []byte("<HTML><BODY><B>Bold</B> <I>Italic</I></BODY></HTML>"),
- expected: []byte("Bold Italic"),
- },
- {
- name: "plain text unchanged",
- input: []byte("Hello World"),
- expected: []byte("Hello World"),
- },
- {
- name: "empty input",
- input: []byte(""),
- expected: []byte(""),
- },
- {
- name: "nbsp entity",
- input: []byte("Hello World"),
- expected: []byte("Hello\u00a0World"),
- },
- {
- name: "realistic HTML message",
- input: []byte(`<HTML><BODY dir="ltr"><FONT color="#000000" size="2" face="Arial">Hello</FONT></BODY></HTML>`),
- expected: []byte("Hello"),
- },
- {
- name: "apos entity",
- input: []byte("it's working"),
- expected: []byte("it's working"),
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- result := stripHTML(tt.input)
- assert.Equal(t, tt.expected, result)
- })
- }
- }
|