server_test.go 34 KB

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