server_test.go 68 KB

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