server_test.go 84 KB

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