message_cache_test.go 23 KB

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