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

Rename workspace member near-jsonrpc-client to avoid name collision #12908

Open
mooori opened this issue Feb 11, 2025 · 3 comments · May be fixed by #12925
Open

Rename workspace member near-jsonrpc-client to avoid name collision #12908

mooori opened this issue Feb 11, 2025 · 3 comments · May be fixed by #12925
Labels
C-good-first-issue Category: issues that are self-contained and easy for newcomers to work on. C-housekeeping Category: Refactoring, cleanups, code quality

Comments

@mooori
Copy link
Contributor

mooori commented Feb 11, 2025

There is an (unpublished) workspace member named near-jsonrpc-client:

[package]
name = "near-jsonrpc-client"

That name collides with a crate published on crates.io that lives in another repo.

This can cause confusion, in particular since /benchmarks/synth-bm depends on the near-jsonrpc-client from crates.io, while other workspace members depend on the unpublished crate with the same name.

To resolve this, the crate in /chain/jsonrpc/client should be renamed. Since it is not published, that shouldn't cause issues elsewhere.

@mooori mooori added C-good-first-issue Category: issues that are self-contained and easy for newcomers to work on. C-housekeeping Category: Refactoring, cleanups, code quality labels Feb 11, 2025
@qiweiii
Copy link
Contributor

qiweiii commented Feb 13, 2025

Is nearcore-jsonrpc-client an acceptable name? if so I can help update.

I also found near-jsonrpc-primitives have the same problem, should I update it to nearcore-jsonrpc-primitives as well?

@mooori
Copy link
Contributor Author

mooori commented Feb 13, 2025

Is nearcore-jsonrpc-client an acceptable name?

Most (or maybe even all) crates in nearcore have names starting with near-. For consistency I would keep that prefix. Perhaps something like near-jsonrpc-client-internal. Or you could check what the crate does and try to come up with a more descriptive name. The new name just shouldn't conflict with any crate in nearcore or on crates.io. And yes, a PR to update the name would be welcome :)

near-jsonrpc-primitives

This one looks actually fine since it is published from nearcore. So there is no name conflict.

@qiweiii qiweiii linked a pull request Feb 13, 2025 that will close this issue
@qiweiii
Copy link
Contributor

qiweiii commented Feb 13, 2025

I didn't think of a better name than near-jsonrpc-client-internal, and just put up a PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-good-first-issue Category: issues that are self-contained and easy for newcomers to work on. C-housekeeping Category: Refactoring, cleanups, code quality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants