Skip to content

revert(internal): Implement ADR 114 by making several modules public again#3004

Merged
melekes merged 13 commits intomainfrom
adi/impl-adr-114
May 6, 2024
Merged

revert(internal): Implement ADR 114 by making several modules public again#3004
melekes merged 13 commits intomainfrom
adi/impl-adr-114

Conversation

@adizere
Copy link
Contributor

@adizere adizere commented May 4, 2024

Closes #2990


The following modules are no longer in internal:

  • libs/pubsub
  • libs/protoio
  • libs/service
  • libs/sync
  • statesync

We also:

  • added "XXX deprecated" marker in the above modules
  • undid the .changelog entry that stated these modules are "Move to internal", since that is no longer true

PR checklist

  • Tests written/updated
  • Changelog entry added in .changelog (we use unclog to manage our changelog)
  • Updated relevant documentation (docs/ or spec/) and code comments
  • Title follows the Conventional Commits spec

@adizere adizere requested a review from a team as a code owner May 4, 2024 08:06
@adizere adizere requested a review from a team May 4, 2024 08:06
Comment on lines +98 to +99
| evidence | keep private | 1 | 26 | high | [evidence-url] |
| consensus | keep private | 1 | 64 | high | [consensus-url] |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

See the remark below in this document

For evidence and consensus: There is a single project we have identified using APIs from these modules,
specifically https://github.com/forbole/juno. The maintainers of this project have agreed it is not a problem
for them if we keep the two modules private.

| bits | keep private | 0 | 26 | low | [bits-url] |
| blocksync | keep private | 0 | 6 | low | [blocksync-url] |
| clist | keep private | 0 | 24 | low | [clist-url] |
| indexer | keep private | 0 | 0 | low | [indexer-url] |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The indexer module has 0 public uses, so it doesn't need to become public again. We can keep it internal.

Copy link
Collaborator

@melekes melekes left a comment

Choose a reason for hiding this comment

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

👍

@melekes melekes enabled auto-merge May 6, 2024 05:44
@melekes melekes added this pull request to the merge queue May 6, 2024
Merged via the queue into main with commit 34e5c05 May 6, 2024
@melekes melekes deleted the adi/impl-adr-114 branch May 6, 2024 05:53
mergify bot pushed a commit that referenced this pull request May 6, 2024
…again (#3004)

<!--

Please add a reference to the issue that this PR addresses and indicate
which
files are most critical to review. If it fully addresses a particular
issue,
please include "Closes #XXX" (where "XXX" is the issue number).

If this PR is non-trivial/large/complex, please ensure that you have
either
created an issue that the team's had a chance to respond to, or had some
discussion with the team prior to submitting substantial pull requests.
The team
can be reached via GitHub Discussions or the Cosmos Network Discord
server in
the #cometbft channel. GitHub Discussions is preferred over Discord as
it
allows us to keep track of conversations topically.
https://github.com/cometbft/cometbft/discussions

If the work in this PR is not aligned with the team's current
priorities, please
be advised that it may take some time before it is merged - especially
if it has
not yet been discussed with the team.

See the project board for the team's current priorities:
https://github.com/orgs/cometbft/projects/1

-->

Closes #2990

---

The following modules are no longer in `internal`:

- [x] `libs/pubsub`
- [x] `libs/protoio`
- [x] `libs/service`
- [x] `libs/sync`
- [x] `statesync`

We also:

- [x] added "XXX deprecated" marker in the above modules
- [x] undid the .changelog entry that stated these modules are "Move to
`internal`", since that is no longer true

#### PR checklist

- [ ] ~~Tests written/updated~~
- [ ] ~~Changelog entry added in `.changelog` (we use
[unclog](https://github.com/informalsystems/unclog) to manage our
changelog)~~
- [ ] ~~Updated relevant documentation (`docs/` or `spec/`) and code
comments~~
- [x] Title follows the [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec

---------

Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>
(cherry picked from commit 34e5c05)

# Conflicts:
#	rpc/core/tx.go
melekes added a commit that referenced this pull request May 6, 2024
…again (backport #3004) (#3011)

Closes #2990 

---

The following modules are no longer in `internal`:

- [x] `libs/pubsub`
- [x] `libs/protoio`
- [x] `libs/service`
- [x] `libs/sync`
- [x] `statesync`


We also:

- [x] added "XXX deprecated" marker in the above modules
- [x] undid the .changelog entry that stated these modules are "Move to
`internal`", since that is no longer true

#### PR checklist

- [ ] ~~Tests written/updated~~
- [ ] ~~Changelog entry added in `.changelog` (we use
[unclog](https://github.com/informalsystems/unclog) to manage our
changelog)~~
- [ ] ~~Updated relevant documentation (`docs/` or `spec/`) and code
comments~~
- [x] Title follows the [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec
<hr>This is an automatic backport of pull request #3004 done by
[Mergify](https://mergify.com).

---------

Co-authored-by: Adi Seredinschi <adizere@gmail.com>
Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>
@adizere adizere mentioned this pull request May 7, 2024
31 tasks
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

Successfully merging this pull request may close these issues.

Implementation of ADR 114: Damage control for ADR 109 by partly undoing that work

2 participants