server_test.go 90 KB

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