server_test.go 86 KB

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