server_test.go 63 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789
  1. package server
  2. import (
  3. "bufio"
  4. "context"
  5. "encoding/base64"
  6. "encoding/json"
  7. "fmt"
  8. "heckel.io/ntfy/user"
  9. "io"
  10. "math/rand"
  11. "net/http"
  12. "net/http/httptest"
  13. "net/netip"
  14. "path/filepath"
  15. "strings"
  16. "sync"
  17. "testing"
  18. "time"
  19. "github.com/stretchr/testify/assert"
  20. "github.com/stretchr/testify/require"
  21. "heckel.io/ntfy/log"
  22. "heckel.io/ntfy/util"
  23. )
  24. func init() {
  25. // log.SetLevel(log.DebugLevel)
  26. }
  27. func TestServer_PublishAndPoll(t *testing.T) {
  28. s := newTestServer(t, newTestConfig(t))
  29. response1 := request(t, s, "PUT", "/mytopic", "my first message", nil)
  30. msg1 := toMessage(t, response1.Body.String())
  31. require.NotEmpty(t, msg1.ID)
  32. require.Equal(t, "my first message", msg1.Message)
  33. response2 := request(t, s, "PUT", "/mytopic", "my second\n\nmessage", nil)
  34. msg2 := toMessage(t, response2.Body.String())
  35. require.NotEqual(t, msg1.ID, msg2.ID)
  36. require.NotEmpty(t, msg2.ID)
  37. require.Equal(t, "my second\n\nmessage", msg2.Message)
  38. response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  39. messages := toMessages(t, response.Body.String())
  40. require.Equal(t, 2, len(messages))
  41. require.Equal(t, "my first message", messages[0].Message)
  42. require.Equal(t, "my second\n\nmessage", messages[1].Message)
  43. response = request(t, s, "GET", "/mytopic/sse?poll=1&since=all", "", nil)
  44. lines := strings.Split(strings.TrimSpace(response.Body.String()), "\n")
  45. require.Equal(t, 3, len(lines))
  46. require.Equal(t, "my first message", toMessage(t, strings.TrimPrefix(lines[0], "data: ")).Message)
  47. require.Equal(t, "", lines[1])
  48. require.Equal(t, "my second\n\nmessage", toMessage(t, strings.TrimPrefix(lines[2], "data: ")).Message)
  49. response = request(t, s, "GET", "/mytopic/raw?poll=1", "", nil)
  50. lines = strings.Split(strings.TrimSpace(response.Body.String()), "\n")
  51. require.Equal(t, 2, len(lines))
  52. require.Equal(t, "my first message", lines[0])
  53. require.Equal(t, "my second message", lines[1]) // \n -> " "
  54. }
  55. func TestServer_PublishWithFirebase(t *testing.T) {
  56. sender := newTestFirebaseSender(10)
  57. s := newTestServer(t, newTestConfig(t))
  58. s.firebaseClient = newFirebaseClient(sender, &testAuther{Allow: true})
  59. response := request(t, s, "PUT", "/mytopic", "my first message", nil)
  60. msg1 := toMessage(t, response.Body.String())
  61. require.NotEmpty(t, msg1.ID)
  62. require.Equal(t, "my first message", msg1.Message)
  63. time.Sleep(100 * time.Millisecond) // Firebase publishing happens
  64. require.Equal(t, 1, len(sender.Messages()))
  65. require.Equal(t, "my first message", sender.Messages()[0].Data["message"])
  66. require.Equal(t, "my first message", sender.Messages()[0].APNS.Payload.Aps.Alert.Body)
  67. require.Equal(t, "my first message", sender.Messages()[0].APNS.Payload.CustomData["message"])
  68. }
  69. func TestServer_SubscribeOpenAndKeepalive(t *testing.T) {
  70. c := newTestConfig(t)
  71. c.KeepaliveInterval = time.Second
  72. s := newTestServer(t, c)
  73. rr := httptest.NewRecorder()
  74. ctx, cancel := context.WithCancel(context.Background())
  75. req, err := http.NewRequestWithContext(ctx, "GET", "/mytopic/json", nil)
  76. if err != nil {
  77. t.Fatal(err)
  78. }
  79. doneChan := make(chan bool)
  80. go func() {
  81. s.handle(rr, req)
  82. doneChan <- true
  83. }()
  84. time.Sleep(1300 * time.Millisecond)
  85. cancel()
  86. <-doneChan
  87. messages := toMessages(t, rr.Body.String())
  88. require.Equal(t, 2, len(messages))
  89. require.Equal(t, openEvent, messages[0].Event)
  90. require.Equal(t, "mytopic", messages[0].Topic)
  91. require.Equal(t, "", messages[0].Message)
  92. require.Equal(t, "", messages[0].Title)
  93. require.Equal(t, 0, messages[0].Priority)
  94. require.Nil(t, messages[0].Tags)
  95. require.Equal(t, keepaliveEvent, messages[1].Event)
  96. require.Equal(t, "mytopic", messages[1].Topic)
  97. require.Equal(t, "", 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. }
  102. func TestServer_PublishAndSubscribe(t *testing.T) {
  103. s := newTestServer(t, newTestConfig(t))
  104. subscribeRR := httptest.NewRecorder()
  105. subscribeCancel := subscribe(t, s, "/mytopic/json", subscribeRR)
  106. publishFirstRR := request(t, s, "PUT", "/mytopic", "my first message", nil)
  107. require.Equal(t, 200, publishFirstRR.Code)
  108. publishSecondRR := request(t, s, "PUT", "/mytopic", "my other message", map[string]string{
  109. "Title": " This is a title ",
  110. "X-Tags": "tag1,tag 2, tag3",
  111. "p": "1",
  112. })
  113. require.Equal(t, 200, publishSecondRR.Code)
  114. subscribeCancel()
  115. messages := toMessages(t, subscribeRR.Body.String())
  116. require.Equal(t, 3, len(messages))
  117. require.Equal(t, openEvent, messages[0].Event)
  118. require.Equal(t, messageEvent, messages[1].Event)
  119. require.Equal(t, "mytopic", messages[1].Topic)
  120. require.Equal(t, "my first message", messages[1].Message)
  121. require.Equal(t, "", messages[1].Title)
  122. require.Equal(t, 0, messages[1].Priority)
  123. require.Nil(t, messages[1].Tags)
  124. require.Equal(t, messageEvent, messages[2].Event)
  125. require.Equal(t, "mytopic", messages[2].Topic)
  126. require.Equal(t, "my other message", messages[2].Message)
  127. require.Equal(t, "This is a title", messages[2].Title)
  128. require.Equal(t, 1, messages[2].Priority)
  129. require.Equal(t, []string{"tag1", "tag 2", "tag3"}, messages[2].Tags)
  130. }
  131. func TestServer_StaticSites(t *testing.T) {
  132. s := newTestServer(t, newTestConfig(t))
  133. rr := request(t, s, "GET", "/", "", nil)
  134. require.Equal(t, 200, rr.Code)
  135. require.Contains(t, rr.Body.String(), "</html>")
  136. rr = request(t, s, "HEAD", "/", "", nil)
  137. require.Equal(t, 200, rr.Code)
  138. rr = request(t, s, "OPTIONS", "/", "", nil)
  139. require.Equal(t, 200, rr.Code)
  140. rr = request(t, s, "GET", "/does-not-exist.txt", "", nil)
  141. require.Equal(t, 404, rr.Code)
  142. rr = request(t, s, "GET", "/mytopic", "", nil)
  143. require.Equal(t, 200, rr.Code)
  144. require.Contains(t, rr.Body.String(), `<meta name="robots" content="noindex, nofollow"/>`)
  145. rr = request(t, s, "GET", "/static/css/home.css", "", nil)
  146. require.Equal(t, 200, rr.Code)
  147. require.Contains(t, rr.Body.String(), `/* general styling */`)
  148. rr = request(t, s, "GET", "/docs", "", nil)
  149. require.Equal(t, 301, rr.Code)
  150. // Docs test removed, it was failing annoyingly.
  151. }
  152. func TestServer_WebEnabled(t *testing.T) {
  153. conf := newTestConfig(t)
  154. conf.EnableWeb = false
  155. s := newTestServer(t, conf)
  156. rr := request(t, s, "GET", "/", "", nil)
  157. require.Equal(t, 404, rr.Code)
  158. rr = request(t, s, "GET", "/config.js", "", nil)
  159. require.Equal(t, 404, rr.Code)
  160. rr = request(t, s, "GET", "/static/css/home.css", "", nil)
  161. require.Equal(t, 404, rr.Code)
  162. conf2 := newTestConfig(t)
  163. conf2.EnableWeb = true
  164. s2 := newTestServer(t, conf2)
  165. rr = request(t, s2, "GET", "/", "", nil)
  166. require.Equal(t, 200, rr.Code)
  167. rr = request(t, s2, "GET", "/config.js", "", nil)
  168. require.Equal(t, 200, rr.Code)
  169. rr = request(t, s2, "GET", "/static/css/home.css", "", nil)
  170. require.Equal(t, 200, rr.Code)
  171. }
  172. func TestServer_PublishLargeMessage(t *testing.T) {
  173. c := newTestConfig(t)
  174. c.AttachmentCacheDir = "" // Disable attachments
  175. s := newTestServer(t, c)
  176. body := strings.Repeat("this is a large message", 5000)
  177. response := request(t, s, "PUT", "/mytopic", body, nil)
  178. require.Equal(t, 400, response.Code)
  179. }
  180. func TestServer_PublishPriority(t *testing.T) {
  181. s := newTestServer(t, newTestConfig(t))
  182. for prio := 1; prio <= 5; prio++ {
  183. response := request(t, s, "GET", fmt.Sprintf("/mytopic/publish?priority=%d", prio), fmt.Sprintf("priority %d", prio), nil)
  184. msg := toMessage(t, response.Body.String())
  185. require.Equal(t, prio, msg.Priority)
  186. }
  187. response := request(t, s, "GET", "/mytopic/publish?priority=min", "test", nil)
  188. require.Equal(t, 1, toMessage(t, response.Body.String()).Priority)
  189. response = request(t, s, "GET", "/mytopic/send?priority=low", "test", nil)
  190. require.Equal(t, 2, toMessage(t, response.Body.String()).Priority)
  191. response = request(t, s, "GET", "/mytopic/send?priority=default", "test", nil)
  192. require.Equal(t, 3, toMessage(t, response.Body.String()).Priority)
  193. response = request(t, s, "GET", "/mytopic/send?priority=high", "test", nil)
  194. require.Equal(t, 4, toMessage(t, response.Body.String()).Priority)
  195. response = request(t, s, "GET", "/mytopic/send?priority=max", "test", nil)
  196. require.Equal(t, 5, toMessage(t, response.Body.String()).Priority)
  197. response = request(t, s, "GET", "/mytopic/trigger?priority=urgent", "test", nil)
  198. require.Equal(t, 5, toMessage(t, response.Body.String()).Priority)
  199. response = request(t, s, "GET", "/mytopic/trigger?priority=INVALID", "test", nil)
  200. require.Equal(t, 40007, toHTTPError(t, response.Body.String()).Code)
  201. }
  202. func TestServer_PublishGETOnlyOneTopic(t *testing.T) {
  203. // This tests a bug that allowed publishing topics with a comma in the name (no ticket)
  204. s := newTestServer(t, newTestConfig(t))
  205. response := request(t, s, "GET", "/mytopic,mytopic2/publish?m=hi", "", nil)
  206. require.Equal(t, 404, response.Code)
  207. }
  208. func TestServer_PublishNoCache(t *testing.T) {
  209. s := newTestServer(t, newTestConfig(t))
  210. response := request(t, s, "PUT", "/mytopic", "this message is not cached", map[string]string{
  211. "Cache": "no",
  212. })
  213. msg := toMessage(t, response.Body.String())
  214. require.NotEmpty(t, msg.ID)
  215. require.Equal(t, "this message is not cached", msg.Message)
  216. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  217. messages := toMessages(t, response.Body.String())
  218. require.Empty(t, messages)
  219. }
  220. func TestServer_PublishAt(t *testing.T) {
  221. c := newTestConfig(t)
  222. c.MinDelay = time.Second
  223. c.DelayedSenderInterval = 100 * time.Millisecond
  224. s := newTestServer(t, c)
  225. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  226. "In": "1s",
  227. })
  228. require.Equal(t, 200, response.Code)
  229. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  230. messages := toMessages(t, response.Body.String())
  231. require.Equal(t, 0, len(messages))
  232. time.Sleep(time.Second)
  233. require.Nil(t, s.sendDelayedMessages())
  234. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  235. messages = toMessages(t, response.Body.String())
  236. require.Equal(t, 1, len(messages))
  237. require.Equal(t, "a message", messages[0].Message)
  238. require.Equal(t, netip.Addr{}, messages[0].Sender) // Never return the sender!
  239. messages, err := s.messageCache.Messages("mytopic", sinceAllMessages, true)
  240. require.Nil(t, err)
  241. require.Equal(t, 1, len(messages))
  242. require.Equal(t, "a message", messages[0].Message)
  243. require.Equal(t, "9.9.9.9", messages[0].Sender.String()) // It's stored in the DB though!
  244. }
  245. func TestServer_PublishAtWithCacheError(t *testing.T) {
  246. s := newTestServer(t, newTestConfig(t))
  247. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  248. "Cache": "no",
  249. "In": "30 min",
  250. })
  251. require.Equal(t, 400, response.Code)
  252. require.Equal(t, errHTTPBadRequestDelayNoCache, toHTTPError(t, response.Body.String()))
  253. }
  254. func TestServer_PublishAtTooShortDelay(t *testing.T) {
  255. s := newTestServer(t, newTestConfig(t))
  256. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  257. "In": "1s",
  258. })
  259. require.Equal(t, 400, response.Code)
  260. }
  261. func TestServer_PublishAtTooLongDelay(t *testing.T) {
  262. s := newTestServer(t, newTestConfig(t))
  263. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  264. "In": "99999999h",
  265. })
  266. require.Equal(t, 400, response.Code)
  267. }
  268. func TestServer_PublishAtInvalidDelay(t *testing.T) {
  269. s := newTestServer(t, newTestConfig(t))
  270. response := request(t, s, "PUT", "/mytopic?delay=INVALID", "a message", nil)
  271. err := toHTTPError(t, response.Body.String())
  272. require.Equal(t, 400, response.Code)
  273. require.Equal(t, 40004, err.Code)
  274. }
  275. func TestServer_PublishAtTooLarge(t *testing.T) {
  276. s := newTestServer(t, newTestConfig(t))
  277. response := request(t, s, "PUT", "/mytopic?x-in=99999h", "a message", nil)
  278. err := toHTTPError(t, response.Body.String())
  279. require.Equal(t, 400, response.Code)
  280. require.Equal(t, 40006, err.Code)
  281. }
  282. func TestServer_PublishAtAndPrune(t *testing.T) {
  283. s := newTestServer(t, newTestConfig(t))
  284. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  285. "In": "1h",
  286. })
  287. require.Equal(t, 200, response.Code)
  288. s.execManager() // Fire pruning
  289. response = request(t, s, "GET", "/mytopic/json?poll=1&scheduled=1", "", nil)
  290. messages := toMessages(t, response.Body.String())
  291. require.Equal(t, 1, len(messages)) // Not affected by pruning
  292. require.Equal(t, "a message", messages[0].Message)
  293. }
  294. func TestServer_PublishAndMultiPoll(t *testing.T) {
  295. s := newTestServer(t, newTestConfig(t))
  296. response := request(t, s, "PUT", "/mytopic1", "message 1", nil)
  297. msg := toMessage(t, response.Body.String())
  298. require.NotEmpty(t, msg.ID)
  299. require.Equal(t, "mytopic1", msg.Topic)
  300. require.Equal(t, "message 1", msg.Message)
  301. response = request(t, s, "PUT", "/mytopic2", "message 2", nil)
  302. msg = toMessage(t, response.Body.String())
  303. require.NotEmpty(t, msg.ID)
  304. require.Equal(t, "mytopic2", msg.Topic)
  305. require.Equal(t, "message 2", msg.Message)
  306. response = request(t, s, "GET", "/mytopic1/json?poll=1", "", nil)
  307. messages := toMessages(t, response.Body.String())
  308. require.Equal(t, 1, len(messages))
  309. require.Equal(t, "mytopic1", messages[0].Topic)
  310. require.Equal(t, "message 1", messages[0].Message)
  311. response = request(t, s, "GET", "/mytopic1,mytopic2/json?poll=1", "", nil)
  312. messages = toMessages(t, response.Body.String())
  313. require.Equal(t, 2, len(messages))
  314. require.Equal(t, "mytopic1", messages[0].Topic)
  315. require.Equal(t, "message 1", messages[0].Message)
  316. require.Equal(t, "mytopic2", messages[1].Topic)
  317. require.Equal(t, "message 2", messages[1].Message)
  318. }
  319. func TestServer_PublishWithNopCache(t *testing.T) {
  320. c := newTestConfig(t)
  321. c.CacheDuration = 0
  322. s := newTestServer(t, c)
  323. subscribeRR := httptest.NewRecorder()
  324. subscribeCancel := subscribe(t, s, "/mytopic/json", subscribeRR)
  325. publishRR := request(t, s, "PUT", "/mytopic", "my first message", nil)
  326. require.Equal(t, 200, publishRR.Code)
  327. subscribeCancel()
  328. messages := toMessages(t, subscribeRR.Body.String())
  329. require.Equal(t, 2, len(messages))
  330. require.Equal(t, openEvent, messages[0].Event)
  331. require.Equal(t, messageEvent, messages[1].Event)
  332. require.Equal(t, "my first message", messages[1].Message)
  333. response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  334. messages = toMessages(t, response.Body.String())
  335. require.Empty(t, messages)
  336. }
  337. func TestServer_PublishAndPollSince(t *testing.T) {
  338. s := newTestServer(t, newTestConfig(t))
  339. request(t, s, "PUT", "/mytopic", "test 1", nil)
  340. time.Sleep(1100 * time.Millisecond)
  341. since := time.Now().Unix()
  342. request(t, s, "PUT", "/mytopic", "test 2", nil)
  343. response := request(t, s, "GET", fmt.Sprintf("/mytopic/json?poll=1&since=%d", since), "", nil)
  344. messages := toMessages(t, response.Body.String())
  345. require.Equal(t, 1, len(messages))
  346. require.Equal(t, "test 2", messages[0].Message)
  347. response = request(t, s, "GET", "/mytopic/json?poll=1&since=10s", "", nil)
  348. messages = toMessages(t, response.Body.String())
  349. require.Equal(t, 2, len(messages))
  350. require.Equal(t, "test 1", messages[0].Message)
  351. response = request(t, s, "GET", "/mytopic/json?poll=1&since=100ms", "", nil)
  352. messages = toMessages(t, response.Body.String())
  353. require.Equal(t, 1, len(messages))
  354. require.Equal(t, "test 2", messages[0].Message)
  355. response = request(t, s, "GET", "/mytopic/json?poll=1&since=INVALID", "", nil)
  356. require.Equal(t, 40008, toHTTPError(t, response.Body.String()).Code)
  357. }
  358. func newMessageWithTimestamp(topic, message string, timestamp int64) *message {
  359. m := newDefaultMessage(topic, message)
  360. m.Time = timestamp
  361. return m
  362. }
  363. func TestServer_PollSinceID_MultipleTopics(t *testing.T) {
  364. s := newTestServer(t, newTestConfig(t))
  365. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic1", "test 1", 1655740277)))
  366. markerMessage := newMessageWithTimestamp("mytopic2", "test 2", 1655740283)
  367. require.Nil(t, s.messageCache.AddMessage(markerMessage))
  368. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic1", "test 3", 1655740289)))
  369. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic2", "test 4", 1655740293)))
  370. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic1", "test 5", 1655740297)))
  371. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic2", "test 6", 1655740303)))
  372. response := request(t, s, "GET", fmt.Sprintf("/mytopic1,mytopic2/json?poll=1&since=%s", markerMessage.ID), "", nil)
  373. messages := toMessages(t, response.Body.String())
  374. require.Equal(t, 4, len(messages))
  375. require.Equal(t, "test 3", messages[0].Message)
  376. require.Equal(t, "mytopic1", messages[0].Topic)
  377. require.Equal(t, "test 4", messages[1].Message)
  378. require.Equal(t, "mytopic2", messages[1].Topic)
  379. require.Equal(t, "test 5", messages[2].Message)
  380. require.Equal(t, "mytopic1", messages[2].Topic)
  381. require.Equal(t, "test 6", messages[3].Message)
  382. require.Equal(t, "mytopic2", messages[3].Topic)
  383. }
  384. func TestServer_PollSinceID_MultipleTopics_IDDoesNotMatch(t *testing.T) {
  385. s := newTestServer(t, newTestConfig(t))
  386. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic1", "test 3", 1655740289)))
  387. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic2", "test 4", 1655740293)))
  388. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic1", "test 5", 1655740297)))
  389. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic2", "test 6", 1655740303)))
  390. response := request(t, s, "GET", "/mytopic1,mytopic2/json?poll=1&since=NoMatchForID", "", nil)
  391. messages := toMessages(t, response.Body.String())
  392. require.Equal(t, 4, len(messages))
  393. require.Equal(t, "test 3", messages[0].Message)
  394. require.Equal(t, "test 4", messages[1].Message)
  395. require.Equal(t, "test 5", messages[2].Message)
  396. require.Equal(t, "test 6", messages[3].Message)
  397. }
  398. func TestServer_PublishViaGET(t *testing.T) {
  399. s := newTestServer(t, newTestConfig(t))
  400. response := request(t, s, "GET", "/mytopic/trigger", "", nil)
  401. msg := toMessage(t, response.Body.String())
  402. require.NotEmpty(t, msg.ID)
  403. require.Equal(t, "triggered", msg.Message)
  404. 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)
  405. msg = toMessage(t, response.Body.String())
  406. require.NotEmpty(t, msg.ID)
  407. require.Equal(t, "This is a test", msg.Message)
  408. require.Equal(t, "This is a title", msg.Title)
  409. require.Equal(t, []string{"skull"}, msg.Tags)
  410. require.Equal(t, 5, msg.Priority)
  411. require.Greater(t, msg.Time, time.Now().Add(23*time.Hour).Unix())
  412. }
  413. func TestServer_PublishMessageInHeaderWithNewlines(t *testing.T) {
  414. s := newTestServer(t, newTestConfig(t))
  415. response := request(t, s, "PUT", "/mytopic", "", map[string]string{
  416. "Message": "Line 1\\nLine 2",
  417. })
  418. msg := toMessage(t, response.Body.String())
  419. require.NotEmpty(t, msg.ID)
  420. require.Equal(t, "Line 1\nLine 2", msg.Message) // \\n -> \n !
  421. }
  422. func TestServer_PublishInvalidTopic(t *testing.T) {
  423. s := newTestServer(t, newTestConfig(t))
  424. s.smtpSender = &testMailer{}
  425. response := request(t, s, "PUT", "/docs", "fail", nil)
  426. require.Equal(t, 40010, toHTTPError(t, response.Body.String()).Code)
  427. }
  428. func TestServer_PollWithQueryFilters(t *testing.T) {
  429. s := newTestServer(t, newTestConfig(t))
  430. response := request(t, s, "PUT", "/mytopic?priority=1&tags=tag1,tag2", "my first message", nil)
  431. msg := toMessage(t, response.Body.String())
  432. require.NotEmpty(t, msg.ID)
  433. response = request(t, s, "PUT", "/mytopic?title=a+title", "my second message", map[string]string{
  434. "Tags": "tag2,tag3",
  435. })
  436. msg = toMessage(t, response.Body.String())
  437. require.NotEmpty(t, msg.ID)
  438. queriesThatShouldReturnMessageOne := []string{
  439. "/mytopic/json?poll=1&priority=1",
  440. "/mytopic/json?poll=1&priority=min",
  441. "/mytopic/json?poll=1&priority=min,low",
  442. "/mytopic/json?poll=1&priority=1,2",
  443. "/mytopic/json?poll=1&p=2,min",
  444. "/mytopic/json?poll=1&tags=tag1",
  445. "/mytopic/json?poll=1&tags=tag1,tag2",
  446. "/mytopic/json?poll=1&message=my+first+message",
  447. }
  448. for _, query := range queriesThatShouldReturnMessageOne {
  449. response = request(t, s, "GET", query, "", nil)
  450. messages := toMessages(t, response.Body.String())
  451. require.Equal(t, 1, len(messages), "Query failed: "+query)
  452. require.Equal(t, "my first message", messages[0].Message, "Query failed: "+query)
  453. }
  454. queriesThatShouldReturnMessageTwo := []string{
  455. "/mytopic/json?poll=1&x-priority=3", // !
  456. "/mytopic/json?poll=1&priority=3",
  457. "/mytopic/json?poll=1&priority=default",
  458. "/mytopic/json?poll=1&p=3",
  459. "/mytopic/json?poll=1&x-tags=tag2,tag3",
  460. "/mytopic/json?poll=1&tags=tag2,tag3",
  461. "/mytopic/json?poll=1&tag=tag2,tag3",
  462. "/mytopic/json?poll=1&ta=tag2,tag3",
  463. "/mytopic/json?poll=1&x-title=a+title",
  464. "/mytopic/json?poll=1&title=a+title",
  465. "/mytopic/json?poll=1&t=a+title",
  466. "/mytopic/json?poll=1&x-message=my+second+message",
  467. "/mytopic/json?poll=1&message=my+second+message",
  468. "/mytopic/json?poll=1&m=my+second+message",
  469. "/mytopic/json?x-poll=1&m=my+second+message",
  470. "/mytopic/json?po=1&m=my+second+message",
  471. }
  472. for _, query := range queriesThatShouldReturnMessageTwo {
  473. response = request(t, s, "GET", query, "", nil)
  474. messages := toMessages(t, response.Body.String())
  475. require.Equal(t, 1, len(messages), "Query failed: "+query)
  476. require.Equal(t, "my second message", messages[0].Message, "Query failed: "+query)
  477. }
  478. queriesThatShouldReturnNoMessages := []string{
  479. "/mytopic/json?poll=1&priority=4",
  480. "/mytopic/json?poll=1&tags=tag1,tag2,tag3",
  481. "/mytopic/json?poll=1&title=another+title",
  482. "/mytopic/json?poll=1&message=my+third+message",
  483. "/mytopic/json?poll=1&message=my+third+message",
  484. }
  485. for _, query := range queriesThatShouldReturnNoMessages {
  486. response = request(t, s, "GET", query, "", nil)
  487. messages := toMessages(t, response.Body.String())
  488. require.Equal(t, 0, len(messages), "Query failed: "+query)
  489. }
  490. }
  491. func TestServer_SubscribeWithQueryFilters(t *testing.T) {
  492. c := newTestConfig(t)
  493. c.KeepaliveInterval = 800 * time.Millisecond
  494. s := newTestServer(t, c)
  495. subscribeResponse := httptest.NewRecorder()
  496. subscribeCancel := subscribe(t, s, "/mytopic/json?tags=zfs-issue", subscribeResponse)
  497. response := request(t, s, "PUT", "/mytopic", "my first message", nil)
  498. require.Equal(t, 200, response.Code)
  499. response = request(t, s, "PUT", "/mytopic", "ZFS scrub failed", map[string]string{
  500. "Tags": "zfs-issue,zfs-scrub",
  501. })
  502. require.Equal(t, 200, response.Code)
  503. time.Sleep(850 * time.Millisecond)
  504. subscribeCancel()
  505. messages := toMessages(t, subscribeResponse.Body.String())
  506. require.Equal(t, 3, len(messages))
  507. require.Equal(t, openEvent, messages[0].Event)
  508. require.Equal(t, messageEvent, messages[1].Event)
  509. require.Equal(t, "ZFS scrub failed", messages[1].Message)
  510. require.Equal(t, keepaliveEvent, messages[2].Event)
  511. }
  512. func TestServer_Auth_Success_Admin(t *testing.T) {
  513. c := newTestConfigWithAuthFile(t)
  514. s := newTestServer(t, c)
  515. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleAdmin))
  516. response := request(t, s, "GET", "/mytopic/auth", "", map[string]string{
  517. "Authorization": util.BasicAuth("phil", "phil"),
  518. })
  519. require.Equal(t, 200, response.Code)
  520. require.Equal(t, `{"success":true}`+"\n", response.Body.String())
  521. }
  522. func TestServer_Auth_Success_User(t *testing.T) {
  523. c := newTestConfigWithAuthFile(t)
  524. c.AuthDefault = user.PermissionDenyAll
  525. s := newTestServer(t, c)
  526. require.Nil(t, s.userManager.AddUser("ben", "ben", user.RoleUser))
  527. require.Nil(t, s.userManager.AllowAccess("ben", "mytopic", user.PermissionReadWrite))
  528. response := request(t, s, "GET", "/mytopic/auth", "", map[string]string{
  529. "Authorization": util.BasicAuth("ben", "ben"),
  530. })
  531. require.Equal(t, 200, response.Code)
  532. }
  533. func TestServer_Auth_Success_User_MultipleTopics(t *testing.T) {
  534. c := newTestConfigWithAuthFile(t)
  535. c.AuthDefault = user.PermissionDenyAll
  536. s := newTestServer(t, c)
  537. require.Nil(t, s.userManager.AddUser("ben", "ben", user.RoleUser))
  538. require.Nil(t, s.userManager.AllowAccess("ben", "mytopic", user.PermissionReadWrite))
  539. require.Nil(t, s.userManager.AllowAccess("ben", "anothertopic", user.PermissionReadWrite))
  540. response := request(t, s, "GET", "/mytopic,anothertopic/auth", "", map[string]string{
  541. "Authorization": util.BasicAuth("ben", "ben"),
  542. })
  543. require.Equal(t, 200, response.Code)
  544. response = request(t, s, "GET", "/mytopic,anothertopic,NOT-THIS-ONE/auth", "", map[string]string{
  545. "Authorization": util.BasicAuth("ben", "ben"),
  546. })
  547. require.Equal(t, 403, response.Code)
  548. }
  549. func TestServer_Auth_Fail_InvalidPass(t *testing.T) {
  550. c := newTestConfig(t)
  551. c.AuthFile = filepath.Join(t.TempDir(), "user.db")
  552. c.AuthDefault = user.PermissionDenyAll
  553. s := newTestServer(t, c)
  554. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleAdmin))
  555. response := request(t, s, "GET", "/mytopic/auth", "", map[string]string{
  556. "Authorization": util.BasicAuth("phil", "INVALID"),
  557. })
  558. require.Equal(t, 401, response.Code)
  559. }
  560. func TestServer_Auth_Fail_Unauthorized(t *testing.T) {
  561. c := newTestConfigWithAuthFile(t)
  562. c.AuthDefault = user.PermissionDenyAll
  563. s := newTestServer(t, c)
  564. require.Nil(t, s.userManager.AddUser("ben", "ben", user.RoleUser))
  565. require.Nil(t, s.userManager.AllowAccess("ben", "sometopic", user.PermissionReadWrite)) // Not mytopic!
  566. response := request(t, s, "GET", "/mytopic/auth", "", map[string]string{
  567. "Authorization": util.BasicAuth("ben", "ben"),
  568. })
  569. require.Equal(t, 403, response.Code)
  570. }
  571. func TestServer_Auth_Fail_CannotPublish(t *testing.T) {
  572. c := newTestConfigWithAuthFile(t)
  573. c.AuthDefault = user.PermissionReadWrite // Open by default
  574. s := newTestServer(t, c)
  575. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleAdmin))
  576. require.Nil(t, s.userManager.AllowAccess(user.Everyone, "private", user.PermissionDenyAll))
  577. require.Nil(t, s.userManager.AllowAccess(user.Everyone, "announcements", user.PermissionRead))
  578. response := request(t, s, "PUT", "/mytopic", "test", nil)
  579. require.Equal(t, 200, response.Code)
  580. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  581. require.Equal(t, 200, response.Code)
  582. response = request(t, s, "PUT", "/announcements", "test", nil)
  583. require.Equal(t, 403, response.Code) // Cannot write as anonymous
  584. response = request(t, s, "PUT", "/announcements", "test", map[string]string{
  585. "Authorization": util.BasicAuth("phil", "phil"),
  586. })
  587. require.Equal(t, 200, response.Code)
  588. response = request(t, s, "GET", "/announcements/json?poll=1", "", nil)
  589. require.Equal(t, 200, response.Code) // Anonymous read allowed
  590. response = request(t, s, "GET", "/private/json?poll=1", "", nil)
  591. require.Equal(t, 403, response.Code) // Anonymous read not allowed
  592. }
  593. func TestServer_Auth_ViaQuery(t *testing.T) {
  594. c := newTestConfigWithAuthFile(t)
  595. c.AuthDefault = user.PermissionDenyAll
  596. s := newTestServer(t, c)
  597. require.Nil(t, s.userManager.AddUser("ben", "some pass", user.RoleAdmin))
  598. u := fmt.Sprintf("/mytopic/json?poll=1&auth=%s", base64.RawURLEncoding.EncodeToString([]byte(util.BasicAuth("ben", "some pass"))))
  599. response := request(t, s, "GET", u, "", nil)
  600. require.Equal(t, 200, response.Code)
  601. u = fmt.Sprintf("/mytopic/json?poll=1&auth=%s", base64.RawURLEncoding.EncodeToString([]byte(util.BasicAuth("ben", "WRONNNGGGG"))))
  602. response = request(t, s, "GET", u, "", nil)
  603. require.Equal(t, 401, response.Code)
  604. }
  605. func TestServer_StatsResetter_User_Without_Tier(t *testing.T) {
  606. // This tests the stats resetter for
  607. // - an anonymous user
  608. // - a user without a tier (treated like the same as the anonymous user)
  609. // - a user with a tier
  610. c := newTestConfigWithAuthFile(t)
  611. c.VisitorStatsResetTime = time.Now().Add(2 * time.Second)
  612. s := newTestServer(t, c)
  613. go s.runStatsResetter()
  614. // Create user with tier (tieruser) and user without tier (phil)
  615. require.Nil(t, s.userManager.CreateTier(&user.Tier{
  616. Code: "test",
  617. MessageLimit: 5,
  618. MessageExpiryDuration: -5 * time.Second, // Second, what a hack!
  619. }))
  620. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  621. require.Nil(t, s.userManager.AddUser("tieruser", "tieruser", user.RoleUser))
  622. require.Nil(t, s.userManager.ChangeTier("tieruser", "test"))
  623. // Send an anonymous message
  624. response := request(t, s, "PUT", "/mytopic", "test", nil)
  625. // Send messages from user without tier (phil)
  626. for i := 0; i < 5; i++ {
  627. response := request(t, s, "PUT", "/mytopic", "test", map[string]string{
  628. "Authorization": util.BasicAuth("phil", "phil"),
  629. })
  630. require.Equal(t, 200, response.Code)
  631. }
  632. // Send messages from user with tier
  633. for i := 0; i < 2; i++ {
  634. response := request(t, s, "PUT", "/mytopic", "test", map[string]string{
  635. "Authorization": util.BasicAuth("tieruser", "tieruser"),
  636. })
  637. require.Equal(t, 200, response.Code)
  638. }
  639. // User stats show 6 messages (for user without tier)
  640. response = request(t, s, "GET", "/v1/account", "", map[string]string{
  641. "Authorization": util.BasicAuth("phil", "phil"),
  642. })
  643. require.Equal(t, 200, response.Code)
  644. account, err := util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  645. require.Nil(t, err)
  646. require.Equal(t, int64(6), account.Stats.Messages)
  647. // User stats show 6 messages (for anonymous visitor)
  648. response = request(t, s, "GET", "/v1/account", "", nil)
  649. require.Equal(t, 200, response.Code)
  650. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  651. require.Nil(t, err)
  652. require.Equal(t, int64(6), account.Stats.Messages)
  653. // User stats show 2 messages (for user with tier)
  654. response = request(t, s, "GET", "/v1/account", "", map[string]string{
  655. "Authorization": util.BasicAuth("tieruser", "tieruser"),
  656. })
  657. require.Equal(t, 200, response.Code)
  658. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  659. require.Nil(t, err)
  660. require.Equal(t, int64(2), account.Stats.Messages)
  661. // Wait for stats resetter to run
  662. time.Sleep(2200 * time.Millisecond)
  663. // User stats show 0 messages now!
  664. response = request(t, s, "GET", "/v1/account", "", map[string]string{
  665. "Authorization": util.BasicAuth("phil", "phil"),
  666. })
  667. require.Equal(t, 200, response.Code)
  668. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  669. require.Nil(t, err)
  670. require.Equal(t, int64(0), account.Stats.Messages)
  671. // Since this is a user without a tier, the anonymous user should have the same stats
  672. response = request(t, s, "GET", "/v1/account", "", nil)
  673. require.Equal(t, 200, response.Code)
  674. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  675. require.Nil(t, err)
  676. require.Equal(t, int64(0), account.Stats.Messages)
  677. // User stats show 0 messages (for user with tier)
  678. response = request(t, s, "GET", "/v1/account", "", map[string]string{
  679. "Authorization": util.BasicAuth("tieruser", "tieruser"),
  680. })
  681. require.Equal(t, 200, response.Code)
  682. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  683. require.Nil(t, err)
  684. require.Equal(t, int64(0), account.Stats.Messages)
  685. }
  686. type testMailer struct {
  687. count int
  688. mu sync.Mutex
  689. }
  690. func (t *testMailer) Send(v *visitor, m *message, to string) error {
  691. t.mu.Lock()
  692. defer t.mu.Unlock()
  693. t.count++
  694. return nil
  695. }
  696. func (t *testMailer) Counts() (total int64, success int64, failure int64) {
  697. return 0, 0, 0
  698. }
  699. func (t *testMailer) Count() int {
  700. t.mu.Lock()
  701. defer t.mu.Unlock()
  702. return t.count
  703. }
  704. func TestServer_PublishTooRequests_Defaults(t *testing.T) {
  705. s := newTestServer(t, newTestConfig(t))
  706. for i := 0; i < 60; i++ {
  707. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), nil)
  708. require.Equal(t, 200, response.Code)
  709. }
  710. response := request(t, s, "PUT", "/mytopic", "message", nil)
  711. require.Equal(t, 429, response.Code)
  712. }
  713. func TestServer_PublishTooRequests_Defaults_ExemptHosts(t *testing.T) {
  714. c := newTestConfig(t)
  715. c.VisitorRequestExemptIPAddrs = []netip.Prefix{netip.MustParsePrefix("9.9.9.9/32")} // see request()
  716. s := newTestServer(t, c)
  717. for i := 0; i < 65; i++ { // > 60
  718. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), nil)
  719. require.Equal(t, 200, response.Code)
  720. }
  721. }
  722. func TestServer_PublishTooRequests_ShortReplenish(t *testing.T) {
  723. c := newTestConfig(t)
  724. c.VisitorRequestLimitBurst = 60
  725. c.VisitorRequestLimitReplenish = time.Second
  726. s := newTestServer(t, c)
  727. for i := 0; i < 60; i++ {
  728. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), nil)
  729. require.Equal(t, 200, response.Code)
  730. }
  731. response := request(t, s, "PUT", "/mytopic", "message", nil)
  732. require.Equal(t, 429, response.Code)
  733. time.Sleep(1020 * time.Millisecond)
  734. response = request(t, s, "PUT", "/mytopic", "message", nil)
  735. require.Equal(t, 200, response.Code)
  736. }
  737. func TestServer_PublishTooManyEmails_Defaults(t *testing.T) {
  738. s := newTestServer(t, newTestConfig(t))
  739. s.smtpSender = &testMailer{}
  740. for i := 0; i < 16; i++ {
  741. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  742. "E-Mail": "test@example.com",
  743. })
  744. require.Equal(t, 200, response.Code)
  745. }
  746. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  747. "E-Mail": "test@example.com",
  748. })
  749. require.Equal(t, 429, response.Code)
  750. }
  751. func TestServer_PublishTooManyEmails_Replenish(t *testing.T) {
  752. c := newTestConfig(t)
  753. c.VisitorEmailLimitReplenish = 500 * time.Millisecond
  754. s := newTestServer(t, c)
  755. s.smtpSender = &testMailer{}
  756. for i := 0; i < 16; i++ {
  757. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  758. "E-Mail": "test@example.com",
  759. })
  760. require.Equal(t, 200, response.Code)
  761. }
  762. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  763. "E-Mail": "test@example.com",
  764. })
  765. require.Equal(t, 429, response.Code)
  766. time.Sleep(510 * time.Millisecond)
  767. response = request(t, s, "PUT", "/mytopic", "this should be okay again too many", map[string]string{
  768. "E-Mail": "test@example.com",
  769. })
  770. require.Equal(t, 200, response.Code)
  771. response = request(t, s, "PUT", "/mytopic", "and bad again", map[string]string{
  772. "E-Mail": "test@example.com",
  773. })
  774. require.Equal(t, 429, response.Code)
  775. }
  776. func TestServer_PublishDelayedEmail_Fail(t *testing.T) {
  777. s := newTestServer(t, newTestConfig(t))
  778. s.smtpSender = &testMailer{}
  779. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  780. "E-Mail": "test@example.com",
  781. "Delay": "20 min",
  782. })
  783. require.Equal(t, 400, response.Code)
  784. }
  785. func TestServer_PublishEmailNoMailer_Fail(t *testing.T) {
  786. s := newTestServer(t, newTestConfig(t))
  787. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  788. "E-Mail": "test@example.com",
  789. })
  790. require.Equal(t, 400, response.Code)
  791. }
  792. func TestServer_UnifiedPushDiscovery(t *testing.T) {
  793. s := newTestServer(t, newTestConfig(t))
  794. response := request(t, s, "GET", "/mytopic?up=1", "", nil)
  795. require.Equal(t, 200, response.Code)
  796. require.Equal(t, `{"unifiedpush":{"version":1}}`+"\n", response.Body.String())
  797. }
  798. func TestServer_PublishUnifiedPushBinary_AndPoll(t *testing.T) {
  799. b := make([]byte, 12) // Max length
  800. _, err := rand.Read(b)
  801. require.Nil(t, err)
  802. s := newTestServer(t, newTestConfig(t))
  803. response := request(t, s, "PUT", "/mytopic?up=1", string(b), nil)
  804. require.Equal(t, 200, response.Code)
  805. m := toMessage(t, response.Body.String())
  806. require.Equal(t, "base64", m.Encoding)
  807. b2, err := base64.StdEncoding.DecodeString(m.Message)
  808. require.Nil(t, err)
  809. require.Equal(t, b, b2)
  810. response = request(t, s, "GET", "/mytopic/json?poll=1", string(b), nil)
  811. require.Equal(t, 200, response.Code)
  812. m = toMessage(t, response.Body.String())
  813. require.Equal(t, "base64", m.Encoding)
  814. b2, err = base64.StdEncoding.DecodeString(m.Message)
  815. require.Nil(t, err)
  816. require.Equal(t, b, b2)
  817. }
  818. func TestServer_PublishUnifiedPushBinary_Truncated(t *testing.T) {
  819. b := make([]byte, 5000) // Longer than max length
  820. _, err := rand.Read(b)
  821. require.Nil(t, err)
  822. s := newTestServer(t, newTestConfig(t))
  823. response := request(t, s, "PUT", "/mytopic?up=1", string(b), nil)
  824. require.Equal(t, 200, response.Code)
  825. m := toMessage(t, response.Body.String())
  826. require.Equal(t, "base64", m.Encoding)
  827. b2, err := base64.StdEncoding.DecodeString(m.Message)
  828. require.Nil(t, err)
  829. require.Equal(t, 4096, len(b2))
  830. require.Equal(t, b[:4096], b2)
  831. }
  832. func TestServer_PublishUnifiedPushText(t *testing.T) {
  833. s := newTestServer(t, newTestConfig(t))
  834. response := request(t, s, "PUT", "/mytopic?up=1", "this is a unifiedpush text message", nil)
  835. require.Equal(t, 200, response.Code)
  836. m := toMessage(t, response.Body.String())
  837. require.Equal(t, "", m.Encoding)
  838. require.Equal(t, "this is a unifiedpush text message", m.Message)
  839. }
  840. func TestServer_MatrixGateway_Discovery_Success(t *testing.T) {
  841. s := newTestServer(t, newTestConfig(t))
  842. response := request(t, s, "GET", "/_matrix/push/v1/notify", "", nil)
  843. require.Equal(t, 200, response.Code)
  844. require.Equal(t, `{"unifiedpush":{"gateway":"matrix"}}`+"\n", response.Body.String())
  845. }
  846. func TestServer_MatrixGateway_Discovery_Failure_Unconfigured(t *testing.T) {
  847. c := newTestConfig(t)
  848. c.BaseURL = ""
  849. s := newTestServer(t, c)
  850. response := request(t, s, "GET", "/_matrix/push/v1/notify", "", nil)
  851. require.Equal(t, 500, response.Code)
  852. err := toHTTPError(t, response.Body.String())
  853. require.Equal(t, 50003, err.Code)
  854. }
  855. func TestServer_MatrixGateway_Push_Success(t *testing.T) {
  856. s := newTestServer(t, newTestConfig(t))
  857. notification := `{"notification":{"devices":[{"pushkey":"http://127.0.0.1:12345/mytopic?up=1"}]}}`
  858. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  859. require.Equal(t, 200, response.Code)
  860. require.Equal(t, `{"rejected":[]}`+"\n", response.Body.String())
  861. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  862. require.Equal(t, 200, response.Code)
  863. m := toMessage(t, response.Body.String())
  864. require.Equal(t, notification, m.Message)
  865. }
  866. func TestServer_MatrixGateway_Push_Failure_InvalidPushkey(t *testing.T) {
  867. s := newTestServer(t, newTestConfig(t))
  868. notification := `{"notification":{"devices":[{"pushkey":"http://wrong-base-url.com/mytopic?up=1"}]}}`
  869. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  870. require.Equal(t, 200, response.Code)
  871. require.Equal(t, `{"rejected":["http://wrong-base-url.com/mytopic?up=1"]}`+"\n", response.Body.String())
  872. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  873. require.Equal(t, 200, response.Code)
  874. require.Equal(t, "", response.Body.String()) // Empty!
  875. }
  876. func TestServer_MatrixGateway_Push_Failure_EverythingIsWrong(t *testing.T) {
  877. s := newTestServer(t, newTestConfig(t))
  878. notification := `{"message":"this is not really a Matrix message"}`
  879. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  880. require.Equal(t, 400, response.Code)
  881. err := toHTTPError(t, response.Body.String())
  882. require.Equal(t, 40019, err.Code)
  883. require.Equal(t, 400, err.HTTPCode)
  884. }
  885. func TestServer_MatrixGateway_Push_Failure_Unconfigured(t *testing.T) {
  886. c := newTestConfig(t)
  887. c.BaseURL = ""
  888. s := newTestServer(t, c)
  889. notification := `{"notification":{"devices":[{"pushkey":"http://127.0.0.1:12345/mytopic?up=1"}]}}`
  890. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  891. require.Equal(t, 500, response.Code)
  892. err := toHTTPError(t, response.Body.String())
  893. require.Equal(t, 50003, err.Code)
  894. require.Equal(t, 500, err.HTTPCode)
  895. }
  896. func TestServer_PublishActions_AndPoll(t *testing.T) {
  897. s := newTestServer(t, newTestConfig(t))
  898. response := request(t, s, "PUT", "/mytopic", "my message", map[string]string{
  899. "Actions": "view, Open portal, https://home.nest.com/; http, Turn down, https://api.nest.com/device/XZ1D2, body=target_temp_f=65",
  900. })
  901. require.Equal(t, 200, response.Code)
  902. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  903. require.Equal(t, 200, response.Code)
  904. m := toMessage(t, response.Body.String())
  905. require.Equal(t, 2, len(m.Actions))
  906. require.Equal(t, "view", m.Actions[0].Action)
  907. require.Equal(t, "Open portal", m.Actions[0].Label)
  908. require.Equal(t, "https://home.nest.com/", m.Actions[0].URL)
  909. require.Equal(t, "http", m.Actions[1].Action)
  910. require.Equal(t, "Turn down", m.Actions[1].Label)
  911. require.Equal(t, "https://api.nest.com/device/XZ1D2", m.Actions[1].URL)
  912. require.Equal(t, "target_temp_f=65", m.Actions[1].Body)
  913. }
  914. func TestServer_PublishAsJSON(t *testing.T) {
  915. s := newTestServer(t, newTestConfig(t))
  916. body := `{"topic":"mytopic","message":"A message","title":"a title\nwith lines","tags":["tag1","tag 2"],` +
  917. `"not-a-thing":"ok", "attach":"http://google.com","filename":"google.pdf", "click":"http://ntfy.sh","priority":4,` +
  918. `"icon":"https://ntfy.sh/static/img/ntfy.png", "delay":"30min"}`
  919. response := request(t, s, "PUT", "/", body, nil)
  920. require.Equal(t, 200, response.Code)
  921. m := toMessage(t, response.Body.String())
  922. require.Equal(t, "mytopic", m.Topic)
  923. require.Equal(t, "A message", m.Message)
  924. require.Equal(t, "a title\nwith lines", m.Title)
  925. require.Equal(t, []string{"tag1", "tag 2"}, m.Tags)
  926. require.Equal(t, "http://google.com", m.Attachment.URL)
  927. require.Equal(t, "google.pdf", m.Attachment.Name)
  928. require.Equal(t, "http://ntfy.sh", m.Click)
  929. require.Equal(t, "https://ntfy.sh/static/img/ntfy.png", m.Icon)
  930. require.Equal(t, 4, m.Priority)
  931. require.True(t, m.Time > time.Now().Unix()+29*60)
  932. require.True(t, m.Time < time.Now().Unix()+31*60)
  933. }
  934. func TestServer_PublishAsJSON_WithEmail(t *testing.T) {
  935. mailer := &testMailer{}
  936. s := newTestServer(t, newTestConfig(t))
  937. s.smtpSender = mailer
  938. body := `{"topic":"mytopic","message":"A message","email":"phil@example.com"}`
  939. response := request(t, s, "PUT", "/", body, nil)
  940. require.Equal(t, 200, response.Code)
  941. time.Sleep(100 * time.Millisecond) // E-Mail publishing happens in a Go routine
  942. m := toMessage(t, response.Body.String())
  943. require.Equal(t, "mytopic", m.Topic)
  944. require.Equal(t, "A message", m.Message)
  945. require.Equal(t, 1, mailer.Count())
  946. }
  947. func TestServer_PublishAsJSON_WithActions(t *testing.T) {
  948. s := newTestServer(t, newTestConfig(t))
  949. body := `{
  950. "topic":"mytopic",
  951. "message":"A message",
  952. "actions": [
  953. {
  954. "action": "view",
  955. "label": "Open portal",
  956. "url": "https://home.nest.com/"
  957. },
  958. {
  959. "action": "http",
  960. "label": "Turn down",
  961. "url": "https://api.nest.com/device/XZ1D2",
  962. "body": "target_temp_f=65"
  963. }
  964. ]
  965. }`
  966. response := request(t, s, "POST", "/", body, nil)
  967. require.Equal(t, 200, response.Code)
  968. m := toMessage(t, response.Body.String())
  969. require.Equal(t, "mytopic", m.Topic)
  970. require.Equal(t, "A message", m.Message)
  971. require.Equal(t, 2, len(m.Actions))
  972. require.Equal(t, "view", m.Actions[0].Action)
  973. require.Equal(t, "Open portal", m.Actions[0].Label)
  974. require.Equal(t, "https://home.nest.com/", m.Actions[0].URL)
  975. require.Equal(t, "http", m.Actions[1].Action)
  976. require.Equal(t, "Turn down", m.Actions[1].Label)
  977. require.Equal(t, "https://api.nest.com/device/XZ1D2", m.Actions[1].URL)
  978. require.Equal(t, "target_temp_f=65", m.Actions[1].Body)
  979. }
  980. func TestServer_PublishAsJSON_Invalid(t *testing.T) {
  981. s := newTestServer(t, newTestConfig(t))
  982. body := `{"topic":"mytopic",INVALID`
  983. response := request(t, s, "PUT", "/", body, nil)
  984. require.Equal(t, 400, response.Code)
  985. }
  986. func TestServer_PublishWithTierBasedMessageLimitAndExpiry(t *testing.T) {
  987. c := newTestConfigWithAuthFile(t)
  988. s := newTestServer(t, c)
  989. // Create tier with certain limits
  990. require.Nil(t, s.userManager.CreateTier(&user.Tier{
  991. Code: "test",
  992. MessageLimit: 5,
  993. MessageExpiryDuration: -5 * time.Second, // Second, what a hack!
  994. }))
  995. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  996. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  997. // Publish to reach message limit
  998. for i := 0; i < 5; i++ {
  999. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("this is message %d", i+1), map[string]string{
  1000. "Authorization": util.BasicAuth("phil", "phil"),
  1001. })
  1002. require.Equal(t, 200, response.Code)
  1003. msg := toMessage(t, response.Body.String())
  1004. require.True(t, msg.Expires < time.Now().Unix()+5)
  1005. }
  1006. response := request(t, s, "PUT", "/mytopic", "this is too much", map[string]string{
  1007. "Authorization": util.BasicAuth("phil", "phil"),
  1008. })
  1009. require.Equal(t, 429, response.Code)
  1010. // Run pruning and see if they are gone
  1011. s.execManager()
  1012. response = request(t, s, "GET", "/mytopic/json?poll=1", "", map[string]string{
  1013. "Authorization": util.BasicAuth("phil", "phil"),
  1014. })
  1015. require.Equal(t, 200, response.Code)
  1016. require.Empty(t, response.Body)
  1017. }
  1018. func TestServer_PublishAttachment(t *testing.T) {
  1019. content := util.RandomString(5000) // > 4096
  1020. s := newTestServer(t, newTestConfig(t))
  1021. response := request(t, s, "PUT", "/mytopic", content, nil)
  1022. msg := toMessage(t, response.Body.String())
  1023. require.Equal(t, "attachment.txt", msg.Attachment.Name)
  1024. require.Equal(t, "text/plain; charset=utf-8", msg.Attachment.Type)
  1025. require.Equal(t, int64(5000), msg.Attachment.Size)
  1026. require.GreaterOrEqual(t, msg.Attachment.Expires, time.Now().Add(179*time.Minute).Unix()) // Almost 3 hours
  1027. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1028. require.Equal(t, netip.Addr{}, msg.Sender) // Should never be returned
  1029. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  1030. // GET
  1031. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1032. response = request(t, s, "GET", path, "", nil)
  1033. require.Equal(t, 200, response.Code)
  1034. require.Equal(t, "5000", response.Header().Get("Content-Length"))
  1035. require.Equal(t, content, response.Body.String())
  1036. // HEAD
  1037. response = request(t, s, "HEAD", path, "", nil)
  1038. require.Equal(t, 200, response.Code)
  1039. require.Equal(t, "5000", response.Header().Get("Content-Length"))
  1040. require.Equal(t, "", response.Body.String())
  1041. // Slightly unrelated cross-test: make sure we add an owner for internal attachments
  1042. size, err := s.messageCache.AttachmentBytesUsedBySender("9.9.9.9") // See request()
  1043. require.Nil(t, err)
  1044. require.Equal(t, int64(5000), size)
  1045. }
  1046. func TestServer_PublishAttachmentShortWithFilename(t *testing.T) {
  1047. c := newTestConfig(t)
  1048. c.BehindProxy = true
  1049. s := newTestServer(t, c)
  1050. content := "this is an ATTACHMENT"
  1051. response := request(t, s, "PUT", "/mytopic?f=myfile.txt", content, map[string]string{
  1052. "X-Forwarded-For": "1.2.3.4",
  1053. })
  1054. msg := toMessage(t, response.Body.String())
  1055. require.Equal(t, "myfile.txt", msg.Attachment.Name)
  1056. require.Equal(t, "text/plain; charset=utf-8", msg.Attachment.Type)
  1057. require.Equal(t, int64(21), msg.Attachment.Size)
  1058. require.GreaterOrEqual(t, msg.Attachment.Expires, time.Now().Add(3*time.Hour).Unix())
  1059. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1060. require.Equal(t, netip.Addr{}, msg.Sender) // Should never be returned
  1061. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  1062. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1063. response = request(t, s, "GET", path, "", nil)
  1064. require.Equal(t, 200, response.Code)
  1065. require.Equal(t, "21", response.Header().Get("Content-Length"))
  1066. require.Equal(t, content, response.Body.String())
  1067. // Slightly unrelated cross-test: make sure we add an owner for internal attachments
  1068. size, err := s.messageCache.AttachmentBytesUsedBySender("1.2.3.4")
  1069. require.Nil(t, err)
  1070. require.Equal(t, int64(21), size)
  1071. }
  1072. func TestServer_PublishAttachmentExternalWithoutFilename(t *testing.T) {
  1073. s := newTestServer(t, newTestConfig(t))
  1074. response := request(t, s, "PUT", "/mytopic", "", map[string]string{
  1075. "Attach": "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg",
  1076. })
  1077. msg := toMessage(t, response.Body.String())
  1078. require.Equal(t, "You received a file: Pink_flower.jpg", msg.Message)
  1079. require.Equal(t, "Pink_flower.jpg", msg.Attachment.Name)
  1080. require.Equal(t, "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg", msg.Attachment.URL)
  1081. require.Equal(t, "", msg.Attachment.Type)
  1082. require.Equal(t, int64(0), msg.Attachment.Size)
  1083. require.Equal(t, int64(0), msg.Attachment.Expires)
  1084. require.Equal(t, netip.Addr{}, msg.Sender)
  1085. // Slightly unrelated cross-test: make sure we don't add an owner for external attachments
  1086. size, err := s.messageCache.AttachmentBytesUsedBySender("127.0.0.1")
  1087. require.Nil(t, err)
  1088. require.Equal(t, int64(0), size)
  1089. }
  1090. func TestServer_PublishAttachmentExternalWithFilename(t *testing.T) {
  1091. s := newTestServer(t, newTestConfig(t))
  1092. response := request(t, s, "PUT", "/mytopic", "This is a custom message", map[string]string{
  1093. "X-Attach": "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg",
  1094. "File": "some file.jpg",
  1095. })
  1096. msg := toMessage(t, response.Body.String())
  1097. require.Equal(t, "This is a custom message", msg.Message)
  1098. require.Equal(t, "some file.jpg", msg.Attachment.Name)
  1099. require.Equal(t, "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg", msg.Attachment.URL)
  1100. require.Equal(t, "", msg.Attachment.Type)
  1101. require.Equal(t, int64(0), msg.Attachment.Size)
  1102. require.Equal(t, int64(0), msg.Attachment.Expires)
  1103. require.Equal(t, netip.Addr{}, msg.Sender)
  1104. }
  1105. func TestServer_PublishAttachmentBadURL(t *testing.T) {
  1106. s := newTestServer(t, newTestConfig(t))
  1107. response := request(t, s, "PUT", "/mytopic?a=not+a+URL", "", nil)
  1108. err := toHTTPError(t, response.Body.String())
  1109. require.Equal(t, 400, response.Code)
  1110. require.Equal(t, 400, err.HTTPCode)
  1111. require.Equal(t, 40013, err.Code)
  1112. }
  1113. func TestServer_PublishAttachmentTooLargeContentLength(t *testing.T) {
  1114. content := util.RandomString(5000) // > 4096
  1115. s := newTestServer(t, newTestConfig(t))
  1116. response := request(t, s, "PUT", "/mytopic", content, map[string]string{
  1117. "Content-Length": "20000000",
  1118. })
  1119. err := toHTTPError(t, response.Body.String())
  1120. require.Equal(t, 413, response.Code)
  1121. require.Equal(t, 413, err.HTTPCode)
  1122. require.Equal(t, 41301, err.Code)
  1123. }
  1124. func TestServer_PublishAttachmentTooLargeBodyAttachmentFileSizeLimit(t *testing.T) {
  1125. content := util.RandomString(5001) // > 5000, see below
  1126. c := newTestConfig(t)
  1127. c.AttachmentFileSizeLimit = 5000
  1128. s := newTestServer(t, c)
  1129. response := request(t, s, "PUT", "/mytopic", content, nil)
  1130. err := toHTTPError(t, response.Body.String())
  1131. require.Equal(t, 413, response.Code)
  1132. require.Equal(t, 413, err.HTTPCode)
  1133. require.Equal(t, 41301, err.Code)
  1134. }
  1135. func TestServer_PublishAttachmentExpiryBeforeDelivery(t *testing.T) {
  1136. c := newTestConfig(t)
  1137. c.AttachmentExpiryDuration = 10 * time.Minute
  1138. s := newTestServer(t, c)
  1139. response := request(t, s, "PUT", "/mytopic", util.RandomString(5000), map[string]string{
  1140. "Delay": "11 min", // > AttachmentExpiryDuration
  1141. })
  1142. err := toHTTPError(t, response.Body.String())
  1143. require.Equal(t, 400, response.Code)
  1144. require.Equal(t, 400, err.HTTPCode)
  1145. require.Equal(t, 40015, err.Code)
  1146. }
  1147. func TestServer_PublishAttachmentTooLargeBodyVisitorAttachmentTotalSizeLimit(t *testing.T) {
  1148. c := newTestConfig(t)
  1149. c.VisitorAttachmentTotalSizeLimit = 10000
  1150. s := newTestServer(t, c)
  1151. response := request(t, s, "PUT", "/mytopic", util.RandomString(5000), nil)
  1152. msg := toMessage(t, response.Body.String())
  1153. require.Equal(t, 200, response.Code)
  1154. require.Equal(t, "You received a file: attachment.txt", msg.Message)
  1155. require.Equal(t, int64(5000), msg.Attachment.Size)
  1156. content := util.RandomString(5001) // 5000+5001 > , see below
  1157. response = request(t, s, "PUT", "/mytopic", content, nil)
  1158. err := toHTTPError(t, response.Body.String())
  1159. require.Equal(t, 413, response.Code)
  1160. require.Equal(t, 413, err.HTTPCode)
  1161. require.Equal(t, 41301, err.Code)
  1162. }
  1163. func TestServer_PublishAttachmentAndExpire(t *testing.T) {
  1164. content := util.RandomString(5000) // > 4096
  1165. c := newTestConfig(t)
  1166. c.AttachmentExpiryDuration = time.Millisecond // Hack
  1167. s := newTestServer(t, c)
  1168. // Publish and make sure we can retrieve it
  1169. response := request(t, s, "PUT", "/mytopic", content, nil)
  1170. msg := toMessage(t, response.Body.String())
  1171. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1172. file := filepath.Join(s.config.AttachmentCacheDir, msg.ID)
  1173. require.FileExists(t, file)
  1174. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1175. response = request(t, s, "GET", path, "", nil)
  1176. require.Equal(t, 200, response.Code)
  1177. require.Equal(t, content, response.Body.String())
  1178. // Prune and makes sure it's gone
  1179. time.Sleep(time.Second) // Sigh ...
  1180. s.execManager()
  1181. require.NoFileExists(t, file)
  1182. response = request(t, s, "GET", path, "", nil)
  1183. require.Equal(t, 404, response.Code)
  1184. }
  1185. func TestServer_PublishAttachmentWithTierBasedExpiry(t *testing.T) {
  1186. content := util.RandomString(5000) // > 4096
  1187. c := newTestConfigWithAuthFile(t)
  1188. c.AttachmentExpiryDuration = time.Millisecond // Hack
  1189. s := newTestServer(t, c)
  1190. // Create tier with certain limits
  1191. sevenDays := time.Duration(604800) * time.Second
  1192. require.Nil(t, s.userManager.CreateTier(&user.Tier{
  1193. Code: "test",
  1194. MessageLimit: 10,
  1195. MessageExpiryDuration: sevenDays,
  1196. AttachmentFileSizeLimit: 50_000,
  1197. AttachmentTotalSizeLimit: 200_000,
  1198. AttachmentExpiryDuration: sevenDays, // 7 days
  1199. AttachmentBandwidthLimit: 100000,
  1200. }))
  1201. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  1202. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  1203. // Publish and make sure we can retrieve it
  1204. response := request(t, s, "PUT", "/mytopic", content, map[string]string{
  1205. "Authorization": util.BasicAuth("phil", "phil"),
  1206. })
  1207. require.Equal(t, 200, response.Code)
  1208. msg := toMessage(t, response.Body.String())
  1209. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1210. require.True(t, msg.Attachment.Expires > time.Now().Add(sevenDays-30*time.Second).Unix())
  1211. require.True(t, msg.Expires > time.Now().Add(sevenDays-30*time.Second).Unix())
  1212. file := filepath.Join(s.config.AttachmentCacheDir, msg.ID)
  1213. require.FileExists(t, file)
  1214. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1215. response = request(t, s, "GET", path, "", nil)
  1216. require.Equal(t, 200, response.Code)
  1217. require.Equal(t, content, response.Body.String())
  1218. // Prune and makes sure it's still there
  1219. time.Sleep(time.Second) // Sigh ...
  1220. s.execManager()
  1221. require.FileExists(t, file)
  1222. response = request(t, s, "GET", path, "", nil)
  1223. require.Equal(t, 200, response.Code)
  1224. }
  1225. func TestServer_PublishAttachmentWithTierBasedBandwidthLimit(t *testing.T) {
  1226. content := util.RandomString(5000) // > 4096
  1227. c := newTestConfigWithAuthFile(t)
  1228. s := newTestServer(t, c)
  1229. // Create tier with certain limits
  1230. require.Nil(t, s.userManager.CreateTier(&user.Tier{
  1231. Code: "test",
  1232. MessageLimit: 10,
  1233. MessageExpiryDuration: time.Hour,
  1234. AttachmentFileSizeLimit: 50_000,
  1235. AttachmentTotalSizeLimit: 200_000,
  1236. AttachmentExpiryDuration: time.Hour,
  1237. AttachmentBandwidthLimit: 14000, // < 3x5000 bytes -> enough for one upload, one download
  1238. }))
  1239. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  1240. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  1241. // Publish and make sure we can retrieve it
  1242. rr := request(t, s, "PUT", "/mytopic", content, map[string]string{
  1243. "Authorization": util.BasicAuth("phil", "phil"),
  1244. })
  1245. require.Equal(t, 200, rr.Code)
  1246. msg := toMessage(t, rr.Body.String())
  1247. // Retrieve it (first time succeeds)
  1248. rr = request(t, s, "GET", "/file/"+msg.ID, content, map[string]string{
  1249. "Authorization": util.BasicAuth("phil", "phil"),
  1250. })
  1251. require.Equal(t, 200, rr.Code)
  1252. require.Equal(t, content, rr.Body.String())
  1253. // Retrieve it AGAIN (fails, due to bandwidth limit)
  1254. rr = request(t, s, "GET", "/file/"+msg.ID, content, map[string]string{
  1255. "Authorization": util.BasicAuth("phil", "phil"),
  1256. })
  1257. require.Equal(t, 429, rr.Code)
  1258. }
  1259. func TestServer_PublishAttachmentWithTierBasedLimits(t *testing.T) {
  1260. smallFile := util.RandomString(20_000)
  1261. largeFile := util.RandomString(50_000)
  1262. c := newTestConfigWithAuthFile(t)
  1263. c.AttachmentFileSizeLimit = 20_000
  1264. c.VisitorAttachmentTotalSizeLimit = 40_000
  1265. s := newTestServer(t, c)
  1266. // Create tier with certain limits
  1267. require.Nil(t, s.userManager.CreateTier(&user.Tier{
  1268. Code: "test",
  1269. MessageLimit: 100,
  1270. AttachmentFileSizeLimit: 50_000,
  1271. AttachmentTotalSizeLimit: 200_000,
  1272. AttachmentExpiryDuration: 30 * time.Second,
  1273. AttachmentBandwidthLimit: 1000000,
  1274. }))
  1275. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  1276. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  1277. // Publish small file as anonymous
  1278. response := request(t, s, "PUT", "/mytopic", smallFile, nil)
  1279. msg := toMessage(t, response.Body.String())
  1280. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1281. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  1282. // Publish large file as anonymous
  1283. response = request(t, s, "PUT", "/mytopic", largeFile, nil)
  1284. require.Equal(t, 413, response.Code)
  1285. require.Equal(t, 41301, toHTTPError(t, response.Body.String()).Code)
  1286. // Publish too large file as phil
  1287. response = request(t, s, "PUT", "/mytopic", largeFile+" a few more bytes", map[string]string{
  1288. "Authorization": util.BasicAuth("phil", "phil"),
  1289. })
  1290. require.Equal(t, 413, response.Code)
  1291. require.Equal(t, 41301, toHTTPError(t, response.Body.String()).Code)
  1292. // Publish large file as phil (4x)
  1293. for i := 0; i < 4; i++ {
  1294. response = request(t, s, "PUT", "/mytopic", largeFile, map[string]string{
  1295. "Authorization": util.BasicAuth("phil", "phil"),
  1296. })
  1297. require.Equal(t, 200, response.Code)
  1298. msg = toMessage(t, response.Body.String())
  1299. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1300. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  1301. }
  1302. response = request(t, s, "PUT", "/mytopic", largeFile, map[string]string{
  1303. "Authorization": util.BasicAuth("phil", "phil"),
  1304. })
  1305. require.Equal(t, 413, response.Code)
  1306. require.Equal(t, 41301, toHTTPError(t, response.Body.String()).Code)
  1307. }
  1308. func TestServer_PublishAttachmentBandwidthLimit(t *testing.T) {
  1309. content := util.RandomString(5000) // > 4096
  1310. c := newTestConfig(t)
  1311. c.VisitorAttachmentDailyBandwidthLimit = 5*5000 + 123 // A little more than 1 upload and 3 downloads
  1312. s := newTestServer(t, c)
  1313. // Publish attachment
  1314. response := request(t, s, "PUT", "/mytopic", content, nil)
  1315. msg := toMessage(t, response.Body.String())
  1316. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1317. // Value it 4 times successfully
  1318. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1319. for i := 1; i <= 4; i++ { // 4 successful downloads
  1320. response = request(t, s, "GET", path, "", nil)
  1321. require.Equal(t, 200, response.Code)
  1322. require.Equal(t, content, response.Body.String())
  1323. }
  1324. // And then fail with a 429
  1325. response = request(t, s, "GET", path, "", nil)
  1326. err := toHTTPError(t, response.Body.String())
  1327. require.Equal(t, 429, response.Code)
  1328. require.Equal(t, 42905, err.Code)
  1329. }
  1330. func TestServer_PublishAttachmentBandwidthLimitUploadOnly(t *testing.T) {
  1331. content := util.RandomString(5000) // > 4096
  1332. c := newTestConfig(t)
  1333. c.VisitorAttachmentDailyBandwidthLimit = 5*5000 + 500 // 5 successful uploads
  1334. s := newTestServer(t, c)
  1335. // 5 successful uploads
  1336. for i := 1; i <= 5; i++ {
  1337. response := request(t, s, "PUT", "/mytopic", content, nil)
  1338. msg := toMessage(t, response.Body.String())
  1339. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1340. }
  1341. // And a failed one
  1342. response := request(t, s, "PUT", "/mytopic", content, nil)
  1343. err := toHTTPError(t, response.Body.String())
  1344. require.Equal(t, 413, response.Code)
  1345. require.Equal(t, 41301, err.Code)
  1346. }
  1347. func TestServer_PublishAttachmentAccountStats(t *testing.T) {
  1348. content := util.RandomString(4999) // > 4096
  1349. c := newTestConfig(t)
  1350. c.AttachmentFileSizeLimit = 5000
  1351. c.VisitorAttachmentTotalSizeLimit = 6000
  1352. s := newTestServer(t, c)
  1353. // Upload one attachment
  1354. response := request(t, s, "PUT", "/mytopic", content, nil)
  1355. msg := toMessage(t, response.Body.String())
  1356. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1357. // User stats
  1358. response = request(t, s, "GET", "/v1/account", "", nil)
  1359. require.Equal(t, 200, response.Code)
  1360. account, err := util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  1361. require.Nil(t, err)
  1362. require.Equal(t, int64(5000), account.Limits.AttachmentFileSize)
  1363. require.Equal(t, int64(6000), account.Limits.AttachmentTotalSize)
  1364. require.Equal(t, int64(4999), account.Stats.AttachmentTotalSize)
  1365. require.Equal(t, int64(1001), account.Stats.AttachmentTotalSizeRemaining)
  1366. require.Equal(t, int64(1), account.Stats.Messages)
  1367. }
  1368. func TestServer_Visitor_XForwardedFor_None(t *testing.T) {
  1369. c := newTestConfig(t)
  1370. c.BehindProxy = true
  1371. s := newTestServer(t, c)
  1372. r, _ := http.NewRequest("GET", "/bla", nil)
  1373. r.RemoteAddr = "8.9.10.11"
  1374. r.Header.Set("X-Forwarded-For", " ") // Spaces, not empty!
  1375. v, err := s.maybeAuthenticate(r)
  1376. require.Nil(t, err)
  1377. require.Equal(t, "8.9.10.11", v.ip.String())
  1378. }
  1379. func TestServer_Visitor_XForwardedFor_Single(t *testing.T) {
  1380. c := newTestConfig(t)
  1381. c.BehindProxy = true
  1382. s := newTestServer(t, c)
  1383. r, _ := http.NewRequest("GET", "/bla", nil)
  1384. r.RemoteAddr = "8.9.10.11"
  1385. r.Header.Set("X-Forwarded-For", "1.1.1.1")
  1386. v, err := s.maybeAuthenticate(r)
  1387. require.Nil(t, err)
  1388. require.Equal(t, "1.1.1.1", v.ip.String())
  1389. }
  1390. func TestServer_Visitor_XForwardedFor_Multiple(t *testing.T) {
  1391. c := newTestConfig(t)
  1392. c.BehindProxy = true
  1393. s := newTestServer(t, c)
  1394. r, _ := http.NewRequest("GET", "/bla", nil)
  1395. r.RemoteAddr = "8.9.10.11"
  1396. r.Header.Set("X-Forwarded-For", "1.2.3.4 , 2.4.4.2,234.5.2.1 ")
  1397. v, err := s.maybeAuthenticate(r)
  1398. require.Nil(t, err)
  1399. require.Equal(t, "234.5.2.1", v.ip.String())
  1400. }
  1401. func TestServer_PublishWhileUpdatingStatsWithLotsOfMessages(t *testing.T) {
  1402. count := 50000
  1403. c := newTestConfig(t)
  1404. c.TotalTopicLimit = 50001
  1405. c.CacheStartupQueries = "pragma journal_mode = WAL; pragma synchronous = normal; pragma temp_store = memory;"
  1406. s := newTestServer(t, c)
  1407. // Add lots of messages
  1408. log.Info("Adding %d messages", count)
  1409. start := time.Now()
  1410. messages := make([]*message, 0)
  1411. for i := 0; i < count; i++ {
  1412. topicID := fmt.Sprintf("topic%d", i)
  1413. _, err := s.topicsFromIDs(topicID) // Add topic to internal s.topics array
  1414. require.Nil(t, err)
  1415. messages = append(messages, newDefaultMessage(topicID, "some message"))
  1416. }
  1417. require.Nil(t, s.messageCache.addMessages(messages))
  1418. log.Info("Done: Adding %d messages; took %s", count, time.Since(start).Round(time.Millisecond))
  1419. // Update stats
  1420. statsChan := make(chan bool)
  1421. go func() {
  1422. log.Info("Updating stats")
  1423. start := time.Now()
  1424. s.execManager()
  1425. log.Info("Done: Updating stats; took %s", time.Since(start).Round(time.Millisecond))
  1426. statsChan <- true
  1427. }()
  1428. time.Sleep(50 * time.Millisecond) // Make sure it starts first
  1429. // Publish message (during stats update)
  1430. log.Info("Publishing message")
  1431. start = time.Now()
  1432. response := request(t, s, "PUT", "/mytopic", "some body", nil)
  1433. m := toMessage(t, response.Body.String())
  1434. assert.Equal(t, "some body", m.Message)
  1435. assert.True(t, time.Since(start) < 100*time.Millisecond)
  1436. log.Info("Done: Publishing message; took %s", time.Since(start).Round(time.Millisecond))
  1437. // Wait for all goroutines
  1438. <-statsChan
  1439. log.Info("Done: Waiting for all locks")
  1440. }
  1441. func newTestConfig(t *testing.T) *Config {
  1442. conf := NewConfig()
  1443. conf.BaseURL = "http://127.0.0.1:12345"
  1444. conf.CacheFile = filepath.Join(t.TempDir(), "cache.db")
  1445. conf.AttachmentCacheDir = t.TempDir()
  1446. return conf
  1447. }
  1448. func newTestConfigWithAuthFile(t *testing.T) *Config {
  1449. conf := newTestConfig(t)
  1450. conf.AuthFile = filepath.Join(t.TempDir(), "user.db")
  1451. return conf
  1452. }
  1453. func newTestServer(t *testing.T, config *Config) *Server {
  1454. server, err := New(config)
  1455. if err != nil {
  1456. t.Fatal(err)
  1457. }
  1458. return server
  1459. }
  1460. func request(t *testing.T, s *Server, method, url, body string, headers map[string]string) *httptest.ResponseRecorder {
  1461. rr := httptest.NewRecorder()
  1462. req, err := http.NewRequest(method, url, strings.NewReader(body))
  1463. if err != nil {
  1464. t.Fatal(err)
  1465. }
  1466. req.RemoteAddr = "9.9.9.9" // Used for tests
  1467. for k, v := range headers {
  1468. req.Header.Set(k, v)
  1469. }
  1470. s.handle(rr, req)
  1471. return rr
  1472. }
  1473. func subscribe(t *testing.T, s *Server, url string, rr *httptest.ResponseRecorder) context.CancelFunc {
  1474. ctx, cancel := context.WithCancel(context.Background())
  1475. req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
  1476. if err != nil {
  1477. t.Fatal(err)
  1478. }
  1479. done := make(chan bool)
  1480. go func() {
  1481. s.handle(rr, req)
  1482. done <- true
  1483. }()
  1484. cancelAndWaitForDone := func() {
  1485. time.Sleep(100 * time.Millisecond)
  1486. cancel()
  1487. <-done
  1488. }
  1489. time.Sleep(100 * time.Millisecond)
  1490. return cancelAndWaitForDone
  1491. }
  1492. func toMessages(t *testing.T, s string) []*message {
  1493. messages := make([]*message, 0)
  1494. scanner := bufio.NewScanner(strings.NewReader(s))
  1495. for scanner.Scan() {
  1496. messages = append(messages, toMessage(t, scanner.Text()))
  1497. }
  1498. return messages
  1499. }
  1500. func toMessage(t *testing.T, s string) *message {
  1501. var m message
  1502. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&m))
  1503. return &m
  1504. }
  1505. func toHTTPError(t *testing.T, s string) *errHTTP {
  1506. var e errHTTP
  1507. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&e))
  1508. return &e
  1509. }
  1510. func readAll(t *testing.T, rc io.ReadCloser) string {
  1511. b, err := io.ReadAll(rc)
  1512. if err != nil {
  1513. t.Fatal(err)
  1514. }
  1515. return string(b)
  1516. }