message_cache_test.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752
  1. package server
  2. import (
  3. "database/sql"
  4. "fmt"
  5. "github.com/stretchr/testify/assert"
  6. "net/netip"
  7. "path/filepath"
  8. "sync"
  9. "testing"
  10. "time"
  11. "github.com/stretchr/testify/require"
  12. )
  13. func TestSqliteCache_Messages(t *testing.T) {
  14. testCacheMessages(t, newSqliteTestCache(t))
  15. }
  16. func TestMemCache_Messages(t *testing.T) {
  17. testCacheMessages(t, newMemTestCache(t))
  18. }
  19. func testCacheMessages(t *testing.T, c *messageCache) {
  20. m1 := newDefaultMessage("mytopic", "my message")
  21. m1.Time = 1
  22. m2 := newDefaultMessage("mytopic", "my other message")
  23. m2.Time = 2
  24. require.Nil(t, c.AddMessage(m1))
  25. require.Nil(t, c.AddMessage(newDefaultMessage("example", "my example message")))
  26. require.Nil(t, c.AddMessage(m2))
  27. // Adding invalid
  28. require.Equal(t, errUnexpectedMessageType, c.AddMessage(newKeepaliveMessage("mytopic"))) // These should not be added!
  29. require.Equal(t, errUnexpectedMessageType, c.AddMessage(newOpenMessage("example"))) // These should not be added!
  30. // mytopic: count
  31. counts, err := c.MessageCounts()
  32. require.Nil(t, err)
  33. require.Equal(t, 2, counts["mytopic"])
  34. // mytopic: since all
  35. messages, _ := c.Messages("mytopic", sinceAllMessages, false)
  36. require.Equal(t, 2, len(messages))
  37. require.Equal(t, "my message", messages[0].Message)
  38. require.Equal(t, "mytopic", messages[0].Topic)
  39. require.Equal(t, messageEvent, messages[0].Event)
  40. require.Equal(t, "", messages[0].Title)
  41. require.Equal(t, 0, messages[0].Priority)
  42. require.Nil(t, messages[0].Tags)
  43. require.Equal(t, "my other message", messages[1].Message)
  44. // mytopic: since none
  45. messages, _ = c.Messages("mytopic", sinceNoMessages, false)
  46. require.Empty(t, messages)
  47. // mytopic: since m1 (by ID)
  48. messages, _ = c.Messages("mytopic", newSinceID(m1.ID), false)
  49. require.Equal(t, 1, len(messages))
  50. require.Equal(t, m2.ID, messages[0].ID)
  51. require.Equal(t, "my other message", messages[0].Message)
  52. require.Equal(t, "mytopic", messages[0].Topic)
  53. // mytopic: since 2
  54. messages, _ = c.Messages("mytopic", newSinceTime(2), false)
  55. require.Equal(t, 1, len(messages))
  56. require.Equal(t, "my other message", messages[0].Message)
  57. // mytopic: latest
  58. messages, _ = c.Messages("mytopic", sinceLatestMessage, false)
  59. require.Equal(t, 1, len(messages))
  60. require.Equal(t, "my other message", messages[0].Message)
  61. // example: count
  62. counts, err = c.MessageCounts()
  63. require.Nil(t, err)
  64. require.Equal(t, 1, counts["example"])
  65. // example: since all
  66. messages, _ = c.Messages("example", sinceAllMessages, false)
  67. require.Equal(t, "my example message", messages[0].Message)
  68. // non-existing: count
  69. counts, err = c.MessageCounts()
  70. require.Nil(t, err)
  71. require.Equal(t, 0, counts["doesnotexist"])
  72. // non-existing: since all
  73. messages, _ = c.Messages("doesnotexist", sinceAllMessages, false)
  74. require.Empty(t, messages)
  75. }
  76. func TestSqliteCache_MessagesLock(t *testing.T) {
  77. testCacheMessagesLock(t, newSqliteTestCache(t))
  78. }
  79. func TestMemCache_MessagesLock(t *testing.T) {
  80. testCacheMessagesLock(t, newMemTestCache(t))
  81. }
  82. func testCacheMessagesLock(t *testing.T, c *messageCache) {
  83. var wg sync.WaitGroup
  84. for i := 0; i < 5000; i++ {
  85. wg.Add(1)
  86. go func() {
  87. assert.Nil(t, c.AddMessage(newDefaultMessage("mytopic", "test message")))
  88. wg.Done()
  89. }()
  90. }
  91. wg.Wait()
  92. }
  93. func TestSqliteCache_MessagesScheduled(t *testing.T) {
  94. testCacheMessagesScheduled(t, newSqliteTestCache(t))
  95. }
  96. func TestMemCache_MessagesScheduled(t *testing.T) {
  97. testCacheMessagesScheduled(t, newMemTestCache(t))
  98. }
  99. func testCacheMessagesScheduled(t *testing.T, c *messageCache) {
  100. m1 := newDefaultMessage("mytopic", "message 1")
  101. m2 := newDefaultMessage("mytopic", "message 2")
  102. m2.Time = time.Now().Add(time.Hour).Unix()
  103. m3 := newDefaultMessage("mytopic", "message 3")
  104. m3.Time = time.Now().Add(time.Minute).Unix() // earlier than m2!
  105. m4 := newDefaultMessage("mytopic2", "message 4")
  106. m4.Time = time.Now().Add(time.Minute).Unix()
  107. require.Nil(t, c.AddMessage(m1))
  108. require.Nil(t, c.AddMessage(m2))
  109. require.Nil(t, c.AddMessage(m3))
  110. messages, _ := c.Messages("mytopic", sinceAllMessages, false) // exclude scheduled
  111. require.Equal(t, 1, len(messages))
  112. require.Equal(t, "message 1", messages[0].Message)
  113. messages, _ = c.Messages("mytopic", sinceAllMessages, true) // include scheduled
  114. require.Equal(t, 3, len(messages))
  115. require.Equal(t, "message 1", messages[0].Message)
  116. require.Equal(t, "message 3", messages[1].Message) // Order!
  117. require.Equal(t, "message 2", messages[2].Message)
  118. messages, _ = c.MessagesDue()
  119. require.Empty(t, messages)
  120. }
  121. func TestSqliteCache_Topics(t *testing.T) {
  122. testCacheTopics(t, newSqliteTestCache(t))
  123. }
  124. func TestMemCache_Topics(t *testing.T) {
  125. testCacheTopics(t, newMemTestCache(t))
  126. }
  127. func testCacheTopics(t *testing.T, c *messageCache) {
  128. require.Nil(t, c.AddMessage(newDefaultMessage("topic1", "my example message")))
  129. require.Nil(t, c.AddMessage(newDefaultMessage("topic2", "message 1")))
  130. require.Nil(t, c.AddMessage(newDefaultMessage("topic2", "message 2")))
  131. require.Nil(t, c.AddMessage(newDefaultMessage("topic2", "message 3")))
  132. topics, err := c.Topics()
  133. if err != nil {
  134. t.Fatal(err)
  135. }
  136. require.Equal(t, 2, len(topics))
  137. require.Equal(t, "topic1", topics["topic1"].ID)
  138. require.Equal(t, "topic2", topics["topic2"].ID)
  139. }
  140. func TestSqliteCache_MessagesTagsPrioAndTitle(t *testing.T) {
  141. testCacheMessagesTagsPrioAndTitle(t, newSqliteTestCache(t))
  142. }
  143. func TestMemCache_MessagesTagsPrioAndTitle(t *testing.T) {
  144. testCacheMessagesTagsPrioAndTitle(t, newMemTestCache(t))
  145. }
  146. func testCacheMessagesTagsPrioAndTitle(t *testing.T, c *messageCache) {
  147. m := newDefaultMessage("mytopic", "some message")
  148. m.Tags = []string{"tag1", "tag2"}
  149. m.Priority = 5
  150. m.Title = "some title"
  151. require.Nil(t, c.AddMessage(m))
  152. messages, _ := c.Messages("mytopic", sinceAllMessages, false)
  153. require.Equal(t, []string{"tag1", "tag2"}, messages[0].Tags)
  154. require.Equal(t, 5, messages[0].Priority)
  155. require.Equal(t, "some title", messages[0].Title)
  156. }
  157. func TestSqliteCache_MessagesSinceID(t *testing.T) {
  158. testCacheMessagesSinceID(t, newSqliteTestCache(t))
  159. }
  160. func TestMemCache_MessagesSinceID(t *testing.T) {
  161. testCacheMessagesSinceID(t, newMemTestCache(t))
  162. }
  163. func testCacheMessagesSinceID(t *testing.T, c *messageCache) {
  164. m1 := newDefaultMessage("mytopic", "message 1")
  165. m1.Time = 100
  166. m2 := newDefaultMessage("mytopic", "message 2")
  167. m2.Time = 200
  168. m3 := newDefaultMessage("mytopic", "message 3")
  169. m3.Time = time.Now().Add(time.Hour).Unix() // Scheduled, in the future, later than m7 and m5
  170. m4 := newDefaultMessage("mytopic", "message 4")
  171. m4.Time = 400
  172. m5 := newDefaultMessage("mytopic", "message 5")
  173. m5.Time = time.Now().Add(time.Minute).Unix() // Scheduled, in the future, later than m7
  174. m6 := newDefaultMessage("mytopic", "message 6")
  175. m6.Time = 600
  176. m7 := newDefaultMessage("mytopic", "message 7")
  177. m7.Time = 700
  178. require.Nil(t, c.AddMessage(m1))
  179. require.Nil(t, c.AddMessage(m2))
  180. require.Nil(t, c.AddMessage(m3))
  181. require.Nil(t, c.AddMessage(m4))
  182. require.Nil(t, c.AddMessage(m5))
  183. require.Nil(t, c.AddMessage(m6))
  184. require.Nil(t, c.AddMessage(m7))
  185. // Case 1: Since ID exists, exclude scheduled
  186. messages, _ := c.Messages("mytopic", newSinceID(m2.ID), false)
  187. require.Equal(t, 3, len(messages))
  188. require.Equal(t, "message 4", messages[0].Message)
  189. require.Equal(t, "message 6", messages[1].Message) // Not scheduled m3/m5!
  190. require.Equal(t, "message 7", messages[2].Message)
  191. // Case 2: Since ID exists, include scheduled
  192. messages, _ = c.Messages("mytopic", newSinceID(m2.ID), true)
  193. require.Equal(t, 5, len(messages))
  194. require.Equal(t, "message 4", messages[0].Message)
  195. require.Equal(t, "message 6", messages[1].Message)
  196. require.Equal(t, "message 7", messages[2].Message)
  197. require.Equal(t, "message 5", messages[3].Message) // Order!
  198. require.Equal(t, "message 3", messages[4].Message) // Order!
  199. // Case 3: Since ID does not exist (-> Return all messages), include scheduled
  200. messages, _ = c.Messages("mytopic", newSinceID("doesntexist"), true)
  201. require.Equal(t, 7, len(messages))
  202. require.Equal(t, "message 1", messages[0].Message)
  203. require.Equal(t, "message 2", messages[1].Message)
  204. require.Equal(t, "message 4", messages[2].Message)
  205. require.Equal(t, "message 6", messages[3].Message)
  206. require.Equal(t, "message 7", messages[4].Message)
  207. require.Equal(t, "message 5", messages[5].Message) // Order!
  208. require.Equal(t, "message 3", messages[6].Message) // Order!
  209. // Case 4: Since ID exists and is last message (-> Return no messages), exclude scheduled
  210. messages, _ = c.Messages("mytopic", newSinceID(m7.ID), false)
  211. require.Equal(t, 0, len(messages))
  212. // Case 5: Since ID exists and is last message (-> Return no messages), include scheduled
  213. messages, _ = c.Messages("mytopic", newSinceID(m7.ID), true)
  214. require.Equal(t, 2, len(messages))
  215. require.Equal(t, "message 5", messages[0].Message)
  216. require.Equal(t, "message 3", messages[1].Message)
  217. }
  218. func TestSqliteCache_Prune(t *testing.T) {
  219. testCachePrune(t, newSqliteTestCache(t))
  220. }
  221. func TestMemCache_Prune(t *testing.T) {
  222. testCachePrune(t, newMemTestCache(t))
  223. }
  224. func testCachePrune(t *testing.T, c *messageCache) {
  225. now := time.Now().Unix()
  226. m1 := newDefaultMessage("mytopic", "my message")
  227. m1.Time = now - 10
  228. m1.Expires = now - 5
  229. m2 := newDefaultMessage("mytopic", "my other message")
  230. m2.Time = now - 5
  231. m2.Expires = now + 5 // In the future
  232. m3 := newDefaultMessage("another_topic", "and another one")
  233. m3.Time = now - 12
  234. m3.Expires = now - 2
  235. require.Nil(t, c.AddMessage(m1))
  236. require.Nil(t, c.AddMessage(m2))
  237. require.Nil(t, c.AddMessage(m3))
  238. counts, err := c.MessageCounts()
  239. require.Nil(t, err)
  240. require.Equal(t, 2, counts["mytopic"])
  241. require.Equal(t, 1, counts["another_topic"])
  242. expiredMessageIDs, err := c.MessagesExpired()
  243. require.Nil(t, err)
  244. require.Nil(t, c.DeleteMessages(expiredMessageIDs...))
  245. counts, err = c.MessageCounts()
  246. require.Nil(t, err)
  247. require.Equal(t, 1, counts["mytopic"])
  248. require.Equal(t, 0, counts["another_topic"])
  249. messages, err := c.Messages("mytopic", sinceAllMessages, false)
  250. require.Nil(t, err)
  251. require.Equal(t, 1, len(messages))
  252. require.Equal(t, "my other message", messages[0].Message)
  253. }
  254. func TestSqliteCache_Attachments(t *testing.T) {
  255. testCacheAttachments(t, newSqliteTestCache(t))
  256. }
  257. func TestMemCache_Attachments(t *testing.T) {
  258. testCacheAttachments(t, newMemTestCache(t))
  259. }
  260. func testCacheAttachments(t *testing.T, c *messageCache) {
  261. expires1 := time.Now().Add(-4 * time.Hour).Unix() // Expired
  262. m := newDefaultMessage("mytopic", "flower for you")
  263. m.ID = "m1"
  264. m.SID = "m1"
  265. m.Sender = netip.MustParseAddr("1.2.3.4")
  266. m.Attachment = &attachment{
  267. Name: "flower.jpg",
  268. Type: "image/jpeg",
  269. Size: 5000,
  270. Expires: expires1,
  271. URL: "https://ntfy.sh/file/AbDeFgJhal.jpg",
  272. }
  273. require.Nil(t, c.AddMessage(m))
  274. expires2 := time.Now().Add(2 * time.Hour).Unix() // Future
  275. m = newDefaultMessage("mytopic", "sending you a car")
  276. m.ID = "m2"
  277. m.SID = "m2"
  278. m.Sender = netip.MustParseAddr("1.2.3.4")
  279. m.Attachment = &attachment{
  280. Name: "car.jpg",
  281. Type: "image/jpeg",
  282. Size: 10000,
  283. Expires: expires2,
  284. URL: "https://ntfy.sh/file/aCaRURL.jpg",
  285. }
  286. require.Nil(t, c.AddMessage(m))
  287. expires3 := time.Now().Add(1 * time.Hour).Unix() // Future
  288. m = newDefaultMessage("another-topic", "sending you another car")
  289. m.ID = "m3"
  290. m.SID = "m3"
  291. m.User = "u_BAsbaAa"
  292. m.Sender = netip.MustParseAddr("5.6.7.8")
  293. m.Attachment = &attachment{
  294. Name: "another-car.jpg",
  295. Type: "image/jpeg",
  296. Size: 20000,
  297. Expires: expires3,
  298. URL: "https://ntfy.sh/file/zakaDHFW.jpg",
  299. }
  300. require.Nil(t, c.AddMessage(m))
  301. messages, err := c.Messages("mytopic", sinceAllMessages, false)
  302. require.Nil(t, err)
  303. require.Equal(t, 2, len(messages))
  304. require.Equal(t, "flower for you", messages[0].Message)
  305. require.Equal(t, "flower.jpg", messages[0].Attachment.Name)
  306. require.Equal(t, "image/jpeg", messages[0].Attachment.Type)
  307. require.Equal(t, int64(5000), messages[0].Attachment.Size)
  308. require.Equal(t, expires1, messages[0].Attachment.Expires)
  309. require.Equal(t, "https://ntfy.sh/file/AbDeFgJhal.jpg", messages[0].Attachment.URL)
  310. require.Equal(t, "1.2.3.4", messages[0].Sender.String())
  311. require.Equal(t, "sending you a car", messages[1].Message)
  312. require.Equal(t, "car.jpg", messages[1].Attachment.Name)
  313. require.Equal(t, "image/jpeg", messages[1].Attachment.Type)
  314. require.Equal(t, int64(10000), messages[1].Attachment.Size)
  315. require.Equal(t, expires2, messages[1].Attachment.Expires)
  316. require.Equal(t, "https://ntfy.sh/file/aCaRURL.jpg", messages[1].Attachment.URL)
  317. require.Equal(t, "1.2.3.4", messages[1].Sender.String())
  318. size, err := c.AttachmentBytesUsedBySender("1.2.3.4")
  319. require.Nil(t, err)
  320. require.Equal(t, int64(10000), size)
  321. size, err = c.AttachmentBytesUsedBySender("5.6.7.8")
  322. require.Nil(t, err)
  323. require.Equal(t, int64(0), size) // Accounted to the user, not the IP!
  324. size, err = c.AttachmentBytesUsedByUser("u_BAsbaAa")
  325. require.Nil(t, err)
  326. require.Equal(t, int64(20000), size)
  327. }
  328. func TestSqliteCache_Attachments_Expired(t *testing.T) {
  329. testCacheAttachmentsExpired(t, newSqliteTestCache(t))
  330. }
  331. func TestMemCache_Attachments_Expired(t *testing.T) {
  332. testCacheAttachmentsExpired(t, newMemTestCache(t))
  333. }
  334. func testCacheAttachmentsExpired(t *testing.T, c *messageCache) {
  335. m := newDefaultMessage("mytopic", "flower for you")
  336. m.ID = "m1"
  337. m.SID = "m1"
  338. m.Expires = time.Now().Add(time.Hour).Unix()
  339. require.Nil(t, c.AddMessage(m))
  340. m = newDefaultMessage("mytopic", "message with attachment")
  341. m.ID = "m2"
  342. m.SID = "m2"
  343. m.Expires = time.Now().Add(2 * time.Hour).Unix()
  344. m.Attachment = &attachment{
  345. Name: "car.jpg",
  346. Type: "image/jpeg",
  347. Size: 10000,
  348. Expires: time.Now().Add(2 * time.Hour).Unix(),
  349. URL: "https://ntfy.sh/file/aCaRURL.jpg",
  350. }
  351. require.Nil(t, c.AddMessage(m))
  352. m = newDefaultMessage("mytopic", "message with external attachment")
  353. m.ID = "m3"
  354. m.SID = "m3"
  355. m.Expires = time.Now().Add(2 * time.Hour).Unix()
  356. m.Attachment = &attachment{
  357. Name: "car.jpg",
  358. Type: "image/jpeg",
  359. Expires: 0, // Unknown!
  360. URL: "https://somedomain.com/car.jpg",
  361. }
  362. require.Nil(t, c.AddMessage(m))
  363. m = newDefaultMessage("mytopic2", "message with expired attachment")
  364. m.ID = "m4"
  365. m.SID = "m4"
  366. m.Expires = time.Now().Add(2 * time.Hour).Unix()
  367. m.Attachment = &attachment{
  368. Name: "expired-car.jpg",
  369. Type: "image/jpeg",
  370. Size: 20000,
  371. Expires: time.Now().Add(-1 * time.Hour).Unix(),
  372. URL: "https://ntfy.sh/file/aCaRURL.jpg",
  373. }
  374. require.Nil(t, c.AddMessage(m))
  375. ids, err := c.AttachmentsExpired()
  376. require.Nil(t, err)
  377. require.Equal(t, 1, len(ids))
  378. require.Equal(t, "m4", ids[0])
  379. }
  380. func TestSqliteCache_Migration_From0(t *testing.T) {
  381. filename := newSqliteTestCacheFile(t)
  382. db, err := sql.Open("sqlite3", filename)
  383. require.Nil(t, err)
  384. // Create "version 0" schema
  385. _, err = db.Exec(`
  386. BEGIN;
  387. CREATE TABLE IF NOT EXISTS messages (
  388. id VARCHAR(20) PRIMARY KEY,
  389. time INT NOT NULL,
  390. topic VARCHAR(64) NOT NULL,
  391. message VARCHAR(1024) NOT NULL
  392. );
  393. CREATE INDEX IF NOT EXISTS idx_topic ON messages (topic);
  394. COMMIT;
  395. `)
  396. require.Nil(t, err)
  397. // Insert a bunch of messages
  398. for i := 0; i < 10; i++ {
  399. _, err = db.Exec(`INSERT INTO messages (id, time, topic, message) VALUES (?, ?, ?, ?)`,
  400. fmt.Sprintf("abcd%d", i), time.Now().Unix(), "mytopic", fmt.Sprintf("some message %d", i))
  401. require.Nil(t, err)
  402. }
  403. require.Nil(t, db.Close())
  404. // Create cache to trigger migration
  405. c := newSqliteTestCacheFromFile(t, filename, "")
  406. checkSchemaVersion(t, c.db)
  407. messages, err := c.Messages("mytopic", sinceAllMessages, false)
  408. require.Nil(t, err)
  409. require.Equal(t, 10, len(messages))
  410. require.Equal(t, "some message 5", messages[5].Message)
  411. require.Equal(t, "", messages[5].Title)
  412. require.Nil(t, messages[5].Tags)
  413. require.Equal(t, 0, messages[5].Priority)
  414. }
  415. func TestSqliteCache_Migration_From1(t *testing.T) {
  416. filename := newSqliteTestCacheFile(t)
  417. db, err := sql.Open("sqlite3", filename)
  418. require.Nil(t, err)
  419. // Create "version 1" schema
  420. _, err = db.Exec(`
  421. CREATE TABLE IF NOT EXISTS messages (
  422. id VARCHAR(20) PRIMARY KEY,
  423. time INT NOT NULL,
  424. topic VARCHAR(64) NOT NULL,
  425. message VARCHAR(512) NOT NULL,
  426. title VARCHAR(256) NOT NULL,
  427. priority INT NOT NULL,
  428. tags VARCHAR(256) NOT NULL
  429. );
  430. CREATE INDEX IF NOT EXISTS idx_topic ON messages (topic);
  431. CREATE TABLE IF NOT EXISTS schemaVersion (
  432. id INT PRIMARY KEY,
  433. version INT NOT NULL
  434. );
  435. INSERT INTO schemaVersion (id, version) VALUES (1, 1);
  436. `)
  437. require.Nil(t, err)
  438. // Insert a bunch of messages
  439. for i := 0; i < 10; i++ {
  440. _, err = db.Exec(`INSERT INTO messages (id, time, topic, message, title, priority, tags) VALUES (?, ?, ?, ?, ?, ?, ?)`,
  441. fmt.Sprintf("abcd%d", i), time.Now().Unix(), "mytopic", fmt.Sprintf("some message %d", i), "", 0, "")
  442. require.Nil(t, err)
  443. }
  444. require.Nil(t, db.Close())
  445. // Create cache to trigger migration
  446. c := newSqliteTestCacheFromFile(t, filename, "")
  447. checkSchemaVersion(t, c.db)
  448. // Add delayed message
  449. delayedMessage := newDefaultMessage("mytopic", "some delayed message")
  450. delayedMessage.Time = time.Now().Add(time.Minute).Unix()
  451. require.Nil(t, c.AddMessage(delayedMessage))
  452. // 10, not 11!
  453. messages, err := c.Messages("mytopic", sinceAllMessages, false)
  454. require.Nil(t, err)
  455. require.Equal(t, 10, len(messages))
  456. // 11!
  457. messages, err = c.Messages("mytopic", sinceAllMessages, true)
  458. require.Nil(t, err)
  459. require.Equal(t, 11, len(messages))
  460. // Check that index "idx_topic" exists
  461. rows, err := c.db.Query(`SELECT name FROM sqlite_master WHERE type='index' AND name='idx_topic'`)
  462. require.Nil(t, err)
  463. require.True(t, rows.Next())
  464. var indexName string
  465. require.Nil(t, rows.Scan(&indexName))
  466. require.Equal(t, "idx_topic", indexName)
  467. }
  468. func TestSqliteCache_Migration_From9(t *testing.T) {
  469. // This primarily tests the awkward migration that introduces the "expires" column.
  470. // The migration logic has to update the column, using the existing "cache-duration" value.
  471. filename := newSqliteTestCacheFile(t)
  472. db, err := sql.Open("sqlite3", filename)
  473. require.Nil(t, err)
  474. // Create "version 8" schema
  475. _, err = db.Exec(`
  476. BEGIN;
  477. CREATE TABLE IF NOT EXISTS messages (
  478. id INTEGER PRIMARY KEY AUTOINCREMENT,
  479. mid TEXT NOT NULL,
  480. time INT NOT NULL,
  481. topic TEXT NOT NULL,
  482. message TEXT NOT NULL,
  483. title TEXT NOT NULL,
  484. priority INT NOT NULL,
  485. tags TEXT NOT NULL,
  486. click TEXT NOT NULL,
  487. icon TEXT NOT NULL,
  488. actions TEXT NOT NULL,
  489. attachment_name TEXT NOT NULL,
  490. attachment_type TEXT NOT NULL,
  491. attachment_size INT NOT NULL,
  492. attachment_expires INT NOT NULL,
  493. attachment_url TEXT NOT NULL,
  494. sender TEXT NOT NULL,
  495. encoding TEXT NOT NULL,
  496. published INT NOT NULL
  497. );
  498. CREATE INDEX IF NOT EXISTS idx_mid ON messages (mid);
  499. CREATE INDEX IF NOT EXISTS idx_time ON messages (time);
  500. CREATE INDEX IF NOT EXISTS idx_topic ON messages (topic);
  501. CREATE TABLE IF NOT EXISTS schemaVersion (
  502. id INT PRIMARY KEY,
  503. version INT NOT NULL
  504. );
  505. INSERT INTO schemaVersion (id, version) VALUES (1, 9);
  506. COMMIT;
  507. `)
  508. require.Nil(t, err)
  509. // Insert a bunch of messages
  510. insertQuery := `
  511. INSERT INTO messages (mid, time, topic, message, title, priority, tags, click, icon, actions, attachment_name, attachment_type, attachment_size, attachment_expires, attachment_url, sender, encoding, published)
  512. VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
  513. `
  514. for i := 0; i < 10; i++ {
  515. _, err = db.Exec(
  516. insertQuery,
  517. fmt.Sprintf("abcd%d", i),
  518. time.Now().Unix(),
  519. "mytopic",
  520. fmt.Sprintf("some message %d", i),
  521. "", // title
  522. 0, // priority
  523. "", // tags
  524. "", // click
  525. "", // icon
  526. "", // actions
  527. "", // attachment_name
  528. "", // attachment_type
  529. 0, // attachment_size
  530. 0, // attachment_type
  531. "", // attachment_url
  532. "9.9.9.9", // sender
  533. "", // encoding
  534. 1, // published
  535. )
  536. require.Nil(t, err)
  537. }
  538. // Create cache to trigger migration
  539. cacheDuration := 17 * time.Hour
  540. c, err := newSqliteCache(filename, "", cacheDuration, 0, 0, false)
  541. require.Nil(t, err)
  542. checkSchemaVersion(t, c.db)
  543. // Check version
  544. rows, err := db.Query(`SELECT version FROM main.schemaVersion WHERE id = 1`)
  545. require.Nil(t, err)
  546. require.True(t, rows.Next())
  547. var version int
  548. require.Nil(t, rows.Scan(&version))
  549. require.Equal(t, currentSchemaVersion, version)
  550. messages, err := c.Messages("mytopic", sinceAllMessages, false)
  551. require.Nil(t, err)
  552. require.Equal(t, 10, len(messages))
  553. for _, m := range messages {
  554. require.True(t, m.Expires > time.Now().Add(cacheDuration-5*time.Second).Unix())
  555. require.True(t, m.Expires < time.Now().Add(cacheDuration+5*time.Second).Unix())
  556. }
  557. }
  558. func TestSqliteCache_StartupQueries_WAL(t *testing.T) {
  559. filename := newSqliteTestCacheFile(t)
  560. startupQueries := `pragma journal_mode = WAL;
  561. pragma synchronous = normal;
  562. pragma temp_store = memory;`
  563. db, err := newSqliteCache(filename, startupQueries, time.Hour, 0, 0, false)
  564. require.Nil(t, err)
  565. require.Nil(t, db.AddMessage(newDefaultMessage("mytopic", "some message")))
  566. require.FileExists(t, filename)
  567. require.FileExists(t, filename+"-wal")
  568. require.FileExists(t, filename+"-shm")
  569. }
  570. func TestSqliteCache_StartupQueries_None(t *testing.T) {
  571. filename := newSqliteTestCacheFile(t)
  572. startupQueries := ""
  573. db, err := newSqliteCache(filename, startupQueries, time.Hour, 0, 0, false)
  574. require.Nil(t, err)
  575. require.Nil(t, db.AddMessage(newDefaultMessage("mytopic", "some message")))
  576. require.FileExists(t, filename)
  577. require.NoFileExists(t, filename+"-wal")
  578. require.NoFileExists(t, filename+"-shm")
  579. }
  580. func TestSqliteCache_StartupQueries_Fail(t *testing.T) {
  581. filename := newSqliteTestCacheFile(t)
  582. startupQueries := `xx error`
  583. _, err := newSqliteCache(filename, startupQueries, time.Hour, 0, 0, false)
  584. require.Error(t, err)
  585. }
  586. func TestSqliteCache_Sender(t *testing.T) {
  587. testSender(t, newSqliteTestCache(t))
  588. }
  589. func TestMemCache_Sender(t *testing.T) {
  590. testSender(t, newMemTestCache(t))
  591. }
  592. func testSender(t *testing.T, c *messageCache) {
  593. m1 := newDefaultMessage("mytopic", "mymessage")
  594. m1.Sender = netip.MustParseAddr("1.2.3.4")
  595. require.Nil(t, c.AddMessage(m1))
  596. m2 := newDefaultMessage("mytopic", "mymessage without sender")
  597. require.Nil(t, c.AddMessage(m2))
  598. messages, err := c.Messages("mytopic", sinceAllMessages, false)
  599. require.Nil(t, err)
  600. require.Equal(t, 2, len(messages))
  601. require.Equal(t, messages[0].Sender, netip.MustParseAddr("1.2.3.4"))
  602. require.Equal(t, messages[1].Sender, netip.Addr{})
  603. }
  604. func checkSchemaVersion(t *testing.T, db *sql.DB) {
  605. rows, err := db.Query(`SELECT version FROM schemaVersion`)
  606. require.Nil(t, err)
  607. require.True(t, rows.Next())
  608. var schemaVersion int
  609. require.Nil(t, rows.Scan(&schemaVersion))
  610. require.Equal(t, currentSchemaVersion, schemaVersion)
  611. require.Nil(t, rows.Close())
  612. }
  613. func TestMemCache_NopCache(t *testing.T) {
  614. c, _ := newNopCache()
  615. require.Nil(t, c.AddMessage(newDefaultMessage("mytopic", "my message")))
  616. messages, err := c.Messages("mytopic", sinceAllMessages, false)
  617. require.Nil(t, err)
  618. require.Empty(t, messages)
  619. topics, err := c.Topics()
  620. require.Nil(t, err)
  621. require.Empty(t, topics)
  622. }
  623. func newSqliteTestCache(t *testing.T) *messageCache {
  624. c, err := newSqliteCache(newSqliteTestCacheFile(t), "", time.Hour, 0, 0, false)
  625. if err != nil {
  626. t.Fatal(err)
  627. }
  628. return c
  629. }
  630. func newSqliteTestCacheFile(t *testing.T) string {
  631. return filepath.Join(t.TempDir(), "cache.db")
  632. }
  633. func newSqliteTestCacheFromFile(t *testing.T, filename, startupQueries string) *messageCache {
  634. c, err := newSqliteCache(filename, startupQueries, time.Hour, 0, 0, false)
  635. require.Nil(t, err)
  636. return c
  637. }
  638. func newMemTestCache(t *testing.T) *messageCache {
  639. c, err := newMemCache()
  640. require.Nil(t, err)
  641. return c
  642. }