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

Remove YAML annotations in .proto files #9705

Closed
4 tasks
ruhatch opened this issue Jul 15, 2021 · 4 comments
Closed
4 tasks

Remove YAML annotations in .proto files #9705

ruhatch opened this issue Jul 15, 2021 · 4 comments

Comments

@ruhatch
Copy link
Contributor

ruhatch commented Jul 15, 2021

Right now we have gogoproto.moretags-based annotations to define custom keys for YAML marshalling. As part of #7488 we want to remove use of gogoproto and we will need to decide which existing annotations we want to add custom support for.

We should be able to do YAML marshalling directly from JSON representations of our proto messages, so we can use that instead of needing to implement a custom annotation.

So, we need to:

  • Audit the codebase to see where YAML marshalling is used
  • Find an appropriate library to marshal JSON -> YAML
  • Replace existing YAML marshaller with new one
  • Remove yaml annotations in .proto files
@lukerhoads
Copy link
Contributor

Hello,
A good example would be the MarshalYAML function in codec? And for the marshalling of types, (which is used in their string functions) would a new marshaller be needed?

@aaronc
Copy link
Member

aaronc commented Jul 26, 2021

Hello,
A good example would be the MarshalYAML function in codec? And for the marshalling of types, (which is used in their string functions) would a new marshaller be needed?

Exactly, we should just use MarshalYAML.

I suggest we switch the implementation to use https://sigs.k8s.io/yaml, and also use that for UnmarshalYAML.

@lukerhoads
Copy link
Contributor

Sounds good, with that library we can directly go from JSON to yaml in the MarshalYAML function. I will open a draft PR with some initial changes and we can work from there to eventually remove the annotations.

@github-actions github-actions bot added the stale label Sep 11, 2021
@amaury1093 amaury1093 added pinned and removed stale labels Sep 17, 2021
@amaury1093 amaury1093 reopened this Sep 17, 2021
mergify bot pushed a commit that referenced this issue Sep 24, 2021
…ions (#9780)

## Description

Draft of: #9705 

Started off with changing codec `MarshalYaml` function to directly go from JSON to yaml using the new library. Replaced the only usage of UnmarshalYaml per request.
---

### 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...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] 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...

- [x] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [x] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [x] reviewed state machine logic
- [x] reviewed API design and naming
- [x] reviewed documentation is accurate
- [x] reviewed tests and test coverage
- [x] manually tested (if applicable)
@clevinson
Copy link
Contributor

@AmauryM can this be closed now?

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

No branches or pull requests

6 participants