feedbag_list_test.go 45 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427
  1. package state
  2. import (
  3. "bytes"
  4. "math"
  5. "testing"
  6. "github.com/mk6i/open-oscar-server/wire"
  7. "github.com/stretchr/testify/assert"
  8. )
  9. func TestFeedbagList_upsertItem(t *testing.T) {
  10. t.Run("generates unique ItemID", func(t *testing.T) {
  11. fl := NewFeedbagList([]wire.FeedbagItem{
  12. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  13. }, func(n int) int { return 42 })
  14. result, inserted := fl.upsertItem(wire.FeedbagItem{
  15. Name: "alice",
  16. ClassID: wire.FeedbagClassIdBuddy,
  17. GroupID: 1,
  18. })
  19. assert.True(t, inserted)
  20. assert.Equal(t, uint16(42), result.ItemID)
  21. assert.Equal(t, "alice", result.Name)
  22. assert.Equal(t, wire.FeedbagClassIdBuddy, result.ClassID)
  23. assert.Equal(t, uint16(1), result.GroupID)
  24. })
  25. t.Run("subsequent insert avoids collision", func(t *testing.T) {
  26. fl := NewFeedbagList([]wire.FeedbagItem{
  27. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  28. }, func(n int) int { return 42 })
  29. fl.upsertItem(wire.FeedbagItem{
  30. Name: "alice",
  31. ClassID: wire.FeedbagClassIdBuddy,
  32. GroupID: 1,
  33. })
  34. result, inserted := fl.upsertItem(wire.FeedbagItem{
  35. Name: "bob",
  36. ClassID: wire.FeedbagClassIdBuddy,
  37. GroupID: 1,
  38. })
  39. assert.True(t, inserted)
  40. assert.Equal(t, uint16(43), result.ItemID)
  41. })
  42. t.Run("non-buddy item does not update group order", func(t *testing.T) {
  43. fl := NewFeedbagList(nil, func(n int) int { return 5 })
  44. fl.upsertItem(wire.FeedbagItem{
  45. Name: "alice",
  46. ClassID: wire.FeedbagClassIDPermit,
  47. })
  48. upserts := fl.PendingUpdates()
  49. assert.Len(t, upserts, 1)
  50. assert.Equal(t, wire.FeedbagClassIDPermit, upserts[0].ClassID)
  51. })
  52. // Classes at or above FeedbagClassIdMin are client-defined and, like
  53. // buddies, live in a group, so GroupID is part of what identifies them.
  54. t.Run("updates client-defined item in the same group in place", func(t *testing.T) {
  55. fl := NewFeedbagList([]wire.FeedbagItem{
  56. {
  57. Name: "custom",
  58. ClassID: wire.FeedbagClassIdMin,
  59. GroupID: 7,
  60. ItemID: 9,
  61. TLVLBlock: wire.TLVLBlock{
  62. TLVList: wire.TLVList{
  63. wire.NewTLVBE(0x01, uint16(100)),
  64. },
  65. },
  66. },
  67. }, nil)
  68. result, inserted := fl.upsertItem(wire.FeedbagItem{
  69. Name: "custom",
  70. ClassID: wire.FeedbagClassIdMin,
  71. GroupID: 7,
  72. TLVLBlock: wire.TLVLBlock{
  73. TLVList: wire.TLVList{
  74. wire.NewTLVBE(0x01, uint16(200)),
  75. },
  76. },
  77. })
  78. assert.False(t, inserted)
  79. assert.Equal(t, uint16(7), result.GroupID)
  80. assert.Equal(t, uint16(9), result.ItemID)
  81. assert.Len(t, fl.Items(), 1)
  82. updates := fl.PendingUpdates()
  83. assert.Len(t, updates, 1)
  84. assert.Equal(t, uint16(7), updates[0].GroupID)
  85. assert.Equal(t, uint16(9), updates[0].ItemID)
  86. val, ok := updates[0].Uint16BE(0x01)
  87. assert.True(t, ok)
  88. assert.Equal(t, uint16(200), val)
  89. })
  90. t.Run("client-defined item in another group is a separate item", func(t *testing.T) {
  91. fl := NewFeedbagList([]wire.FeedbagItem{
  92. {Name: "custom", ClassID: wire.FeedbagClassIdMin, GroupID: 7, ItemID: 9},
  93. }, func(n int) int { return 42 })
  94. result, inserted := fl.upsertItem(wire.FeedbagItem{
  95. Name: "custom",
  96. ClassID: wire.FeedbagClassIdMin,
  97. GroupID: 8,
  98. })
  99. // The group 7 item must survive untouched rather than be rewritten
  100. // into group 8's item.
  101. assert.True(t, inserted)
  102. assert.Equal(t, uint16(8), result.GroupID)
  103. assert.Equal(t, uint16(42), result.ItemID)
  104. assert.Len(t, fl.Items(), 2)
  105. })
  106. t.Run("updates existing non-buddy item in place", func(t *testing.T) {
  107. fl := NewFeedbagList([]wire.FeedbagItem{
  108. {
  109. Name: "alice",
  110. ClassID: wire.FeedbagClassIDPermit,
  111. ItemID: 7,
  112. TLVLBlock: wire.TLVLBlock{
  113. TLVList: wire.TLVList{
  114. wire.NewTLVBE(0x01, uint16(100)),
  115. },
  116. },
  117. },
  118. }, nil)
  119. _, inserted := fl.upsertItem(wire.FeedbagItem{
  120. Name: "alice",
  121. ClassID: wire.FeedbagClassIDPermit,
  122. TLVLBlock: wire.TLVLBlock{
  123. TLVList: wire.TLVList{
  124. wire.NewTLVBE(0x01, uint16(200)),
  125. },
  126. },
  127. })
  128. assert.False(t, inserted)
  129. upserts := fl.PendingUpdates()
  130. assert.Len(t, upserts, 1)
  131. assert.Equal(t, uint16(7), upserts[0].ItemID)
  132. val, ok := upserts[0].Uint16BE(0x01)
  133. assert.True(t, ok)
  134. assert.Equal(t, uint16(200), val)
  135. })
  136. t.Run("updates existing buddy item matched by group", func(t *testing.T) {
  137. fl := NewFeedbagList([]wire.FeedbagItem{
  138. {Name: "Group1", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  139. {Name: "Group2", ClassID: wire.FeedbagClassIdGroup, GroupID: 2},
  140. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 10},
  141. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 2, ItemID: 20},
  142. }, nil)
  143. _, inserted := fl.upsertItem(wire.FeedbagItem{
  144. Name: "alice",
  145. ClassID: wire.FeedbagClassIdBuddy,
  146. GroupID: 2,
  147. TLVLBlock: wire.TLVLBlock{
  148. TLVList: wire.TLVList{
  149. wire.NewTLVBE(0x01, uint16(999)),
  150. },
  151. },
  152. })
  153. assert.False(t, inserted)
  154. upserts := fl.PendingUpdates()
  155. assert.Len(t, upserts, 1)
  156. assert.Equal(t, uint16(2), upserts[0].GroupID)
  157. assert.Equal(t, "alice", upserts[0].Name)
  158. assert.Equal(t, uint16(20), upserts[0].ItemID)
  159. val, ok := upserts[0].Uint16BE(0x01)
  160. assert.True(t, ok)
  161. assert.Equal(t, uint16(999), val)
  162. })
  163. t.Run("skips update when existing item is identical", func(t *testing.T) {
  164. fl := NewFeedbagList([]wire.FeedbagItem{
  165. {
  166. Name: "alice",
  167. ClassID: wire.FeedbagClassIDPermit,
  168. ItemID: 7,
  169. TLVLBlock: wire.TLVLBlock{
  170. TLVList: wire.TLVList{
  171. wire.NewTLVBE(0x01, uint16(100)),
  172. },
  173. },
  174. },
  175. }, nil)
  176. _, inserted := fl.upsertItem(wire.FeedbagItem{
  177. Name: "alice",
  178. ClassID: wire.FeedbagClassIDPermit,
  179. ItemID: 7,
  180. TLVLBlock: wire.TLVLBlock{
  181. TLVList: wire.TLVList{
  182. wire.NewTLVBE(0x01, uint16(100)),
  183. },
  184. },
  185. })
  186. assert.False(t, inserted)
  187. assert.Nil(t, fl.PendingUpdates())
  188. })
  189. t.Run("normalized screen name: buddy stored with lowercase name", func(t *testing.T) {
  190. fl := NewFeedbagList([]wire.FeedbagItem{
  191. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  192. }, func(n int) int { return 10 })
  193. result, inserted := fl.upsertItem(wire.FeedbagItem{
  194. Name: "Alice",
  195. ClassID: wire.FeedbagClassIdBuddy,
  196. GroupID: 1,
  197. })
  198. assert.True(t, inserted)
  199. assert.Equal(t, "alice", result.Name)
  200. })
  201. t.Run("normalized screen name: buddy upsert with different case matches existing", func(t *testing.T) {
  202. fl := NewFeedbagList([]wire.FeedbagItem{
  203. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  204. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 99},
  205. }, nil)
  206. result, inserted := fl.upsertItem(wire.FeedbagItem{
  207. Name: "ALICE",
  208. ClassID: wire.FeedbagClassIdBuddy,
  209. GroupID: 1,
  210. })
  211. assert.False(t, inserted)
  212. assert.Equal(t, uint16(99), result.ItemID)
  213. assert.Equal(t, "alice", result.Name)
  214. })
  215. t.Run("normalized screen name: permit stored with lowercase name and spaces stripped", func(t *testing.T) {
  216. fl := NewFeedbagList(nil, func(n int) int { return 1 })
  217. result, _ := fl.upsertItem(wire.FeedbagItem{
  218. Name: " Bob Smith ",
  219. ClassID: wire.FeedbagClassIDPermit,
  220. })
  221. assert.Equal(t, "bobsmith", result.Name)
  222. })
  223. t.Run("normalized screen name: permit upsert with different case matches existing", func(t *testing.T) {
  224. fl := NewFeedbagList([]wire.FeedbagItem{
  225. {Name: "bob", ClassID: wire.FeedbagClassIDPermit, ItemID: 5},
  226. }, nil)
  227. result, inserted := fl.upsertItem(wire.FeedbagItem{
  228. Name: "BOB",
  229. ClassID: wire.FeedbagClassIDPermit,
  230. })
  231. assert.False(t, inserted)
  232. assert.Equal(t, "bob", result.Name)
  233. assert.Equal(t, uint16(5), result.ItemID)
  234. })
  235. t.Run("normalized screen name: deny upsert with different case matches existing", func(t *testing.T) {
  236. fl := NewFeedbagList([]wire.FeedbagItem{
  237. {Name: "charlie", ClassID: wire.FeedbagClassIDDeny, ItemID: 3},
  238. }, nil)
  239. result, inserted := fl.upsertItem(wire.FeedbagItem{
  240. Name: "Charlie",
  241. ClassID: wire.FeedbagClassIDDeny,
  242. })
  243. assert.False(t, inserted)
  244. assert.Equal(t, "charlie", result.Name)
  245. assert.Equal(t, uint16(3), result.ItemID)
  246. })
  247. }
  248. func TestFeedbagList_deleteItem(t *testing.T) {
  249. t.Run("non-buddy item does not update group order", func(t *testing.T) {
  250. fl := NewFeedbagList([]wire.FeedbagItem{
  251. {Name: "alice", ClassID: wire.FeedbagClassIDPermit, ItemID: 5},
  252. }, nil)
  253. fl.deleteItem(wire.FeedbagItem{Name: "alice", ClassID: wire.FeedbagClassIDPermit, ItemID: 5})
  254. deletes := fl.PendingDeletes()
  255. assert.Len(t, deletes, 1)
  256. assert.Nil(t, fl.PendingUpdates())
  257. })
  258. t.Run("removes item from items list", func(t *testing.T) {
  259. fl := NewFeedbagList([]wire.FeedbagItem{
  260. {Name: "alice", ClassID: wire.FeedbagClassIDPermit, ItemID: 1},
  261. {Name: "bob", ClassID: wire.FeedbagClassIDPermit, ItemID: 2},
  262. {Name: "charlie", ClassID: wire.FeedbagClassIDPermit, ItemID: 3},
  263. }, nil)
  264. fl.deleteItem(wire.FeedbagItem{Name: "bob", ClassID: wire.FeedbagClassIDPermit, ItemID: 2})
  265. deletes := fl.PendingDeletes()
  266. assert.Len(t, deletes, 1)
  267. assert.Equal(t, "bob", deletes[0].Name)
  268. assert.Equal(t, wire.FeedbagClassIDPermit, deletes[0].ClassID)
  269. })
  270. t.Run("multiple deletes accumulate", func(t *testing.T) {
  271. fl := NewFeedbagList([]wire.FeedbagItem{
  272. {Name: "alice", ClassID: wire.FeedbagClassIDDeny, ItemID: 1},
  273. {Name: "bob", ClassID: wire.FeedbagClassIDDeny, ItemID: 2},
  274. }, nil)
  275. fl.deleteItem(wire.FeedbagItem{Name: "alice", ClassID: wire.FeedbagClassIDDeny, ItemID: 1})
  276. fl.deleteItem(wire.FeedbagItem{Name: "bob", ClassID: wire.FeedbagClassIDDeny, ItemID: 2})
  277. deletes := fl.PendingDeletes()
  278. assert.Len(t, deletes, 2)
  279. })
  280. t.Run("normalized screen name: delete buddy by different case", func(t *testing.T) {
  281. fl := NewFeedbagList([]wire.FeedbagItem{
  282. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  283. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 50},
  284. }, nil)
  285. deleted, found := fl.deleteItem(wire.FeedbagItem{
  286. Name: "ALICE",
  287. ClassID: wire.FeedbagClassIdBuddy,
  288. GroupID: 1,
  289. })
  290. assert.True(t, found)
  291. assert.Equal(t, "alice", deleted.Name)
  292. assert.Equal(t, uint16(50), deleted.ItemID)
  293. })
  294. t.Run("normalized screen name: delete permit by different case", func(t *testing.T) {
  295. fl := NewFeedbagList([]wire.FeedbagItem{
  296. {Name: "bob", ClassID: wire.FeedbagClassIDPermit, ItemID: 7},
  297. }, nil)
  298. deleted, found := fl.deleteItem(wire.FeedbagItem{Name: "Bob", ClassID: wire.FeedbagClassIDPermit})
  299. assert.True(t, found)
  300. assert.Equal(t, "bob", deleted.Name)
  301. })
  302. t.Run("normalized screen name: delete deny by different case", func(t *testing.T) {
  303. fl := NewFeedbagList([]wire.FeedbagItem{
  304. {Name: "charlie", ClassID: wire.FeedbagClassIDDeny, ItemID: 8},
  305. }, nil)
  306. deleted, found := fl.deleteItem(wire.FeedbagItem{Name: "CHARLIE", ClassID: wire.FeedbagClassIDDeny})
  307. assert.True(t, found)
  308. assert.Equal(t, "charlie", deleted.Name)
  309. })
  310. }
  311. func TestFeedbagList_genID(t *testing.T) {
  312. tt := []struct {
  313. name string
  314. randInt func(n int) int
  315. items []wire.FeedbagItem
  316. want uint16
  317. }{
  318. {
  319. name: "empty items list returns random ID",
  320. randInt: func(n int) int { return 1000 },
  321. items: []wire.FeedbagItem{},
  322. want: 1000,
  323. },
  324. {
  325. name: "finds next available ID when starting ID conflicts with ItemID",
  326. randInt: func(n int) int { return 100 },
  327. items: []wire.FeedbagItem{
  328. {ItemID: 100, GroupID: 1},
  329. {ItemID: 101, GroupID: 1},
  330. },
  331. want: 102,
  332. },
  333. {
  334. name: "finds next available ID when starting ID conflicts with GroupID",
  335. randInt: func(n int) int { return 50 },
  336. items: []wire.FeedbagItem{
  337. {ItemID: 1, GroupID: 50},
  338. {ItemID: 2, GroupID: 51},
  339. },
  340. want: 52,
  341. },
  342. {
  343. name: "wraps around and skips 0 to find next available ID",
  344. randInt: func(n int) int { return math.MaxUint16 - 2 },
  345. items: []wire.FeedbagItem{
  346. {ItemID: math.MaxUint16 - 2, GroupID: 1},
  347. {ItemID: math.MaxUint16 - 1, GroupID: 1},
  348. {ItemID: math.MaxUint16, GroupID: 1},
  349. },
  350. want: 2,
  351. },
  352. {
  353. name: "skips 0 when starting from 0 and finds next available",
  354. randInt: func(n int) int { return 0 },
  355. items: []wire.FeedbagItem{},
  356. want: 1,
  357. },
  358. {
  359. name: "returns 0 when all IDs are taken",
  360. randInt: func(n int) int { return 100 },
  361. items: func() []wire.FeedbagItem {
  362. items := make([]wire.FeedbagItem, 0, math.MaxUint16+1)
  363. for i := 0; i <= math.MaxUint16; i++ {
  364. items = append(items, wire.FeedbagItem{
  365. ItemID: uint16(i),
  366. GroupID: uint16(i),
  367. })
  368. }
  369. return items
  370. }(),
  371. want: 0,
  372. },
  373. {
  374. name: "finds ID that conflicts with both ItemID and GroupID",
  375. randInt: func(n int) int { return 200 },
  376. items: []wire.FeedbagItem{
  377. {ItemID: 200, GroupID: 201},
  378. {ItemID: 201, GroupID: 200},
  379. },
  380. want: 202,
  381. },
  382. {
  383. name: "finds available ID immediately when no conflicts",
  384. randInt: func(n int) int { return 500 },
  385. items: []wire.FeedbagItem{
  386. {ItemID: 100, GroupID: 1},
  387. {ItemID: 200, GroupID: 2},
  388. {ItemID: 300, GroupID: 3},
  389. },
  390. want: 500,
  391. },
  392. {
  393. name: "handles single conflict and finds next",
  394. randInt: func(n int) int { return 42 },
  395. items: []wire.FeedbagItem{
  396. {ItemID: 42, GroupID: 1},
  397. },
  398. want: 43,
  399. },
  400. {
  401. name: "finds ID before starting point when wrapping",
  402. randInt: func(n int) int { return 5 },
  403. items: []wire.FeedbagItem{
  404. {ItemID: 5, GroupID: 1},
  405. {ItemID: 6, GroupID: 1},
  406. {ItemID: 7, GroupID: 1},
  407. },
  408. want: 8,
  409. },
  410. }
  411. for _, tc := range tt {
  412. t.Run(tc.name, func(t *testing.T) {
  413. fl := NewFeedbagList(tc.items, tc.randInt)
  414. got := fl.genID()
  415. assert.Equal(t, tc.want, got)
  416. })
  417. }
  418. }
  419. func TestFeedbagList_AddGroup(t *testing.T) {
  420. t.Run("creates group and root group when none exists", func(t *testing.T) {
  421. fl := NewFeedbagList(nil, func(n int) int { return 5 })
  422. group := fl.AddGroup("Buddies")
  423. assert.Equal(t, uint16(5), group.GroupID)
  424. assert.Equal(t, "Buddies", group.Name)
  425. assert.Equal(t, wire.FeedbagClassIdGroup, group.ClassID)
  426. upserts := fl.PendingUpdates()
  427. assert.Len(t, upserts, 2)
  428. root := upserts[0]
  429. assert.Equal(t, wire.FeedbagClassIdGroup, root.ClassID)
  430. assert.Equal(t, uint16(0), root.GroupID)
  431. order, ok := root.Uint16SliceBE(wire.FeedbagAttributesOrder)
  432. assert.True(t, ok)
  433. assert.Equal(t, []uint16{5}, order)
  434. })
  435. t.Run("updates existing root group order", func(t *testing.T) {
  436. existing := []wire.FeedbagItem{
  437. {
  438. ClassID: wire.FeedbagClassIdGroup,
  439. GroupID: 0,
  440. TLVLBlock: wire.TLVLBlock{
  441. TLVList: wire.TLVList{
  442. wire.NewTLVBE(wire.FeedbagAttributesOrder, []uint16{1}),
  443. },
  444. },
  445. },
  446. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  447. }
  448. callCount := 0
  449. fl := NewFeedbagList(existing, func(n int) int {
  450. callCount++
  451. return callCount + 1
  452. })
  453. group := fl.AddGroup("Coworkers")
  454. upserts := fl.PendingUpdates()
  455. assert.Len(t, upserts, 2)
  456. order, ok := upserts[0].Uint16SliceBE(wire.FeedbagAttributesOrder)
  457. assert.True(t, ok)
  458. assert.Equal(t, []uint16{1, group.GroupID}, order)
  459. })
  460. t.Run("multiple AddGroup calls accumulate in root order", func(t *testing.T) {
  461. callCount := 0
  462. fl := NewFeedbagList(nil, func(n int) int {
  463. callCount++
  464. return callCount * 10
  465. })
  466. g1 := fl.AddGroup("Group1")
  467. g2 := fl.AddGroup("Group2")
  468. upserts := fl.PendingUpdates()
  469. assert.Len(t, upserts, 3)
  470. order, ok := upserts[0].Uint16SliceBE(wire.FeedbagAttributesOrder)
  471. assert.True(t, ok)
  472. assert.Equal(t, []uint16{g1.GroupID, g2.GroupID}, order)
  473. })
  474. }
  475. func TestFeedbagList_SetMode(t *testing.T) {
  476. t.Run("upserts pdinfo item with mode TLV", func(t *testing.T) {
  477. fl := NewFeedbagList(nil, func(n int) int { return 0 })
  478. fl.SetMode(2)
  479. upserts := fl.PendingUpdates()
  480. assert.Len(t, upserts, 1)
  481. assert.Equal(t, wire.FeedbagClassIdPdinfo, upserts[0].ClassID)
  482. mode, ok := upserts[0].Uint8(wire.FeedbagAttributesPdMode)
  483. assert.True(t, ok)
  484. assert.Equal(t, uint8(2), mode)
  485. })
  486. t.Run("second SetMode updates existing item in place", func(t *testing.T) {
  487. fl := NewFeedbagList(nil, func(n int) int { return 0 })
  488. fl.SetMode(1)
  489. _ = fl.PendingUpdates()
  490. fl.SetMode(3)
  491. upserts := fl.PendingUpdates()
  492. assert.Len(t, upserts, 1)
  493. mode, ok := upserts[0].Uint8(wire.FeedbagAttributesPdMode)
  494. assert.True(t, ok)
  495. assert.Equal(t, uint8(3), mode)
  496. })
  497. }
  498. func TestFeedbagList_DeleteGroup(t *testing.T) {
  499. t.Run("updates root group order", func(t *testing.T) {
  500. fl := NewFeedbagList([]wire.FeedbagItem{
  501. {
  502. Name: "", ClassID: wire.FeedbagClassIdGroup, GroupID: 0,
  503. TLVLBlock: wire.TLVLBlock{
  504. TLVList: wire.TLVList{
  505. wire.NewTLVBE(wire.FeedbagAttributesOrder, []uint16{1, 2, 3}),
  506. },
  507. },
  508. },
  509. {
  510. Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1,
  511. TLVLBlock: wire.TLVLBlock{
  512. TLVList: wire.TLVList{
  513. wire.NewTLVBE(wire.FeedbagAttributesOrder, []uint16{1}),
  514. },
  515. },
  516. },
  517. {Name: "Jane", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 1},
  518. {
  519. Name: "Coworkers", ClassID: wire.FeedbagClassIdGroup, GroupID: 2,
  520. TLVLBlock: wire.TLVLBlock{
  521. TLVList: wire.TLVList{
  522. wire.NewTLVBE(wire.FeedbagAttributesOrder, []uint16{2, 3}),
  523. },
  524. },
  525. },
  526. {Name: "Joe", ClassID: wire.FeedbagClassIdBuddy, GroupID: 2, ItemID: 2},
  527. {Name: "Fred", ClassID: wire.FeedbagClassIdBuddy, GroupID: 2, ItemID: 3},
  528. {Name: "Family", ClassID: wire.FeedbagClassIdGroup, GroupID: 3,
  529. TLVLBlock: wire.TLVLBlock{
  530. TLVList: wire.TLVList{
  531. wire.NewTLVBE(wire.FeedbagAttributesOrder, []uint16{4}),
  532. },
  533. },
  534. },
  535. {Name: "Alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 3, ItemID: 4},
  536. }, nil)
  537. fl.DeleteGroup("Coworkers")
  538. deletes := fl.PendingDeletes()
  539. assert.Len(t, deletes, 3)
  540. assert.Equal(t, "Coworkers", deletes[0].Name)
  541. assert.Equal(t, uint16(2), deletes[0].GroupID)
  542. assert.Equal(t, "Joe", deletes[1].Name)
  543. assert.Equal(t, uint16(2), deletes[1].GroupID)
  544. assert.Equal(t, "Fred", deletes[2].Name)
  545. assert.Equal(t, uint16(2), deletes[2].GroupID)
  546. upserts := fl.PendingUpdates()
  547. assert.Len(t, upserts, 1)
  548. assert.Equal(t, uint16(0), upserts[0].GroupID)
  549. order, ok := upserts[0].Uint16SliceBE(wire.FeedbagAttributesOrder)
  550. assert.True(t, ok)
  551. assert.Equal(t, []uint16{1, 3}, order)
  552. })
  553. t.Run("deleting non-existent group is a no-op", func(t *testing.T) {
  554. fl := NewFeedbagList(nil, nil)
  555. fl.DeleteGroup("Nonexistent")
  556. assert.Empty(t, fl.PendingDeletes())
  557. assert.Nil(t, fl.PendingUpdates())
  558. })
  559. }
  560. func TestFeedbagList_AddBuddy(t *testing.T) {
  561. t.Run("updates parent group order", func(t *testing.T) {
  562. fl := NewFeedbagList([]wire.FeedbagItem{
  563. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  564. }, func(n int) int { return 50 })
  565. inserted, err := fl.AddBuddy("Buddies", "alice", "", "")
  566. assert.NoError(t, err)
  567. assert.True(t, inserted)
  568. upserts := fl.PendingUpdates()
  569. assert.Len(t, upserts, 2)
  570. assert.Equal(t, uint16(1), upserts[1].GroupID)
  571. order, ok := upserts[1].Uint16SliceBE(wire.FeedbagAttributesOrder)
  572. assert.True(t, ok)
  573. assert.Equal(t, []uint16{upserts[0].ItemID}, order)
  574. })
  575. t.Run("multiple buddies accumulate in parent group order", func(t *testing.T) {
  576. fl := NewFeedbagList([]wire.FeedbagItem{
  577. {
  578. Name: "Buddies",
  579. ClassID: wire.FeedbagClassIdGroup,
  580. GroupID: 1,
  581. TLVLBlock: wire.TLVLBlock{
  582. TLVList: wire.TLVList{
  583. wire.NewTLVBE(wire.FeedbagAttributesOrder, []uint16{10}),
  584. },
  585. },
  586. },
  587. }, func(n int) int { return 50 })
  588. _, err := fl.AddBuddy("Buddies", "alice", "", "")
  589. assert.NoError(t, err)
  590. _, err = fl.AddBuddy("Buddies", "bob", "", "")
  591. assert.NoError(t, err)
  592. upserts := fl.PendingUpdates()
  593. assert.Len(t, upserts, 3)
  594. order, ok := upserts[1].Uint16SliceBE(wire.FeedbagAttributesOrder)
  595. assert.True(t, ok)
  596. assert.Equal(t, []uint16{10, upserts[0].ItemID, upserts[2].ItemID}, order)
  597. })
  598. t.Run("returns error when parent group does not exist", func(t *testing.T) {
  599. fl := NewFeedbagList(nil, func(n int) int { return 5 })
  600. _, err := fl.AddBuddy("Nonexistent", "alice", "", "")
  601. assert.ErrorContains(t, err, "group \"Nonexistent\" not found")
  602. })
  603. t.Run("normalized screen name: stores buddy with lowercase name", func(t *testing.T) {
  604. fl := NewFeedbagList([]wire.FeedbagItem{
  605. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  606. }, func(n int) int { return 1 })
  607. inserted, err := fl.AddBuddy("Buddies", "Alice", "", "")
  608. assert.NoError(t, err)
  609. assert.True(t, inserted)
  610. upserts := fl.PendingUpdates()
  611. var buddy *wire.FeedbagItem
  612. for i := range upserts {
  613. if upserts[i].ClassID == wire.FeedbagClassIdBuddy {
  614. buddy = &upserts[i]
  615. break
  616. }
  617. }
  618. assert.NotNil(t, buddy)
  619. assert.Equal(t, "alice", buddy.Name)
  620. })
  621. t.Run("normalized screen name: second AddBuddy with different case does not insert duplicate", func(t *testing.T) {
  622. fl := NewFeedbagList([]wire.FeedbagItem{
  623. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  624. }, func(n int) int { return 1 })
  625. inserted1, err := fl.AddBuddy("Buddies", "alice", "", "")
  626. assert.NoError(t, err)
  627. assert.True(t, inserted1)
  628. inserted2, err := fl.AddBuddy("Buddies", "ALICE", "", "")
  629. assert.NoError(t, err)
  630. assert.False(t, inserted2)
  631. })
  632. t.Run("normalized screen name: DeleteBuddy finds buddy by different case", func(t *testing.T) {
  633. fl := NewFeedbagList([]wire.FeedbagItem{
  634. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  635. }, func(n int) int { return 1 })
  636. _, err := fl.AddBuddy("Buddies", "alice", "", "")
  637. assert.NoError(t, err)
  638. _ = fl.PendingUpdates()
  639. err = fl.DeleteBuddy("Buddies", "Alice")
  640. assert.NoError(t, err)
  641. deletes := fl.PendingDeletes()
  642. assert.Len(t, deletes, 1)
  643. assert.Equal(t, "alice", deletes[0].Name)
  644. })
  645. t.Run("alias is stored as TLV attribute", func(t *testing.T) {
  646. fl := NewFeedbagList([]wire.FeedbagItem{
  647. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  648. }, func(n int) int { return 1 })
  649. _, err := fl.AddBuddy("Buddies", "alice", "Al", "")
  650. assert.NoError(t, err)
  651. upserts := fl.PendingUpdates()
  652. var buddy *wire.FeedbagItem
  653. for i := range upserts {
  654. if upserts[i].ClassID == wire.FeedbagClassIdBuddy {
  655. buddy = &upserts[i]
  656. break
  657. }
  658. }
  659. assert.NotNil(t, buddy)
  660. alias, ok := buddy.Bytes(wire.FeedbagAttributesAlias)
  661. assert.True(t, ok)
  662. assert.Equal(t, []byte("Al"), alias)
  663. })
  664. t.Run("note is stored as TLV attribute", func(t *testing.T) {
  665. fl := NewFeedbagList([]wire.FeedbagItem{
  666. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  667. }, func(n int) int { return 1 })
  668. _, err := fl.AddBuddy("Buddies", "alice", "", "call first")
  669. assert.NoError(t, err)
  670. upserts := fl.PendingUpdates()
  671. var buddy *wire.FeedbagItem
  672. for i := range upserts {
  673. if upserts[i].ClassID == wire.FeedbagClassIdBuddy {
  674. buddy = &upserts[i]
  675. break
  676. }
  677. }
  678. assert.NotNil(t, buddy)
  679. note, ok := buddy.Bytes(wire.FeedbagAttributesNote)
  680. assert.True(t, ok)
  681. assert.Equal(t, []byte("call first"), note)
  682. })
  683. }
  684. func TestFeedbagList_DeleteBuddy(t *testing.T) {
  685. t.Run("updates parent group order", func(t *testing.T) {
  686. fl := NewFeedbagList([]wire.FeedbagItem{
  687. {
  688. Name: "Buddies",
  689. ClassID: wire.FeedbagClassIdGroup,
  690. GroupID: 1,
  691. TLVLBlock: wire.TLVLBlock{
  692. TLVList: wire.TLVList{
  693. wire.NewTLVBE(wire.FeedbagAttributesOrder, []uint16{10, 20, 30}),
  694. },
  695. },
  696. },
  697. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 10},
  698. {Name: "bob", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 20},
  699. {Name: "charlie", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 30},
  700. }, nil)
  701. err := fl.DeleteBuddy("Buddies", "bob")
  702. assert.NoError(t, err)
  703. deletes := fl.PendingDeletes()
  704. assert.Len(t, deletes, 1)
  705. assert.Equal(t, "bob", deletes[0].Name)
  706. assert.Equal(t, uint16(20), deletes[0].ItemID)
  707. upserts := fl.PendingUpdates()
  708. assert.Len(t, upserts, 1)
  709. order, ok := upserts[0].Uint16SliceBE(wire.FeedbagAttributesOrder)
  710. assert.True(t, ok)
  711. assert.Equal(t, []uint16{10, 30}, order)
  712. })
  713. t.Run("wildcard removes buddy from all groups", func(t *testing.T) {
  714. fl := NewFeedbagList([]wire.FeedbagItem{
  715. {
  716. Name: "Buddies",
  717. ClassID: wire.FeedbagClassIdGroup,
  718. GroupID: 1,
  719. TLVLBlock: wire.TLVLBlock{
  720. TLVList: wire.TLVList{
  721. wire.NewTLVBE(wire.FeedbagAttributesOrder, []uint16{10, 20}),
  722. },
  723. },
  724. },
  725. {
  726. Name: "Coworkers",
  727. ClassID: wire.FeedbagClassIdGroup,
  728. GroupID: 2,
  729. TLVLBlock: wire.TLVLBlock{
  730. TLVList: wire.TLVList{
  731. wire.NewTLVBE(wire.FeedbagAttributesOrder, []uint16{30, 40}),
  732. },
  733. },
  734. },
  735. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 10},
  736. {Name: "bob", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 20},
  737. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 2, ItemID: 30},
  738. {Name: "charlie", ClassID: wire.FeedbagClassIdBuddy, GroupID: 2, ItemID: 40},
  739. }, nil)
  740. err := fl.DeleteBuddy("*", "alice")
  741. assert.NoError(t, err)
  742. deletes := fl.PendingDeletes()
  743. assert.Len(t, deletes, 2)
  744. upserts := fl.PendingUpdates()
  745. assert.Len(t, upserts, 2)
  746. order1, ok := upserts[0].Uint16SliceBE(wire.FeedbagAttributesOrder)
  747. assert.True(t, ok)
  748. assert.Equal(t, []uint16{20}, order1)
  749. order2, ok := upserts[1].Uint16SliceBE(wire.FeedbagAttributesOrder)
  750. assert.True(t, ok)
  751. assert.Equal(t, []uint16{40}, order2)
  752. })
  753. t.Run("removes only buddy in specified group when same screen name in two groups", func(t *testing.T) {
  754. fl := NewFeedbagList([]wire.FeedbagItem{
  755. {
  756. Name: "Buddies",
  757. ClassID: wire.FeedbagClassIdGroup,
  758. GroupID: 1,
  759. TLVLBlock: wire.TLVLBlock{
  760. TLVList: wire.TLVList{
  761. wire.NewTLVBE(wire.FeedbagAttributesOrder, []uint16{10, 20}),
  762. },
  763. },
  764. },
  765. {
  766. Name: "Coworkers",
  767. ClassID: wire.FeedbagClassIdGroup,
  768. GroupID: 2,
  769. TLVLBlock: wire.TLVLBlock{
  770. TLVList: wire.TLVList{
  771. wire.NewTLVBE(wire.FeedbagAttributesOrder, []uint16{20}),
  772. },
  773. },
  774. },
  775. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 2, ItemID: 20},
  776. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 10},
  777. }, nil)
  778. err := fl.DeleteBuddy("Buddies", "alice")
  779. assert.NoError(t, err)
  780. deletes := fl.PendingDeletes()
  781. assert.Len(t, deletes, 1)
  782. assert.Equal(t, "alice", deletes[0].Name)
  783. assert.Equal(t, uint16(1), deletes[0].GroupID, "should delete from Buddies (group 1), not Coworkers (group 2)")
  784. assert.Equal(t, uint16(10), deletes[0].ItemID)
  785. })
  786. }
  787. func TestFeedbagList_PendingUpdates(t *testing.T) {
  788. t.Run("empty when nothing inserted", func(t *testing.T) {
  789. fl := NewFeedbagList(nil, func(n int) int { return 1 })
  790. assert.Nil(t, fl.PendingUpdates())
  791. })
  792. t.Run("includes inserts and updates", func(t *testing.T) {
  793. fl := NewFeedbagList([]wire.FeedbagItem{
  794. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  795. }, func(n int) int { return 50 })
  796. _, err := fl.AddBuddy("Buddies", "alice", "", "")
  797. assert.NoError(t, err)
  798. _, err = fl.AddBuddy("Buddies", "bob", "", "")
  799. assert.NoError(t, err)
  800. upserts := fl.PendingUpdates()
  801. assert.Len(t, upserts, 3)
  802. assert.Equal(t, wire.FeedbagClassIdBuddy, upserts[0].ClassID)
  803. assert.Equal(t, wire.FeedbagClassIdGroup, upserts[1].ClassID)
  804. assert.Equal(t, wire.FeedbagClassIdBuddy, upserts[2].ClassID)
  805. })
  806. t.Run("clears after retrieval", func(t *testing.T) {
  807. fl := NewFeedbagList(nil, func(n int) int { return 5 })
  808. fl.AddGroup("Buddies")
  809. assert.Len(t, fl.PendingUpdates(), 2)
  810. assert.Nil(t, fl.PendingUpdates())
  811. })
  812. }
  813. func TestFeedbagList_PendingDeletes(t *testing.T) {
  814. t.Run("empty when nothing deleted", func(t *testing.T) {
  815. fl := NewFeedbagList(nil, nil)
  816. assert.Nil(t, fl.PendingDeletes())
  817. })
  818. t.Run("clears after retrieval", func(t *testing.T) {
  819. fl := NewFeedbagList([]wire.FeedbagItem{
  820. {Name: "alice", ClassID: wire.FeedbagClassIDPermit, ItemID: 1},
  821. }, nil)
  822. fl.deleteItem(wire.FeedbagItem{Name: "alice", ClassID: wire.FeedbagClassIDPermit, ItemID: 1})
  823. assert.Len(t, fl.PendingDeletes(), 1)
  824. assert.Nil(t, fl.PendingDeletes())
  825. })
  826. }
  827. func TestFeedbagList_PendingUpdates_upsertsOnly(t *testing.T) {
  828. t.Run("tracks upserted items", func(t *testing.T) {
  829. fl := NewFeedbagList(nil, func(n int) int { return 5 })
  830. result, inserted := fl.upsertItem(wire.FeedbagItem{ClassID: wire.FeedbagClassIDPermit, Name: "alice"})
  831. assert.True(t, inserted)
  832. upserts := fl.PendingUpdates()
  833. assert.Len(t, upserts, 1)
  834. assert.Equal(t, "alice", upserts[0].Name)
  835. assert.Equal(t, uint16(5), result.ItemID)
  836. })
  837. t.Run("clears after retrieval", func(t *testing.T) {
  838. fl := NewFeedbagList(nil, func(n int) int { return 5 })
  839. fl.upsertItem(wire.FeedbagItem{ClassID: wire.FeedbagClassIDPermit})
  840. assert.Len(t, fl.PendingUpdates(), 1)
  841. assert.Nil(t, fl.PendingUpdates())
  842. })
  843. t.Run("multiple inserts accumulate", func(t *testing.T) {
  844. fl := NewFeedbagList(nil, func(n int) int { return 10 })
  845. fl.upsertItem(wire.FeedbagItem{ClassID: wire.FeedbagClassIDPermit, Name: "alice"})
  846. fl.upsertItem(wire.FeedbagItem{ClassID: wire.FeedbagClassIDPermit, Name: "bob"})
  847. upserts := fl.PendingUpdates()
  848. assert.Len(t, upserts, 2)
  849. })
  850. }
  851. func TestFeedbagList_PermitUser(t *testing.T) {
  852. t.Run("new permit entry is added", func(t *testing.T) {
  853. fl := NewFeedbagList(nil, func(n int) int { return 0 })
  854. fl.PermitUser("alice")
  855. upserts := fl.PendingUpdates()
  856. assert.Len(t, upserts, 1)
  857. assert.Equal(t, wire.FeedbagClassIDPermit, upserts[0].ClassID)
  858. assert.Equal(t, "alice", upserts[0].Name)
  859. })
  860. t.Run("duplicate permit is not re-added", func(t *testing.T) {
  861. fl := NewFeedbagList([]wire.FeedbagItem{
  862. {ClassID: wire.FeedbagClassIDPermit, Name: "alice", ItemID: 1},
  863. }, nil)
  864. fl.PermitUser("alice")
  865. assert.Nil(t, fl.PendingUpdates())
  866. })
  867. t.Run("name is normalized", func(t *testing.T) {
  868. fl := NewFeedbagList(nil, func(n int) int { return 0 })
  869. fl.PermitUser("Alice")
  870. upserts := fl.PendingUpdates()
  871. assert.Len(t, upserts, 1)
  872. assert.Equal(t, "alice", upserts[0].Name)
  873. })
  874. }
  875. func TestFeedbagList_DenyUser(t *testing.T) {
  876. t.Run("new deny entry is added", func(t *testing.T) {
  877. fl := NewFeedbagList(nil, func(n int) int { return 0 })
  878. fl.DenyUser("alice")
  879. upserts := fl.PendingUpdates()
  880. assert.Len(t, upserts, 1)
  881. assert.Equal(t, wire.FeedbagClassIDDeny, upserts[0].ClassID)
  882. assert.Equal(t, "alice", upserts[0].Name)
  883. })
  884. t.Run("duplicate deny is not re-added", func(t *testing.T) {
  885. fl := NewFeedbagList([]wire.FeedbagItem{
  886. {ClassID: wire.FeedbagClassIDDeny, Name: "alice", ItemID: 1},
  887. }, nil)
  888. fl.DenyUser("alice")
  889. assert.Nil(t, fl.PendingUpdates())
  890. })
  891. t.Run("name is normalized", func(t *testing.T) {
  892. fl := NewFeedbagList(nil, func(n int) int { return 0 })
  893. fl.DenyUser("Alice")
  894. upserts := fl.PendingUpdates()
  895. assert.Len(t, upserts, 1)
  896. assert.Equal(t, "alice", upserts[0].Name)
  897. })
  898. }
  899. func TestFeedbagList_DeletePermit(t *testing.T) {
  900. t.Run("existing permit is deleted", func(t *testing.T) {
  901. item := wire.FeedbagItem{ClassID: wire.FeedbagClassIDPermit, Name: "alice", ItemID: 1}
  902. fl := NewFeedbagList([]wire.FeedbagItem{item}, nil)
  903. fl.DeletePermit("alice")
  904. deletes := fl.PendingDeletes()
  905. assert.Len(t, deletes, 1)
  906. assert.Equal(t, item, deletes[0])
  907. })
  908. t.Run("deleting non-existent permit is a no-op", func(t *testing.T) {
  909. fl := NewFeedbagList(nil, nil)
  910. fl.DeletePermit("alice")
  911. assert.Empty(t, fl.PendingDeletes())
  912. })
  913. t.Run("name comparison is case-insensitive", func(t *testing.T) {
  914. item := wire.FeedbagItem{ClassID: wire.FeedbagClassIDPermit, Name: "alice", ItemID: 1}
  915. fl := NewFeedbagList([]wire.FeedbagItem{item}, nil)
  916. fl.DeletePermit("Alice")
  917. assert.Len(t, fl.PendingDeletes(), 1)
  918. })
  919. }
  920. func TestFeedbagList_DeleteDeny(t *testing.T) {
  921. t.Run("existing deny is deleted", func(t *testing.T) {
  922. item := wire.FeedbagItem{ClassID: wire.FeedbagClassIDDeny, Name: "alice", ItemID: 1}
  923. fl := NewFeedbagList([]wire.FeedbagItem{item}, nil)
  924. fl.DeleteDeny("alice")
  925. deletes := fl.PendingDeletes()
  926. assert.Len(t, deletes, 1)
  927. assert.Equal(t, item, deletes[0])
  928. })
  929. t.Run("deleting non-existent deny is a no-op", func(t *testing.T) {
  930. fl := NewFeedbagList(nil, nil)
  931. fl.DeleteDeny("alice")
  932. assert.Empty(t, fl.PendingDeletes())
  933. })
  934. t.Run("name comparison is case-insensitive", func(t *testing.T) {
  935. item := wire.FeedbagItem{ClassID: wire.FeedbagClassIDDeny, Name: "alice", ItemID: 1}
  936. fl := NewFeedbagList([]wire.FeedbagItem{item}, nil)
  937. fl.DeleteDeny("Alice")
  938. assert.Len(t, fl.PendingDeletes(), 1)
  939. })
  940. }
  941. func TestFeedbagList_AddLinkedScreenName(t *testing.T) {
  942. t.Run("new linked screen name is added", func(t *testing.T) {
  943. fl := NewFeedbagList(nil, func(n int) int { return 0 })
  944. fl.AddLinkedScreenName("alice")
  945. upserts := fl.PendingUpdates()
  946. assert.Len(t, upserts, 1)
  947. assert.Equal(t, wire.FeedbagClassIdAlInfo, upserts[0].ClassID)
  948. assert.Equal(t, "alice", upserts[0].Name)
  949. })
  950. t.Run("duplicate linked screen name is not re-added", func(t *testing.T) {
  951. fl := NewFeedbagList([]wire.FeedbagItem{
  952. {ClassID: wire.FeedbagClassIdAlInfo, Name: "alice", ItemID: 1},
  953. }, nil)
  954. fl.AddLinkedScreenName("alice")
  955. assert.Nil(t, fl.PendingUpdates())
  956. })
  957. t.Run("name is normalized", func(t *testing.T) {
  958. fl := NewFeedbagList(nil, func(n int) int { return 0 })
  959. fl.AddLinkedScreenName("Alice")
  960. upserts := fl.PendingUpdates()
  961. assert.Len(t, upserts, 1)
  962. assert.Equal(t, "alice", upserts[0].Name)
  963. })
  964. }
  965. func TestFeedbagList_DeleteLinkedScreenName(t *testing.T) {
  966. t.Run("existing linked screen name is deleted, root group created and pending", func(t *testing.T) {
  967. item := wire.FeedbagItem{ClassID: wire.FeedbagClassIdAlInfo, Name: "alice", ItemID: 1}
  968. fl := NewFeedbagList([]wire.FeedbagItem{item}, nil)
  969. fl.DeleteLinkedScreenName("alice")
  970. deletes := fl.PendingDeletes()
  971. assert.Len(t, deletes, 1)
  972. assert.Equal(t, item, deletes[0])
  973. upserts := fl.PendingUpdates()
  974. assert.Len(t, upserts, 1)
  975. assert.Equal(t, wire.FeedbagClassIdGroup, upserts[0].ClassID)
  976. assert.Equal(t, uint16(0), upserts[0].GroupID)
  977. })
  978. t.Run("existing root group is touched on delete", func(t *testing.T) {
  979. root := wire.FeedbagItem{ClassID: wire.FeedbagClassIdGroup, GroupID: 0, ItemID: 1}
  980. item := wire.FeedbagItem{ClassID: wire.FeedbagClassIdAlInfo, Name: "alice", ItemID: 2}
  981. fl := NewFeedbagList([]wire.FeedbagItem{root, item}, nil)
  982. fl.DeleteLinkedScreenName("alice")
  983. upserts := fl.PendingUpdates()
  984. assert.Len(t, upserts, 1)
  985. assert.Equal(t, wire.FeedbagClassIdGroup, upserts[0].ClassID)
  986. assert.Equal(t, uint16(0), upserts[0].GroupID)
  987. })
  988. t.Run("deleting non-existent linked screen name is a no-op", func(t *testing.T) {
  989. fl := NewFeedbagList(nil, nil)
  990. fl.DeleteLinkedScreenName("alice")
  991. assert.Empty(t, fl.PendingDeletes())
  992. assert.Nil(t, fl.PendingUpdates())
  993. })
  994. t.Run("name comparison is case-insensitive", func(t *testing.T) {
  995. item := wire.FeedbagItem{ClassID: wire.FeedbagClassIdAlInfo, Name: "alice", ItemID: 1}
  996. fl := NewFeedbagList([]wire.FeedbagItem{item}, nil)
  997. fl.DeleteLinkedScreenName("Alice")
  998. assert.Len(t, fl.PendingDeletes(), 1)
  999. })
  1000. }
  1001. func TestFeedbagList_LinkedScreenNames(t *testing.T) {
  1002. t.Run("returns all linked screen names", func(t *testing.T) {
  1003. fl := NewFeedbagList([]wire.FeedbagItem{
  1004. {ClassID: wire.FeedbagClassIdAlInfo, Name: "alice", ItemID: 1},
  1005. {ClassID: wire.FeedbagClassIdAlInfo, Name: "bob", ItemID: 2},
  1006. {ClassID: wire.FeedbagClassIdBuddy, Name: "carol", ItemID: 3},
  1007. }, nil)
  1008. names := fl.LinkedScreenNames()
  1009. assert.Equal(t, []IdentScreenName{
  1010. NewIdentScreenName("alice"),
  1011. NewIdentScreenName("bob"),
  1012. }, names)
  1013. })
  1014. t.Run("returns nil when no linked screen names exist", func(t *testing.T) {
  1015. fl := NewFeedbagList(nil, nil)
  1016. assert.Nil(t, fl.LinkedScreenNames())
  1017. })
  1018. }
  1019. func TestFeedbagList_HasLinkedScreenName(t *testing.T) {
  1020. t.Run("returns true when linked screen name exists", func(t *testing.T) {
  1021. fl := NewFeedbagList([]wire.FeedbagItem{
  1022. {ClassID: wire.FeedbagClassIdAlInfo, Name: "alice", ItemID: 1},
  1023. }, nil)
  1024. assert.True(t, fl.HasLinkedScreenName("alice"))
  1025. })
  1026. t.Run("returns false when linked screen name does not exist", func(t *testing.T) {
  1027. fl := NewFeedbagList(nil, nil)
  1028. assert.False(t, fl.HasLinkedScreenName("alice"))
  1029. })
  1030. t.Run("match is case-insensitive", func(t *testing.T) {
  1031. fl := NewFeedbagList([]wire.FeedbagItem{
  1032. {ClassID: wire.FeedbagClassIdAlInfo, Name: "alice", ItemID: 1},
  1033. }, nil)
  1034. assert.True(t, fl.HasLinkedScreenName("Alice"))
  1035. })
  1036. }
  1037. func TestFeedbagList_RenameGroup(t *testing.T) {
  1038. t.Run("renames group in place preserving IDs", func(t *testing.T) {
  1039. fl := NewFeedbagList([]wire.FeedbagItem{
  1040. {Name: "Coworkers", ClassID: wire.FeedbagClassIdGroup, GroupID: 5, ItemID: 0},
  1041. }, nil)
  1042. err := fl.RenameGroup("Coworkers", "Colleagues")
  1043. assert.NoError(t, err)
  1044. upserts := fl.PendingUpdates()
  1045. assert.Len(t, upserts, 1)
  1046. assert.Equal(t, "Colleagues", upserts[0].Name)
  1047. assert.Equal(t, uint16(5), upserts[0].GroupID)
  1048. assert.Equal(t, wire.FeedbagClassIdGroup, upserts[0].ClassID)
  1049. })
  1050. t.Run("returns ErrGroupNotFound for missing group", func(t *testing.T) {
  1051. fl := NewFeedbagList(nil, nil)
  1052. err := fl.RenameGroup("Nope", "New")
  1053. assert.ErrorIs(t, err, ErrGroupNotFound)
  1054. assert.Nil(t, fl.PendingUpdates())
  1055. })
  1056. t.Run("returns ErrGroupExists when target name taken", func(t *testing.T) {
  1057. fl := NewFeedbagList([]wire.FeedbagItem{
  1058. {Name: "A", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  1059. {Name: "B", ClassID: wire.FeedbagClassIdGroup, GroupID: 2},
  1060. }, nil)
  1061. err := fl.RenameGroup("A", "B")
  1062. assert.ErrorIs(t, err, ErrGroupExists)
  1063. assert.Nil(t, fl.PendingUpdates())
  1064. })
  1065. t.Run("renaming to same name is a no-op", func(t *testing.T) {
  1066. fl := NewFeedbagList([]wire.FeedbagItem{
  1067. {Name: "A", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  1068. }, nil)
  1069. err := fl.RenameGroup("A", "A")
  1070. assert.NoError(t, err)
  1071. assert.Nil(t, fl.PendingUpdates())
  1072. })
  1073. }
  1074. func TestFeedbagList_MoveBuddy(t *testing.T) {
  1075. t.Run("moves buddy across groups carrying all attributes", func(t *testing.T) {
  1076. fl := NewFeedbagList([]wire.FeedbagItem{
  1077. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1,
  1078. TLVLBlock: wire.TLVLBlock{TLVList: wire.TLVList{
  1079. wire.NewTLVBE(wire.FeedbagAttributesOrder, []uint16{10}),
  1080. }}},
  1081. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 10,
  1082. TLVLBlock: wire.TLVLBlock{TLVList: wire.TLVList{
  1083. wire.NewTLVBE(wire.FeedbagAttributesAlias, "Al"),
  1084. wire.NewTLVBE(wire.FeedbagAttributesNote, "friend"),
  1085. // a non-alias/note attribute that must survive the move
  1086. wire.NewTLVBE(wire.FeedbagAttributesPending, []byte{}),
  1087. }}},
  1088. {Name: "Coworkers", ClassID: wire.FeedbagClassIdGroup, GroupID: 2},
  1089. }, func(n int) int { return 99 })
  1090. err := fl.MoveBuddy("Buddies", "Coworkers", "alice", "")
  1091. assert.NoError(t, err)
  1092. deletes := fl.PendingDeletes()
  1093. assert.Len(t, deletes, 1)
  1094. assert.Equal(t, "alice", deletes[0].Name)
  1095. assert.Equal(t, uint16(1), deletes[0].GroupID)
  1096. upserts := fl.PendingUpdates()
  1097. var newBuddy *wire.FeedbagItem
  1098. for i := range upserts {
  1099. if upserts[i].ClassID == wire.FeedbagClassIdBuddy {
  1100. newBuddy = &upserts[i]
  1101. }
  1102. }
  1103. assert.NotNil(t, newBuddy)
  1104. assert.Equal(t, uint16(2), newBuddy.GroupID)
  1105. alias, ok := newBuddy.Bytes(wire.FeedbagAttributesAlias)
  1106. assert.True(t, ok)
  1107. assert.Equal(t, []byte("Al"), alias)
  1108. note, ok := newBuddy.Bytes(wire.FeedbagAttributesNote)
  1109. assert.True(t, ok)
  1110. assert.Equal(t, []byte("friend"), note)
  1111. // the non-alias/note attribute is preserved rather than stripped
  1112. assert.True(t, newBuddy.HasTag(wire.FeedbagAttributesPending))
  1113. })
  1114. t.Run("reorders within a group before another buddy", func(t *testing.T) {
  1115. fl := NewFeedbagList([]wire.FeedbagItem{
  1116. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1,
  1117. TLVLBlock: wire.TLVLBlock{TLVList: wire.TLVList{
  1118. wire.NewTLVBE(wire.FeedbagAttributesOrder, []uint16{10, 20, 30}),
  1119. }}},
  1120. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 10},
  1121. {Name: "bob", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 20},
  1122. {Name: "carol", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 30},
  1123. }, nil)
  1124. // move carol (30) before alice (10)
  1125. err := fl.MoveBuddy("Buddies", "", "carol", "alice")
  1126. assert.NoError(t, err)
  1127. upserts := fl.PendingUpdates()
  1128. assert.Len(t, upserts, 1)
  1129. order, ok := upserts[0].Uint16SliceBE(wire.FeedbagAttributesOrder)
  1130. assert.True(t, ok)
  1131. assert.Equal(t, []uint16{30, 10, 20}, order)
  1132. })
  1133. t.Run("returns ErrBuddyNotFound when buddy missing", func(t *testing.T) {
  1134. fl := NewFeedbagList([]wire.FeedbagItem{
  1135. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  1136. }, nil)
  1137. err := fl.MoveBuddy("Buddies", "", "ghost", "")
  1138. assert.ErrorIs(t, err, ErrBuddyNotFound)
  1139. })
  1140. t.Run("returns ErrGroupNotFound when destination missing", func(t *testing.T) {
  1141. fl := NewFeedbagList([]wire.FeedbagItem{
  1142. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  1143. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 10},
  1144. }, nil)
  1145. err := fl.MoveBuddy("Buddies", "Nowhere", "alice", "")
  1146. assert.ErrorIs(t, err, ErrGroupNotFound)
  1147. })
  1148. }
  1149. func TestFeedbagList_SetBuddyAlias(t *testing.T) {
  1150. t.Run("sets alias on all matching buddies", func(t *testing.T) {
  1151. fl := NewFeedbagList([]wire.FeedbagItem{
  1152. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 10},
  1153. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 2, ItemID: 20},
  1154. }, nil)
  1155. found, err := fl.SetBuddyAlias("alice", "Al")
  1156. assert.NoError(t, err)
  1157. assert.True(t, found)
  1158. upserts := fl.PendingUpdates()
  1159. assert.Len(t, upserts, 2)
  1160. for _, item := range upserts {
  1161. alias, ok := item.Bytes(wire.FeedbagAttributesAlias)
  1162. assert.True(t, ok)
  1163. assert.Equal(t, []byte("Al"), alias)
  1164. }
  1165. })
  1166. t.Run("clears alias when empty", func(t *testing.T) {
  1167. fl := NewFeedbagList([]wire.FeedbagItem{
  1168. {Name: "alice", ClassID: wire.FeedbagClassIdBuddy, GroupID: 1, ItemID: 10,
  1169. TLVLBlock: wire.TLVLBlock{TLVList: wire.TLVList{
  1170. wire.NewTLVBE(wire.FeedbagAttributesAlias, "Al"),
  1171. }}},
  1172. }, nil)
  1173. found, err := fl.SetBuddyAlias("alice", "")
  1174. assert.NoError(t, err)
  1175. assert.True(t, found)
  1176. upserts := fl.PendingUpdates()
  1177. assert.Len(t, upserts, 1)
  1178. assert.False(t, upserts[0].HasTag(wire.FeedbagAttributesAlias))
  1179. })
  1180. t.Run("returns false when buddy not found", func(t *testing.T) {
  1181. fl := NewFeedbagList(nil, nil)
  1182. found, err := fl.SetBuddyAlias("ghost", "X")
  1183. assert.NoError(t, err)
  1184. assert.False(t, found)
  1185. assert.Nil(t, fl.PendingUpdates())
  1186. })
  1187. }
  1188. func TestFeedbagList_SetGroupCollapsed(t *testing.T) {
  1189. t.Run("sets collapsed attribute", func(t *testing.T) {
  1190. fl := NewFeedbagList([]wire.FeedbagItem{
  1191. {Name: "Coworkers", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  1192. }, nil)
  1193. err := fl.SetGroupCollapsed("Coworkers", true)
  1194. assert.NoError(t, err)
  1195. upserts := fl.PendingUpdates()
  1196. assert.Len(t, upserts, 1)
  1197. assert.True(t, upserts[0].HasTag(wire.FeedbagAttributesCollapsed))
  1198. })
  1199. t.Run("clears collapsed attribute", func(t *testing.T) {
  1200. fl := NewFeedbagList([]wire.FeedbagItem{
  1201. {Name: "Coworkers", ClassID: wire.FeedbagClassIdGroup, GroupID: 1,
  1202. TLVLBlock: wire.TLVLBlock{TLVList: wire.TLVList{
  1203. wire.NewTLVBE(wire.FeedbagAttributesCollapsed, []byte{}),
  1204. }}},
  1205. }, nil)
  1206. err := fl.SetGroupCollapsed("Coworkers", false)
  1207. assert.NoError(t, err)
  1208. upserts := fl.PendingUpdates()
  1209. assert.Len(t, upserts, 1)
  1210. assert.False(t, upserts[0].HasTag(wire.FeedbagAttributesCollapsed))
  1211. })
  1212. t.Run("targets unnamed default group, not the root group", func(t *testing.T) {
  1213. fl := NewFeedbagList([]wire.FeedbagItem{
  1214. {Name: "", ClassID: wire.FeedbagClassIdGroup, GroupID: 0},
  1215. {Name: "", ClassID: wire.FeedbagClassIdGroup, GroupID: 3},
  1216. }, nil)
  1217. err := fl.SetGroupCollapsed("", true)
  1218. assert.NoError(t, err)
  1219. upserts := fl.PendingUpdates()
  1220. assert.Len(t, upserts, 1)
  1221. assert.Equal(t, uint16(3), upserts[0].GroupID)
  1222. assert.True(t, upserts[0].HasTag(wire.FeedbagAttributesCollapsed))
  1223. })
  1224. t.Run("returns ErrGroupNotFound for missing group", func(t *testing.T) {
  1225. fl := NewFeedbagList(nil, nil)
  1226. err := fl.SetGroupCollapsed("Nope", true)
  1227. assert.ErrorIs(t, err, ErrGroupNotFound)
  1228. })
  1229. }
  1230. func TestFeedbagList_SetIcon(t *testing.T) {
  1231. t.Run("first icon gets a nonzero ItemID", func(t *testing.T) {
  1232. // The feedbag is keyed by (screenName, groupID, itemID), so an icon
  1233. // left at 0/0 would overwrite the root group's row.
  1234. fl := NewFeedbagList([]wire.FeedbagItem{
  1235. {ClassID: wire.FeedbagClassIdGroup, GroupID: 0, ItemID: 0},
  1236. {Name: "Buddies", ClassID: wire.FeedbagClassIdGroup, GroupID: 1},
  1237. }, func(n int) int { return 42 })
  1238. item, inserted := fl.SetIcon(wire.BARTTypesBuddyIcon, []byte{0xde, 0xad})
  1239. assert.True(t, inserted)
  1240. assert.Equal(t, uint16(42), item.ItemID)
  1241. assert.Equal(t, wire.FeedbagClassIdBart, item.ClassID)
  1242. assert.Equal(t, "1", item.Name)
  1243. b, ok := item.Bytes(wire.FeedbagAttributesBartInfo)
  1244. assert.True(t, ok)
  1245. info := wire.BARTInfo{}
  1246. assert.NoError(t, wire.UnmarshalBE(&info, bytes.NewBuffer(b)))
  1247. assert.Equal(t, wire.BARTFlagsCustom, info.Flags)
  1248. assert.Equal(t, []byte{0xde, 0xad}, info.Hash)
  1249. })
  1250. t.Run("replacing an icon reuses the stored ItemID", func(t *testing.T) {
  1251. // A buddy icon lives at group 0, so ItemID alone identifies it.
  1252. fl := NewFeedbagList([]wire.FeedbagItem{
  1253. {Name: "1", ClassID: wire.FeedbagClassIdBart, GroupID: 0, ItemID: 9},
  1254. }, func(n int) int { return 42 })
  1255. item, inserted := fl.SetIcon(wire.BARTTypesBuddyIcon, []byte{0xbe, 0xef})
  1256. assert.False(t, inserted)
  1257. assert.Zero(t, item.GroupID)
  1258. assert.Equal(t, uint16(9), item.ItemID)
  1259. assert.Len(t, fl.Items(), 1)
  1260. })
  1261. }