server_test.go 98 KB

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