server_test.go 82 KB

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