server_test.go 81 KB

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