host_test.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370
  1. package nativehost
  2. import (
  3. "bytes"
  4. "clusterflow.dev/cfbrowser/internal/capture"
  5. "context"
  6. "encoding/json"
  7. "errors"
  8. "image"
  9. "image/png"
  10. "io"
  11. "os"
  12. "strings"
  13. "testing"
  14. "time"
  15. "clusterflow.dev/cfbrowser/api"
  16. "clusterflow.dev/cfbrowser/protocol"
  17. )
  18. type fakeBackend struct {
  19. opts api.EngineOptions
  20. value json.RawMessage
  21. fail error
  22. pending func(error)
  23. async bool
  24. double bool
  25. asyncEvaluate bool
  26. finishEvaluate func(json.RawMessage, error)
  27. closedPages []uint64
  28. closed bool
  29. }
  30. func (f *fakeBackend) Configure(o api.EngineOptions, done func(error)) { f.opts = o; done(f.fail) }
  31. func (f *fakeBackend) NewPage(_ uint64, done func(error)) {
  32. if f.async {
  33. f.pending = done
  34. return
  35. }
  36. done(f.fail)
  37. }
  38. func (f *fakeBackend) Navigate(_ uint64, url, op string, done func(string, error)) { done(url, f.fail) }
  39. func (f *fakeBackend) Evaluate(_ uint64, _ string, done func(json.RawMessage, error)) {
  40. if f.asyncEvaluate {
  41. f.finishEvaluate = done
  42. return
  43. }
  44. done(f.value, f.fail)
  45. if f.double {
  46. done(f.value, f.fail)
  47. }
  48. }
  49. func (f *fakeBackend) ClosePage(id uint64) error {
  50. f.closedPages = append(f.closedPages, id)
  51. return f.fail
  52. }
  53. func (f *fakeBackend) Close() { f.closed = true }
  54. // Dispatch one request on the test's UI thread, retaining native state ownership.
  55. func dispatch(t *testing.T, h *Host, method, raw string) (any, error) {
  56. t.Helper()
  57. done := make(chan result, 1)
  58. go func() { v, e := h.Handle(context.Background(), method, json.RawMessage(raw)); done <- result{v, e} }()
  59. select {
  60. case fn := <-h.Queue:
  61. fn()
  62. case r := <-done:
  63. return r.value, r.err
  64. case <-time.After(time.Second):
  65. t.Fatal("dispatch stalled")
  66. }
  67. select {
  68. case r := <-done:
  69. return r.value, r.err
  70. case <-time.After(time.Second):
  71. t.Fatal("completion stalled")
  72. }
  73. return nil, nil
  74. }
  75. func wantError(t *testing.T, e error, code string) {
  76. t.Helper()
  77. var typed *api.Error
  78. if !errors.As(e, &typed) || typed.Code != code {
  79. t.Fatalf("want %s, got %v", code, e)
  80. }
  81. }
  82. func TestHostValidationAndLifecycle(t *testing.T) {
  83. f := &fakeBackend{value: json.RawMessage(`{"answer":42}`)}
  84. h := New(f)
  85. _, e := dispatch(t, h, "page.new", "null")
  86. wantError(t, e, "BROWSER_INVALID_CONFIG")
  87. for _, raw := range []string{`{`, `{"ViewportWidth":-1}`, `{"ViewportHeight":4097}`} {
  88. _, e := dispatch(t, h, "configure", raw)
  89. if e == nil {
  90. t.Fatalf("accepted %s", raw)
  91. }
  92. }
  93. if v, e := dispatch(t, h, "configure", `{}`); e != nil || v != true {
  94. t.Fatal(v, e)
  95. }
  96. if f.opts.ViewportWidth != 1280 || f.opts.ViewportHeight != 800 {
  97. t.Fatal(f.opts)
  98. }
  99. _, e = dispatch(t, h, "configure", `{}`)
  100. wantError(t, e, "BROWSER_INVALID_CONFIG")
  101. _, e = dispatch(t, h, "page.close", `{`)
  102. wantError(t, e, "BROWSER_INVALID_ARGUMENT")
  103. _, e = dispatch(t, h, "unknown", `{}`)
  104. wantError(t, e, "BROWSER_CAPABILITY_UNSUPPORTED")
  105. _, e = dispatch(t, h, "page.evaluate", `{"page":999}`)
  106. wantError(t, e, "BROWSER_PAGE_NOT_FOUND")
  107. for i := uint64(1); i <= 16; i++ {
  108. v, e := dispatch(t, h, "page.new", `null`)
  109. if e != nil || v != i {
  110. t.Fatal(v, e)
  111. }
  112. }
  113. _, e = dispatch(t, h, "page.new", `null`)
  114. wantError(t, e, "BROWSER_LIMIT")
  115. _, e = dispatch(t, h, "page.navigate", `{"page":1,"op":"invalid"}`)
  116. wantError(t, e, "BROWSER_INVALID_ARGUMENT")
  117. _, e = dispatch(t, h, "page.navigate", `{"page":1,"op":"goto","url":"x\u0000y"}`)
  118. wantError(t, e, "BROWSER_INVALID_ARGUMENT")
  119. _, e = dispatch(t, h, "page.evaluate", `{"page":1,"script":"x\u0000y"}`)
  120. wantError(t, e, "BROWSER_INVALID_ARGUMENT")
  121. for _, op := range []string{"goto", "back", "forward", "reload"} {
  122. v, e := dispatch(t, h, "page.navigate", `{"page":1,"op":"`+op+`","url":"https://example.org"}`)
  123. if e != nil || v != "https://example.org" {
  124. t.Fatal(v, e)
  125. }
  126. }
  127. v, e := dispatch(t, h, "page.evaluate", `{"page":1,"script":"42"}`)
  128. if e != nil || string(v.(json.RawMessage)) != string(f.value) {
  129. t.Fatal(v, e)
  130. }
  131. f.value = json.RawMessage(`invalid`)
  132. _, e = dispatch(t, h, "page.evaluate", `{"page":1}`)
  133. wantError(t, e, "BROWSER_INVALID_RESULT")
  134. f.value = json.RawMessage(`"` + strings.Repeat("x", protocol.MaxMessage) + `"`)
  135. _, e = dispatch(t, h, "page.evaluate", `{"page":1}`)
  136. wantError(t, e, "BROWSER_INVALID_RESULT")
  137. args, _ := json.Marshal(map[string]any{"page": 1, "script": strings.Repeat("x", protocol.MaxMessage)})
  138. _, e = dispatch(t, h, "page.evaluate", string(args))
  139. wantError(t, e, "BROWSER_ARGUMENT_LIMIT")
  140. f.fail = errors.New("engine failed")
  141. _, e = dispatch(t, h, "page.evaluate", `{"page":1}`)
  142. if !errors.Is(e, f.fail) {
  143. t.Fatal(e)
  144. }
  145. f.fail = nil
  146. _, e = dispatch(t, h, "page.close", `{"page":1}`)
  147. if e != nil || len(f.closedPages) != 1 {
  148. t.Fatal(e, f.closedPages)
  149. }
  150. h.Close()
  151. if !f.closed || len(h.pages) != 0 {
  152. t.Fatal("not closed")
  153. }
  154. }
  155. func TestHostCreationFailuresAndCancellation(t *testing.T) {
  156. f := &fakeBackend{fail: errors.New("startup failed")}
  157. h := New(f)
  158. _, e := dispatch(t, h, "configure", `{}`)
  159. if e == nil || h.configured {
  160. t.Fatal(e)
  161. }
  162. f.fail = nil
  163. _, _ = dispatch(t, h, "configure", `{}`)
  164. f.fail = errors.New("new page failed")
  165. _, e = dispatch(t, h, "page.new", `null`)
  166. if e == nil || len(h.pages) != 0 {
  167. t.Fatal(e)
  168. }
  169. f.fail = nil
  170. f.async = true
  171. ctx, cancel := context.WithCancel(context.Background())
  172. done := make(chan error, 1)
  173. go func() { _, e := h.Handle(ctx, "page.new", nil); done <- e }()
  174. (<-h.Queue)()
  175. cancel()
  176. if e := <-done; !errors.Is(e, context.Canceled) {
  177. t.Fatal(e)
  178. }
  179. f.pending(nil)
  180. if len(h.pages) != 0 || len(f.closedPages) != 1 {
  181. t.Fatal("canceled creation leaked", h.pages, f.closedPages)
  182. }
  183. ctx, cancel = context.WithCancel(context.Background())
  184. cancel()
  185. if _, e := h.Handle(ctx, "page.new", nil); !errors.Is(e, context.Canceled) {
  186. t.Fatal(e)
  187. }
  188. // Cancellation after enqueue must prevent a native side effect.
  189. ctx, cancel = context.WithCancel(context.Background())
  190. go func() { _, e := h.Handle(ctx, "page.new", nil); done <- e }()
  191. fn := <-h.Queue
  192. cancel()
  193. fn()
  194. <-done
  195. if len(h.pages) != 0 {
  196. t.Fatal("dispatched after cancellation")
  197. }
  198. }
  199. func TestRunFramedRPCAndShutdown(t *testing.T) {
  200. input, writer := io.Pipe()
  201. reader, output := io.Pipe()
  202. f := &fakeBackend{value: json.RawMessage(`true`)}
  203. done := make(chan error, 1)
  204. go func() {
  205. done <- Run(context.Background(), input, output, f, func() error { return nil })
  206. output.Close()
  207. }()
  208. client := protocol.NewClient(reader, writer)
  209. defer client.Close()
  210. ctx, cancel := context.WithTimeout(context.Background(), time.Second)
  211. defer cancel()
  212. var ok bool
  213. if e := client.Call(ctx, "configure", api.EngineOptions{}, &ok); e != nil || !ok {
  214. t.Fatal(ok, e)
  215. }
  216. var id uint64
  217. if e := client.Call(ctx, "page.new", nil, &id); e != nil || id != 1 {
  218. t.Fatal(id, e)
  219. }
  220. writer.Close()
  221. select {
  222. case e := <-done:
  223. if e != nil {
  224. t.Fatal(e)
  225. }
  226. case <-ctx.Done():
  227. t.Fatal("EOF shutdown stalled")
  228. }
  229. if !f.closed {
  230. t.Fatal("backend not closed")
  231. }
  232. }
  233. func TestRunPumpFailure(t *testing.T) {
  234. input, writer := io.Pipe()
  235. defer writer.Close()
  236. f := &fakeBackend{}
  237. failure := errors.New("pump failed")
  238. if e := Run(context.Background(), input, io.Discard, f, func() error { return failure }); !errors.Is(e, failure) {
  239. t.Fatal(e)
  240. }
  241. if !f.closed {
  242. t.Fatal("backend leaked")
  243. }
  244. }
  245. func TestNativeEvaluationQuotaAndQueueCancellation(t *testing.T) {
  246. f := &fakeBackend{value: json.RawMessage(`null`)}
  247. h := New(f)
  248. _, _ = dispatch(t, h, "configure", `{}`)
  249. _, _ = dispatch(t, h, "page.new", `null`)
  250. // A timed-out native call can still be executing; the native quota survives RPC cancellation.
  251. h.evaluations = 32
  252. _, e := dispatch(t, h, "page.evaluate", `{"page":1}`)
  253. wantError(t, e, "BROWSER_LIMIT")
  254. h.evaluations = 31
  255. f.double = true
  256. if _, e = dispatch(t, h, "page.evaluate", `{"page":1}`); e != nil || h.evaluations != 31 {
  257. t.Fatal(e, h.evaluations)
  258. }
  259. for i := 0; i < cap(h.Queue); i++ {
  260. h.Queue <- func() {}
  261. }
  262. ctx, cancel := context.WithTimeout(context.Background(), 5*time.Millisecond)
  263. defer cancel()
  264. if _, e = h.Handle(ctx, "page.new", nil); !errors.Is(e, context.DeadlineExceeded) {
  265. t.Fatal(e)
  266. }
  267. }
  268. func TestCloseReleasesPendingEvaluationAndIgnoresLateResult(t *testing.T) {
  269. for _, closeHost := range []bool{false, true} {
  270. t.Run(map[bool]string{false: "page", true: "host"}[closeHost], func(t *testing.T) {
  271. f := &fakeBackend{asyncEvaluate: true}
  272. h := New(f)
  273. _, _ = dispatch(t, h, "configure", `{}`)
  274. _, _ = dispatch(t, h, "page.new", `null`)
  275. done := make(chan error, 1)
  276. go func() {
  277. _, e := h.Handle(context.Background(), "page.evaluate", json.RawMessage(`{"page":1}`))
  278. done <- e
  279. }()
  280. (<-h.Queue)()
  281. if h.evaluations != 1 {
  282. t.Fatal(h.evaluations)
  283. }
  284. if closeHost {
  285. h.Close()
  286. } else {
  287. _, _ = dispatch(t, h, "page.close", `{"page":1}`)
  288. }
  289. wantError(t, <-done, "BROWSER_CLOSED")
  290. f.finishEvaluate(json.RawMessage(`true`), nil)
  291. if h.evaluations != 0 || len(h.pending) != 0 {
  292. t.Fatal("pending evaluation leaked", h.evaluations, h.pending)
  293. }
  294. })
  295. }
  296. }
  297. type featureBackend struct {
  298. fakeBackend
  299. image []byte
  300. captureDone func([]byte, error)
  301. inputCount int
  302. }
  303. func (f *featureBackend) Capture(_ uint64, _ bool, done func([]byte, error)) {
  304. if f.image == nil {
  305. f.captureDone = done
  306. } else {
  307. done(f.image, nil)
  308. }
  309. }
  310. func (f *featureBackend) Input(_ uint64, _ string, _ string, _ float64, _ float64, done func(error)) {
  311. f.inputCount++
  312. done(nil)
  313. }
  314. func TestCaptureInputAndFeatureHandshake(t *testing.T) {
  315. var pngData bytes.Buffer
  316. _ = png.Encode(&pngData, image.NewRGBA(image.Rect(0, 0, 16, 16)))
  317. f := &featureBackend{image: pngData.Bytes()}
  318. h := New(f)
  319. dir := t.TempDir()
  320. opts, _ := json.Marshal(api.EngineOptions{DownloadDir: dir})
  321. if _, err := dispatch(t, h, "configure", string(opts)); err != nil {
  322. t.Fatal(err)
  323. }
  324. v, err := dispatch(t, h, "session.features", `null`)
  325. if err != nil || v.(map[string]int)["featureVersion"] != protocol.FeatureVersion {
  326. t.Fatal(v, err)
  327. }
  328. _, _ = dispatch(t, h, "page.new", `null`)
  329. token, err := dispatch(t, h, "page.capture", `{"page":1}`)
  330. if err != nil {
  331. t.Fatal(err)
  332. }
  333. data, err := capture.Load(dir, token.(string))
  334. if err != nil || !bytes.Equal(data, pngData.Bytes()) {
  335. t.Fatal(err)
  336. }
  337. if _, err = dispatch(t, h, "page.input", `{"page":1,"action":"click"}`); err != nil || f.inputCount != 1 {
  338. t.Fatal(err)
  339. }
  340. if h.evaluations != 0 {
  341. t.Fatal("pending quota leaked")
  342. }
  343. f.image = nil
  344. waiting := make(chan error, 1)
  345. go func() {
  346. _, err := h.Handle(context.Background(), "page.capture", json.RawMessage(`{"page":1}`))
  347. waiting <- err
  348. }()
  349. (<-h.Queue)()
  350. _, _ = dispatch(t, h, "page.close", `{"page":1}`)
  351. wantError(t, <-waiting, "BROWSER_CLOSED")
  352. f.captureDone(pngData.Bytes(), nil)
  353. files, _ := os.ReadDir(dir)
  354. if len(files) != 0 || h.evaluations != 0 {
  355. t.Fatal("late capture persisted", files)
  356. }
  357. }