server_test.go 69 KB

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