server_test.go 64 KB

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