Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve dfx start messages. #3946

Merged
merged 12 commits into from
Nov 12, 2024
Merged

Conversation

vincent-dfinity
Copy link
Contributor

@vincent-dfinity vincent-dfinity commented Oct 9, 2024

Description

  1. Improve dfx start messages to let users know what to do next clearly.
  2. Add PostStart actor which will be notified by PocketIcProxy actor to output the messages in the right order.
  3. Set the original_background environment variable which will be used by the second start, as for now with --background we will run the dfx start again without --background option, but we need its value in PostStart actor.

Fixes # (issue)

SDK-1844

How Has This Been Tested?

Manually tests.

$ dfx start
Running dfx start for version 0.23.0-beta.3+rev34.dirty-11793309
Using the default configuration for the local shared network.
Initialized replica.
Initialized HTTP gateway.
Replica API running on 127.0.0.1:4943
The dfx server is running.
You can start a new terminal to continue developing, or quit with 'Ctrl-C'.
$ dfx start --background
Running dfx start for version 0.23.0-beta.3+rev34.dirty-11793309
Using the default configuration for the local shared network.
Initialized replica.
Initialized HTTP gateway.
Replica API running on 127.0.0.1:4943
The dfx server is running in the background.

Also add e2e test for dfx start --background, not sure how to add test for dfx start...

Checklist:

  • The title of this PR complies with Conventional Commits.
  • I have edited the CHANGELOG accordingly.
  • I have made corresponding changes to the documentation.

@vincent-dfinity vincent-dfinity requested review from ericswanson-dfinity and lwshang and removed request for ericswanson-dfinity October 9, 2024 03:59
@vincent-dfinity vincent-dfinity marked this pull request as ready for review October 21, 2024 04:58
@vincent-dfinity vincent-dfinity requested a review from a team as a code owner October 21, 2024 04:58
@marydwyer
Copy link

Because new user often don't realize that they successfully ran dfx start and need to open a new terminal, I recommend making it even more clear.

For dfx start:
✅ Success! The dfx server is running.
➕ You must open a new terminal to continue developing. If you'd prefer to stop, quit with 'Ctrl-C'.

For dfx start --background:
✅ Success! The dfx server is running in the background.

@vincent-dfinity vincent-dfinity requested review from ericswanson-dfinity and removed request for lwshang November 7, 2024 12:22
@ericswanson-dfinity ericswanson-dfinity enabled auto-merge (squash) November 12, 2024 19:23
@ericswanson-dfinity ericswanson-dfinity merged commit a08f9de into master Nov 12, 2024
297 checks passed
@ericswanson-dfinity ericswanson-dfinity deleted the vincent/SDK-1844 branch November 12, 2024 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants