feat: support downloading car files from @helia/verified-fetch #441
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.
SgtPooki
approved these changes
Feb 21, 2024
| }()) | ||
|
|
||
| // write the DAG behind `cid` into the writer | ||
| c.export(cid, writer, options) |
There was a problem hiding this comment.
We may not want to pass full options here?
There was a problem hiding this comment.
We can change it if we need to, my experience has generally been that it's often useful to be able to pass options to sub components whole.
As it stands there's complete overlap between the option types so I think all we'd gain by limiting the option keys is verbosity.
Co-authored-by: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com>
SgtPooki
approved these changes
Feb 21, 2024
Comment on lines
161
to
166
| private async handleCar ({ cid, options }: FetchHandlerFunctionArg): Promise<Response> { | ||
| const c = car(this.helia) | ||
| const stream = toBrowserReadableStream<Uint8Array>(c.stream(cid, options)) | ||
|
|
||
| const response = okResponse(stream) | ||
| response.headers.set('content-type', 'application/vnd.ipld.car; version=1') |
There was a problem hiding this comment.
This is so much cleaner. very nice
Base automatically changed from
feat/handle-accept-header-for-raw-types
to
main
February 22, 2024 09:56
…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 the
application/vnd.ipld.caraccept header to allow downloading CAR files of DAGs.Change checklist