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

feat(gossipsub): deprecate Rpc in preparation for making it private #4833

Merged
merged 7 commits into from
Nov 13, 2023

Conversation

thomaseizinger
Copy link
Contributor

Description

Notes & open questions

Change checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • A changelog entry has been made in the appropriate crates

@thomaseizinger thomaseizinger requested a review from jxs November 10, 2023 01:51
protocols/gossipsub/CHANGELOG.md Outdated Show resolved Hide resolved
protocols/gossipsub/src/handler.rs Outdated Show resolved Hide resolved
protocols/gossipsub/src/lib.rs Outdated Show resolved Hide resolved
protocols/gossipsub/src/types.rs Outdated Show resolved Hide resolved
@mxinden
Copy link
Member

mxinden commented Nov 12, 2023

Is Rpc used outside of the communication between the NetworkBehaviour and the ConnectionHandler implementation? In other words, is Rpc even used by any user code? If not, I suggest we don't treat removal of Rpc as a breaking change.

@thomaseizinger
Copy link
Contributor Author

Is Rpc used outside of the communication between the NetworkBehaviour and the ConnectionHandler implementation? In other words, is Rpc even used by any user code? If not, I suggest we don't treat removal of Rpc as a breaking change.

It is not but we don't necessarily know that :)

Is there much harm in deprecating it first?

Copy link
Member

@jxs jxs left a comment

Choose a reason for hiding this comment

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

Thanks Thomas!

@mergify mergify bot merged commit 33f1765 into master Nov 13, 2023
71 checks passed
@mergify mergify bot deleted the feat/gossipsub-make-rpc-private branch November 13, 2023 21:11
@mxinden
Copy link
Member

mxinden commented Nov 16, 2023

Is Rpc used outside of the communication between the NetworkBehaviour and the ConnectionHandler implementation? In other words, is Rpc even used by any user code? If not, I suggest we don't treat removal of Rpc as a breaking change.

It is not but we don't necessarily know that :)

Is there much harm in deprecating it first?

No harm in deprecating first. Just trying to find consensus for when we make a "breaking" change to it.

@thomaseizinger
Copy link
Contributor Author

The rule of thumb I often apply is: If somebody does depend on it, can they fix it easily? Activating a feature that used to be default? Yes. Access a now private type, no.

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.

3 participants