| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888 |
- package webapi
- import (
- "context"
- "encoding/json"
- "fmt"
- "log/slog"
- "net/http"
- "net/http/httptest"
- "strings"
- "testing"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/mock"
- "github.com/stretchr/testify/require"
- "github.com/mk6i/open-oscar-server/state"
- "github.com/mk6i/open-oscar-server/wire"
- )
- // onlineUserInfoReply builds a locate UserInfoReply for an online user,
- // optionally marking them idle by the given number of minutes (0 = not idle).
- func onlineUserInfoReply(screenName string, idleMinutes uint16) wire.SNACMessage {
- info := wire.TLVUserInfo{ScreenName: screenName}
- if idleMinutes > 0 {
- info.Append(wire.NewTLVBE(wire.OServiceUserInfoIdleTime, idleMinutes))
- }
- return wire.SNACMessage{
- Body: wire.SNAC_0x02_0x06_LocateUserInfoReply{TLVUserInfo: info},
- }
- }
- // screenNameMatcher matches a UserInfoQuery request body by its target screen name.
- func screenNameMatcher(screenName string) any {
- return mock.MatchedBy(func(b wire.SNAC_0x02_0x05_LocateUserInfoQuery) bool {
- return b.ScreenName == screenName
- })
- }
- func TestPresenceHandler_GetPresence(t *testing.T) {
- tests := []struct {
- name string
- queryParams string
- setupMocks func(*mockFeedbagService, *mockLocateService)
- expectedStatusCode int
- checkResponse func(*testing.T, string)
- }{
- {
- name: "Success_BuddyList",
- queryParams: "bl=1",
- setupMocks: func(fr *mockFeedbagService, ls *mockLocateService) {
- // Return feedbag with a group and buddy
- fr.EXPECT().Query(mock.Anything, mock.Anything, mock.Anything).
- Return(wire.SNACMessage{
- Body: wire.SNAC_0x13_0x06_FeedbagReply{
- Items: []wire.FeedbagItem{
- {ItemID: 0, ClassID: wire.FeedbagClassIdGroup, Name: "Friends", GroupID: 1},
- {ItemID: 2, ClassID: wire.FeedbagClassIdBuddy, Name: "buddy1", GroupID: 1},
- },
- },
- }, nil)
- ls.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, screenNameMatcher("buddy1")).
- Return(onlineUserInfoReply("buddy1", 0), nil)
- },
- expectedStatusCode: http.StatusOK,
- checkResponse: func(t *testing.T, body string) {
- assert.Contains(t, body, `"statusCode":200`)
- assert.Contains(t, body, `"groups"`)
- assert.Contains(t, body, `"Friends"`)
- assert.Contains(t, body, `"buddy1"`)
- assert.Contains(t, body, `"online"`)
- },
- },
- {
- name: "Success_TargetUsers",
- queryParams: "t=user1,user2",
- setupMocks: func(fr *mockFeedbagService, ls *mockLocateService) {
- ls.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, screenNameMatcher("user1")).
- Return(onlineUserInfoReply("user1", 0), nil)
- // user2 is idle for 7 minutes.
- ls.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, screenNameMatcher("user2")).
- Return(onlineUserInfoReply("user2", 7), nil)
- },
- expectedStatusCode: http.StatusOK,
- checkResponse: func(t *testing.T, body string) {
- assert.Contains(t, body, `"statusCode":200`)
- assert.Contains(t, body, `"users"`)
- assert.Contains(t, body, `"user1"`)
- assert.Contains(t, body, `"user2"`)
- assert.Contains(t, body, `"idle"`)
- },
- },
- {
- name: "Success_BlockedOrOfflineUser",
- queryParams: "t=blockeduser",
- setupMocks: func(fr *mockFeedbagService, ls *mockLocateService) {
- // A blocked or offline user comes back as a locate error.
- ls.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, screenNameMatcher("blockeduser")).
- Return(wire.SNACMessage{Body: wire.SNACError{Code: wire.ErrorCodeNotLoggedOn}}, nil)
- },
- expectedStatusCode: http.StatusOK,
- checkResponse: func(t *testing.T, body string) {
- assert.Contains(t, body, `"statusCode":200`)
- assert.Contains(t, body, `"blockeduser"`)
- assert.Contains(t, body, `"offline"`)
- },
- },
- {
- name: "Success_EmptyRequest",
- queryParams: "",
- setupMocks: func(fr *mockFeedbagService, ls *mockLocateService) {},
- expectedStatusCode: http.StatusOK,
- checkResponse: func(t *testing.T, body string) {
- assert.Contains(t, body, `"statusCode":200`)
- },
- },
- {
- // A full search page: memberDir/search returns 20 profiles and the
- // client asks about every one, plus the keyword when it is a UIN.
- // This is the largest list a real client sends, and it must be served
- // whole — anything but a 200 costs the user the entire page.
- name: "Success_FullSearchPage",
- queryParams: "t=" + strings.Join(searchPageTargets(21), "&t="),
- setupMocks: func(fr *mockFeedbagService, ls *mockLocateService) {
- ls.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, mock.Anything).
- RunAndReturn(func(_ context.Context, _ *state.SessionInstance, _ wire.SNACFrame, body wire.SNAC_0x02_0x05_LocateUserInfoQuery) (wire.SNACMessage, error) {
- return onlineUserInfoReply(body.ScreenName, 0), nil
- }).Times(21)
- },
- expectedStatusCode: http.StatusOK,
- checkResponse: func(t *testing.T, body string) {
- assert.Contains(t, body, `"statusCode":200`)
- assert.Contains(t, body, `"user0"`)
- assert.Contains(t, body, `"user20"`)
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- feedbagService := newMockFeedbagService(t)
- locateService := newMockLocateService(t)
- oscarInstance := state.NewSession().AddInstance()
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("testuser", oscarInstance)
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- FeedbagService: feedbagService,
- LocateService: locateService,
- Logger: slog.Default(),
- }
- tt.setupMocks(feedbagService, locateService)
- // Presence payloads carry the viewer's alias, so GetPresence reads the
- // feedbag. Registered last so a case's own Query stub takes precedence.
- feedbagService.EXPECT().Query(mock.Anything, mock.Anything, mock.Anything).
- Return(wire.SNACMessage{Body: wire.SNAC_0x13_0x06_FeedbagReply{}}, nil).Maybe()
- reqURL := "/presence/get?aimsid=" + aimsid
- if tt.queryParams != "" {
- reqURL += "&" + tt.queryParams
- }
- req, err := http.NewRequest("GET", reqURL, nil)
- assert.NoError(t, err)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.GetPresence).ServeHTTP(rr, req)
- assert.Equal(t, tt.expectedStatusCode, rr.Code)
- if tt.checkResponse != nil {
- responseBody := strings.TrimSpace(rr.Body.String())
- tt.checkResponse(t, responseBody)
- }
- })
- }
- }
- // TestPresenceHandler_GetPresence_PublishesIconForOnlineBuddiesOnly verifies that
- // the icon is published only for an online, non-blocking user, and that an
- // offline or blocking user is never even looked up — so neither their icon nor
- // its hash leaks to a caller they are invisible to.
- func TestPresenceHandler_GetPresence_PublishesIconForOnlineBuddiesOnly(t *testing.T) {
- ctx := context.Background()
- feedbagService := newMockFeedbagService(t)
- feedbagService.EXPECT().Query(mock.Anything, mock.Anything, mock.Anything).
- Return(wire.SNACMessage{Body: wire.SNAC_0x13_0x06_FeedbagReply{}}, nil).Maybe()
- locateService := newMockLocateService(t)
- locateService.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, screenNameMatcher("onlineuser")).
- Return(onlineUserInfoReply("onlineuser", 0), nil)
- locateService.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, screenNameMatcher("offlineuser")).
- Return(wire.SNACMessage{Body: wire.SNACError{Code: wire.ErrorCodeNotLoggedOn}}, nil)
- iconRetriever := newMockBuddyIconRetriever(t)
- iconRetriever.EXPECT().BuddyIconMetadata(mock.Anything, state.NewIdentScreenName("onlineuser")).
- Return(bartID([]byte{0xab, 0xcd}), nil).Once()
- oscarInstance := state.NewSession().AddInstance()
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("testuser", oscarInstance)
- sess, err := sessionMgr.GetSession(ctx, aimsid)
- require.NoError(t, err)
- sess.BaseURL = "http://api.example.com"
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- FeedbagService: feedbagService,
- LocateService: locateService,
- IconSource: BuddyIconSource{IconRetriever: iconRetriever, Logger: slog.Default()},
- Logger: slog.Default(),
- }
- req, err := http.NewRequest("GET", "/presence/get?aimsid="+aimsid+"&t=onlineuser,offlineuser", nil)
- require.NoError(t, err)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.GetPresence).ServeHTTP(rr, req)
- require.Equal(t, http.StatusOK, rr.Code)
- var got struct {
- Response struct {
- Data struct {
- Users []struct {
- AimID string `json:"aimId"`
- State string `json:"state"`
- BuddyIcon string `json:"buddyIcon"`
- } `json:"users"`
- } `json:"data"`
- } `json:"response"`
- }
- require.NoError(t, json.Unmarshal(rr.Body.Bytes(), &got))
- icons := map[string]string{}
- states := map[string]string{}
- for _, u := range got.Response.Data.Users {
- icons[u.AimID] = u.BuddyIcon
- states[u.AimID] = u.State
- }
- assert.Equal(t, "online", states["onlineuser"])
- assert.Equal(t,
- "http://api.example.com/expressions/get?t=onlineuser&type=buddyIcon&bartId=abcd",
- icons["onlineuser"])
- assert.Equal(t, "offline", states["offlineuser"])
- assert.Empty(t, icons["offlineuser"])
- iconRetriever.AssertNotCalled(t, "BuddyIconMetadata", mock.Anything, state.NewIdentScreenName("offlineuser"))
- }
- // TestPresenceHandler_GetPresence_BuddyListGrouping verifies that bl=1 places
- // each buddy under its own group using realistic feedbag data, where group rows
- // carry ItemID 0 and a distinct nonzero GroupID, and buddy rows reference those
- // GroupIDs. This is the shape the OSCAR feedbag actually stores.
- func TestPresenceHandler_GetPresence_BuddyListGrouping(t *testing.T) {
- feedbagService := newMockFeedbagService(t)
- locateService := newMockLocateService(t)
- items := []wire.FeedbagItem{
- // Root order group: ItemID 0, GroupID 0, empty name — not a real buddy group.
- {ItemID: 0, GroupID: 0, ClassID: wire.FeedbagClassIdGroup, Name: ""},
- // Named groups: ItemID 0, distinct nonzero GroupIDs.
- {ItemID: 0, GroupID: 10, ClassID: wire.FeedbagClassIdGroup, Name: "Friends"},
- {ItemID: 0, GroupID: 20, ClassID: wire.FeedbagClassIdGroup, Name: "Work"},
- // Buddies reference their group's GroupID.
- {ItemID: 101, GroupID: 10, ClassID: wire.FeedbagClassIdBuddy, Name: "alice"},
- {ItemID: 201, GroupID: 20, ClassID: wire.FeedbagClassIdBuddy, Name: "bob"},
- }
- feedbagService.EXPECT().Query(mock.Anything, mock.Anything, mock.Anything).
- Return(wire.SNACMessage{Body: wire.SNAC_0x13_0x06_FeedbagReply{Items: items}}, nil)
- locateService.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, screenNameMatcher("alice")).
- Return(onlineUserInfoReply("alice", 0), nil)
- locateService.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, screenNameMatcher("bob")).
- Return(onlineUserInfoReply("bob", 0), nil)
- oscarInstance := state.NewSession().AddInstance()
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("testuser", oscarInstance)
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- FeedbagService: feedbagService,
- LocateService: locateService,
- Logger: slog.Default(),
- }
- req, err := http.NewRequest("GET", "/presence/get?aimsid="+aimsid+"&bl=1", nil)
- assert.NoError(t, err)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.GetPresence).ServeHTTP(rr, req)
- assert.Equal(t, http.StatusOK, rr.Code)
- var parsed struct {
- Response struct {
- Data struct {
- Groups []struct {
- Name string `json:"name"`
- Buddies []struct {
- AimID string `json:"aimId"`
- } `json:"buddies"`
- } `json:"groups"`
- } `json:"data"`
- } `json:"response"`
- }
- assert.NoError(t, json.Unmarshal(rr.Body.Bytes(), &parsed))
- // Build name -> set of buddy aimIds.
- byGroup := map[string][]string{}
- for _, g := range parsed.Response.Data.Groups {
- for _, b := range g.Buddies {
- byGroup[g.Name] = append(byGroup[g.Name], b.AimID)
- }
- }
- // Exactly the two named groups appear; the root group is excluded.
- assert.Len(t, parsed.Response.Data.Groups, 2)
- assert.Equal(t, []string{"alice"}, byGroup["Friends"])
- assert.Equal(t, []string{"bob"}, byGroup["Work"])
- }
- func TestPresenceHandler_GetPresence_MissingAimsid(t *testing.T) {
- handler := &PresenceHandler{
- SessionManager: NewSessionManager(),
- Logger: slog.Default(),
- }
- req, err := http.NewRequest("GET", "/presence/get", nil)
- assert.NoError(t, err)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.GetPresence).ServeHTTP(rr, req)
- assert.Equal(t, http.StatusBadRequest, rr.Code)
- assert.Contains(t, rr.Body.String(), "missing aimsid parameter")
- }
- func TestPresenceHandler_GetPresence_SessionNotFound(t *testing.T) {
- handler := &PresenceHandler{
- SessionManager: NewSessionManager(),
- Logger: slog.Default(),
- }
- req, err := http.NewRequest("GET", "/presence/get?aimsid=nonexistent", nil)
- assert.NoError(t, err)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.GetPresence).ServeHTTP(rr, req)
- assert.Equal(t, http.StatusUnauthorized, rr.Code)
- assert.Contains(t, rr.Body.String(), "invalid or expired session")
- }
- func TestPresenceHandler_SetState_MissingAimsid(t *testing.T) {
- handler := &PresenceHandler{
- SessionManager: NewSessionManager(),
- Logger: slog.Default(),
- }
- req, err := http.NewRequest("GET", "/presence/setState", nil)
- assert.NoError(t, err)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.SetState).ServeHTTP(rr, req)
- assert.Equal(t, http.StatusBadRequest, rr.Code)
- assert.Contains(t, rr.Body.String(), "missing aimsid parameter")
- }
- func TestPresenceHandler_SetState_InvalidState(t *testing.T) {
- oscarInstance := state.NewSession().AddInstance()
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("testuser", oscarInstance)
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- Logger: slog.Default(),
- }
- req, err := http.NewRequest("GET", "/presence/setState?aimsid="+aimsid+"&state=bogus", nil)
- assert.NoError(t, err)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.SetState).ServeHTTP(rr, req)
- assert.Equal(t, http.StatusBadRequest, rr.Code)
- assert.Contains(t, rr.Body.String(), "invalid state parameter")
- }
- func TestPresenceHandler_SetState_EmitsMyInfoEvent(t *testing.T) {
- // The AIM client re-renders its own status badge only from "myInfo" events,
- // so setState must queue one on the user's own session for the change to be
- // visible in their UI.
- oscarInstance := state.NewSession().AddInstance()
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("testuser", oscarInstance)
- broadcaster := newMockBuddyBroadcaster(t)
- broadcaster.EXPECT().BroadcastBuddyArrived(mock.Anything, mock.Anything, mock.Anything).Return(nil)
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- BuddyBroadcaster: broadcaster,
- Logger: slog.Default(),
- }
- req, err := http.NewRequest("GET", "/presence/setState?aimsid="+aimsid+"&state=away&awayMsg=brb", nil)
- assert.NoError(t, err)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.SetState).ServeHTTP(rr, req)
- assert.Equal(t, http.StatusOK, rr.Code)
- session, err := sessionMgr.GetSession(context.Background(), aimsid)
- assert.NoError(t, err)
- myInfo := queuedMyInfo(session)
- assert.NotNil(t, myInfo, "expected a myInfo event to be queued")
- assert.Equal(t, "away", myInfo.State)
- assert.Equal(t, "brb", myInfo.AwayMsg)
- assert.Equal(t, "testuser", myInfo.AimID)
- }
- func TestPresenceHandler_SetState_MyInfoNormalizesAimID(t *testing.T) {
- // The client shallow-merges myInfo onto the shared user object, so aimId must
- // be the normalized id while displayId and friendly keep the user's own
- // casing and spacing.
- oscarInstance := state.NewSession().AddInstance()
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("Mike Kelly", oscarInstance)
- broadcaster := newMockBuddyBroadcaster(t)
- broadcaster.EXPECT().BroadcastBuddyArrived(mock.Anything, mock.Anything, mock.Anything).Return(nil)
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- BuddyBroadcaster: broadcaster,
- Logger: slog.Default(),
- }
- req, err := http.NewRequest("GET", "/presence/setState?aimsid="+aimsid+"&state=away", nil)
- assert.NoError(t, err)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.SetState).ServeHTTP(rr, req)
- assert.Equal(t, http.StatusOK, rr.Code)
- // The setState response body carries the same identity fields.
- var resp struct {
- Response struct {
- Data map[string]interface{} `json:"data"`
- } `json:"response"`
- }
- assert.NoError(t, json.Unmarshal(rr.Body.Bytes(), &resp))
- assert.Equal(t, "mikekelly", resp.Response.Data["aimId"])
- assert.Equal(t, "Mike Kelly", resp.Response.Data["displayId"])
- session, err := sessionMgr.GetSession(context.Background(), aimsid)
- assert.NoError(t, err)
- myInfo := queuedMyInfo(session)
- require.NotNil(t, myInfo, "expected a myInfo event to be queued")
- assert.Equal(t, "mikekelly", myInfo.AimID)
- assert.Equal(t, "Mike Kelly", myInfo.DisplayID)
- assert.Equal(t, "Mike Kelly", myInfo.Friendly)
- }
- func TestIsICQScreenName(t *testing.T) {
- tests := []struct {
- name string
- screenName string
- expected bool
- }{
- {"ICQ_Number", "123456789", true},
- {"AIM_Name", "cooluser", false},
- {"AIM_WithNumbers", "cool123", false},
- {"Empty", "", false},
- {"Single_Digit", "5", true},
- {"Mixed_Chars", "12abc34", false},
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- assert.Equal(t, tt.expected, isICQScreenName(tt.screenName))
- })
- }
- }
- func TestPresenceHandler_Icon(t *testing.T) {
- tests := []struct {
- name string
- queryParams string
- expectedStatusCode int
- checkRedirect func(*testing.T, *httptest.ResponseRecorder)
- }{
- {
- name: "Redirect_OfflineUser",
- // No aimsid, so there is no OSCAR session to query on behalf of and
- // the target resolves to offline.
- queryParams: "name=offlineuser",
- expectedStatusCode: http.StatusFound,
- checkRedirect: func(t *testing.T, rr *httptest.ResponseRecorder) {
- location := rr.Header().Get("Location")
- assert.Contains(t, location, "offline")
- },
- },
- {
- name: "Error_MissingName",
- queryParams: "",
- expectedStatusCode: http.StatusBadRequest,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- handler := &PresenceHandler{
- SessionManager: NewSessionManager(),
- LocateService: newMockLocateService(t),
- Logger: slog.Default(),
- }
- reqURL := "/presence/icon"
- if tt.queryParams != "" {
- reqURL += "?" + tt.queryParams
- }
- req, err := http.NewRequest("GET", reqURL, nil)
- assert.NoError(t, err)
- rr := httptest.NewRecorder()
- handler.Icon(rr, req)
- assert.Equal(t, tt.expectedStatusCode, rr.Code)
- if tt.checkRedirect != nil {
- tt.checkRedirect(t, rr)
- }
- })
- }
- }
- func TestPresenceHandler_SetProfile(t *testing.T) {
- oscarInstance := state.NewSession().AddInstance()
- tests := []struct {
- name string
- queryParams string
- setupMocks func(*mockLocateService)
- expectedStatusCode int
- checkResponse func(*testing.T, string)
- }{
- {
- name: "Success_SetProfile",
- queryParams: "profile=Hello+World",
- setupMocks: func(ls *mockLocateService) {
- ls.EXPECT().SetInfo(mock.Anything, oscarInstance, mock.AnythingOfType("wire.SNAC_0x02_0x04_LocateSetInfo")).Return(nil)
- },
- expectedStatusCode: http.StatusOK,
- checkResponse: func(t *testing.T, body string) {
- assert.Contains(t, body, `"statusCode":200`)
- },
- },
- {
- name: "Error_ProfileTooLarge",
- queryParams: "profile=" + strings.Repeat("x", 4097),
- setupMocks: func(ls *mockLocateService) {},
- expectedStatusCode: http.StatusBadRequest,
- checkResponse: func(t *testing.T, body string) {
- assert.Contains(t, body, "profile too large")
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- locateService := newMockLocateService(t)
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("testuser", oscarInstance)
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- LocateService: locateService,
- Logger: slog.Default(),
- }
- tt.setupMocks(locateService)
- reqURL := "/presence/setProfile?aimsid=" + aimsid + "&" + tt.queryParams
- req, err := http.NewRequest("GET", reqURL, nil)
- assert.NoError(t, err)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.SetProfile).ServeHTTP(rr, req)
- assert.Equal(t, tt.expectedStatusCode, rr.Code)
- if tt.checkResponse != nil {
- responseBody := strings.TrimSpace(rr.Body.String())
- tt.checkResponse(t, responseBody)
- }
- })
- }
- }
- func TestPresenceHandler_GetProfile(t *testing.T) {
- locateService := newMockLocateService(t)
- oscarInstance := state.NewSession().AddInstance()
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("testuser", oscarInstance)
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- LocateService: locateService,
- Logger: slog.Default(),
- }
- locateService.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, screenNameMatcher("testuser")).
- Return(wire.SNACMessage{
- Body: wire.SNAC_0x02_0x06_LocateUserInfoReply{
- LocateInfo: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LocateTLVTagsInfoSigData, "My profile"),
- },
- },
- },
- }, nil)
- req, err := http.NewRequest("GET", "/presence/getProfile?aimsid="+aimsid, nil)
- assert.NoError(t, err)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.GetProfile).ServeHTTP(rr, req)
- assert.Equal(t, http.StatusOK, rr.Code)
- body := rr.Body.String()
- assert.Contains(t, body, `"statusCode":200`)
- assert.Contains(t, body, `"My profile"`)
- assert.Contains(t, body, `"testuser"`)
- }
- // queuedMyInfo returns the myInfo event the session has queued, if any.
- func queuedMyInfo(session *Session) *MyInfo {
- var myInfo *MyInfo
- for _, event := range session.EventQueue.GetAllEvents() {
- if event.Type == "myInfo" {
- myInfo, _ = event.Data.(*MyInfo)
- }
- }
- return myInfo
- }
- func TestPresenceHandler_SetState_Occupied(t *testing.T) {
- // ICQ's Busy, which is a selectable connect state and must be accepted.
- oscarInstance := state.NewSession().AddInstance()
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("testuser", oscarInstance)
- broadcaster := newMockBuddyBroadcaster(t)
- broadcaster.EXPECT().BroadcastBuddyArrived(mock.Anything, mock.Anything, mock.Anything).Return(nil)
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- BuddyBroadcaster: broadcaster,
- Logger: slog.Default(),
- }
- req, err := http.NewRequest("GET", "/presence/setState?aimsid="+aimsid+"&view=occupied&away=", nil)
- assert.NoError(t, err)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.SetState).ServeHTTP(rr, req)
- assert.Equal(t, http.StatusOK, rr.Code)
- assert.Equal(t, wire.OServiceUserStatusBusy, oscarInstance.UserStatusBitmask())
- // The state must survive the round trip: a later myInfo push reads it back
- // through currentWebState, and reporting "away" or "online" there would undo
- // the change in the user's own UI.
- assert.Equal(t, "occupied", currentWebState(oscarInstance))
- session, err := sessionMgr.GetSession(context.Background(), aimsid)
- assert.NoError(t, err)
- myInfo := queuedMyInfo(session)
- assert.NotNil(t, myInfo, "expected a myInfo event to be queued")
- assert.Equal(t, "occupied", myInfo.State)
- }
- func TestPresenceHandler_GetPresence_MdirAttachesProfile(t *testing.T) {
- // Search results are populated from this call, and a user carrying no nested
- // "profile" object is dropped by clients, so a found user would not render.
- ctx := context.Background()
- dirReply := wire.SNAC_0x02_0x0C_LocateGetDirReply{Status: wire.LocateGetDirReplyOK}
- dirReply.Append(wire.NewTLVBE(wire.ODirTLVFirstName, "Bob"))
- dirReply.Append(wire.NewTLVBE(wire.ODirTLVLastName, "Smith"))
- dirReply.Append(wire.NewTLVBE(wire.ODirTLVCity, "Reno"))
- feedbagService := newMockFeedbagService(t)
- feedbagService.EXPECT().Query(mock.Anything, mock.Anything, mock.Anything).
- Return(wire.SNACMessage{Body: wire.SNAC_0x13_0x06_FeedbagReply{}}, nil).Maybe()
- locateService := newMockLocateService(t)
- locateService.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, mock.Anything).
- Return(onlineUserInfoReply("founduser", 0), nil)
- locateService.EXPECT().DirInfo(mock.Anything, mock.Anything, mock.Anything).
- Return(wire.SNACMessage{Body: dirReply}, nil)
- oscarInstance := state.NewSession().AddInstance()
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("testuser", oscarInstance)
- _, err := sessionMgr.GetSession(ctx, aimsid)
- require.NoError(t, err)
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- FeedbagService: feedbagService,
- LocateService: locateService,
- Logger: slog.Default(),
- }
- req, err := http.NewRequest("GET", "/presence/get?aimsid="+aimsid+"&mdir=1&t=founduser", nil)
- require.NoError(t, err)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.GetPresence).ServeHTTP(rr, req)
- require.Equal(t, http.StatusOK, rr.Code)
- var got struct {
- Response struct {
- Data struct {
- Users []struct {
- AimID string `json:"aimId"`
- Profile *BuddyProfileInfo `json:"profile"`
- } `json:"users"`
- } `json:"data"`
- } `json:"response"`
- }
- require.NoError(t, json.Unmarshal(rr.Body.Bytes(), &got))
- require.Len(t, got.Response.Data.Users, 1)
- profile := got.Response.Data.Users[0].Profile
- require.NotNil(t, profile, "mdir=1 must carry a profile object")
- assert.Equal(t, "Bob", profile.FirstName)
- assert.Equal(t, "Smith", profile.LastName)
- require.Len(t, profile.HomeAddress, 1)
- assert.Equal(t, "Reno", profile.HomeAddress[0].City)
- }
- func TestPresenceHandler_GetPresence_MdirProfileIsEmptyNotAbsent(t *testing.T) {
- // A user with no directory record must still render, or a freshly created
- // account can never be found.
- ctx := context.Background()
- feedbagService := newMockFeedbagService(t)
- feedbagService.EXPECT().Query(mock.Anything, mock.Anything, mock.Anything).
- Return(wire.SNACMessage{Body: wire.SNAC_0x13_0x06_FeedbagReply{}}, nil).Maybe()
- locateService := newMockLocateService(t)
- locateService.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, mock.Anything).
- Return(onlineUserInfoReply("blankuser", 0), nil)
- locateService.EXPECT().DirInfo(mock.Anything, mock.Anything, mock.Anything).
- Return(wire.SNACMessage{Body: wire.SNAC_0x02_0x0C_LocateGetDirReply{Status: wire.LocateGetDirReplyOK}}, nil)
- oscarInstance := state.NewSession().AddInstance()
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("testuser", oscarInstance)
- _, err := sessionMgr.GetSession(ctx, aimsid)
- require.NoError(t, err)
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- FeedbagService: feedbagService,
- LocateService: locateService,
- Logger: slog.Default(),
- }
- req, _ := http.NewRequest("GET", "/presence/get?aimsid="+aimsid+"&mdir=1&t=blankuser", nil)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.GetPresence).ServeHTTP(rr, req)
- // The key must be present and non-null, which is what the client tests for.
- assert.Contains(t, rr.Body.String(), `"profile":{}`)
- }
- func TestPresenceHandler_GetPresence_NoMdirOmitsProfile(t *testing.T) {
- // Without mdir the directory is not consulted at all — the mock asserts that by
- // having no DirInfo expectation.
- ctx := context.Background()
- feedbagService := newMockFeedbagService(t)
- feedbagService.EXPECT().Query(mock.Anything, mock.Anything, mock.Anything).
- Return(wire.SNACMessage{Body: wire.SNAC_0x13_0x06_FeedbagReply{}}, nil).Maybe()
- locateService := newMockLocateService(t)
- locateService.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, mock.Anything).
- Return(onlineUserInfoReply("someuser", 0), nil)
- oscarInstance := state.NewSession().AddInstance()
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("testuser", oscarInstance)
- _, err := sessionMgr.GetSession(ctx, aimsid)
- require.NoError(t, err)
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- FeedbagService: feedbagService,
- LocateService: locateService,
- Logger: slog.Default(),
- }
- req, _ := http.NewRequest("GET", "/presence/get?aimsid="+aimsid+"&t=someuser", nil)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.GetPresence).ServeHTTP(rr, req)
- assert.NotContains(t, rr.Body.String(), `"profile"`)
- }
- func TestPresenceHandler_GetPresence_EmptyQueryRendersBothArrays(t *testing.T) {
- ctx := context.Background()
- // No expectations on either service: naming no list must cost no lookups.
- feedbagService := newMockFeedbagService(t)
- locateService := newMockLocateService(t)
- oscarInstance := state.NewSession().AddInstance()
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("testuser", oscarInstance)
- _, err := sessionMgr.GetSession(ctx, aimsid)
- require.NoError(t, err)
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- FeedbagService: feedbagService,
- LocateService: locateService,
- Logger: slog.Default(),
- }
- req, _ := http.NewRequest("GET", "/presence/get?aimsid="+aimsid+"&f=json&mdir=1", nil)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.GetPresence).ServeHTTP(rr, req)
- assert.Equal(t, http.StatusOK, rr.Code)
- assert.Contains(t, rr.Body.String(), `"users":[]`)
- assert.Contains(t, rr.Body.String(), `"groups":[]`)
- }
- func TestPresenceHandler_GetPresence_TruncatesOversizedTargetList(t *testing.T) {
- ctx := context.Background()
- feedbagService := newMockFeedbagService(t)
- var queried int
- locateService := newMockLocateService(t)
- locateService.EXPECT().UserInfoQuery(mock.Anything, mock.Anything, mock.Anything, mock.Anything).
- RunAndReturn(func(_ context.Context, _ *state.SessionInstance, _ wire.SNACFrame, body wire.SNAC_0x02_0x05_LocateUserInfoQuery) (wire.SNACMessage, error) {
- queried++
- return onlineUserInfoReply(body.ScreenName, 0), nil
- })
- oscarInstance := state.NewSession().AddInstance()
- sessionMgr, aimsid := createTestSessionManagerWithOSCAR("testuser", oscarInstance)
- _, err := sessionMgr.GetSession(ctx, aimsid)
- require.NoError(t, err)
- handler := &PresenceHandler{
- SessionManager: sessionMgr,
- FeedbagService: feedbagService,
- LocateService: locateService,
- Logger: slog.Default(),
- }
- query := "/presence/get?aimsid=" + aimsid + "&f=json"
- for i := 0; i < maxPresenceTargets+8; i++ {
- query += fmt.Sprintf("&t=user%d", i)
- }
- req, _ := http.NewRequest("GET", query, nil)
- rr := httptest.NewRecorder()
- requireSession(handler.SessionManager, handler.GetPresence).ServeHTTP(rr, req)
- assert.Equal(t, http.StatusOK, rr.Code)
- assert.Contains(t, rr.Body.String(), `"statusCode":200`)
- assert.Equal(t, maxPresenceTargets, queried, "the list is cut to the cap, not refused")
- // A full search page has to fit: 20 profiles plus the searched-for UIN.
- assert.GreaterOrEqual(t, maxPresenceTargets, 21)
- }
- // searchPageTargets builds n distinct screen names, standing in for the hits of a
- // member-directory search page.
- func searchPageTargets(n int) []string {
- names := make([]string, 0, n)
- for i := 0; i < n; i++ {
- names = append(names, fmt.Sprintf("user%d", i))
- }
- return names
- }
|