server_test.go 68 KB

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