Skip to content
This repository has been archived by the owner on Mar 10, 2020. It is now read-only.

chore: remove ipld formats re-export #374

Merged
merged 1 commit into from
Oct 15, 2018
Merged

Conversation

vmx
Copy link
Contributor

@vmx vmx commented Oct 9, 2018

Prior to this change the ipld-dag-cbor and ipld-dag-pb modules
are re-exported so that can be accessed within the Browser bundle.
Those modules normally don't need to be used directly, they are
kind of implementation details of IPLD. Hence remove them.

Prior to this change the `ipld-dag-cbor` and `ipld-dag-pb` modules
are re-exported so that can be accessed within the Browser bundle.
Those modules normally don't need to be used directly, they are
kind of implementation details of IPLD. Hence remove them.
@vmx
Copy link
Contributor Author

vmx commented Oct 9, 2018

Copy link
Contributor

@vasco-santos vasco-santos left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

@lidel lidel left a comment

Choose a reason for hiding this comment

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

👌

Copy link
Contributor

@alanshaw alanshaw left a comment

Choose a reason for hiding this comment

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

LGTM.

Just to clarify reasoning behind this:

Re-exporting these types here effectively forces ipfs core implementation versions to follow versions of these packages. Their API is now our API. i.e. if dag-pb increments major, then ipfs has to also increment major even if the rest of the IPFS API has no breaking changes.

Keeping these in sync is also problematic - if we try to use an old dag-pb module with ipfs whose ipld has a newer dag-pb things can break. If at all, they should be exported from ipld and re-exported here, so that ipfs doesn't have to keep them in sync. However considering they should not be used directly for day-to-day operation I'm in agreement with them being removed.

@alanshaw alanshaw merged commit 7a931c1 into master Oct 15, 2018
@alanshaw alanshaw deleted the remove-ipld-formats-re-export branch October 15, 2018 09:08
@ghost ghost removed the in progress label Oct 15, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants