Skip to content

Commit

Permalink
fix: use CID object for verified-fetch progress events (#425)
Browse files Browse the repository at this point in the history 
Do not stringify CIDs before using them as events.

The user can do this is they want, parsing them back to objects is not free.
  • Loading branch information
@achingbrain
achingbrain authored Feb 12, 2024
1 parent b5c95e6 commit b010184
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion src/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ import type { ProgressEvent, ProgressOptions } from 'progress-events'
export type Resource = string | CID

export interface CIDDetail {
cid: string
cid: CID
path: string
}

Expand Down
24 changes: 12 additions & 12 deletions src/verified-fetch.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,38 +107,38 @@ export class VerifiedFetch {

private async handleDagJson ({ cid, path, options }: FetchHandlerFunctionArg): Promise<Response> {
this.log.trace('fetching %c/%s', cid, path)
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:start', { cid: cid.toString(), path }))
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:start', { cid, path }))
const result = await this.dagJson.get(cid, {
signal: options?.signal,
onProgress: options?.onProgress
})
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:end', { cid: cid.toString(), path }))
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:end', { cid, path }))
const response = new Response(JSON.stringify(result), { status: 200 })
response.headers.set('content-type', 'application/json')
return response
}

private async handleJson ({ cid, path, options }: FetchHandlerFunctionArg): Promise<Response> {
this.log.trace('fetching %c/%s', cid, path)
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:start', { cid: cid.toString(), path }))
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:start', { cid, path }))
const result: Record<any, any> = await this.json.get(cid, {
signal: options?.signal,
onProgress: options?.onProgress
})
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:end', { cid: cid.toString(), path }))
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:end', { cid, path }))
const response = new Response(JSON.stringify(result), { status: 200 })
response.headers.set('content-type', 'application/json')
return response
}

private async handleDagCbor ({ cid, path, options }: FetchHandlerFunctionArg): Promise<Response> {
this.log.trace('fetching %c/%s', cid, path)
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:start', { cid: cid.toString(), path }))
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:start', { cid, path }))
const result = await this.dagCbor.get<Uint8Array>(cid, {
signal: options?.signal,
onProgress: options?.onProgress
})
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:end', { cid: cid.toString(), path }))
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:end', { cid, path }))
const response = new Response(result, { status: 200 })
await this.setContentType(result, path, response)
return response
Expand All @@ -154,7 +154,7 @@ export class VerifiedFetch {
const rootFilePath = 'index.html'
try {
this.log.trace('found directory at %c/%s, looking for index.html', cid, path)
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:start', { cid: dirCid.toString(), path: rootFilePath }))
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:start', { cid: dirCid, path: rootFilePath }))
stat = await this.unixfs.stat(dirCid, {
path: rootFilePath,
signal: options?.signal,
Expand All @@ -168,16 +168,16 @@ export class VerifiedFetch {
this.log('error loading path %c/%s', dirCid, rootFilePath, err)
return new Response('Unable to find index.html for directory at given path. Support for directories with implicit root is not implemented', { status: 501 })
} finally {
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:end', { cid: dirCid.toString(), path: rootFilePath }))
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:end', { cid: dirCid, path: rootFilePath }))
}
}

options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:start', { cid: resolvedCID.toString(), path: '' }))
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:start', { cid: resolvedCID, path: '' }))
const asyncIter = this.unixfs.cat(resolvedCID, {
signal: options?.signal,
onProgress: options?.onProgress
})
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:end', { cid: resolvedCID.toString(), path: '' }))
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:end', { cid: resolvedCID, path: '' }))
this.log('got async iterator for %c/%s', cid, path)

const { stream, firstChunk } = await getStreamFromAsyncIterable(asyncIter, path ?? '', this.helia.logger, {
Expand All @@ -191,9 +191,9 @@ export class VerifiedFetch {

private async handleRaw ({ cid, path, options }: FetchHandlerFunctionArg): Promise<Response> {
this.log.trace('fetching %c/%s', cid, path)
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:start', { cid: cid.toString(), path }))
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:start', { cid, path }))
const result = await this.helia.blockstore.get(cid)
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:end', { cid: cid.toString(), path }))
options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:end', { cid, path }))
const response = new Response(decode(result), { status: 200 })
await this.setContentType(result, path, response)
return response
Expand Down
18 changes: 9 additions & 9 deletions test/verified-fetch.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -225,15 +225,15 @@ describe('@helia/verifed-fetch', () => {

const onProgressEvents = onProgress.getCalls().map(call => call.args[0])
expect(onProgressEvents[0]).to.include({ type: 'verified-fetch:request:start' }).and.to.have.property('detail').that.deep.equals({
cid: testCID.toString(),
cid: testCID,
path: 'index.html'
})
expect(onProgressEvents[1]).to.include({ type: 'verified-fetch:request:end' }).and.to.have.property('detail').that.deep.equals({
cid: testCID.toString(),
cid: testCID,
path: 'index.html'
})
expect(onProgressEvents[3]).to.include({ type: 'verified-fetch:request:end' }).and.to.have.property('detail').that.deep.equals({
cid: 'Qmc3zqKcwzbbvw3MQm3hXdg8BQoFjGdZiGdAfXAyAGGdLi',
cid: CID.parse('Qmc3zqKcwzbbvw3MQm3hXdg8BQoFjGdZiGdAfXAyAGGdLi'),
path: ''
})
expect(onProgressEvents[4]).to.include({ type: 'verified-fetch:request:progress:chunk' }).and.to.have.property('detail').that.is.undefined()
Expand Down Expand Up @@ -294,12 +294,12 @@ describe('@helia/verifed-fetch', () => {
const onProgressEvents = onProgress.getCalls().map(call => call.args[0])
expect(onProgressEvents[0]).to.have.property('type', 'verified-fetch:request:start')
expect(onProgressEvents[0]).to.have.property('detail').that.deep.equals({
cid: cid.toString(),
cid,
path: ''
})
expect(onProgressEvents[1]).to.have.property('type', 'verified-fetch:request:end')
expect(onProgressEvents[1]).to.have.property('detail').that.deep.equals({
cid: cid.toString(),
cid,
path: ''
})
expect(resp).to.be.ok()
Expand Down Expand Up @@ -330,12 +330,12 @@ describe('@helia/verifed-fetch', () => {
const onProgressEvents = onProgress.getCalls().map(call => call.args[0])
expect(onProgressEvents[0]).to.have.property('type', 'verified-fetch:request:start')
expect(onProgressEvents[0]).to.have.property('detail').that.deep.equals({
cid: cid.toString(),
cid,
path: ''
})
expect(onProgressEvents[1]).to.have.property('type', 'verified-fetch:request:end')
expect(onProgressEvents[1]).to.have.property('detail').that.deep.equals({
cid: cid.toString(),
cid,
path: ''
})
const data = await resp.json()
Expand All @@ -362,12 +362,12 @@ describe('@helia/verifed-fetch', () => {
const onProgressEvents = onProgress.getCalls().map(call => call.args[0])
expect(onProgressEvents[0]).to.have.property('type', 'verified-fetch:request:start')
expect(onProgressEvents[0]).to.have.property('detail').that.deep.equals({
cid: cid.toString(),
cid,
path: ''
})
expect(onProgressEvents[1]).to.have.property('type', 'verified-fetch:request:end')
expect(onProgressEvents[1]).to.have.property('detail').that.deep.equals({
cid: cid.toString(),
cid,
path: ''
})
expect(resp).to.be.ok()
Expand Down

0 comments on commit b010184

Please sign in to comment.