server_test.go 89 KB

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