server_test.go 80 KB

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