server_test.go 67 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876
  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(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. require.Equal(t, 200, response.Code)
  626. // Send messages from user without tier (phil)
  627. for i := 0; i < 5; i++ {
  628. response := request(t, s, "PUT", "/mytopic", "test", map[string]string{
  629. "Authorization": util.BasicAuth("phil", "phil"),
  630. })
  631. require.Equal(t, 200, response.Code)
  632. }
  633. // Send messages from user with tier
  634. for i := 0; i < 2; i++ {
  635. response := request(t, s, "PUT", "/mytopic", "test", map[string]string{
  636. "Authorization": util.BasicAuth("tieruser", "tieruser"),
  637. })
  638. require.Equal(t, 200, response.Code)
  639. }
  640. // User stats show 6 messages (for user without tier)
  641. response = request(t, s, "GET", "/v1/account", "", map[string]string{
  642. "Authorization": util.BasicAuth("phil", "phil"),
  643. })
  644. require.Equal(t, 200, response.Code)
  645. account, err := util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  646. require.Nil(t, err)
  647. require.Equal(t, int64(6), account.Stats.Messages)
  648. // User stats show 6 messages (for anonymous visitor)
  649. response = request(t, s, "GET", "/v1/account", "", nil)
  650. require.Equal(t, 200, response.Code)
  651. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  652. require.Nil(t, err)
  653. require.Equal(t, int64(6), account.Stats.Messages)
  654. // User stats show 2 messages (for user with tier)
  655. response = request(t, s, "GET", "/v1/account", "", map[string]string{
  656. "Authorization": util.BasicAuth("tieruser", "tieruser"),
  657. })
  658. require.Equal(t, 200, response.Code)
  659. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  660. require.Nil(t, err)
  661. require.Equal(t, int64(2), account.Stats.Messages)
  662. // Wait for stats resetter to run
  663. time.Sleep(2200 * time.Millisecond)
  664. // User stats show 0 messages now!
  665. response = request(t, s, "GET", "/v1/account", "", map[string]string{
  666. "Authorization": util.BasicAuth("phil", "phil"),
  667. })
  668. require.Equal(t, 200, response.Code)
  669. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  670. require.Nil(t, err)
  671. require.Equal(t, int64(0), account.Stats.Messages)
  672. // Since this is a user without a tier, the anonymous user should have the same stats
  673. response = request(t, s, "GET", "/v1/account", "", nil)
  674. require.Equal(t, 200, response.Code)
  675. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  676. require.Nil(t, err)
  677. require.Equal(t, int64(0), account.Stats.Messages)
  678. // User stats show 0 messages (for user with tier)
  679. response = request(t, s, "GET", "/v1/account", "", map[string]string{
  680. "Authorization": util.BasicAuth("tieruser", "tieruser"),
  681. })
  682. require.Equal(t, 200, response.Code)
  683. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  684. require.Nil(t, err)
  685. require.Equal(t, int64(0), account.Stats.Messages)
  686. }
  687. func TestServer_StatsResetter_MessageLimiter_EmailsLimiter(t *testing.T) {
  688. // This tests that the messageLimiter (the only fixed limiter) and the emailsLimiter (token bucket)
  689. // is reset by the stats resetter
  690. c := newTestConfigWithAuthFile(t)
  691. s := newTestServer(t, c)
  692. s.smtpSender = &testMailer{}
  693. // Publish some messages, and check stats
  694. for i := 0; i < 3; i++ {
  695. response := request(t, s, "PUT", "/mytopic", "test", nil)
  696. require.Equal(t, 200, response.Code)
  697. }
  698. response := request(t, s, "PUT", "/mytopic", "test", map[string]string{
  699. "Email": "test@email.com",
  700. })
  701. require.Equal(t, 200, response.Code)
  702. rr := request(t, s, "GET", "/v1/account", "", nil)
  703. require.Equal(t, 200, rr.Code)
  704. account, err := util.UnmarshalJSON[apiAccountResponse](io.NopCloser(rr.Body))
  705. require.Nil(t, err)
  706. require.Equal(t, int64(4), account.Stats.Messages)
  707. require.Equal(t, int64(1), account.Stats.Emails)
  708. v := s.visitor(netip.MustParseAddr("9.9.9.9"), nil)
  709. require.Equal(t, int64(4), v.Stats().Messages)
  710. require.Equal(t, int64(4), v.messagesLimiter.Value())
  711. require.Equal(t, int64(1), v.Stats().Emails)
  712. require.Equal(t, int64(1), v.emailsLimiter.Value())
  713. // Reset stats and check again
  714. s.resetStats()
  715. rr = request(t, s, "GET", "/v1/account", "", nil)
  716. require.Equal(t, 200, rr.Code)
  717. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(rr.Body))
  718. require.Nil(t, err)
  719. require.Equal(t, int64(0), account.Stats.Messages)
  720. require.Equal(t, int64(0), account.Stats.Emails)
  721. v = s.visitor(netip.MustParseAddr("9.9.9.9"), nil)
  722. require.Equal(t, int64(0), v.Stats().Messages)
  723. require.Equal(t, int64(0), v.messagesLimiter.Value())
  724. require.Equal(t, int64(0), v.Stats().Emails)
  725. require.Equal(t, int64(0), v.emailsLimiter.Value())
  726. }
  727. func TestServer_DailyMessageQuotaFromDatabase(t *testing.T) {
  728. // This tests that the daily message quota is prefilled originally from the database,
  729. // if the visitor is unknown
  730. c := newTestConfigWithAuthFile(t)
  731. s := newTestServer(t, c)
  732. var err error
  733. s.userManager, err = user.NewManagerWithStatsInterval(c.AuthFile, c.AuthStartupQueries, c.AuthDefault, 100*time.Millisecond)
  734. require.Nil(t, err)
  735. // Create user, and update it with some message and email stats
  736. require.Nil(t, s.userManager.CreateTier(&user.Tier{
  737. Code: "test",
  738. }))
  739. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  740. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  741. u, err := s.userManager.User("phil")
  742. require.Nil(t, err)
  743. s.userManager.EnqueueStats(u.ID, &user.Stats{
  744. Messages: 123456,
  745. Emails: 999,
  746. })
  747. time.Sleep(400 * time.Millisecond)
  748. // Get account and verify stats are read from the DB, and that the visitor also has these stats
  749. rr := request(t, s, "GET", "/v1/account", "", map[string]string{
  750. "Authorization": util.BasicAuth("phil", "phil"),
  751. })
  752. require.Equal(t, 200, rr.Code)
  753. account, err := util.UnmarshalJSON[apiAccountResponse](io.NopCloser(rr.Body))
  754. require.Nil(t, err)
  755. require.Equal(t, int64(123456), account.Stats.Messages)
  756. require.Equal(t, int64(999), account.Stats.Emails)
  757. v := s.visitor(netip.MustParseAddr("9.9.9.9"), u)
  758. require.Equal(t, int64(123456), v.Stats().Messages)
  759. require.Equal(t, int64(123456), v.messagesLimiter.Value())
  760. require.Equal(t, int64(999), v.Stats().Emails)
  761. require.Equal(t, int64(999), v.emailsLimiter.Value())
  762. }
  763. type testMailer struct {
  764. count int
  765. mu sync.Mutex
  766. }
  767. func (t *testMailer) Send(v *visitor, m *message, to string) error {
  768. t.mu.Lock()
  769. defer t.mu.Unlock()
  770. t.count++
  771. return nil
  772. }
  773. func (t *testMailer) Counts() (total int64, success int64, failure int64) {
  774. return 0, 0, 0
  775. }
  776. func (t *testMailer) Count() int {
  777. t.mu.Lock()
  778. defer t.mu.Unlock()
  779. return t.count
  780. }
  781. func TestServer_PublishTooRequests_Defaults(t *testing.T) {
  782. s := newTestServer(t, newTestConfig(t))
  783. for i := 0; i < 60; i++ {
  784. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), nil)
  785. require.Equal(t, 200, response.Code)
  786. }
  787. response := request(t, s, "PUT", "/mytopic", "message", nil)
  788. require.Equal(t, 429, response.Code)
  789. }
  790. func TestServer_PublishTooRequests_Defaults_ExemptHosts(t *testing.T) {
  791. c := newTestConfig(t)
  792. c.VisitorRequestExemptIPAddrs = []netip.Prefix{netip.MustParsePrefix("9.9.9.9/32")} // see request()
  793. s := newTestServer(t, c)
  794. for i := 0; i < 65; i++ { // > 60
  795. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), nil)
  796. require.Equal(t, 200, response.Code)
  797. }
  798. }
  799. func TestServer_PublishTooRequests_ShortReplenish(t *testing.T) {
  800. c := newTestConfig(t)
  801. c.VisitorRequestLimitBurst = 60
  802. c.VisitorRequestLimitReplenish = time.Second
  803. s := newTestServer(t, c)
  804. for i := 0; i < 60; i++ {
  805. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), nil)
  806. require.Equal(t, 200, response.Code)
  807. }
  808. response := request(t, s, "PUT", "/mytopic", "message", nil)
  809. require.Equal(t, 429, response.Code)
  810. time.Sleep(1020 * time.Millisecond)
  811. response = request(t, s, "PUT", "/mytopic", "message", nil)
  812. require.Equal(t, 200, response.Code)
  813. }
  814. func TestServer_PublishTooManyEmails_Defaults(t *testing.T) {
  815. s := newTestServer(t, newTestConfig(t))
  816. s.smtpSender = &testMailer{}
  817. for i := 0; i < 16; i++ {
  818. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  819. "E-Mail": "test@example.com",
  820. })
  821. require.Equal(t, 200, response.Code)
  822. }
  823. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  824. "E-Mail": "test@example.com",
  825. })
  826. require.Equal(t, 429, response.Code)
  827. }
  828. func TestServer_PublishTooManyEmails_Replenish(t *testing.T) {
  829. c := newTestConfig(t)
  830. c.VisitorEmailLimitReplenish = 500 * time.Millisecond
  831. s := newTestServer(t, c)
  832. s.smtpSender = &testMailer{}
  833. for i := 0; i < 16; i++ {
  834. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  835. "E-Mail": "test@example.com",
  836. })
  837. require.Equal(t, 200, response.Code)
  838. }
  839. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  840. "E-Mail": "test@example.com",
  841. })
  842. require.Equal(t, 429, response.Code)
  843. time.Sleep(510 * time.Millisecond)
  844. response = request(t, s, "PUT", "/mytopic", "this should be okay again too many", map[string]string{
  845. "E-Mail": "test@example.com",
  846. })
  847. require.Equal(t, 200, response.Code)
  848. response = request(t, s, "PUT", "/mytopic", "and bad again", map[string]string{
  849. "E-Mail": "test@example.com",
  850. })
  851. require.Equal(t, 429, response.Code)
  852. }
  853. func TestServer_PublishDelayedEmail_Fail(t *testing.T) {
  854. s := newTestServer(t, newTestConfig(t))
  855. s.smtpSender = &testMailer{}
  856. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  857. "E-Mail": "test@example.com",
  858. "Delay": "20 min",
  859. })
  860. require.Equal(t, 400, response.Code)
  861. }
  862. func TestServer_PublishEmailNoMailer_Fail(t *testing.T) {
  863. s := newTestServer(t, newTestConfig(t))
  864. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  865. "E-Mail": "test@example.com",
  866. })
  867. require.Equal(t, 400, response.Code)
  868. }
  869. func TestServer_UnifiedPushDiscovery(t *testing.T) {
  870. s := newTestServer(t, newTestConfig(t))
  871. response := request(t, s, "GET", "/mytopic?up=1", "", nil)
  872. require.Equal(t, 200, response.Code)
  873. require.Equal(t, `{"unifiedpush":{"version":1}}`+"\n", response.Body.String())
  874. }
  875. func TestServer_PublishUnifiedPushBinary_AndPoll(t *testing.T) {
  876. b := make([]byte, 12) // Max length
  877. _, err := rand.Read(b)
  878. require.Nil(t, err)
  879. s := newTestServer(t, newTestConfig(t))
  880. response := request(t, s, "PUT", "/mytopic?up=1", string(b), nil)
  881. require.Equal(t, 200, response.Code)
  882. m := toMessage(t, response.Body.String())
  883. require.Equal(t, "base64", m.Encoding)
  884. b2, err := base64.StdEncoding.DecodeString(m.Message)
  885. require.Nil(t, err)
  886. require.Equal(t, b, b2)
  887. response = request(t, s, "GET", "/mytopic/json?poll=1", string(b), nil)
  888. require.Equal(t, 200, response.Code)
  889. m = toMessage(t, response.Body.String())
  890. require.Equal(t, "base64", m.Encoding)
  891. b2, err = base64.StdEncoding.DecodeString(m.Message)
  892. require.Nil(t, err)
  893. require.Equal(t, b, b2)
  894. }
  895. func TestServer_PublishUnifiedPushBinary_Truncated(t *testing.T) {
  896. b := make([]byte, 5000) // Longer than max length
  897. _, err := rand.Read(b)
  898. require.Nil(t, err)
  899. s := newTestServer(t, newTestConfig(t))
  900. response := request(t, s, "PUT", "/mytopic?up=1", string(b), nil)
  901. require.Equal(t, 200, response.Code)
  902. m := toMessage(t, response.Body.String())
  903. require.Equal(t, "base64", m.Encoding)
  904. b2, err := base64.StdEncoding.DecodeString(m.Message)
  905. require.Nil(t, err)
  906. require.Equal(t, 4096, len(b2))
  907. require.Equal(t, b[:4096], b2)
  908. }
  909. func TestServer_PublishUnifiedPushText(t *testing.T) {
  910. s := newTestServer(t, newTestConfig(t))
  911. response := request(t, s, "PUT", "/mytopic?up=1", "this is a unifiedpush text message", nil)
  912. require.Equal(t, 200, response.Code)
  913. m := toMessage(t, response.Body.String())
  914. require.Equal(t, "", m.Encoding)
  915. require.Equal(t, "this is a unifiedpush text message", m.Message)
  916. }
  917. func TestServer_MatrixGateway_Discovery_Success(t *testing.T) {
  918. s := newTestServer(t, newTestConfig(t))
  919. response := request(t, s, "GET", "/_matrix/push/v1/notify", "", nil)
  920. require.Equal(t, 200, response.Code)
  921. require.Equal(t, `{"unifiedpush":{"gateway":"matrix"}}`+"\n", response.Body.String())
  922. }
  923. func TestServer_MatrixGateway_Discovery_Failure_Unconfigured(t *testing.T) {
  924. c := newTestConfig(t)
  925. c.BaseURL = ""
  926. s := newTestServer(t, c)
  927. response := request(t, s, "GET", "/_matrix/push/v1/notify", "", nil)
  928. require.Equal(t, 500, response.Code)
  929. err := toHTTPError(t, response.Body.String())
  930. require.Equal(t, 50003, err.Code)
  931. }
  932. func TestServer_MatrixGateway_Push_Success(t *testing.T) {
  933. s := newTestServer(t, newTestConfig(t))
  934. notification := `{"notification":{"devices":[{"pushkey":"http://127.0.0.1:12345/mytopic?up=1"}]}}`
  935. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  936. require.Equal(t, 200, response.Code)
  937. require.Equal(t, `{"rejected":[]}`+"\n", response.Body.String())
  938. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  939. require.Equal(t, 200, response.Code)
  940. m := toMessage(t, response.Body.String())
  941. require.Equal(t, notification, m.Message)
  942. }
  943. func TestServer_MatrixGateway_Push_Failure_InvalidPushkey(t *testing.T) {
  944. s := newTestServer(t, newTestConfig(t))
  945. notification := `{"notification":{"devices":[{"pushkey":"http://wrong-base-url.com/mytopic?up=1"}]}}`
  946. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  947. require.Equal(t, 200, response.Code)
  948. require.Equal(t, `{"rejected":["http://wrong-base-url.com/mytopic?up=1"]}`+"\n", response.Body.String())
  949. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  950. require.Equal(t, 200, response.Code)
  951. require.Equal(t, "", response.Body.String()) // Empty!
  952. }
  953. func TestServer_MatrixGateway_Push_Failure_EverythingIsWrong(t *testing.T) {
  954. s := newTestServer(t, newTestConfig(t))
  955. notification := `{"message":"this is not really a Matrix message"}`
  956. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  957. require.Equal(t, 400, response.Code)
  958. err := toHTTPError(t, response.Body.String())
  959. require.Equal(t, 40019, err.Code)
  960. require.Equal(t, 400, err.HTTPCode)
  961. }
  962. func TestServer_MatrixGateway_Push_Failure_Unconfigured(t *testing.T) {
  963. c := newTestConfig(t)
  964. c.BaseURL = ""
  965. s := newTestServer(t, c)
  966. notification := `{"notification":{"devices":[{"pushkey":"http://127.0.0.1:12345/mytopic?up=1"}]}}`
  967. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  968. require.Equal(t, 500, response.Code)
  969. err := toHTTPError(t, response.Body.String())
  970. require.Equal(t, 50003, err.Code)
  971. require.Equal(t, 500, err.HTTPCode)
  972. }
  973. func TestServer_PublishActions_AndPoll(t *testing.T) {
  974. s := newTestServer(t, newTestConfig(t))
  975. response := request(t, s, "PUT", "/mytopic", "my message", map[string]string{
  976. "Actions": "view, Open portal, https://home.nest.com/; http, Turn down, https://api.nest.com/device/XZ1D2, body=target_temp_f=65",
  977. })
  978. require.Equal(t, 200, response.Code)
  979. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  980. require.Equal(t, 200, response.Code)
  981. m := toMessage(t, response.Body.String())
  982. require.Equal(t, 2, len(m.Actions))
  983. require.Equal(t, "view", m.Actions[0].Action)
  984. require.Equal(t, "Open portal", m.Actions[0].Label)
  985. require.Equal(t, "https://home.nest.com/", m.Actions[0].URL)
  986. require.Equal(t, "http", m.Actions[1].Action)
  987. require.Equal(t, "Turn down", m.Actions[1].Label)
  988. require.Equal(t, "https://api.nest.com/device/XZ1D2", m.Actions[1].URL)
  989. require.Equal(t, "target_temp_f=65", m.Actions[1].Body)
  990. }
  991. func TestServer_PublishAsJSON(t *testing.T) {
  992. s := newTestServer(t, newTestConfig(t))
  993. body := `{"topic":"mytopic","message":"A message","title":"a title\nwith lines","tags":["tag1","tag 2"],` +
  994. `"not-a-thing":"ok", "attach":"http://google.com","filename":"google.pdf", "click":"http://ntfy.sh","priority":4,` +
  995. `"icon":"https://ntfy.sh/static/img/ntfy.png", "delay":"30min"}`
  996. response := request(t, s, "PUT", "/", body, nil)
  997. require.Equal(t, 200, response.Code)
  998. m := toMessage(t, response.Body.String())
  999. require.Equal(t, "mytopic", m.Topic)
  1000. require.Equal(t, "A message", m.Message)
  1001. require.Equal(t, "a title\nwith lines", m.Title)
  1002. require.Equal(t, []string{"tag1", "tag 2"}, m.Tags)
  1003. require.Equal(t, "http://google.com", m.Attachment.URL)
  1004. require.Equal(t, "google.pdf", m.Attachment.Name)
  1005. require.Equal(t, "http://ntfy.sh", m.Click)
  1006. require.Equal(t, "https://ntfy.sh/static/img/ntfy.png", m.Icon)
  1007. require.Equal(t, 4, m.Priority)
  1008. require.True(t, m.Time > time.Now().Unix()+29*60)
  1009. require.True(t, m.Time < time.Now().Unix()+31*60)
  1010. }
  1011. func TestServer_PublishAsJSON_WithEmail(t *testing.T) {
  1012. mailer := &testMailer{}
  1013. s := newTestServer(t, newTestConfig(t))
  1014. s.smtpSender = mailer
  1015. body := `{"topic":"mytopic","message":"A message","email":"phil@example.com"}`
  1016. response := request(t, s, "PUT", "/", body, nil)
  1017. require.Equal(t, 200, response.Code)
  1018. time.Sleep(100 * time.Millisecond) // E-Mail publishing happens in a Go routine
  1019. m := toMessage(t, response.Body.String())
  1020. require.Equal(t, "mytopic", m.Topic)
  1021. require.Equal(t, "A message", m.Message)
  1022. require.Equal(t, 1, mailer.Count())
  1023. }
  1024. func TestServer_PublishAsJSON_WithActions(t *testing.T) {
  1025. s := newTestServer(t, newTestConfig(t))
  1026. body := `{
  1027. "topic":"mytopic",
  1028. "message":"A message",
  1029. "actions": [
  1030. {
  1031. "action": "view",
  1032. "label": "Open portal",
  1033. "url": "https://home.nest.com/"
  1034. },
  1035. {
  1036. "action": "http",
  1037. "label": "Turn down",
  1038. "url": "https://api.nest.com/device/XZ1D2",
  1039. "body": "target_temp_f=65"
  1040. }
  1041. ]
  1042. }`
  1043. response := request(t, s, "POST", "/", body, nil)
  1044. require.Equal(t, 200, response.Code)
  1045. m := toMessage(t, response.Body.String())
  1046. require.Equal(t, "mytopic", m.Topic)
  1047. require.Equal(t, "A message", m.Message)
  1048. require.Equal(t, 2, len(m.Actions))
  1049. require.Equal(t, "view", m.Actions[0].Action)
  1050. require.Equal(t, "Open portal", m.Actions[0].Label)
  1051. require.Equal(t, "https://home.nest.com/", m.Actions[0].URL)
  1052. require.Equal(t, "http", m.Actions[1].Action)
  1053. require.Equal(t, "Turn down", m.Actions[1].Label)
  1054. require.Equal(t, "https://api.nest.com/device/XZ1D2", m.Actions[1].URL)
  1055. require.Equal(t, "target_temp_f=65", m.Actions[1].Body)
  1056. }
  1057. func TestServer_PublishAsJSON_Invalid(t *testing.T) {
  1058. s := newTestServer(t, newTestConfig(t))
  1059. body := `{"topic":"mytopic",INVALID`
  1060. response := request(t, s, "PUT", "/", body, nil)
  1061. require.Equal(t, 400, response.Code)
  1062. }
  1063. func TestServer_PublishWithTierBasedMessageLimitAndExpiry(t *testing.T) {
  1064. c := newTestConfigWithAuthFile(t)
  1065. s := newTestServer(t, c)
  1066. // Create tier with certain limits
  1067. require.Nil(t, s.userManager.CreateTier(&user.Tier{
  1068. Code: "test",
  1069. MessageLimit: 5,
  1070. MessageExpiryDuration: -5 * time.Second, // Second, what a hack!
  1071. }))
  1072. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  1073. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  1074. // Publish to reach message limit
  1075. for i := 0; i < 5; i++ {
  1076. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("this is message %d", i+1), map[string]string{
  1077. "Authorization": util.BasicAuth("phil", "phil"),
  1078. })
  1079. require.Equal(t, 200, response.Code)
  1080. msg := toMessage(t, response.Body.String())
  1081. require.True(t, msg.Expires < time.Now().Unix()+5)
  1082. }
  1083. response := request(t, s, "PUT", "/mytopic", "this is too much", map[string]string{
  1084. "Authorization": util.BasicAuth("phil", "phil"),
  1085. })
  1086. require.Equal(t, 429, response.Code)
  1087. // Run pruning and see if they are gone
  1088. s.execManager()
  1089. response = request(t, s, "GET", "/mytopic/json?poll=1", "", map[string]string{
  1090. "Authorization": util.BasicAuth("phil", "phil"),
  1091. })
  1092. require.Equal(t, 200, response.Code)
  1093. require.Empty(t, response.Body)
  1094. }
  1095. func TestServer_PublishAttachment(t *testing.T) {
  1096. content := util.RandomString(5000) // > 4096
  1097. s := newTestServer(t, newTestConfig(t))
  1098. response := request(t, s, "PUT", "/mytopic", content, nil)
  1099. msg := toMessage(t, response.Body.String())
  1100. require.Equal(t, "attachment.txt", msg.Attachment.Name)
  1101. require.Equal(t, "text/plain; charset=utf-8", msg.Attachment.Type)
  1102. require.Equal(t, int64(5000), msg.Attachment.Size)
  1103. require.GreaterOrEqual(t, msg.Attachment.Expires, time.Now().Add(179*time.Minute).Unix()) // Almost 3 hours
  1104. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1105. require.Equal(t, netip.Addr{}, msg.Sender) // Should never be returned
  1106. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  1107. // GET
  1108. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1109. response = request(t, s, "GET", path, "", nil)
  1110. require.Equal(t, 200, response.Code)
  1111. require.Equal(t, "5000", response.Header().Get("Content-Length"))
  1112. require.Equal(t, content, response.Body.String())
  1113. // HEAD
  1114. response = request(t, s, "HEAD", path, "", nil)
  1115. require.Equal(t, 200, response.Code)
  1116. require.Equal(t, "5000", response.Header().Get("Content-Length"))
  1117. require.Equal(t, "", response.Body.String())
  1118. // Slightly unrelated cross-test: make sure we add an owner for internal attachments
  1119. size, err := s.messageCache.AttachmentBytesUsedBySender("9.9.9.9") // See request()
  1120. require.Nil(t, err)
  1121. require.Equal(t, int64(5000), size)
  1122. }
  1123. func TestServer_PublishAttachmentShortWithFilename(t *testing.T) {
  1124. c := newTestConfig(t)
  1125. c.BehindProxy = true
  1126. s := newTestServer(t, c)
  1127. content := "this is an ATTACHMENT"
  1128. response := request(t, s, "PUT", "/mytopic?f=myfile.txt", content, map[string]string{
  1129. "X-Forwarded-For": "1.2.3.4",
  1130. })
  1131. msg := toMessage(t, response.Body.String())
  1132. require.Equal(t, "myfile.txt", msg.Attachment.Name)
  1133. require.Equal(t, "text/plain; charset=utf-8", msg.Attachment.Type)
  1134. require.Equal(t, int64(21), msg.Attachment.Size)
  1135. require.GreaterOrEqual(t, msg.Attachment.Expires, time.Now().Add(3*time.Hour).Unix())
  1136. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1137. require.Equal(t, netip.Addr{}, msg.Sender) // Should never be returned
  1138. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  1139. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1140. response = request(t, s, "GET", path, "", nil)
  1141. require.Equal(t, 200, response.Code)
  1142. require.Equal(t, "21", response.Header().Get("Content-Length"))
  1143. require.Equal(t, content, response.Body.String())
  1144. // Slightly unrelated cross-test: make sure we add an owner for internal attachments
  1145. size, err := s.messageCache.AttachmentBytesUsedBySender("1.2.3.4")
  1146. require.Nil(t, err)
  1147. require.Equal(t, int64(21), size)
  1148. }
  1149. func TestServer_PublishAttachmentExternalWithoutFilename(t *testing.T) {
  1150. s := newTestServer(t, newTestConfig(t))
  1151. response := request(t, s, "PUT", "/mytopic", "", map[string]string{
  1152. "Attach": "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg",
  1153. })
  1154. msg := toMessage(t, response.Body.String())
  1155. require.Equal(t, "You received a file: Pink_flower.jpg", msg.Message)
  1156. require.Equal(t, "Pink_flower.jpg", msg.Attachment.Name)
  1157. require.Equal(t, "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg", msg.Attachment.URL)
  1158. require.Equal(t, "", msg.Attachment.Type)
  1159. require.Equal(t, int64(0), msg.Attachment.Size)
  1160. require.Equal(t, int64(0), msg.Attachment.Expires)
  1161. require.Equal(t, netip.Addr{}, msg.Sender)
  1162. // Slightly unrelated cross-test: make sure we don't add an owner for external attachments
  1163. size, err := s.messageCache.AttachmentBytesUsedBySender("127.0.0.1")
  1164. require.Nil(t, err)
  1165. require.Equal(t, int64(0), size)
  1166. }
  1167. func TestServer_PublishAttachmentExternalWithFilename(t *testing.T) {
  1168. s := newTestServer(t, newTestConfig(t))
  1169. response := request(t, s, "PUT", "/mytopic", "This is a custom message", map[string]string{
  1170. "X-Attach": "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg",
  1171. "File": "some file.jpg",
  1172. })
  1173. msg := toMessage(t, response.Body.String())
  1174. require.Equal(t, "This is a custom message", msg.Message)
  1175. require.Equal(t, "some file.jpg", msg.Attachment.Name)
  1176. require.Equal(t, "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg", msg.Attachment.URL)
  1177. require.Equal(t, "", msg.Attachment.Type)
  1178. require.Equal(t, int64(0), msg.Attachment.Size)
  1179. require.Equal(t, int64(0), msg.Attachment.Expires)
  1180. require.Equal(t, netip.Addr{}, msg.Sender)
  1181. }
  1182. func TestServer_PublishAttachmentBadURL(t *testing.T) {
  1183. s := newTestServer(t, newTestConfig(t))
  1184. response := request(t, s, "PUT", "/mytopic?a=not+a+URL", "", nil)
  1185. err := toHTTPError(t, response.Body.String())
  1186. require.Equal(t, 400, response.Code)
  1187. require.Equal(t, 400, err.HTTPCode)
  1188. require.Equal(t, 40013, err.Code)
  1189. }
  1190. func TestServer_PublishAttachmentTooLargeContentLength(t *testing.T) {
  1191. content := util.RandomString(5000) // > 4096
  1192. s := newTestServer(t, newTestConfig(t))
  1193. response := request(t, s, "PUT", "/mytopic", content, map[string]string{
  1194. "Content-Length": "20000000",
  1195. })
  1196. err := toHTTPError(t, response.Body.String())
  1197. require.Equal(t, 413, response.Code)
  1198. require.Equal(t, 413, err.HTTPCode)
  1199. require.Equal(t, 41301, err.Code)
  1200. }
  1201. func TestServer_PublishAttachmentTooLargeBodyAttachmentFileSizeLimit(t *testing.T) {
  1202. content := util.RandomString(5001) // > 5000, see below
  1203. c := newTestConfig(t)
  1204. c.AttachmentFileSizeLimit = 5000
  1205. s := newTestServer(t, c)
  1206. response := request(t, s, "PUT", "/mytopic", content, nil)
  1207. err := toHTTPError(t, response.Body.String())
  1208. require.Equal(t, 413, response.Code)
  1209. require.Equal(t, 413, err.HTTPCode)
  1210. require.Equal(t, 41301, err.Code)
  1211. }
  1212. func TestServer_PublishAttachmentExpiryBeforeDelivery(t *testing.T) {
  1213. c := newTestConfig(t)
  1214. c.AttachmentExpiryDuration = 10 * time.Minute
  1215. s := newTestServer(t, c)
  1216. response := request(t, s, "PUT", "/mytopic", util.RandomString(5000), map[string]string{
  1217. "Delay": "11 min", // > AttachmentExpiryDuration
  1218. })
  1219. err := toHTTPError(t, response.Body.String())
  1220. require.Equal(t, 400, response.Code)
  1221. require.Equal(t, 400, err.HTTPCode)
  1222. require.Equal(t, 40015, err.Code)
  1223. }
  1224. func TestServer_PublishAttachmentTooLargeBodyVisitorAttachmentTotalSizeLimit(t *testing.T) {
  1225. c := newTestConfig(t)
  1226. c.VisitorAttachmentTotalSizeLimit = 10000
  1227. s := newTestServer(t, c)
  1228. response := request(t, s, "PUT", "/mytopic", util.RandomString(5000), nil)
  1229. msg := toMessage(t, response.Body.String())
  1230. require.Equal(t, 200, response.Code)
  1231. require.Equal(t, "You received a file: attachment.txt", msg.Message)
  1232. require.Equal(t, int64(5000), msg.Attachment.Size)
  1233. content := util.RandomString(5001) // 5000+5001 > , see below
  1234. response = request(t, s, "PUT", "/mytopic", content, nil)
  1235. err := toHTTPError(t, response.Body.String())
  1236. require.Equal(t, 413, response.Code)
  1237. require.Equal(t, 413, err.HTTPCode)
  1238. require.Equal(t, 41301, err.Code)
  1239. }
  1240. func TestServer_PublishAttachmentAndExpire(t *testing.T) {
  1241. content := util.RandomString(5000) // > 4096
  1242. c := newTestConfig(t)
  1243. c.AttachmentExpiryDuration = time.Millisecond // Hack
  1244. s := newTestServer(t, c)
  1245. // Publish and make sure we can retrieve it
  1246. response := request(t, s, "PUT", "/mytopic", content, nil)
  1247. msg := toMessage(t, response.Body.String())
  1248. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1249. file := filepath.Join(s.config.AttachmentCacheDir, msg.ID)
  1250. require.FileExists(t, file)
  1251. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1252. response = request(t, s, "GET", path, "", nil)
  1253. require.Equal(t, 200, response.Code)
  1254. require.Equal(t, content, response.Body.String())
  1255. // Prune and makes sure it's gone
  1256. time.Sleep(time.Second) // Sigh ...
  1257. s.execManager()
  1258. require.NoFileExists(t, file)
  1259. response = request(t, s, "GET", path, "", nil)
  1260. require.Equal(t, 404, response.Code)
  1261. }
  1262. func TestServer_PublishAttachmentWithTierBasedExpiry(t *testing.T) {
  1263. content := util.RandomString(5000) // > 4096
  1264. c := newTestConfigWithAuthFile(t)
  1265. c.AttachmentExpiryDuration = time.Millisecond // Hack
  1266. s := newTestServer(t, c)
  1267. // Create tier with certain limits
  1268. sevenDays := time.Duration(604800) * time.Second
  1269. require.Nil(t, s.userManager.CreateTier(&user.Tier{
  1270. Code: "test",
  1271. MessageLimit: 10,
  1272. MessageExpiryDuration: sevenDays,
  1273. AttachmentFileSizeLimit: 50_000,
  1274. AttachmentTotalSizeLimit: 200_000,
  1275. AttachmentExpiryDuration: sevenDays, // 7 days
  1276. AttachmentBandwidthLimit: 100000,
  1277. }))
  1278. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  1279. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  1280. // Publish and make sure we can retrieve it
  1281. response := request(t, s, "PUT", "/mytopic", content, map[string]string{
  1282. "Authorization": util.BasicAuth("phil", "phil"),
  1283. })
  1284. require.Equal(t, 200, response.Code)
  1285. msg := toMessage(t, response.Body.String())
  1286. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1287. require.True(t, msg.Attachment.Expires > time.Now().Add(sevenDays-30*time.Second).Unix())
  1288. require.True(t, msg.Expires > time.Now().Add(sevenDays-30*time.Second).Unix())
  1289. file := filepath.Join(s.config.AttachmentCacheDir, msg.ID)
  1290. require.FileExists(t, file)
  1291. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1292. response = request(t, s, "GET", path, "", nil)
  1293. require.Equal(t, 200, response.Code)
  1294. require.Equal(t, content, response.Body.String())
  1295. // Prune and makes sure it's still there
  1296. time.Sleep(time.Second) // Sigh ...
  1297. s.execManager()
  1298. require.FileExists(t, file)
  1299. response = request(t, s, "GET", path, "", nil)
  1300. require.Equal(t, 200, response.Code)
  1301. }
  1302. func TestServer_PublishAttachmentWithTierBasedBandwidthLimit(t *testing.T) {
  1303. content := util.RandomString(5000) // > 4096
  1304. c := newTestConfigWithAuthFile(t)
  1305. s := newTestServer(t, c)
  1306. // Create tier with certain limits
  1307. require.Nil(t, s.userManager.CreateTier(&user.Tier{
  1308. Code: "test",
  1309. MessageLimit: 10,
  1310. MessageExpiryDuration: time.Hour,
  1311. AttachmentFileSizeLimit: 50_000,
  1312. AttachmentTotalSizeLimit: 200_000,
  1313. AttachmentExpiryDuration: time.Hour,
  1314. AttachmentBandwidthLimit: 14000, // < 3x5000 bytes -> enough for one upload, one download
  1315. }))
  1316. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  1317. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  1318. // Publish and make sure we can retrieve it
  1319. rr := request(t, s, "PUT", "/mytopic", content, map[string]string{
  1320. "Authorization": util.BasicAuth("phil", "phil"),
  1321. })
  1322. require.Equal(t, 200, rr.Code)
  1323. msg := toMessage(t, rr.Body.String())
  1324. // Retrieve it (first time succeeds)
  1325. rr = request(t, s, "GET", "/file/"+msg.ID, content, map[string]string{
  1326. "Authorization": util.BasicAuth("phil", "phil"),
  1327. })
  1328. require.Equal(t, 200, rr.Code)
  1329. require.Equal(t, content, rr.Body.String())
  1330. // Retrieve it AGAIN (fails, due to bandwidth limit)
  1331. rr = request(t, s, "GET", "/file/"+msg.ID, content, map[string]string{
  1332. "Authorization": util.BasicAuth("phil", "phil"),
  1333. })
  1334. require.Equal(t, 429, rr.Code)
  1335. }
  1336. func TestServer_PublishAttachmentWithTierBasedLimits(t *testing.T) {
  1337. smallFile := util.RandomString(20_000)
  1338. largeFile := util.RandomString(50_000)
  1339. c := newTestConfigWithAuthFile(t)
  1340. c.AttachmentFileSizeLimit = 20_000
  1341. c.VisitorAttachmentTotalSizeLimit = 40_000
  1342. s := newTestServer(t, c)
  1343. // Create tier with certain limits
  1344. require.Nil(t, s.userManager.CreateTier(&user.Tier{
  1345. Code: "test",
  1346. MessageLimit: 100,
  1347. AttachmentFileSizeLimit: 50_000,
  1348. AttachmentTotalSizeLimit: 200_000,
  1349. AttachmentExpiryDuration: 30 * time.Second,
  1350. AttachmentBandwidthLimit: 1000000,
  1351. }))
  1352. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  1353. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  1354. // Publish small file as anonymous
  1355. response := request(t, s, "PUT", "/mytopic", smallFile, nil)
  1356. msg := toMessage(t, response.Body.String())
  1357. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1358. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  1359. // Publish large file as anonymous
  1360. response = request(t, s, "PUT", "/mytopic", largeFile, nil)
  1361. require.Equal(t, 413, response.Code)
  1362. require.Equal(t, 41301, toHTTPError(t, response.Body.String()).Code)
  1363. // Publish too large file as phil
  1364. response = request(t, s, "PUT", "/mytopic", largeFile+" a few more bytes", map[string]string{
  1365. "Authorization": util.BasicAuth("phil", "phil"),
  1366. })
  1367. require.Equal(t, 413, response.Code)
  1368. require.Equal(t, 41301, toHTTPError(t, response.Body.String()).Code)
  1369. // Publish large file as phil (4x)
  1370. for i := 0; i < 4; i++ {
  1371. response = request(t, s, "PUT", "/mytopic", largeFile, map[string]string{
  1372. "Authorization": util.BasicAuth("phil", "phil"),
  1373. })
  1374. require.Equal(t, 200, response.Code)
  1375. msg = toMessage(t, response.Body.String())
  1376. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1377. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  1378. }
  1379. response = request(t, s, "PUT", "/mytopic", largeFile, map[string]string{
  1380. "Authorization": util.BasicAuth("phil", "phil"),
  1381. })
  1382. require.Equal(t, 413, response.Code)
  1383. require.Equal(t, 41301, toHTTPError(t, response.Body.String()).Code)
  1384. }
  1385. func TestServer_PublishAttachmentBandwidthLimit(t *testing.T) {
  1386. content := util.RandomString(5000) // > 4096
  1387. c := newTestConfig(t)
  1388. c.VisitorAttachmentDailyBandwidthLimit = 5*5000 + 123 // A little more than 1 upload and 3 downloads
  1389. s := newTestServer(t, c)
  1390. // Publish attachment
  1391. response := request(t, s, "PUT", "/mytopic", content, nil)
  1392. msg := toMessage(t, response.Body.String())
  1393. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1394. // Value it 4 times successfully
  1395. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1396. for i := 1; i <= 4; i++ { // 4 successful downloads
  1397. response = request(t, s, "GET", path, "", nil)
  1398. require.Equal(t, 200, response.Code)
  1399. require.Equal(t, content, response.Body.String())
  1400. }
  1401. // And then fail with a 429
  1402. response = request(t, s, "GET", path, "", nil)
  1403. err := toHTTPError(t, response.Body.String())
  1404. require.Equal(t, 429, response.Code)
  1405. require.Equal(t, 42905, err.Code)
  1406. }
  1407. func TestServer_PublishAttachmentBandwidthLimitUploadOnly(t *testing.T) {
  1408. content := util.RandomString(5000) // > 4096
  1409. c := newTestConfig(t)
  1410. c.VisitorAttachmentDailyBandwidthLimit = 5*5000 + 500 // 5 successful uploads
  1411. s := newTestServer(t, c)
  1412. // 5 successful uploads
  1413. for i := 1; i <= 5; i++ {
  1414. response := request(t, s, "PUT", "/mytopic", content, nil)
  1415. msg := toMessage(t, response.Body.String())
  1416. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1417. }
  1418. // And a failed one
  1419. response := request(t, s, "PUT", "/mytopic", content, nil)
  1420. err := toHTTPError(t, response.Body.String())
  1421. require.Equal(t, 413, response.Code)
  1422. require.Equal(t, 41301, err.Code)
  1423. }
  1424. func TestServer_PublishAttachmentAccountStats(t *testing.T) {
  1425. content := util.RandomString(4999) // > 4096
  1426. c := newTestConfig(t)
  1427. c.AttachmentFileSizeLimit = 5000
  1428. c.VisitorAttachmentTotalSizeLimit = 6000
  1429. s := newTestServer(t, c)
  1430. // Upload one attachment
  1431. response := request(t, s, "PUT", "/mytopic", content, nil)
  1432. msg := toMessage(t, response.Body.String())
  1433. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1434. // User stats
  1435. response = request(t, s, "GET", "/v1/account", "", nil)
  1436. require.Equal(t, 200, response.Code)
  1437. account, err := util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  1438. require.Nil(t, err)
  1439. require.Equal(t, int64(5000), account.Limits.AttachmentFileSize)
  1440. require.Equal(t, int64(6000), account.Limits.AttachmentTotalSize)
  1441. require.Equal(t, int64(4999), account.Stats.AttachmentTotalSize)
  1442. require.Equal(t, int64(1001), account.Stats.AttachmentTotalSizeRemaining)
  1443. require.Equal(t, int64(1), account.Stats.Messages)
  1444. }
  1445. func TestServer_Visitor_XForwardedFor_None(t *testing.T) {
  1446. c := newTestConfig(t)
  1447. c.BehindProxy = true
  1448. s := newTestServer(t, c)
  1449. r, _ := http.NewRequest("GET", "/bla", nil)
  1450. r.RemoteAddr = "8.9.10.11"
  1451. r.Header.Set("X-Forwarded-For", " ") // Spaces, not empty!
  1452. v, err := s.maybeAuthenticate(r)
  1453. require.Nil(t, err)
  1454. require.Equal(t, "8.9.10.11", v.ip.String())
  1455. }
  1456. func TestServer_Visitor_XForwardedFor_Single(t *testing.T) {
  1457. c := newTestConfig(t)
  1458. c.BehindProxy = true
  1459. s := newTestServer(t, c)
  1460. r, _ := http.NewRequest("GET", "/bla", nil)
  1461. r.RemoteAddr = "8.9.10.11"
  1462. r.Header.Set("X-Forwarded-For", "1.1.1.1")
  1463. v, err := s.maybeAuthenticate(r)
  1464. require.Nil(t, err)
  1465. require.Equal(t, "1.1.1.1", v.ip.String())
  1466. }
  1467. func TestServer_Visitor_XForwardedFor_Multiple(t *testing.T) {
  1468. c := newTestConfig(t)
  1469. c.BehindProxy = true
  1470. s := newTestServer(t, c)
  1471. r, _ := http.NewRequest("GET", "/bla", nil)
  1472. r.RemoteAddr = "8.9.10.11"
  1473. r.Header.Set("X-Forwarded-For", "1.2.3.4 , 2.4.4.2,234.5.2.1 ")
  1474. v, err := s.maybeAuthenticate(r)
  1475. require.Nil(t, err)
  1476. require.Equal(t, "234.5.2.1", v.ip.String())
  1477. }
  1478. func TestServer_PublishWhileUpdatingStatsWithLotsOfMessages(t *testing.T) {
  1479. count := 50000
  1480. c := newTestConfig(t)
  1481. c.TotalTopicLimit = 50001
  1482. c.CacheStartupQueries = "pragma journal_mode = WAL; pragma synchronous = normal; pragma temp_store = memory;"
  1483. s := newTestServer(t, c)
  1484. // Add lots of messages
  1485. log.Info("Adding %d messages", count)
  1486. start := time.Now()
  1487. messages := make([]*message, 0)
  1488. for i := 0; i < count; i++ {
  1489. topicID := fmt.Sprintf("topic%d", i)
  1490. _, err := s.topicsFromIDs(topicID) // Add topic to internal s.topics array
  1491. require.Nil(t, err)
  1492. messages = append(messages, newDefaultMessage(topicID, "some message"))
  1493. }
  1494. require.Nil(t, s.messageCache.addMessages(messages))
  1495. log.Info("Done: Adding %d messages; took %s", count, time.Since(start).Round(time.Millisecond))
  1496. // Update stats
  1497. statsChan := make(chan bool)
  1498. go func() {
  1499. log.Info("Updating stats")
  1500. start := time.Now()
  1501. s.execManager()
  1502. log.Info("Done: Updating stats; took %s", time.Since(start).Round(time.Millisecond))
  1503. statsChan <- true
  1504. }()
  1505. time.Sleep(50 * time.Millisecond) // Make sure it starts first
  1506. // Publish message (during stats update)
  1507. log.Info("Publishing message")
  1508. start = time.Now()
  1509. response := request(t, s, "PUT", "/mytopic", "some body", nil)
  1510. m := toMessage(t, response.Body.String())
  1511. assert.Equal(t, "some body", m.Message)
  1512. assert.True(t, time.Since(start) < 100*time.Millisecond)
  1513. log.Info("Done: Publishing message; took %s", time.Since(start).Round(time.Millisecond))
  1514. // Wait for all goroutines
  1515. <-statsChan
  1516. log.Info("Done: Waiting for all locks")
  1517. }
  1518. func newTestConfig(t *testing.T) *Config {
  1519. conf := NewConfig()
  1520. conf.BaseURL = "http://127.0.0.1:12345"
  1521. conf.CacheFile = filepath.Join(t.TempDir(), "cache.db")
  1522. conf.AttachmentCacheDir = t.TempDir()
  1523. return conf
  1524. }
  1525. func newTestConfigWithAuthFile(t *testing.T) *Config {
  1526. conf := newTestConfig(t)
  1527. conf.AuthFile = filepath.Join(t.TempDir(), "user.db")
  1528. return conf
  1529. }
  1530. func newTestServer(t *testing.T, config *Config) *Server {
  1531. server, err := New(config)
  1532. if err != nil {
  1533. t.Fatal(err)
  1534. }
  1535. return server
  1536. }
  1537. func request(t *testing.T, s *Server, method, url, body string, headers map[string]string) *httptest.ResponseRecorder {
  1538. rr := httptest.NewRecorder()
  1539. req, err := http.NewRequest(method, url, strings.NewReader(body))
  1540. if err != nil {
  1541. t.Fatal(err)
  1542. }
  1543. req.RemoteAddr = "9.9.9.9" // Used for tests
  1544. for k, v := range headers {
  1545. req.Header.Set(k, v)
  1546. }
  1547. s.handle(rr, req)
  1548. return rr
  1549. }
  1550. func subscribe(t *testing.T, s *Server, url string, rr *httptest.ResponseRecorder) context.CancelFunc {
  1551. ctx, cancel := context.WithCancel(context.Background())
  1552. req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
  1553. if err != nil {
  1554. t.Fatal(err)
  1555. }
  1556. done := make(chan bool)
  1557. go func() {
  1558. s.handle(rr, req)
  1559. done <- true
  1560. }()
  1561. cancelAndWaitForDone := func() {
  1562. time.Sleep(100 * time.Millisecond)
  1563. cancel()
  1564. <-done
  1565. }
  1566. time.Sleep(100 * time.Millisecond)
  1567. return cancelAndWaitForDone
  1568. }
  1569. func toMessages(t *testing.T, s string) []*message {
  1570. messages := make([]*message, 0)
  1571. scanner := bufio.NewScanner(strings.NewReader(s))
  1572. for scanner.Scan() {
  1573. messages = append(messages, toMessage(t, scanner.Text()))
  1574. }
  1575. return messages
  1576. }
  1577. func toMessage(t *testing.T, s string) *message {
  1578. var m message
  1579. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&m))
  1580. return &m
  1581. }
  1582. func toHTTPError(t *testing.T, s string) *errHTTP {
  1583. var e errHTTP
  1584. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&e))
  1585. return &e
  1586. }
  1587. func readAll(t *testing.T, rc io.ReadCloser) string {
  1588. b, err := io.ReadAll(rc)
  1589. if err != nil {
  1590. t.Fatal(err)
  1591. }
  1592. return string(b)
  1593. }