Don't convert IPFS pins' CIDs #17
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The original (pre-emptive) intention was to avoid (potential) case-sensitive problems, stemming from a pin's CID. While this is an okay idea, it's not our problem to solve, and doing so incurs a cost per-request. This should be left up to the node operator. If a CID v0 does cause problems, they can upgrade it (once), and use the new v1 reference instead (removing the necessity of per-request conversions). This also removes the maintenance need to keep up to date with external CID revisions (in this section of the code).
Only slightly less gross, but still gross. - [micro-opt] Struct alignment. - [S&P] Return error values to caller. - [S&P] Better (?) reference names and ordering. - [redundancy] Trust the CID string from `fs.FS` path, if it passes CID decoding. (Instead of calling the String method on the CID instance. These /should/ always match [future footgun].)
11bw
approved these changes
Nov 18, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The original (pre-emptive) intention was to avoid (potential) case-sensitive problems, stemming from a pin's CID.
While this is an okay idea, it's not our problem to solve, and doing so incurs a cost per-request.
Conversions should be left up to the node operator.
If a CID v0 does cause problems, they can upgrade it (once), and use the newer reference instead (removing the necessity of per-request conversions).
This also removes the maintenance need to keep up to date with external CID revisions (in this section of the code).
Extra:
This feature is also something we can add back in on-demand in an external program (like the file explorer shell extension), so that it only happens when it's actually desired.
But the only use case I can imagine for this is if someone wants to copy a reference to a v0 path, and assure it's compliant with non-case-preserving systems.
Seems unlikely, but it shouldn't be a hard problem to deal with later if it does come up.
We'd just use the same logic. Receive a path string, find the CID, convert and replace it, return the new reference.