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

Replace Deprecated UUID Package #7

Closed
tri-adam opened this issue May 4, 2021 · 3 comments · Fixed by #33
Closed

Replace Deprecated UUID Package #7

tri-adam opened this issue May 4, 2021 · 3 comments · Fixed by #33
Labels
v2 Affects v2 API

Comments

@tri-adam
Copy link
Member

tri-adam commented May 4, 2021

The github.com/satori/go.uuid module used by this project does not appear to be actively maintained (ref).

We should consider switching to the github.com/gofrs/uuid package, or some other suitable alternative.

@tri-adam
Copy link
Member Author

tri-adam commented May 5, 2021

Did a little research into this. The github.com/gofrs/uuid package lacks a go.mod, with an explanation offered in gofrs/uuid#85. Personally, that feels a little off-putting to me, and I think we'd be wise to consider alternatives.

github.com/google/uuid seems to be the other, obvious alternative.

The uuid.UUID type is used in two exported struct fields in the SIF API:

ID uuid.UUID // image unique identifier

ID uuid.UUID // image unique identifier

Strictly speaking, the semantics of Go module versioning require a major version bump to implement this backwards incompatible change (see here for more info.)

@cameracker
Copy link

Hey!

I wandered into this issue because someone posted on that issue you linked. I wanted to mention that this repo is using a version of satori/go.uuid that has a CVE filed against it because periodically the UUIDs will be about 50% 0's. This problem is fixed on master but the maintainer failed to tag it.

It seems like the recommendations in the issue here are pretty great! But I'd suggest expediency.

@tri-adam
Copy link
Member Author

tri-adam commented May 7, 2021

Thank you for the heads up @cameracker, much appreciated!

I've gone ahead and opened up #8 as a short-term solution to this that doesn't require a major version bump.

We still need to move away from that module to something that is maintained, but this buys us some time to consider if there are any other breaking changes we want to introduce with the new major version of this module.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v2 Affects v2 API
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants