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 shaded ch.randelshofer:fastdoubleparser classes to prevent use by downstream consumers #1264

Closed
seadbrane opened this issue Apr 16, 2024 · 3 comments
Labels
2.18 Issues planned at earliest for 2.18
Milestone

Comments

@seadbrane
Copy link

The shaded ch.randelshofer:fastdoubleparser classes are being used by at least one other open source project. As the shaded version of these classes do not appear to be intentionally made available for consumers of jackson-core, it would be useful to either 1) not shade this dependency or to 2) randomize the package name and make it sufficiently obviously that these are not meant for general consumption.

For 2, one option would be to embed jackson-core version number and other identifiers that indicated this was for internal jackson-core use only and/or that this is a shaded dependency.

Such as:

com/fasterxml/jackson/core/internal/v2_18_0/fastdoubleparser/

And/or:

com/fasterxml/jackson/core/internal/v2_18_0/shaded/fastdoubleparser/
@pjfanning
Copy link
Member

I would recommened the opposite - raise issues with anyone who is using the jackson shaded classes.

@seadbrane
Copy link
Author

I would recommened the opposite - raise issues with anyone who is using the jackson shaded classes.

This will do that as well and also minimize the possibility of other packages using the shaded code.

@cowtowncoder
Copy link
Member

While I agree that trying to educate users would ideally suffice, I do think that making package name vary across releases will act as the "stick" to the "carrot" (of telling everyone the right way).

I did not realize that we had no indicator for "shaded" or "internal" as part of target package name (I usually add such a marker just for informational purposes) so even just adding that would be good. But version number seems like a nice addition.

I think this is preferable to changing FDP to regular dependency; there is value in being a 0-dependency package.

@cowtowncoder cowtowncoder changed the title Shaded ch.randelshofer:fastdoubleparser classes are being used by downstream consumers Rename shaded ch.randelshofer:fastdoubleparser classes to prevent use by downstream consumers May 1, 2024
@cowtowncoder cowtowncoder added the 2.18 Issues planned at earliest for 2.18 label May 1, 2024
@cowtowncoder cowtowncoder added this to the 2.18.0 milestone May 4, 2024
cowtowncoder added a commit that referenced this issue May 5, 2024
mfussenegger added a commit to crate/crate that referenced this issue Nov 4, 2024
See https://github.com/wrandelshofer/FastDoubleParser

I noticed looking at the jackson 2.18.1 release notes that it's included
and thought why not use it if it's already there (the shaded version)

But after seeing FasterXML/jackson-core#1264
it seems like using the shaded variant is discouraged, so this adds the
upstream dependency instead.
mfussenegger added a commit to crate/crate that referenced this issue Nov 4, 2024
See https://github.com/wrandelshofer/FastDoubleParser

I noticed looking at the jackson 2.18.1 release notes that it's included
and thought why not use it if it's already there (the shaded version)

But after seeing FasterXML/jackson-core#1264
it seems like using the shaded variant is discouraged, so this adds the
upstream dependency instead.
mfussenegger added a commit to crate/crate that referenced this issue Nov 4, 2024
See https://github.com/wrandelshofer/FastDoubleParser

I noticed looking at the jackson 2.18.1 release notes that it's included
and thought why not use it if it's already there (the shaded version)

But after seeing FasterXML/jackson-core#1264
it seems like using the shaded variant is discouraged, so this adds the
upstream dependency instead.
mergify bot pushed a commit to crate/crate that referenced this issue Nov 4, 2024
See https://github.com/wrandelshofer/FastDoubleParser

I noticed looking at the jackson 2.18.1 release notes that it's included
and thought why not use it if it's already there (the shaded version)

But after seeing FasterXML/jackson-core#1264
it seems like using the shaded variant is discouraged, so this adds the
upstream dependency instead.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.18 Issues planned at earliest for 2.18
Projects
None yet
Development

No branches or pull requests

3 participants