server_test.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721
  1. package server
  2. import (
  3. "bufio"
  4. "context"
  5. "encoding/json"
  6. "firebase.google.com/go/messaging"
  7. "fmt"
  8. "github.com/stretchr/testify/require"
  9. "net/http"
  10. "net/http/httptest"
  11. "os"
  12. "path/filepath"
  13. "strings"
  14. "sync"
  15. "testing"
  16. "time"
  17. )
  18. func TestServer_PublishAndPoll(t *testing.T) {
  19. s := newTestServer(t, newTestConfig(t))
  20. response1 := request(t, s, "PUT", "/mytopic", "my first message", nil)
  21. msg1 := toMessage(t, response1.Body.String())
  22. require.NotEmpty(t, msg1.ID)
  23. require.Equal(t, "my first message", msg1.Message)
  24. response2 := request(t, s, "PUT", "/mytopic", "my second\n\nmessage", nil)
  25. msg2 := toMessage(t, response2.Body.String())
  26. require.NotEqual(t, msg1.ID, msg2.ID)
  27. require.NotEmpty(t, msg2.ID)
  28. require.Equal(t, "my second\n\nmessage", msg2.Message)
  29. response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  30. messages := toMessages(t, response.Body.String())
  31. require.Equal(t, 2, len(messages))
  32. require.Equal(t, "my first message", messages[0].Message)
  33. require.Equal(t, "my second\n\nmessage", messages[1].Message)
  34. response = request(t, s, "GET", "/mytopic/sse?poll=1&since=all", "", nil)
  35. lines := strings.Split(strings.TrimSpace(response.Body.String()), "\n")
  36. require.Equal(t, 3, len(lines))
  37. require.Equal(t, "my first message", toMessage(t, strings.TrimPrefix(lines[0], "data: ")).Message)
  38. require.Equal(t, "", lines[1])
  39. require.Equal(t, "my second\n\nmessage", toMessage(t, strings.TrimPrefix(lines[2], "data: ")).Message)
  40. response = request(t, s, "GET", "/mytopic/raw?poll=1", "", nil)
  41. lines = strings.Split(strings.TrimSpace(response.Body.String()), "\n")
  42. require.Equal(t, 2, len(lines))
  43. require.Equal(t, "my first message", lines[0])
  44. require.Equal(t, "my second message", lines[1]) // \n -> " "
  45. }
  46. func TestServer_SubscribeOpenAndKeepalive(t *testing.T) {
  47. c := newTestConfig(t)
  48. c.KeepaliveInterval = time.Second
  49. s := newTestServer(t, c)
  50. rr := httptest.NewRecorder()
  51. ctx, cancel := context.WithCancel(context.Background())
  52. req, err := http.NewRequestWithContext(ctx, "GET", "/mytopic/json", nil)
  53. if err != nil {
  54. t.Fatal(err)
  55. }
  56. doneChan := make(chan bool)
  57. go func() {
  58. s.handle(rr, req)
  59. doneChan <- true
  60. }()
  61. time.Sleep(1300 * time.Millisecond)
  62. cancel()
  63. <-doneChan
  64. messages := toMessages(t, rr.Body.String())
  65. require.Equal(t, 2, len(messages))
  66. require.Equal(t, openEvent, messages[0].Event)
  67. require.Equal(t, "mytopic", messages[0].Topic)
  68. require.Equal(t, "", messages[0].Message)
  69. require.Equal(t, "", messages[0].Title)
  70. require.Equal(t, 0, messages[0].Priority)
  71. require.Nil(t, messages[0].Tags)
  72. require.Equal(t, keepaliveEvent, messages[1].Event)
  73. require.Equal(t, "mytopic", messages[1].Topic)
  74. require.Equal(t, "", messages[1].Message)
  75. require.Equal(t, "", messages[1].Title)
  76. require.Equal(t, 0, messages[1].Priority)
  77. require.Nil(t, messages[1].Tags)
  78. }
  79. func TestServer_PublishAndSubscribe(t *testing.T) {
  80. s := newTestServer(t, newTestConfig(t))
  81. subscribeRR := httptest.NewRecorder()
  82. subscribeCancel := subscribe(t, s, "/mytopic/json", subscribeRR)
  83. publishFirstRR := request(t, s, "PUT", "/mytopic", "my first message", nil)
  84. require.Equal(t, 200, publishFirstRR.Code)
  85. publishSecondRR := request(t, s, "PUT", "/mytopic", "my other message", map[string]string{
  86. "Title": " This is a title ",
  87. "X-Tags": "tag1,tag 2, tag3",
  88. "p": "1",
  89. })
  90. require.Equal(t, 200, publishSecondRR.Code)
  91. subscribeCancel()
  92. messages := toMessages(t, subscribeRR.Body.String())
  93. require.Equal(t, 3, len(messages))
  94. require.Equal(t, openEvent, messages[0].Event)
  95. require.Equal(t, messageEvent, messages[1].Event)
  96. require.Equal(t, "mytopic", messages[1].Topic)
  97. require.Equal(t, "my first message", messages[1].Message)
  98. require.Equal(t, "", messages[1].Title)
  99. require.Equal(t, 0, messages[1].Priority)
  100. require.Nil(t, messages[1].Tags)
  101. require.Equal(t, messageEvent, messages[2].Event)
  102. require.Equal(t, "mytopic", messages[2].Topic)
  103. require.Equal(t, "my other message", messages[2].Message)
  104. require.Equal(t, "This is a title", messages[2].Title)
  105. require.Equal(t, 1, messages[2].Priority)
  106. require.Equal(t, []string{"tag1", "tag 2", "tag3"}, messages[2].Tags)
  107. }
  108. func TestServer_StaticSites(t *testing.T) {
  109. s := newTestServer(t, newTestConfig(t))
  110. rr := request(t, s, "GET", "/", "", nil)
  111. require.Equal(t, 200, rr.Code)
  112. require.Contains(t, rr.Body.String(), "</html>")
  113. rr = request(t, s, "HEAD", "/", "", nil)
  114. require.Equal(t, 200, rr.Code)
  115. rr = request(t, s, "OPTIONS", "/", "", nil)
  116. require.Equal(t, 200, rr.Code)
  117. rr = request(t, s, "GET", "/does-not-exist.txt", "", nil)
  118. require.Equal(t, 404, rr.Code)
  119. rr = request(t, s, "GET", "/mytopic", "", nil)
  120. require.Equal(t, 200, rr.Code)
  121. require.Contains(t, rr.Body.String(), `<meta name="robots" content="noindex, nofollow" />`)
  122. rr = request(t, s, "GET", "/static/css/app.css", "", nil)
  123. require.Equal(t, 200, rr.Code)
  124. require.Contains(t, rr.Body.String(), `html, body {`)
  125. rr = request(t, s, "GET", "/docs", "", nil)
  126. require.Equal(t, 301, rr.Code)
  127. rr = request(t, s, "GET", "/docs/", "", nil)
  128. require.Equal(t, 200, rr.Code)
  129. require.Contains(t, rr.Body.String(), `Made with ❤️ by Philipp C. Heckel`)
  130. require.Contains(t, rr.Body.String(), `<script src=static/js/extra.js></script>`)
  131. rr = request(t, s, "GET", "/example.html", "", nil)
  132. require.Equal(t, 200, rr.Code)
  133. require.Contains(t, rr.Body.String(), "</html>")
  134. }
  135. func TestServer_PublishLargeMessage(t *testing.T) {
  136. s := newTestServer(t, newTestConfig(t))
  137. body := strings.Repeat("this is a large message", 5000)
  138. response := request(t, s, "PUT", "/mytopic", body, nil)
  139. require.Equal(t, 400, response.Code)
  140. }
  141. func TestServer_PublishPriority(t *testing.T) {
  142. s := newTestServer(t, newTestConfig(t))
  143. for prio := 1; prio <= 5; prio++ {
  144. response := request(t, s, "GET", fmt.Sprintf("/mytopic/publish?priority=%d", prio), fmt.Sprintf("priority %d", prio), nil)
  145. msg := toMessage(t, response.Body.String())
  146. require.Equal(t, prio, msg.Priority)
  147. }
  148. response := request(t, s, "GET", "/mytopic/publish?priority=min", "test", nil)
  149. require.Equal(t, 1, toMessage(t, response.Body.String()).Priority)
  150. response = request(t, s, "GET", "/mytopic/send?priority=low", "test", nil)
  151. require.Equal(t, 2, toMessage(t, response.Body.String()).Priority)
  152. response = request(t, s, "GET", "/mytopic/send?priority=default", "test", nil)
  153. require.Equal(t, 3, toMessage(t, response.Body.String()).Priority)
  154. response = request(t, s, "GET", "/mytopic/send?priority=high", "test", nil)
  155. require.Equal(t, 4, toMessage(t, response.Body.String()).Priority)
  156. response = request(t, s, "GET", "/mytopic/send?priority=max", "test", nil)
  157. require.Equal(t, 5, toMessage(t, response.Body.String()).Priority)
  158. response = request(t, s, "GET", "/mytopic/trigger?priority=urgent", "test", nil)
  159. require.Equal(t, 5, toMessage(t, response.Body.String()).Priority)
  160. }
  161. func TestServer_PublishNoCache(t *testing.T) {
  162. s := newTestServer(t, newTestConfig(t))
  163. response := request(t, s, "PUT", "/mytopic", "this message is not cached", map[string]string{
  164. "Cache": "no",
  165. })
  166. msg := toMessage(t, response.Body.String())
  167. require.NotEmpty(t, msg.ID)
  168. require.Equal(t, "this message is not cached", msg.Message)
  169. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  170. messages := toMessages(t, response.Body.String())
  171. require.Empty(t, messages)
  172. }
  173. func TestServer_PublishAt(t *testing.T) {
  174. c := newTestConfig(t)
  175. c.MinDelay = time.Second
  176. c.AtSenderInterval = 100 * time.Millisecond
  177. s := newTestServer(t, c)
  178. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  179. "In": "1s",
  180. })
  181. require.Equal(t, 200, response.Code)
  182. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  183. messages := toMessages(t, response.Body.String())
  184. require.Equal(t, 0, len(messages))
  185. time.Sleep(time.Second)
  186. require.Nil(t, s.sendDelayedMessages())
  187. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  188. messages = toMessages(t, response.Body.String())
  189. require.Equal(t, 1, len(messages))
  190. require.Equal(t, "a message", messages[0].Message)
  191. }
  192. func TestServer_PublishAtWithCacheError(t *testing.T) {
  193. s := newTestServer(t, newTestConfig(t))
  194. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  195. "Cache": "no",
  196. "In": "30 min",
  197. })
  198. require.Equal(t, 400, response.Code)
  199. require.Equal(t, errHTTPBadRequestDelayNoCache, toHTTPError(t, response.Body.String()))
  200. }
  201. func TestServer_PublishAtTooShortDelay(t *testing.T) {
  202. s := newTestServer(t, newTestConfig(t))
  203. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  204. "In": "1s",
  205. })
  206. require.Equal(t, 400, response.Code)
  207. }
  208. func TestServer_PublishAtTooLongDelay(t *testing.T) {
  209. s := newTestServer(t, newTestConfig(t))
  210. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  211. "In": "99999999h",
  212. })
  213. require.Equal(t, 400, response.Code)
  214. }
  215. func TestServer_PublishAtAndPrune(t *testing.T) {
  216. s := newTestServer(t, newTestConfig(t))
  217. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  218. "In": "1h",
  219. })
  220. require.Equal(t, 200, response.Code)
  221. s.updateStatsAndPrune() // Fire pruning
  222. response = request(t, s, "GET", "/mytopic/json?poll=1&scheduled=1", "", nil)
  223. messages := toMessages(t, response.Body.String())
  224. require.Equal(t, 1, len(messages)) // Not affected by pruning
  225. require.Equal(t, "a message", messages[0].Message)
  226. }
  227. func TestServer_PublishAndMultiPoll(t *testing.T) {
  228. s := newTestServer(t, newTestConfig(t))
  229. response := request(t, s, "PUT", "/mytopic1", "message 1", nil)
  230. msg := toMessage(t, response.Body.String())
  231. require.NotEmpty(t, msg.ID)
  232. require.Equal(t, "mytopic1", msg.Topic)
  233. require.Equal(t, "message 1", msg.Message)
  234. response = request(t, s, "PUT", "/mytopic2", "message 2", nil)
  235. msg = toMessage(t, response.Body.String())
  236. require.NotEmpty(t, msg.ID)
  237. require.Equal(t, "mytopic2", msg.Topic)
  238. require.Equal(t, "message 2", msg.Message)
  239. response = request(t, s, "GET", "/mytopic1/json?poll=1", "", nil)
  240. messages := toMessages(t, response.Body.String())
  241. require.Equal(t, 1, len(messages))
  242. require.Equal(t, "mytopic1", messages[0].Topic)
  243. require.Equal(t, "message 1", messages[0].Message)
  244. response = request(t, s, "GET", "/mytopic1,mytopic2/json?poll=1", "", nil)
  245. messages = toMessages(t, response.Body.String())
  246. require.Equal(t, 2, len(messages))
  247. require.Equal(t, "mytopic1", messages[0].Topic)
  248. require.Equal(t, "message 1", messages[0].Message)
  249. require.Equal(t, "mytopic2", messages[1].Topic)
  250. require.Equal(t, "message 2", messages[1].Message)
  251. }
  252. func TestServer_PublishWithNopCache(t *testing.T) {
  253. c := newTestConfig(t)
  254. c.CacheDuration = 0
  255. s := newTestServer(t, c)
  256. subscribeRR := httptest.NewRecorder()
  257. subscribeCancel := subscribe(t, s, "/mytopic/json", subscribeRR)
  258. publishRR := request(t, s, "PUT", "/mytopic", "my first message", nil)
  259. require.Equal(t, 200, publishRR.Code)
  260. subscribeCancel()
  261. messages := toMessages(t, subscribeRR.Body.String())
  262. require.Equal(t, 2, len(messages))
  263. require.Equal(t, openEvent, messages[0].Event)
  264. require.Equal(t, messageEvent, messages[1].Event)
  265. require.Equal(t, "my first message", messages[1].Message)
  266. response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  267. messages = toMessages(t, response.Body.String())
  268. require.Empty(t, messages)
  269. }
  270. func TestServer_PublishAndPollSince(t *testing.T) {
  271. s := newTestServer(t, newTestConfig(t))
  272. request(t, s, "PUT", "/mytopic", "test 1", nil)
  273. time.Sleep(1100 * time.Millisecond)
  274. since := time.Now().Unix()
  275. request(t, s, "PUT", "/mytopic", "test 2", nil)
  276. response := request(t, s, "GET", fmt.Sprintf("/mytopic/json?poll=1&since=%d", since), "", nil)
  277. messages := toMessages(t, response.Body.String())
  278. require.Equal(t, 1, len(messages))
  279. require.Equal(t, "test 2", messages[0].Message)
  280. }
  281. func TestServer_PublishViaGET(t *testing.T) {
  282. s := newTestServer(t, newTestConfig(t))
  283. response := request(t, s, "GET", "/mytopic/trigger", "", nil)
  284. msg := toMessage(t, response.Body.String())
  285. require.NotEmpty(t, msg.ID)
  286. require.Equal(t, "triggered", msg.Message)
  287. response = request(t, s, "GET", "/mytopic/send?message=This+is+a+test&t=This+is+a+title&tags=skull&x-priority=5&delay=24h", "", nil)
  288. msg = toMessage(t, response.Body.String())
  289. require.NotEmpty(t, msg.ID)
  290. require.Equal(t, "This is a test", msg.Message)
  291. require.Equal(t, "This is a title", msg.Title)
  292. require.Equal(t, []string{"skull"}, msg.Tags)
  293. require.Equal(t, 5, msg.Priority)
  294. require.Greater(t, msg.Time, time.Now().Add(23*time.Hour).Unix())
  295. }
  296. func TestServer_PublishFirebase(t *testing.T) {
  297. // This is unfortunately not much of a test, since it merely fires the messages towards Firebase,
  298. // but cannot re-read them. There is no way from Go to read the messages back, or even get an error back.
  299. // I tried everything. I already had written the test, and it increases the code coverage, so I'll leave it ... :shrug: ...
  300. c := newTestConfig(t)
  301. c.FirebaseKeyFile = firebaseServiceAccountFile(t) // May skip the test!
  302. s := newTestServer(t, c)
  303. // Normal message
  304. response := request(t, s, "PUT", "/mytopic", "This is a message for firebase", nil)
  305. msg := toMessage(t, response.Body.String())
  306. require.NotEmpty(t, msg.ID)
  307. // Keepalive message
  308. require.Nil(t, s.firebase(newKeepaliveMessage(firebaseControlTopic)))
  309. time.Sleep(500 * time.Millisecond) // Time for sends
  310. }
  311. func TestServer_PollWithQueryFilters(t *testing.T) {
  312. s := newTestServer(t, newTestConfig(t))
  313. response := request(t, s, "PUT", "/mytopic?priority=1&tags=tag1,tag2", "my first message", nil)
  314. msg := toMessage(t, response.Body.String())
  315. require.NotEmpty(t, msg.ID)
  316. response = request(t, s, "PUT", "/mytopic?title=a+title", "my second message", map[string]string{
  317. "Tags": "tag2,tag3",
  318. })
  319. msg = toMessage(t, response.Body.String())
  320. require.NotEmpty(t, msg.ID)
  321. queriesThatShouldReturnMessageOne := []string{
  322. "/mytopic/json?poll=1&priority=1",
  323. "/mytopic/json?poll=1&priority=min",
  324. "/mytopic/json?poll=1&priority=min,low",
  325. "/mytopic/json?poll=1&priority=1,2",
  326. "/mytopic/json?poll=1&p=2,min",
  327. "/mytopic/json?poll=1&tags=tag1",
  328. "/mytopic/json?poll=1&tags=tag1,tag2",
  329. "/mytopic/json?poll=1&message=my+first+message",
  330. }
  331. for _, query := range queriesThatShouldReturnMessageOne {
  332. response = request(t, s, "GET", query, "", nil)
  333. messages := toMessages(t, response.Body.String())
  334. require.Equal(t, 1, len(messages), "Query failed: "+query)
  335. require.Equal(t, "my first message", messages[0].Message, "Query failed: "+query)
  336. }
  337. queriesThatShouldReturnMessageTwo := []string{
  338. "/mytopic/json?poll=1&x-priority=3", // !
  339. "/mytopic/json?poll=1&priority=3",
  340. "/mytopic/json?poll=1&priority=default",
  341. "/mytopic/json?poll=1&p=3",
  342. "/mytopic/json?poll=1&x-tags=tag2,tag3",
  343. "/mytopic/json?poll=1&tags=tag2,tag3",
  344. "/mytopic/json?poll=1&tag=tag2,tag3",
  345. "/mytopic/json?poll=1&ta=tag2,tag3",
  346. "/mytopic/json?poll=1&x-title=a+title",
  347. "/mytopic/json?poll=1&title=a+title",
  348. "/mytopic/json?poll=1&t=a+title",
  349. "/mytopic/json?poll=1&x-message=my+second+message",
  350. "/mytopic/json?poll=1&message=my+second+message",
  351. "/mytopic/json?poll=1&m=my+second+message",
  352. "/mytopic/json?x-poll=1&m=my+second+message",
  353. "/mytopic/json?po=1&m=my+second+message",
  354. }
  355. for _, query := range queriesThatShouldReturnMessageTwo {
  356. response = request(t, s, "GET", query, "", nil)
  357. messages := toMessages(t, response.Body.String())
  358. require.Equal(t, 1, len(messages), "Query failed: "+query)
  359. require.Equal(t, "my second message", messages[0].Message, "Query failed: "+query)
  360. }
  361. queriesThatShouldReturnNoMessages := []string{
  362. "/mytopic/json?poll=1&priority=4",
  363. "/mytopic/json?poll=1&tags=tag1,tag2,tag3",
  364. "/mytopic/json?poll=1&title=another+title",
  365. "/mytopic/json?poll=1&message=my+third+message",
  366. "/mytopic/json?poll=1&message=my+third+message",
  367. }
  368. for _, query := range queriesThatShouldReturnNoMessages {
  369. response = request(t, s, "GET", query, "", nil)
  370. messages := toMessages(t, response.Body.String())
  371. require.Equal(t, 0, len(messages), "Query failed: "+query)
  372. }
  373. }
  374. func TestServer_SubscribeWithQueryFilters(t *testing.T) {
  375. c := newTestConfig(t)
  376. c.KeepaliveInterval = 800 * time.Millisecond
  377. s := newTestServer(t, c)
  378. subscribeResponse := httptest.NewRecorder()
  379. subscribeCancel := subscribe(t, s, "/mytopic/json?tags=zfs-issue", subscribeResponse)
  380. response := request(t, s, "PUT", "/mytopic", "my first message", nil)
  381. require.Equal(t, 200, response.Code)
  382. response = request(t, s, "PUT", "/mytopic", "ZFS scrub failed", map[string]string{
  383. "Tags": "zfs-issue,zfs-scrub",
  384. })
  385. require.Equal(t, 200, response.Code)
  386. time.Sleep(850 * time.Millisecond)
  387. subscribeCancel()
  388. messages := toMessages(t, subscribeResponse.Body.String())
  389. require.Equal(t, 3, len(messages))
  390. require.Equal(t, openEvent, messages[0].Event)
  391. require.Equal(t, messageEvent, messages[1].Event)
  392. require.Equal(t, "ZFS scrub failed", messages[1].Message)
  393. require.Equal(t, keepaliveEvent, messages[2].Event)
  394. }
  395. /*
  396. func TestServer_Curl_Publish_Poll(t *testing.T) {
  397. s, port := test.StartServer(t)
  398. defer test.StopServer(t, s, port)
  399. cmd := exec.Command("sh", "-c", fmt.Sprintf(`curl -sd "This is a test" localhost:%d/mytopic`, port))
  400. require.Nil(t, cmd.Run())
  401. b, err := cmd.CombinedOutput()
  402. require.Nil(t, err)
  403. msg := toMessage(t, string(b))
  404. require.Equal(t, "This is a test", msg.Message)
  405. cmd = exec.Command("sh", "-c", fmt.Sprintf(`curl "localhost:%d/mytopic?poll=1"`, port))
  406. require.Nil(t, cmd.Run())
  407. b, err = cmd.CombinedOutput()
  408. require.Nil(t, err)
  409. msg = toMessage(t, string(b))
  410. require.Equal(t, "This is a test", msg.Message)
  411. }
  412. */
  413. type testMailer struct {
  414. count int
  415. mu sync.Mutex
  416. }
  417. func (t *testMailer) Send(from, to string, m *message) error {
  418. t.mu.Lock()
  419. defer t.mu.Unlock()
  420. t.count++
  421. return nil
  422. }
  423. func TestServer_PublishTooManyEmails_Defaults(t *testing.T) {
  424. s := newTestServer(t, newTestConfig(t))
  425. s.mailer = &testMailer{}
  426. for i := 0; i < 16; i++ {
  427. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  428. "E-Mail": "test@example.com",
  429. })
  430. require.Equal(t, 200, response.Code)
  431. }
  432. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  433. "E-Mail": "test@example.com",
  434. })
  435. require.Equal(t, 429, response.Code)
  436. }
  437. func TestServer_PublishTooManyEmails_Replenish(t *testing.T) {
  438. c := newTestConfig(t)
  439. c.VisitorEmailLimitReplenish = 500 * time.Millisecond
  440. s := newTestServer(t, c)
  441. s.mailer = &testMailer{}
  442. for i := 0; i < 16; i++ {
  443. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  444. "E-Mail": "test@example.com",
  445. })
  446. require.Equal(t, 200, response.Code)
  447. }
  448. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  449. "E-Mail": "test@example.com",
  450. })
  451. require.Equal(t, 429, response.Code)
  452. time.Sleep(510 * time.Millisecond)
  453. response = request(t, s, "PUT", "/mytopic", "this should be okay again too many", map[string]string{
  454. "E-Mail": "test@example.com",
  455. })
  456. require.Equal(t, 200, response.Code)
  457. response = request(t, s, "PUT", "/mytopic", "and bad again", map[string]string{
  458. "E-Mail": "test@example.com",
  459. })
  460. require.Equal(t, 429, response.Code)
  461. }
  462. func TestServer_PublishDelayedEmail_Fail(t *testing.T) {
  463. s := newTestServer(t, newTestConfig(t))
  464. s.mailer = &testMailer{}
  465. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  466. "E-Mail": "test@example.com",
  467. "Delay": "20 min",
  468. })
  469. require.Equal(t, 400, response.Code)
  470. }
  471. func TestServer_PublishEmailNoMailer_Fail(t *testing.T) {
  472. s := newTestServer(t, newTestConfig(t))
  473. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  474. "E-Mail": "test@example.com",
  475. })
  476. require.Equal(t, 400, response.Code)
  477. }
  478. func TestServer_UnifiedPushDiscovery(t *testing.T) {
  479. s := newTestServer(t, newTestConfig(t))
  480. response := request(t, s, "GET", "/mytopic?up=1", "", nil)
  481. require.Equal(t, 200, response.Code)
  482. require.Equal(t, `{"unifiedpush":{"version":1}}`+"\n", response.Body.String())
  483. }
  484. func TestServer_MaybeTruncateFCMMessage(t *testing.T) {
  485. origMessage := strings.Repeat("this is a long string", 300)
  486. origFCMMessage := &messaging.Message{
  487. Topic: "mytopic",
  488. Data: map[string]string{
  489. "id": "abcdefg",
  490. "time": "1641324761",
  491. "event": "message",
  492. "topic": "mytopic",
  493. "priority": "0",
  494. "tags": "",
  495. "title": "",
  496. "message": origMessage,
  497. },
  498. Android: &messaging.AndroidConfig{
  499. Priority: "high",
  500. },
  501. }
  502. origMessageLength := len(origFCMMessage.Data["message"])
  503. serializedOrigFCMMessage, _ := json.Marshal(origFCMMessage)
  504. require.Greater(t, len(serializedOrigFCMMessage), fcmMessageLimit) // Pre-condition
  505. truncatedFCMMessage := maybeTruncateFCMMessage(origFCMMessage)
  506. truncatedMessageLength := len(truncatedFCMMessage.Data["message"])
  507. serializedTruncatedFCMMessage, _ := json.Marshal(truncatedFCMMessage)
  508. require.Equal(t, fcmMessageLimit, len(serializedTruncatedFCMMessage))
  509. require.Equal(t, "1", truncatedFCMMessage.Data["truncated"])
  510. require.NotEqual(t, origMessageLength, truncatedMessageLength)
  511. }
  512. func TestServer_MaybeTruncateFCMMessage_NotTooLong(t *testing.T) {
  513. origMessage := "not really a long string"
  514. origFCMMessage := &messaging.Message{
  515. Topic: "mytopic",
  516. Data: map[string]string{
  517. "id": "abcdefg",
  518. "time": "1641324761",
  519. "event": "message",
  520. "topic": "mytopic",
  521. "priority": "0",
  522. "tags": "",
  523. "title": "",
  524. "message": origMessage,
  525. },
  526. }
  527. origMessageLength := len(origFCMMessage.Data["message"])
  528. serializedOrigFCMMessage, _ := json.Marshal(origFCMMessage)
  529. require.LessOrEqual(t, len(serializedOrigFCMMessage), fcmMessageLimit) // Pre-condition
  530. notTruncatedFCMMessage := maybeTruncateFCMMessage(origFCMMessage)
  531. notTruncatedMessageLength := len(notTruncatedFCMMessage.Data["message"])
  532. serializedNotTruncatedFCMMessage, _ := json.Marshal(notTruncatedFCMMessage)
  533. require.Equal(t, origMessageLength, notTruncatedMessageLength)
  534. require.Equal(t, len(serializedOrigFCMMessage), len(serializedNotTruncatedFCMMessage))
  535. require.Equal(t, "", notTruncatedFCMMessage.Data["truncated"])
  536. }
  537. func newTestConfig(t *testing.T) *Config {
  538. conf := NewConfig()
  539. conf.CacheFile = filepath.Join(t.TempDir(), "cache.db")
  540. return conf
  541. }
  542. func newTestServer(t *testing.T, config *Config) *Server {
  543. server, err := New(config)
  544. if err != nil {
  545. t.Fatal(err)
  546. }
  547. return server
  548. }
  549. func request(t *testing.T, s *Server, method, url, body string, headers map[string]string) *httptest.ResponseRecorder {
  550. rr := httptest.NewRecorder()
  551. req, err := http.NewRequest(method, url, strings.NewReader(body))
  552. if err != nil {
  553. t.Fatal(err)
  554. }
  555. for k, v := range headers {
  556. req.Header.Set(k, v)
  557. }
  558. s.handle(rr, req)
  559. return rr
  560. }
  561. func subscribe(t *testing.T, s *Server, url string, rr *httptest.ResponseRecorder) context.CancelFunc {
  562. ctx, cancel := context.WithCancel(context.Background())
  563. req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
  564. if err != nil {
  565. t.Fatal(err)
  566. }
  567. done := make(chan bool)
  568. go func() {
  569. s.handle(rr, req)
  570. done <- true
  571. }()
  572. cancelAndWaitForDone := func() {
  573. time.Sleep(100 * time.Millisecond)
  574. cancel()
  575. <-done
  576. }
  577. time.Sleep(100 * time.Millisecond)
  578. return cancelAndWaitForDone
  579. }
  580. func toMessages(t *testing.T, s string) []*message {
  581. messages := make([]*message, 0)
  582. scanner := bufio.NewScanner(strings.NewReader(s))
  583. for scanner.Scan() {
  584. messages = append(messages, toMessage(t, scanner.Text()))
  585. }
  586. return messages
  587. }
  588. func toMessage(t *testing.T, s string) *message {
  589. var m message
  590. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&m))
  591. return &m
  592. }
  593. func toHTTPError(t *testing.T, s string) *errHTTP {
  594. var e errHTTP
  595. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&e))
  596. return &e
  597. }
  598. func firebaseServiceAccountFile(t *testing.T) string {
  599. if os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT_FILE") != "" {
  600. return os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT_FILE")
  601. } else if os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT") != "" {
  602. filename := filepath.Join(t.TempDir(), "firebase.json")
  603. require.NotNil(t, os.WriteFile(filename, []byte(os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT")), 0600))
  604. return filename
  605. }
  606. t.SkipNow()
  607. return ""
  608. }