server_test.go 35 KB

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