feat: download tars from @helia/verified-fetch #442
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
Let users get raw data back from CIDs that would otherwise trigger
decoding as JSON or CBOR etc by specifying an `Accept` header.
```typescript
const res = await verifiedFetch(cid, {
headers: {
accept: 'application/octet-stream'
}
})
console.info(res.headers.get('accept')) // application/octet-stream
```
Make sure the content-type matches the accept header:
```typescript
const res = await verifiedFetch(cid, {
headers: {
accept: 'application/vnd.ipld.raw'
}
})
console.info(res.headers.get('accept')) // application/vnd.ipld.raw
```
Support multiple values, match the first one:
```typescript
const res = await verifiedFetch(cid, {
headers: {
accept: 'application/vnd.ipld.raw, application/octet-stream, */*'
}
})
console.info(res.headers.get('accept')) // application/vnd.ipld.raw
```
If they specify an Accept header we can't honor, return a [406](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406):
```typescript
const res = await verifiedFetch(cid, {
headers: {
accept: 'application/what-even-is-this'
}
})
console.info(res.status) // 406
```
…ader-for-raw-types
Adds support for the `application/vnd.ipld.car` accept header to allow downloading CAR files of DAGs.
Adds support for downloading tar archives of UnixFS directories
SgtPooki
approved these changes
Feb 21, 2024
Comment on lines
+98
to
+111
| expect(entries).to.have.lengthOf(5) | ||
| expect(entries[0]).to.have.nested.property('header.name', importResult.cid.toString()) | ||
|
|
||
| expect(entries[1]).to.have.nested.property('header.name', `${importResult.cid}/${directory[1].path}`) | ||
| await expect(toBuffer(entries[1].body)).to.eventually.deep.equal(directory[1].content) | ||
|
|
||
| expect(entries[2]).to.have.nested.property('header.name', `${importResult.cid}/${directory[2].path?.split('/')[0]}`) | ||
|
|
||
| expect(entries[3]).to.have.nested.property('header.name', `${importResult.cid}/${directory[2].path}`) | ||
| await expect(toBuffer(entries[3].body)).to.eventually.deep.equal(directory[2].content) | ||
|
|
||
| expect(entries[4]).to.have.nested.property('header.name', `${importResult.cid}/${directory[0].path}`) | ||
| await expect(toBuffer(entries[4].body)).to.eventually.deep.equal(directory[0].content) | ||
| }) |
There was a problem hiding this comment.
the order here seems odd.. should ${importResult.cid}/${directory[0].path} be at entries[1] ?
There was a problem hiding this comment.
Alex let me know it-tar handles ordering and it's stable, so it should be fine.
There was a problem hiding this comment.
There's some interesting discussion on tar file ordering here: https://unix.stackexchange.com/questions/120143/how-is-the-order-in-which-tar-works-on-files-determined
Either way, it's external to @helia/verified-fetch.
| name: file.path, | ||
| mode, | ||
| mtime, | ||
| size: Number(file.size), |
There was a problem hiding this comment.
do we want to squash the bigint from Exportable.size to a Number here?
There was a problem hiding this comment.
We have to convert it because it-tar expects the field to be a number.
We may lose some precision but Number.MAX_SAFE_INTEGER is 9PB so famous last words but I think files of that size may be uncommon.
Base automatically changed from
feat/download-cars-from-verified-fetch
to
main
February 22, 2024 10:16
Co-authored-by: Russell Dempsey <[email protected]>
…om-verified-fetch
Merged
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.
Adds support for downloading tar archives of UnixFS directories