refactor(identity): follow naming conventions for conversion methods by drHuangMHT · Pull Request #3775 · libp2p/rust-libp2p

drHuangMHT · 2023-04-12T06:36:29Z

Description

This PR renames some method names that don't follow Rust naming conventions or behave differently from what the name suggests:

Enforce "try" prefix on all methods that return Result.
Enforce "encode" method name for methods that return encoded bytes.
Enforce "to_bytes" method name for methods that return raw bytes.
Enforce "decode" method name for methods that convert encoded key.
Enforce "from_bytes" method name for methods that convert raw bytes.

Notes & open questions

Some method are intentionally left out to prevent conflict with #3681.
~~Base branch is contaminated by #3621.~~

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

Unreleased patch version 0.43.1 bumped. Added entry for PR 3606: Deriving 'Clone' for 'mdns::Event'

New unreleased minor version 0.44.0.

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>

Unsynced co-authered change.

thomaseizinger

Very nicely done, only a few nits!

Also, can you add a changelog entry to libp2p-identity please and bump the patch version in the manifest of libp2p-identity?

identity/src/ecdsa.rs

identity/src/ed25519.rs

identity/src/error.rs

…libp2p into rename-identity

drHuangMHT · 2023-04-13T05:59:11Z

I've intentionally kept Cargo.lock untouched. Should I commit the change?

thomaseizinger · 2023-04-13T14:33:53Z

I've intentionally kept Cargo.lock untouched. Should I commit the change?

Yes, the lockfile needs to be up to date.

thomaseizinger

Nicely done, only one more things!

identity/CHANGELOG.md

identity/src/error.rs

thomaseizinger

This is ready for merge. We are just missing some version bumps to point to the correct version of libp2p-identity.

@mxinden We are renaming several functions to be consistent with Rust's naming guidelines. Unfortunately, there is no clippy lint for this.

protocols/gossipsub/src/behaviour.rs

protocols/identify/src/protocol.rs

transports/noise/src/io/handshake.rs

transports/plaintext/src/handshake.rs

transports/tls/src/certificate.rs

…libp2p into rename-identity

thomaseizinger · 2023-04-14T08:54:25Z

Awesome, thank you for sending this PR!

This PR renames some method names that don't follow Rust naming conventions or behave differently from what the name suggests: - Enforce "try" prefix on all methods that return `Result`. - Enforce "encode" method name for methods that return encoded bytes. - Enforce "to_bytes" method name for methods that return raw bytes. - Enforce "decode" method name for methods that convert encoded key. - Enforce "from_bytes" method name for methods that convert raw bytes. Pull-Request: libp2p#3775.

mxinden

Sorry for the late review here. Great work @drHuangMHT!

drHuangMHT and others added 29 commits March 13, 2023 19:06

feat: make mdns::Event clone-able

7d5e606

Merge branch 'libp2p:master' into master

05ce438

docs: filling CHANGELOG for PR 3606

a72e5e2

Unreleased patch version 0.43.1 bumped. Added entry for PR 3606: Deriving 'Clone' for 'mdns::Event'

Merge branch 'master' of https://github.com/drHuangMHT/rust-libp2p

09bef20

Update protocols/mdns/CHANGELOG.md

926c7ca

Update protocols/mdns/CHANGELOG.md

49d26c4

Merge branch 'master' into master

4a35406

feat: change 'mdns::Event' to hold 'SmallVec'

a8ff1eb

test: adapting test to 'mdns::Event' change

4cec5fa

Merge branch 'master' of https://github.com/drHuangMHT/rust-libp2p

a876f2f

feat(mdns): change 'mdns::Event' to hold 'Vec'

18811d2

doc: add entry for libp2p#3621

abdce7e

New unreleased minor version 0.44.0.

Update protocols/mdns/CHANGELOG.md

d5c246c

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>

Merge branch 'master' of https://github.com/drHuangMHT/rust-libp2p

ed128a7

Merge branch 'master' of https://github.com/drHuangMHT/rust-libp2p

0d06f4c

Unsynced co-authered change.

Remove conflict marker to resolve conflicts

9d45cf3

Merge branch 'master' of https://github.com/drHuangMHT/rust-libp2p

752002b

rename methods in 'libp2p-identity::ecdsa'

74d01be

introduce 'KeyType' in 'libp2p-identity'

d219b0e

introduce 'OtherVariantError' in 'libp2p-identity::error'

8ca95ee

rename methods in 'libp2p-identity::ed25519'

9b81b81

rename methods in 'libp2p-identity::keypair'

7a1f645

rename methods in 'libp2p-identity::rsa'

25e1139

rename methods in 'libp2p-identity::secp256k1'

d15d95b

formatting

19ff427

change call to deprecated methods to recommended ones

ba4511d

clippy fix

8e9c227

formatting

9ed6436

Undo mdns changes

cbbd01b

thomaseizinger reviewed Apr 12, 2023

View reviewed changes

drHuangMHT added 7 commits April 12, 2023 21:22

documentation improvement on 'libp2p-identity::ecdsa'

e6a3144

rename methods in 'libp2p-identity::ed25519'

4c7caf8

change visibility of 'OtherVariantError::new' to crate level

aa1577a

documentation improvement on 'OtherVariantError'

6d9de35

documentation improvement and correction on 'libp2p_identity::ed25519'

fdc0d25

Merge branch 'rename-identity' of https://github.com/drHuangMHT/rust-…

e736918

…libp2p into rename-identity

patch version bump(to 0.1.2) for 'libp2p-identity'

a46f661

thomaseizinger reviewed Apr 13, 2023

View reviewed changes

identity/CHANGELOG.md Outdated Show resolved Hide resolved

identity/src/error.rs Show resolved Hide resolved

thomaseizinger and others added 4 commits April 14, 2023 00:38

Update identity/CHANGELOG.md

4479ff9

lockfile update

947284c

export 'OtherVariantError'

9ae4e41

Merge branch 'libp2p:master' into rename-identity

85e9f5f

thomaseizinger changed the title ~~refactor(identity): follow Rust naming conventions for conversion methods~~ refactor(identity): follow naming conventions for conversion methods Apr 14, 2023

thomaseizinger mentioned this pull request Apr 14, 2023

identity::Keypair ergonomics improvements #3649

Closed

thomaseizinger marked this pull request as ready for review April 14, 2023 06:58

thomaseizinger approved these changes Apr 14, 2023

View reviewed changes

drHuangMHT added 6 commits April 14, 2023 15:29

dependency version bump for 'gossipsub'

38f4b38

dependency version bump for 'identify'

4fe27a0

dependency version bump for 'noise'

b426f0d

dependency version bump for 'plaintext'

f19ce60

dependency version bump for 'tls'

8394c6a

Merge branch 'rename-identity' of https://github.com/drHuangMHT/rust-…

c3d3038

…libp2p into rename-identity

thomaseizinger added the send-it label Apr 14, 2023

mergify bot merged commit 058c2d8 into libp2p:master Apr 14, 2023

thomaseizinger mentioned this pull request May 5, 2023

feat(identity): make Keypair and Publickey opaque #3866

Merged

3 tasks

mxinden reviewed May 8, 2023

View reviewed changes

Conversation

drHuangMHT commented Apr 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Notes & open questions

Change checklist

Uh oh!

thomaseizinger left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

drHuangMHT commented Apr 13, 2023

Uh oh!

thomaseizinger commented Apr 13, 2023

Uh oh!

thomaseizinger left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

thomaseizinger left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thomaseizinger commented Apr 14, 2023

Uh oh!

mxinden left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

drHuangMHT commented Apr 12, 2023 •

edited

Loading