server_test.go 94 KB

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