Test what each browser-check step does in a browser

Open
#311 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
57/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
javascript, node.js, playwright
Domain
testing, tooling

Research direction

Start with the existing tests in contributing/test/browse.test.mjs and its opening note, then read contributing/lib/browse.mjs to understand --plan and how browser runs are started. Add Chromium-only tests using the small sample and Playwright to cover the listed browser actions and outputs, including the shot in shots/index.md; Safari can remain a manual check. Done when the browser behavior, failures and run setup are covered by tests.

Written by the indexing model from the issue text.

Description

good first issue infrastructure

contributing/lib/browse.mjs runs a review's steps in every browser and theme: clicks, taps, drags, typing, waits and shots, in Chromium, Firefox, WebKit and Safari Technology Preview. Its options, the runs they expand into, where a step acts, and the check that each step is one action are tested in contributing/test/browse.test.mjs, without a browser, using its --plan mode. What each step does in a browser isn't tested at all.

What's untested:

  • each action in a browser: click, tap, drag (touch and mouse), type, press, wait, until, eval, console, shot and sleep;
  • Safari's WebDriver path, including that it treats a frame's name as the page's frame;
  • shots/index.md, the names it gives shots, and its exit codes: 1 for a failed step, 4 for a run that couldn't start;
  • the theme steps it adds, and the scratch copy of the folder it serves;
  • --dev passed on to reader;
  • the step and whole-run timeouts, and stopping cleanly on Ctrl-C.

Suggested start: a test that runs browse.mjs in Chromium alone (Playwright is a dev dependency) on a small sample, with one step of each kind, and checks what it prints and the shot it writes. The tests already in browse.test.mjs show the pattern, and its opening note says how to add one. Safari's path can stay a manual check, as it runs only outside the sandbox.

Found in the 0.0.5 release review (#81).

Dominant language
JavaScript
Stars
0
Forks
1
Avg merge
2d 4h
Merged PRs (30d)
26

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jzheaux/reader

All issues in jzheaux/reader

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.