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

Introduce handshake command + tighter ping UI #468

Closed
wants to merge 4 commits into from

Conversation

smelc
Copy link
Contributor

@smelc smelc commented Nov 21, 2023

Changelog

- description: |
    Remove the `-u/--unixsock` option from `cardano-cli ping`,
    because it wasn't performing ping; only handshake.

    Add the `cardano-cli handshake` commands,
    that support both distant hosts (`-h/--host`, `-p/--port`)
    and local hosts (`-u/--unixsock`).
    Like its name suggests, `cardano-cli handshake` only does the handshake part of `cardano-cli ping`.
    
    Deprecate `cardano-cli ping`'s `-Q,--query-versions` flags.
    You should use the same flag with `cardano-cli handshake` instead.
    
    TLDR: if you were using `cardano-cli ping -Q`, use `cardano-cli handshake` instead.
    And don't pretend `cardano-cli ping` works on unix sockets.
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  # - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

How to trust this PR

  • Execute cardano-cli handshake, witness it works
  • Execute cardano-cli ping -u SOCKET, witness it doesn't exist anymore.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • NA New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff

@smelc smelc force-pushed the smelc/better-ping-ui branch 5 times, most recently from cd1ba2f to a732c02 Compare November 22, 2023 09:32
@smelc smelc marked this pull request as ready for review November 22, 2023 10:26
import qualified Prettyprinter as PP

data HandShakeCmd = HandShakeCmd
{ endPoint :: !Ping.EndPoint
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shouldn't be a separate command. It should live under the ping command as something like handshake-only.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've settled for cardano-cli ping --handshake-only here on Slack.

@smelc smelc marked this pull request as draft November 22, 2023 16:08
@smelc
Copy link
Contributor Author

smelc commented Jan 2, 2024

Will likely be superseded by #524 in the end

Copy link

This PR is stale because it has been open 45 days with no activity.

@github-actions github-actions bot added the Stale label Feb 17, 2024
@smelc smelc closed this Mar 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] - cardano-cli ping --unixsock not sending pings
3 participants