server_test.go 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937
  1. package server
  2. import (
  3. "bufio"
  4. "context"
  5. "encoding/json"
  6. "fmt"
  7. "github.com/stretchr/testify/require"
  8. "heckel.io/ntfy/util"
  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. c := newTestConfig(t)
  137. c.AttachmentCacheDir = "" // Disable attachments
  138. s := newTestServer(t, c)
  139. body := strings.Repeat("this is a large message", 5000)
  140. response := request(t, s, "PUT", "/mytopic", body, nil)
  141. require.Equal(t, 400, response.Code)
  142. }
  143. func TestServer_PublishPriority(t *testing.T) {
  144. s := newTestServer(t, newTestConfig(t))
  145. for prio := 1; prio <= 5; prio++ {
  146. response := request(t, s, "GET", fmt.Sprintf("/mytopic/publish?priority=%d", prio), fmt.Sprintf("priority %d", prio), nil)
  147. msg := toMessage(t, response.Body.String())
  148. require.Equal(t, prio, msg.Priority)
  149. }
  150. response := request(t, s, "GET", "/mytopic/publish?priority=min", "test", nil)
  151. require.Equal(t, 1, toMessage(t, response.Body.String()).Priority)
  152. response = request(t, s, "GET", "/mytopic/send?priority=low", "test", nil)
  153. require.Equal(t, 2, toMessage(t, response.Body.String()).Priority)
  154. response = request(t, s, "GET", "/mytopic/send?priority=default", "test", nil)
  155. require.Equal(t, 3, toMessage(t, response.Body.String()).Priority)
  156. response = request(t, s, "GET", "/mytopic/send?priority=high", "test", nil)
  157. require.Equal(t, 4, toMessage(t, response.Body.String()).Priority)
  158. response = request(t, s, "GET", "/mytopic/send?priority=max", "test", nil)
  159. require.Equal(t, 5, toMessage(t, response.Body.String()).Priority)
  160. response = request(t, s, "GET", "/mytopic/trigger?priority=urgent", "test", nil)
  161. require.Equal(t, 5, toMessage(t, response.Body.String()).Priority)
  162. response = request(t, s, "GET", "/mytopic/trigger?priority=INVALID", "test", nil)
  163. require.Equal(t, 40007, toHTTPError(t, response.Body.String()).Code)
  164. }
  165. func TestServer_PublishNoCache(t *testing.T) {
  166. s := newTestServer(t, newTestConfig(t))
  167. response := request(t, s, "PUT", "/mytopic", "this message is not cached", map[string]string{
  168. "Cache": "no",
  169. })
  170. msg := toMessage(t, response.Body.String())
  171. require.NotEmpty(t, msg.ID)
  172. require.Equal(t, "this message is not cached", msg.Message)
  173. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  174. messages := toMessages(t, response.Body.String())
  175. require.Empty(t, messages)
  176. }
  177. func TestServer_PublishAt(t *testing.T) {
  178. c := newTestConfig(t)
  179. c.MinDelay = time.Second
  180. c.AtSenderInterval = 100 * time.Millisecond
  181. s := newTestServer(t, c)
  182. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  183. "In": "1s",
  184. })
  185. require.Equal(t, 200, response.Code)
  186. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  187. messages := toMessages(t, response.Body.String())
  188. require.Equal(t, 0, len(messages))
  189. time.Sleep(time.Second)
  190. require.Nil(t, s.sendDelayedMessages())
  191. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  192. messages = toMessages(t, response.Body.String())
  193. require.Equal(t, 1, len(messages))
  194. require.Equal(t, "a message", messages[0].Message)
  195. }
  196. func TestServer_PublishAtWithCacheError(t *testing.T) {
  197. s := newTestServer(t, newTestConfig(t))
  198. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  199. "Cache": "no",
  200. "In": "30 min",
  201. })
  202. require.Equal(t, 400, response.Code)
  203. require.Equal(t, errHTTPBadRequestDelayNoCache, toHTTPError(t, response.Body.String()))
  204. }
  205. func TestServer_PublishAtTooShortDelay(t *testing.T) {
  206. s := newTestServer(t, newTestConfig(t))
  207. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  208. "In": "1s",
  209. })
  210. require.Equal(t, 400, response.Code)
  211. }
  212. func TestServer_PublishAtTooLongDelay(t *testing.T) {
  213. s := newTestServer(t, newTestConfig(t))
  214. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  215. "In": "99999999h",
  216. })
  217. require.Equal(t, 400, response.Code)
  218. }
  219. func TestServer_PublishAtInvalidDelay(t *testing.T) {
  220. s := newTestServer(t, newTestConfig(t))
  221. response := request(t, s, "PUT", "/mytopic?delay=INVALID", "a message", nil)
  222. err := toHTTPError(t, response.Body.String())
  223. require.Equal(t, 400, response.Code)
  224. require.Equal(t, 40004, err.Code)
  225. }
  226. func TestServer_PublishAtTooLarge(t *testing.T) {
  227. s := newTestServer(t, newTestConfig(t))
  228. response := request(t, s, "PUT", "/mytopic?x-in=99999h", "a message", nil)
  229. err := toHTTPError(t, response.Body.String())
  230. require.Equal(t, 400, response.Code)
  231. require.Equal(t, 40006, err.Code)
  232. }
  233. func TestServer_PublishAtAndPrune(t *testing.T) {
  234. s := newTestServer(t, newTestConfig(t))
  235. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  236. "In": "1h",
  237. })
  238. require.Equal(t, 200, response.Code)
  239. s.updateStatsAndPrune() // Fire pruning
  240. response = request(t, s, "GET", "/mytopic/json?poll=1&scheduled=1", "", nil)
  241. messages := toMessages(t, response.Body.String())
  242. require.Equal(t, 1, len(messages)) // Not affected by pruning
  243. require.Equal(t, "a message", messages[0].Message)
  244. }
  245. func TestServer_PublishAndMultiPoll(t *testing.T) {
  246. s := newTestServer(t, newTestConfig(t))
  247. response := request(t, s, "PUT", "/mytopic1", "message 1", nil)
  248. msg := toMessage(t, response.Body.String())
  249. require.NotEmpty(t, msg.ID)
  250. require.Equal(t, "mytopic1", msg.Topic)
  251. require.Equal(t, "message 1", msg.Message)
  252. response = request(t, s, "PUT", "/mytopic2", "message 2", nil)
  253. msg = toMessage(t, response.Body.String())
  254. require.NotEmpty(t, msg.ID)
  255. require.Equal(t, "mytopic2", msg.Topic)
  256. require.Equal(t, "message 2", msg.Message)
  257. response = request(t, s, "GET", "/mytopic1/json?poll=1", "", nil)
  258. messages := toMessages(t, response.Body.String())
  259. require.Equal(t, 1, len(messages))
  260. require.Equal(t, "mytopic1", messages[0].Topic)
  261. require.Equal(t, "message 1", messages[0].Message)
  262. response = request(t, s, "GET", "/mytopic1,mytopic2/json?poll=1", "", nil)
  263. messages = toMessages(t, response.Body.String())
  264. require.Equal(t, 2, len(messages))
  265. require.Equal(t, "mytopic1", messages[0].Topic)
  266. require.Equal(t, "message 1", messages[0].Message)
  267. require.Equal(t, "mytopic2", messages[1].Topic)
  268. require.Equal(t, "message 2", messages[1].Message)
  269. }
  270. func TestServer_PublishWithNopCache(t *testing.T) {
  271. c := newTestConfig(t)
  272. c.CacheDuration = 0
  273. s := newTestServer(t, c)
  274. subscribeRR := httptest.NewRecorder()
  275. subscribeCancel := subscribe(t, s, "/mytopic/json", subscribeRR)
  276. publishRR := request(t, s, "PUT", "/mytopic", "my first message", nil)
  277. require.Equal(t, 200, publishRR.Code)
  278. subscribeCancel()
  279. messages := toMessages(t, subscribeRR.Body.String())
  280. require.Equal(t, 2, len(messages))
  281. require.Equal(t, openEvent, messages[0].Event)
  282. require.Equal(t, messageEvent, messages[1].Event)
  283. require.Equal(t, "my first message", messages[1].Message)
  284. response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  285. messages = toMessages(t, response.Body.String())
  286. require.Empty(t, messages)
  287. }
  288. func TestServer_PublishAndPollSince(t *testing.T) {
  289. s := newTestServer(t, newTestConfig(t))
  290. request(t, s, "PUT", "/mytopic", "test 1", nil)
  291. time.Sleep(1100 * time.Millisecond)
  292. since := time.Now().Unix()
  293. request(t, s, "PUT", "/mytopic", "test 2", nil)
  294. response := request(t, s, "GET", fmt.Sprintf("/mytopic/json?poll=1&since=%d", since), "", nil)
  295. messages := toMessages(t, response.Body.String())
  296. require.Equal(t, 1, len(messages))
  297. require.Equal(t, "test 2", messages[0].Message)
  298. response = request(t, s, "GET", "/mytopic/json?poll=1&since=10s", "", nil)
  299. messages = toMessages(t, response.Body.String())
  300. require.Equal(t, 2, len(messages))
  301. require.Equal(t, "test 1", messages[0].Message)
  302. response = request(t, s, "GET", "/mytopic/json?poll=1&since=100ms", "", nil)
  303. messages = toMessages(t, response.Body.String())
  304. require.Equal(t, 1, len(messages))
  305. require.Equal(t, "test 2", messages[0].Message)
  306. response = request(t, s, "GET", "/mytopic/json?poll=1&since=INVALID", "", nil)
  307. require.Equal(t, 40008, toHTTPError(t, response.Body.String()).Code)
  308. }
  309. func TestServer_PublishViaGET(t *testing.T) {
  310. s := newTestServer(t, newTestConfig(t))
  311. response := request(t, s, "GET", "/mytopic/trigger", "", nil)
  312. msg := toMessage(t, response.Body.String())
  313. require.NotEmpty(t, msg.ID)
  314. require.Equal(t, "triggered", msg.Message)
  315. 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)
  316. msg = toMessage(t, response.Body.String())
  317. require.NotEmpty(t, msg.ID)
  318. require.Equal(t, "This is a test", msg.Message)
  319. require.Equal(t, "This is a title", msg.Title)
  320. require.Equal(t, []string{"skull"}, msg.Tags)
  321. require.Equal(t, 5, msg.Priority)
  322. require.Greater(t, msg.Time, time.Now().Add(23*time.Hour).Unix())
  323. }
  324. func TestServer_PublishFirebase(t *testing.T) {
  325. // This is unfortunately not much of a test, since it merely fires the messages towards Firebase,
  326. // but cannot re-read them. There is no way from Go to read the messages back, or even get an error back.
  327. // I tried everything. I already had written the test, and it increases the code coverage, so I'll leave it ... :shrug: ...
  328. c := newTestConfig(t)
  329. c.FirebaseKeyFile = firebaseServiceAccountFile(t) // May skip the test!
  330. s := newTestServer(t, c)
  331. // Normal message
  332. response := request(t, s, "PUT", "/mytopic", "This is a message for firebase", nil)
  333. msg := toMessage(t, response.Body.String())
  334. require.NotEmpty(t, msg.ID)
  335. // Keepalive message
  336. require.Nil(t, s.firebase(newKeepaliveMessage(firebaseControlTopic)))
  337. time.Sleep(500 * time.Millisecond) // Time for sends
  338. }
  339. func TestServer_PublishInvalidTopic(t *testing.T) {
  340. s := newTestServer(t, newTestConfig(t))
  341. s.mailer = &testMailer{}
  342. response := request(t, s, "PUT", "/docs", "fail", nil)
  343. require.Equal(t, 40010, toHTTPError(t, response.Body.String()).Code)
  344. }
  345. func TestServer_PollWithQueryFilters(t *testing.T) {
  346. s := newTestServer(t, newTestConfig(t))
  347. response := request(t, s, "PUT", "/mytopic?priority=1&tags=tag1,tag2", "my first message", nil)
  348. msg := toMessage(t, response.Body.String())
  349. require.NotEmpty(t, msg.ID)
  350. response = request(t, s, "PUT", "/mytopic?title=a+title", "my second message", map[string]string{
  351. "Tags": "tag2,tag3",
  352. })
  353. msg = toMessage(t, response.Body.String())
  354. require.NotEmpty(t, msg.ID)
  355. queriesThatShouldReturnMessageOne := []string{
  356. "/mytopic/json?poll=1&priority=1",
  357. "/mytopic/json?poll=1&priority=min",
  358. "/mytopic/json?poll=1&priority=min,low",
  359. "/mytopic/json?poll=1&priority=1,2",
  360. "/mytopic/json?poll=1&p=2,min",
  361. "/mytopic/json?poll=1&tags=tag1",
  362. "/mytopic/json?poll=1&tags=tag1,tag2",
  363. "/mytopic/json?poll=1&message=my+first+message",
  364. }
  365. for _, query := range queriesThatShouldReturnMessageOne {
  366. response = request(t, s, "GET", query, "", nil)
  367. messages := toMessages(t, response.Body.String())
  368. require.Equal(t, 1, len(messages), "Query failed: "+query)
  369. require.Equal(t, "my first message", messages[0].Message, "Query failed: "+query)
  370. }
  371. queriesThatShouldReturnMessageTwo := []string{
  372. "/mytopic/json?poll=1&x-priority=3", // !
  373. "/mytopic/json?poll=1&priority=3",
  374. "/mytopic/json?poll=1&priority=default",
  375. "/mytopic/json?poll=1&p=3",
  376. "/mytopic/json?poll=1&x-tags=tag2,tag3",
  377. "/mytopic/json?poll=1&tags=tag2,tag3",
  378. "/mytopic/json?poll=1&tag=tag2,tag3",
  379. "/mytopic/json?poll=1&ta=tag2,tag3",
  380. "/mytopic/json?poll=1&x-title=a+title",
  381. "/mytopic/json?poll=1&title=a+title",
  382. "/mytopic/json?poll=1&t=a+title",
  383. "/mytopic/json?poll=1&x-message=my+second+message",
  384. "/mytopic/json?poll=1&message=my+second+message",
  385. "/mytopic/json?poll=1&m=my+second+message",
  386. "/mytopic/json?x-poll=1&m=my+second+message",
  387. "/mytopic/json?po=1&m=my+second+message",
  388. }
  389. for _, query := range queriesThatShouldReturnMessageTwo {
  390. response = request(t, s, "GET", query, "", nil)
  391. messages := toMessages(t, response.Body.String())
  392. require.Equal(t, 1, len(messages), "Query failed: "+query)
  393. require.Equal(t, "my second message", messages[0].Message, "Query failed: "+query)
  394. }
  395. queriesThatShouldReturnNoMessages := []string{
  396. "/mytopic/json?poll=1&priority=4",
  397. "/mytopic/json?poll=1&tags=tag1,tag2,tag3",
  398. "/mytopic/json?poll=1&title=another+title",
  399. "/mytopic/json?poll=1&message=my+third+message",
  400. "/mytopic/json?poll=1&message=my+third+message",
  401. }
  402. for _, query := range queriesThatShouldReturnNoMessages {
  403. response = request(t, s, "GET", query, "", nil)
  404. messages := toMessages(t, response.Body.String())
  405. require.Equal(t, 0, len(messages), "Query failed: "+query)
  406. }
  407. }
  408. func TestServer_SubscribeWithQueryFilters(t *testing.T) {
  409. c := newTestConfig(t)
  410. c.KeepaliveInterval = 800 * time.Millisecond
  411. s := newTestServer(t, c)
  412. subscribeResponse := httptest.NewRecorder()
  413. subscribeCancel := subscribe(t, s, "/mytopic/json?tags=zfs-issue", subscribeResponse)
  414. response := request(t, s, "PUT", "/mytopic", "my first message", nil)
  415. require.Equal(t, 200, response.Code)
  416. response = request(t, s, "PUT", "/mytopic", "ZFS scrub failed", map[string]string{
  417. "Tags": "zfs-issue,zfs-scrub",
  418. })
  419. require.Equal(t, 200, response.Code)
  420. time.Sleep(850 * time.Millisecond)
  421. subscribeCancel()
  422. messages := toMessages(t, subscribeResponse.Body.String())
  423. require.Equal(t, 3, len(messages))
  424. require.Equal(t, openEvent, messages[0].Event)
  425. require.Equal(t, messageEvent, messages[1].Event)
  426. require.Equal(t, "ZFS scrub failed", messages[1].Message)
  427. require.Equal(t, keepaliveEvent, messages[2].Event)
  428. }
  429. /*
  430. func TestServer_Curl_Publish_Poll(t *testing.T) {
  431. s, port := test.StartServer(t)
  432. defer test.StopServer(t, s, port)
  433. cmd := exec.Command("sh", "-c", fmt.Sprintf(`curl -sd "This is a test" localhost:%d/mytopic`, port))
  434. require.Nil(t, cmd.Run())
  435. b, err := cmd.CombinedOutput()
  436. require.Nil(t, err)
  437. msg := toMessage(t, string(b))
  438. require.Equal(t, "This is a test", msg.Message)
  439. cmd = exec.Command("sh", "-c", fmt.Sprintf(`curl "localhost:%d/mytopic?poll=1"`, port))
  440. require.Nil(t, cmd.Run())
  441. b, err = cmd.CombinedOutput()
  442. require.Nil(t, err)
  443. msg = toMessage(t, string(b))
  444. require.Equal(t, "This is a test", msg.Message)
  445. }
  446. */
  447. type testMailer struct {
  448. count int
  449. mu sync.Mutex
  450. }
  451. func (t *testMailer) Send(from, to string, m *message) error {
  452. t.mu.Lock()
  453. defer t.mu.Unlock()
  454. t.count++
  455. return nil
  456. }
  457. func TestServer_PublishTooManyEmails_Defaults(t *testing.T) {
  458. s := newTestServer(t, newTestConfig(t))
  459. s.mailer = &testMailer{}
  460. for i := 0; i < 16; i++ {
  461. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  462. "E-Mail": "test@example.com",
  463. })
  464. require.Equal(t, 200, response.Code)
  465. }
  466. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  467. "E-Mail": "test@example.com",
  468. })
  469. require.Equal(t, 429, response.Code)
  470. }
  471. func TestServer_PublishTooManyEmails_Replenish(t *testing.T) {
  472. c := newTestConfig(t)
  473. c.VisitorEmailLimitReplenish = 500 * time.Millisecond
  474. s := newTestServer(t, c)
  475. s.mailer = &testMailer{}
  476. for i := 0; i < 16; i++ {
  477. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  478. "E-Mail": "test@example.com",
  479. })
  480. require.Equal(t, 200, response.Code)
  481. }
  482. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  483. "E-Mail": "test@example.com",
  484. })
  485. require.Equal(t, 429, response.Code)
  486. time.Sleep(510 * time.Millisecond)
  487. response = request(t, s, "PUT", "/mytopic", "this should be okay again too many", map[string]string{
  488. "E-Mail": "test@example.com",
  489. })
  490. require.Equal(t, 200, response.Code)
  491. response = request(t, s, "PUT", "/mytopic", "and bad again", map[string]string{
  492. "E-Mail": "test@example.com",
  493. })
  494. require.Equal(t, 429, response.Code)
  495. }
  496. func TestServer_PublishDelayedEmail_Fail(t *testing.T) {
  497. s := newTestServer(t, newTestConfig(t))
  498. s.mailer = &testMailer{}
  499. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  500. "E-Mail": "test@example.com",
  501. "Delay": "20 min",
  502. })
  503. require.Equal(t, 400, response.Code)
  504. }
  505. func TestServer_PublishEmailNoMailer_Fail(t *testing.T) {
  506. s := newTestServer(t, newTestConfig(t))
  507. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  508. "E-Mail": "test@example.com",
  509. })
  510. require.Equal(t, 400, response.Code)
  511. }
  512. func TestServer_UnifiedPushDiscovery(t *testing.T) {
  513. s := newTestServer(t, newTestConfig(t))
  514. response := request(t, s, "GET", "/mytopic?up=1", "", nil)
  515. require.Equal(t, 200, response.Code)
  516. require.Equal(t, `{"unifiedpush":{"version":1}}`+"\n", response.Body.String())
  517. }
  518. func TestServer_PublishAttachment(t *testing.T) {
  519. content := util.RandomString(5000) // > 4096
  520. s := newTestServer(t, newTestConfig(t))
  521. response := request(t, s, "PUT", "/mytopic", content, nil)
  522. msg := toMessage(t, response.Body.String())
  523. require.Equal(t, "attachment.txt", msg.Attachment.Name)
  524. require.Equal(t, "text/plain; charset=utf-8", msg.Attachment.Type)
  525. require.Equal(t, int64(5000), msg.Attachment.Size)
  526. require.GreaterOrEqual(t, msg.Attachment.Expires, time.Now().Add(3*time.Hour).Unix())
  527. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  528. require.Equal(t, "", msg.Attachment.Owner) // Should never be returned
  529. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  530. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  531. response = request(t, s, "GET", path, "", nil)
  532. require.Equal(t, 200, response.Code)
  533. require.Equal(t, "5000", response.Header().Get("Content-Length"))
  534. require.Equal(t, content, response.Body.String())
  535. // Slightly unrelated cross-test: make sure we add an owner for internal attachments
  536. size, err := s.cache.AttachmentsSize("9.9.9.9") // See request()
  537. require.Nil(t, err)
  538. require.Equal(t, int64(5000), size)
  539. }
  540. func TestServer_PublishAttachmentShortWithFilename(t *testing.T) {
  541. c := newTestConfig(t)
  542. c.BehindProxy = true
  543. s := newTestServer(t, c)
  544. content := "this is an ATTACHMENT"
  545. response := request(t, s, "PUT", "/mytopic?f=myfile.txt", content, map[string]string{
  546. "X-Forwarded-For": "1.2.3.4",
  547. })
  548. msg := toMessage(t, response.Body.String())
  549. require.Equal(t, "myfile.txt", msg.Attachment.Name)
  550. require.Equal(t, "text/plain; charset=utf-8", msg.Attachment.Type)
  551. require.Equal(t, int64(21), msg.Attachment.Size)
  552. require.GreaterOrEqual(t, msg.Attachment.Expires, time.Now().Add(3*time.Hour).Unix())
  553. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  554. require.Equal(t, "", msg.Attachment.Owner) // Should never be returned
  555. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  556. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  557. response = request(t, s, "GET", path, "", nil)
  558. require.Equal(t, 200, response.Code)
  559. require.Equal(t, "21", response.Header().Get("Content-Length"))
  560. require.Equal(t, content, response.Body.String())
  561. // Slightly unrelated cross-test: make sure we add an owner for internal attachments
  562. size, err := s.cache.AttachmentsSize("1.2.3.4")
  563. require.Nil(t, err)
  564. require.Equal(t, int64(21), size)
  565. }
  566. func TestServer_PublishAttachmentExternalWithoutFilename(t *testing.T) {
  567. s := newTestServer(t, newTestConfig(t))
  568. response := request(t, s, "PUT", "/mytopic", "", map[string]string{
  569. "Attach": "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg",
  570. })
  571. msg := toMessage(t, response.Body.String())
  572. require.Equal(t, "You received a file: Pink_flower.jpg", msg.Message)
  573. require.Equal(t, "Pink_flower.jpg", msg.Attachment.Name)
  574. require.Equal(t, "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg", msg.Attachment.URL)
  575. require.Equal(t, "", msg.Attachment.Type)
  576. require.Equal(t, int64(0), msg.Attachment.Size)
  577. require.Equal(t, int64(0), msg.Attachment.Expires)
  578. require.Equal(t, "", msg.Attachment.Owner)
  579. // Slightly unrelated cross-test: make sure we don't add an owner for external attachments
  580. size, err := s.cache.AttachmentsSize("127.0.0.1")
  581. require.Nil(t, err)
  582. require.Equal(t, int64(0), size)
  583. }
  584. func TestServer_PublishAttachmentExternalWithFilename(t *testing.T) {
  585. s := newTestServer(t, newTestConfig(t))
  586. response := request(t, s, "PUT", "/mytopic", "This is a custom message", map[string]string{
  587. "X-Attach": "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg",
  588. "File": "some file.jpg",
  589. })
  590. msg := toMessage(t, response.Body.String())
  591. require.Equal(t, "This is a custom message", msg.Message)
  592. require.Equal(t, "some file.jpg", msg.Attachment.Name)
  593. require.Equal(t, "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg", msg.Attachment.URL)
  594. require.Equal(t, "", msg.Attachment.Type)
  595. require.Equal(t, int64(0), msg.Attachment.Size)
  596. require.Equal(t, int64(0), msg.Attachment.Expires)
  597. require.Equal(t, "", msg.Attachment.Owner)
  598. }
  599. func TestServer_PublishAttachmentBadURL(t *testing.T) {
  600. s := newTestServer(t, newTestConfig(t))
  601. response := request(t, s, "PUT", "/mytopic?a=not+a+URL", "", nil)
  602. err := toHTTPError(t, response.Body.String())
  603. require.Equal(t, 400, response.Code)
  604. require.Equal(t, 400, err.HTTPCode)
  605. require.Equal(t, 40013, err.Code)
  606. }
  607. func TestServer_PublishAttachmentTooLargeContentLength(t *testing.T) {
  608. content := util.RandomString(5000) // > 4096
  609. s := newTestServer(t, newTestConfig(t))
  610. response := request(t, s, "PUT", "/mytopic", content, map[string]string{
  611. "Content-Length": "20000000",
  612. })
  613. err := toHTTPError(t, response.Body.String())
  614. require.Equal(t, 400, response.Code)
  615. require.Equal(t, 400, err.HTTPCode)
  616. require.Equal(t, 40012, err.Code)
  617. }
  618. func TestServer_PublishAttachmentTooLargeBodyAttachmentFileSizeLimit(t *testing.T) {
  619. content := util.RandomString(5001) // > 5000, see below
  620. c := newTestConfig(t)
  621. c.AttachmentFileSizeLimit = 5000
  622. s := newTestServer(t, c)
  623. response := request(t, s, "PUT", "/mytopic", content, nil)
  624. err := toHTTPError(t, response.Body.String())
  625. require.Equal(t, 400, response.Code)
  626. require.Equal(t, 400, err.HTTPCode)
  627. require.Equal(t, 40012, err.Code)
  628. }
  629. func TestServer_PublishAttachmentExpiryBeforeDelivery(t *testing.T) {
  630. c := newTestConfig(t)
  631. c.AttachmentExpiryDuration = 10 * time.Minute
  632. s := newTestServer(t, c)
  633. response := request(t, s, "PUT", "/mytopic", util.RandomString(5000), map[string]string{
  634. "Delay": "11 min", // > AttachmentExpiryDuration
  635. })
  636. err := toHTTPError(t, response.Body.String())
  637. require.Equal(t, 400, response.Code)
  638. require.Equal(t, 400, err.HTTPCode)
  639. require.Equal(t, 40015, err.Code)
  640. }
  641. func TestServer_PublishAttachmentTooLargeBodyVisitorAttachmentTotalSizeLimit(t *testing.T) {
  642. c := newTestConfig(t)
  643. c.VisitorAttachmentTotalSizeLimit = 10000
  644. s := newTestServer(t, c)
  645. response := request(t, s, "PUT", "/mytopic", util.RandomString(5000), nil)
  646. msg := toMessage(t, response.Body.String())
  647. require.Equal(t, 200, response.Code)
  648. require.Equal(t, "You received a file: attachment.txt", msg.Message)
  649. require.Equal(t, int64(5000), msg.Attachment.Size)
  650. content := util.RandomString(5001) // 5000+5001 > , see below
  651. response = request(t, s, "PUT", "/mytopic", content, nil)
  652. err := toHTTPError(t, response.Body.String())
  653. require.Equal(t, 400, response.Code)
  654. require.Equal(t, 400, err.HTTPCode)
  655. require.Equal(t, 40012, err.Code)
  656. }
  657. func TestServer_PublishAttachmentAndPrune(t *testing.T) {
  658. content := util.RandomString(5000) // > 4096
  659. c := newTestConfig(t)
  660. c.AttachmentExpiryDuration = time.Millisecond // Hack
  661. s := newTestServer(t, c)
  662. // Publish and make sure we can retrieve it
  663. response := request(t, s, "PUT", "/mytopic", content, nil)
  664. msg := toMessage(t, response.Body.String())
  665. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  666. file := filepath.Join(s.config.AttachmentCacheDir, msg.ID)
  667. require.FileExists(t, file)
  668. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  669. response = request(t, s, "GET", path, "", nil)
  670. require.Equal(t, 200, response.Code)
  671. require.Equal(t, content, response.Body.String())
  672. // Prune and makes sure it's gone
  673. time.Sleep(time.Second) // Sigh ...
  674. s.updateStatsAndPrune()
  675. require.NoFileExists(t, file)
  676. response = request(t, s, "GET", path, "", nil)
  677. require.Equal(t, 404, response.Code)
  678. }
  679. func TestServer_PublishAttachmentBandwidthLimit(t *testing.T) {
  680. content := util.RandomString(5000) // > 4096
  681. c := newTestConfig(t)
  682. c.VisitorAttachmentDailyBandwidthLimit = 5*5000 + 123 // A little more than 1 upload and 3 downloads
  683. s := newTestServer(t, c)
  684. // Publish attachment
  685. response := request(t, s, "PUT", "/mytopic", content, nil)
  686. msg := toMessage(t, response.Body.String())
  687. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  688. // Get it 4 times successfully
  689. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  690. for i := 1; i <= 4; i++ { // 4 successful downloads
  691. response = request(t, s, "GET", path, "", nil)
  692. require.Equal(t, 200, response.Code)
  693. require.Equal(t, content, response.Body.String())
  694. }
  695. // And then fail with a 429
  696. response = request(t, s, "GET", path, "", nil)
  697. err := toHTTPError(t, response.Body.String())
  698. require.Equal(t, 429, response.Code)
  699. require.Equal(t, 42905, err.Code)
  700. }
  701. func TestServer_PublishAttachmentBandwidthLimitUploadOnly(t *testing.T) {
  702. content := util.RandomString(5000) // > 4096
  703. c := newTestConfig(t)
  704. c.VisitorAttachmentDailyBandwidthLimit = 5*5000 + 500 // 5 successful uploads
  705. s := newTestServer(t, c)
  706. // 5 successful uploads
  707. for i := 1; i <= 5; i++ {
  708. response := request(t, s, "PUT", "/mytopic", content, nil)
  709. msg := toMessage(t, response.Body.String())
  710. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  711. }
  712. // And a failed one
  713. response := request(t, s, "PUT", "/mytopic", content, nil)
  714. err := toHTTPError(t, response.Body.String())
  715. require.Equal(t, 400, response.Code)
  716. require.Equal(t, 40012, err.Code)
  717. }
  718. func newTestConfig(t *testing.T) *Config {
  719. conf := NewConfig()
  720. conf.BaseURL = "http://127.0.0.1:12345"
  721. conf.CacheFile = filepath.Join(t.TempDir(), "cache.db")
  722. conf.AttachmentCacheDir = t.TempDir()
  723. return conf
  724. }
  725. func newTestServer(t *testing.T, config *Config) *Server {
  726. server, err := New(config)
  727. if err != nil {
  728. t.Fatal(err)
  729. }
  730. return server
  731. }
  732. func request(t *testing.T, s *Server, method, url, body string, headers map[string]string) *httptest.ResponseRecorder {
  733. rr := httptest.NewRecorder()
  734. req, err := http.NewRequest(method, url, strings.NewReader(body))
  735. if err != nil {
  736. t.Fatal(err)
  737. }
  738. req.RemoteAddr = "9.9.9.9" // Used for tests
  739. for k, v := range headers {
  740. req.Header.Set(k, v)
  741. }
  742. s.handle(rr, req)
  743. return rr
  744. }
  745. func subscribe(t *testing.T, s *Server, url string, rr *httptest.ResponseRecorder) context.CancelFunc {
  746. ctx, cancel := context.WithCancel(context.Background())
  747. req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
  748. if err != nil {
  749. t.Fatal(err)
  750. }
  751. done := make(chan bool)
  752. go func() {
  753. s.handle(rr, req)
  754. done <- true
  755. }()
  756. cancelAndWaitForDone := func() {
  757. time.Sleep(100 * time.Millisecond)
  758. cancel()
  759. <-done
  760. }
  761. time.Sleep(100 * time.Millisecond)
  762. return cancelAndWaitForDone
  763. }
  764. func toMessages(t *testing.T, s string) []*message {
  765. messages := make([]*message, 0)
  766. scanner := bufio.NewScanner(strings.NewReader(s))
  767. for scanner.Scan() {
  768. messages = append(messages, toMessage(t, scanner.Text()))
  769. }
  770. return messages
  771. }
  772. func toMessage(t *testing.T, s string) *message {
  773. var m message
  774. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&m))
  775. return &m
  776. }
  777. func toHTTPError(t *testing.T, s string) *errHTTP {
  778. var e errHTTP
  779. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&e))
  780. return &e
  781. }
  782. func firebaseServiceAccountFile(t *testing.T) string {
  783. if os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT_FILE") != "" {
  784. return os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT_FILE")
  785. } else if os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT") != "" {
  786. filename := filepath.Join(t.TempDir(), "firebase.json")
  787. require.NotNil(t, os.WriteFile(filename, []byte(os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT")), 0600))
  788. return filename
  789. }
  790. t.SkipNow()
  791. return ""
  792. }