server_test.go 93 KB

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