Tell macOS binary users when a newer release is available
Maintainers usually reply within 1 day
Assessment
This issue has not been assessed yet.
Description
Problem
A candidate who runs the prebuilt macOS binary from the latest release has no way to learn that a newer build exists. Every successful build of main replaces latest (docs/install.md), several times a day at the current pace, but the running binary never says so. The only way to find out is to open the releases page by hand and compare the commit ./codetrial --version prints with the one the release names, since the package version stays 0.1.0 across builds. In practice that check is skipped, so candidates keep practicing on builds that already have fixes they are missing, and a bug report from such a build describes behavior main no longer has.
docs/desktop.md already lists automatic updates as something the desktop app does not do. This asks for something smaller than updating: telling the candidate that an update exists.
Proposed behavior
The lobby checks whether the latest release names a different commit than the running binary, at three moments:
- When the binary starts and the lobby first loads.
- When the candidate ends an interview and returns to the lobby.
- Every hour on the hour while the lobby stays open and no interview is running.
When a newer build exists, the lobby shows a dialog that names the running commit and the release's commit and links to the release page (or the macOS asset). No check runs and no dialog appears during an interview.
Scope
The CLI binary for macOS (codetrial-aarch64-apple-darwin.zip from latest) only, because macOS is the only platform I can test on. The check itself does not depend on the platform, so Linux, Windows and the desktop app's desktop-latest can follow once someone who can test them picks them up. Downloading or replacing the binary is out of scope: the candidate still replaces the executable by hand, keeping config/, as docs/install.md describes.
Acceptance criteria
- A macOS release binary older than
latestshows the dialog at each of the three moments above, with a working link. - A binary that matches
latestshows nothing. - A failed check (no network, a GitHub error, the short window in which
latestresolves to nothing while it is republished) shows nothing and does not affect the lobby or an interview. - Nothing is checked or shown while an interview is running.
Implementation notes
The running commit is already known: build.rs embeds the first seven characters of GITHUB_SHA as CODETRIAL_BUILD_COMMIT, and the release job creates latest with --target "$GITHUB_SHA", so the two can be compared directly. Moments 1 and 2 are one code path: leaving an interview navigates to /, so the lobby loads afresh either way.
Two ways to make the check, compared:
- The server asks GitHub (
GET /repos/sysprog21/codetrial/releases/tags/latest) and caches the answer, and the lobby asks the server through a new endpoint. The page'sconnect-srcstays as it is, and one GitHub request per hour serves every open tab, well inside the unauthenticated limit of 60 requests an hour. - The lobby asks GitHub directly. This needs
https://api.github.comadded toconnect-srcin src/web/policy.rs, and every open tab makes its own requests.
The first keeps the page's policy unchanged, so I would start there.
Questions
- Should the check be on by default, or opt-in, given that it sends a request to GitHub that the binary does not make today?
- A build from source has a commit too, but usually not one
latestwill ever name. Should the check run only in release builds, for example only whenGITHUB_SHAwas set at build time? - After the candidate dismisses the dialog, should it stay hidden until the next release, or appear again at the next check?
Related
#153 (merged) made a binary report the commit it was built from, which is what this compares. #14 (merged) introduced the single rolling latest release this reads. #494 (merged) publishes desktop-latest for the desktop app. I found no existing issue or PR about update notifications.
- Dominant language
- Rust
- Stars
- 215
- Forks
- 141
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 232
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from sysprog21/codetrial
-
Audio output can be confirmed without playing a test soundPossibly taken @ChenYingHan1121 claimed this 11 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
sysprog21/codetrial#359 · 9 comments · 1 assignee ·
Maintainers usually reply within 1 day
-
Reset or Show pressed while the task cube is turning does not stickPossibly taken @YEH-YU-YANG claimed this today. Open
sysprog21/codetrial#558 · 1 assignee ·
Maintainers usually reply within 1 day
-
Treat low-evidence candidate speech as unassessedPossibly taken @Danielncku claimed this today. Open
Difficulty 5/5 Over a week Newbie friendliness 35/100
sysprog21/codetrial#553 · 1 comment · 1 assignee ·
Maintainers usually reply within 1 day
-
Web lobby cannot reopen Setup after configurationPossibly taken @YEH-YU-YANG claimed this 3 days ago. Open
sysprog21/codetrial#525 · 3 comments · 1 assignee ·
Maintainers usually reply within 1 day
-
Offer a way back to Setup from the lobbyPossibly taken @Patriciaath999 claimed this 4 days ago. Open
sysprog21/codetrial#513 · 4 comments · 1 assignee ·
Maintainers usually reply within 1 day
All issues in sysprog21/codetrial
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
area:ci kind:bug priority:p3 ready
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
srikanth235/centraid#1155 ·
Maintainers usually reply within 1 day
-
dotfiles: failed batch untrack removes earlier tracking declarationsPossibly taken @jdx claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 2 days