Run oracles in a real browser (Vitest browser mode)

Đang mở
#49 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
18/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript, playwright
Lĩnh vực
testing

Hướng nghiên cứu

Start with the imports in oracleProperty (node:async_hooks, node:fs, node:util) and with useOracleClock, then read oracle-gaps/capture-setup.mjs where ORACLE_GAPS_STATE is read through readFileSync. Running a test file under Vitest browser mode should show these failures, such as AsyncLocalStorage is not a constructor. Done means a browser-safe entry imports and runs in browser mode, and the gap check either runs there or is documented as unsupported.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Problem

An oracle for DOM code must run in jsdom today, so its driver supplies the
browser facts that jsdom lacks: layout, scroll positions, the targets where
scroll events fire, ResizeObserver notifications, and computed styles. When
the driver's stand-in and production rest on the same wrong belief about the
browser, the oracle passes, and only a human or a real browser finds the bug.

We hit this three times in one pull request (react-headroom):

  • The stand-in notified a ResizeObserver on any size change. Chrome notifies
    a content-box observer only when the content box changes, so a header that
    changes only its padding kept a stale height.
  • The stand-in decided that a body with overflow-y: auto scrolls itself.
    With html { overflow-y: scroll } body { overflow-x: hidden }, Chrome
    computes the body's overflow-y as auto, but the body grows with its
    content and the page scrolls.
  • The stand-in gave a body the viewport's height. In Chrome, a body that does
    not scroll itself grows with the page.

We checked each fact by hand in headless Chrome. An oracle that runs in
Chrome would have checked them on every run.

What stops it at 4749f61

  1. oracleProperty imports node:async_hooks (AsyncLocalStorage for probe
    windows), node:fs (appendFileSync) and node:util (inspect,
    isDeepStrictEqual, types). In Vitest browser mode the test file fails
    to import: AsyncLocalStorage is not a constructor.
  2. The gap check's setup file (oracle-gaps/capture-setup.mjs) reads its run
    state from process.env.ORACLE_GAPS_STATE with readFileSync. In browser
    mode, setup files run in the page.

Request

  • Let oracleProperty and useOracleClock run in Vitest browser mode, for
    example with a browser-safe entry that replaces AsyncLocalStorage, fs
    and util with browser equivalents or leaves those features out.
  • Let oracle-gaps run an oracle in browser mode, or document that it cannot,
    and recommend a pattern: for example, an oracle that runs in Chrome for its
    laws, and the same oracle in jsdom for the gap check.

Workaround we considered

Keep the oracle in Node and drive a Chrome page through Playwright: the
driver sends each history to the page, which runs it against a bundle of
production and returns the observations. This needs a page bundle, a
page-side clock in place of useOracleClock, and two copies of the driver
environment. The gap check still cannot mutate the code in the page.

Ngôn ngữ chính
JavaScript
Star
5
Fork
1
Merge trung bình
8 giờ 31 phút
Pull request đã merge (30 ngày)
60

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của TanStack/oracles

Tất cả issue của TanStack/oracles

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.