feat(cli): verify Docker daemon is running and warn on occupied proof-server port#78
Open
notsoblack wants to merge 1 commit into
Open
Conversation
…-server port - Extend RequirementChecker.checkDocker() to run `docker info` after detecting the binary. Previously only `docker --version` was checked, which passes even when Docker Desktop is closed and the daemon is down. This led to confusing downstream failures during proof-server setup. - Add RequirementChecker.checkPortAvailable(port) using a lightweight TCP socket probe to localhost. Warns the user if port 6300 (proof-server default) is already occupied before scaffolding begins, preventing opaque 'port already allocated' errors from Docker. - Integrate port check into createApp() alongside existing Docker and Compact checks. - Add comprehensive unit tests (vitest) covering: – Docker binary missing – Docker installed + daemon running – Docker installed + daemon NOT running (warning path) – Compact compiler missing – Compact compiler version compatibility – Compact compiler newer than expected (warning path) – Port availability (free port) Closes silent failures when Docker daemon is off or another process holds port 6300.
|
Midnight Contributor seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improves the
create-mn-appCLI's pre-flight requirement checks to catch two of the most common silent failure modes reported by developers:docker --versionsucceeds even when the daemon is down, causing confusing errors later during proof-server setup.What's changed
src/utils/requirement-checker.tscheckDocker()now runsdocker info(with a 5s timeout) after detecting the binary. If the daemon is unreachable, the check marks Docker asfound: falsewith a warning explaining the user must start Docker Desktop.checkPortAvailable(port)added — performs a lightweightnet.Socketprobe to127.0.0.1:6300. If the connection succeeds, a warning is emitted so the user knows the port is occupied before scaffolding begins.netfrom Node.js stdlib (no new dependencies).src/create-app.tsawait RequirementChecker.checkPortAvailable(6300)into the existing requirements block so the port check runs alongside Node, Docker, and Compact checks.src/__tests__/requirement-checker.test.ts(new)found: falsefound: true, no warningfound: false, warning about daemonfound: falsefound: trueWhy this matters
These are the top two support issues new Windows developers hit:
setup.docker runfails with "bind: address already in use".Both failures are now caught before file scaffolding begins, with clear warnings and actionable guidance.
Verification
npm run testpasses (vitest)src/__tests__/requirement-checker.test.tscovers all new code paths