Tell macOS binary users when a newer release is available
メンテナーはふだん 1 日以内に返信
評価
この issue はまだ評価されていません。
説明
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.
- 主要言語
- Rust
- スター
- 215
- フォーク
- 141
- 平均マージ
- 1日 12時間
- マージ済み PR(30日)
- 232
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
sysprog21/codetrial のほかの issue
-
Audio output can be confirmed without playing a test sound対応中かも @ChenYingHan1121 が 11 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
sysprog21/codetrial#359 · コメント 9 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
Reset or Show pressed while the task cube is turning does not stick対応中かも @YEH-YU-YANG が今日担当しました。 オープン
sysprog21/codetrial#558 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
Treat low-evidence candidate speech as unassessed対応中かも @Danielncku が今日担当しました。 オープン
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
sysprog21/codetrial#553 · コメント 1 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
Web lobby cannot reopen Setup after configuration対応中かも @YEH-YU-YANG が 3 日前に担当しました。 オープン
sysprog21/codetrial#525 · コメント 3 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
Offer a way back to Setup from the lobby対応中かも @Patriciaath999 が 4 日前に担当しました。 オープン
sysprog21/codetrial#513 · コメント 4 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
sysprog21/codetrial の issue をすべて見る
似ている issue
-
bug priority: low ui
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
storytold/photocraft#10370 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
area:doc bug in progress needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
bherbruck/solvecraft#9634 · コメント 2 件 · リアクション 1 件 ·
-
inflate: total_in uses plain += on c_ulong (32-bit on Windows), panics in debug for streams > 4 GiBオープン
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
trifectatechfoundation/zlib-rs#570 · コメント 1 件 ·
-
bug discord-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
LanternOps/breeze#10755 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
aranya-project/aranya#803 ·