interchain-security icon indicating copy to clipboard operation
interchain-security copied to clipboard

simplify naming

Open faddat opened this issue 2 years ago • 20 comments

Description

Binary names and paths were too long.

This PR:

  • interchain-security-cd => consumer
  • interchain-security-cdd => democracy
  • interchain-security-pd => provider

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

  • [x] Included the correct type prefix in the PR title
  • [x] Added ! to the type prefix if API or client breaking change
  • [x] Targeted the correct branch (see PR Targeting)
  • [ ] Provided a link to the relevant issue or specification
  • [ ] Followed the guidelines for building SDK modules
  • [ ] Included the necessary unit and integration tests
  • [ ] Added a changelog entry to CHANGELOG.md
  • [ ] Included comments for documenting Go code
  • [ ] Updated the relevant documentation or specification
  • [x] Reviewed "Files changed" and left comments if necessary
  • [x] Confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

I have...

  • [ ] confirmed the correct type prefix in the PR title
  • [ ] confirmed ! in the type prefix if API or client breaking change
  • [ ] confirmed all author checklist items have been addressed
  • [ ] reviewed state machine logic
  • [ ] reviewed API design and naming
  • [ ] reviewed documentation is accurate
  • [ ] reviewed tests and test coverage

faddat avatar May 07 '23 20:05 faddat

This just changes the binary names? I like the idea

jtremback avatar May 09 '23 20:05 jtremback

yep. I just need to clean it up and such, should be able to get to it tomorrow.

It is inspired by typing:

interchain-security-pd

too many times

:)

faddat avatar May 09 '23 20:05 faddat

I'm getting test failures on this even after re-running. Can you check that the e2e tests all have the updated binary names?

jtremback avatar May 11 '23 15:05 jtremback

ah that's why it is still on draft.

faddat avatar May 11 '23 19:05 faddat

hmmmm I thought i had this working....

faddat avatar May 13 '23 23:05 faddat

@jtremback please note that we could debug this directly on github, if we changed the automated tests to use the --verbose flag as seen in #867

that would:

  • prioritize human time over machine time
  • make agreeing on the state of bugs easier
  • reduce overall time spent to diagnose and fix issues

... idk exactly how things work at Informal but at Notional we've noticed very consistently that machines are dramatically cheaper than the people who program them.

faddat avatar May 13 '23 23:05 faddat

For reference, 5/5 vietnamese undersea cables have some kind of fault right now.

Thus, i am still downloading docker containers.

faddat avatar May 13 '23 23:05 faddat

LGTM but looks like some merge conflicts snuck in

jtremback avatar May 22 '23 22:05 jtremback

Set this to draft, but once the merge conflicts are fixed I'm happy to review

shaspitz avatar Jun 09 '23 21:06 shaspitz

hey really sorry guys!

this one has been a while 1 moment while I do the conflict resolution dance.

faddat avatar Jun 18 '23 18:06 faddat

There's an sdk pattern that binary names have a d appended, was there reasoning around avoiding that pattern?

Ex: providerd or provider-d

shaspitz avatar Jun 19 '23 16:06 shaspitz

@smarshall-spitzbart it's broken inconssitently throughout the ecosystem. I don't mind appending d's to the names though, and prefer consistency, so I'll mark this as draft till that's fixed.

faddat avatar Jun 23 '23 11:06 faddat

If we're taking the time to change/review the binary names I'd prefer we do it the proper way with the d appended, thanks @faddat

shaspitz avatar Jun 23 '23 18:06 shaspitz

Gonna add the d now...

faddat avatar Jun 25 '23 04:06 faddat

Not sure that changing "democracy consumer" to "democracy" is beneficial or makes things clearer.

yeah the idea was def to make binary names shorter, any other name changes, were done for the sake of consistency is there a specific instance where this is an issue?

Happy to address

faddat avatar Jul 06 '23 16:07 faddat

https://github.com/cosmos/interchain-security/issues?q=is%3Aopen+is%3Aissue+label%3Arefactoring

🖖

thank you

faddat avatar Jul 06 '23 16:07 faddat

Merge conflicts snuck in again, can merge once it's fixed though

jtremback avatar Jul 17 '23 21:07 jtremback

@jtremback hey sorry about the delay here. Baby gap sir.

faddat avatar Aug 13 '23 12:08 faddat

I've merged main, hopefully this fixes the cometmocktest.

faddat avatar Aug 20 '23 17:08 faddat

@faddat Could you please also add the compiler/linker flags (ldflags) during the build call so that we can also close https://github.com/cosmos/interchain-security/issues/1035? We decided against goreleaser for ICS, but it would be useful to populate those fields for the version CLI command.

mpoke avatar Sep 19 '23 08:09 mpoke

Closing this as it is out of sync with main. It's easier to redo the PR than to rebase.

mpoke avatar Jun 11 '24 08:06 mpoke