fix: check for blob/accept receipts before blob/add is concluded #1459
+553
−93
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| import retry, { AbortError } from 'p-retry' | ||
| import { CAR } from '@ucanto/transport' | ||
| import { receiptsEndpoint } from './service.js' | ||
| import { REQUEST_RETRIES } from './constants.js' | ||
|
|
||
| export class ReceiptNotFound extends Error { | ||
| /** | ||
| * @param {import('multiformats').UnknownLink} taskCid | ||
| */ | ||
| constructor(taskCid) { | ||
| super() | ||
| this.taskCid = taskCid | ||
| } | ||
|
|
||
| /* c8 ignore start */ | ||
| get reason() { | ||
| return `receipt not found for task ${this.taskCid}` | ||
joaosa marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| /* c8 ignore end */ | ||
|
|
||
| get name() { | ||
| return 'ReceiptNotFound' | ||
| } | ||
| } | ||
|
|
||
| export class ReceiptMissing extends Error { | ||
| /** | ||
| * @param {import('multiformats').UnknownLink} taskCid | ||
| */ | ||
| constructor(taskCid) { | ||
| super() | ||
| this.taskCid = taskCid | ||
| } | ||
|
|
||
| /* c8 ignore start */ | ||
| get reason() { | ||
| return `receipt missing for task ${this.taskCid}` | ||
| } | ||
| /* c8 ignore end */ | ||
|
|
||
| get name() { | ||
| return 'ReceiptMissing' | ||
| } | ||
| } | ||
|
|
||
| export class Receipt { | ||
| /** | ||
| * @param {import('./types.js').RequestOptions} [options] | ||
| */ | ||
| constructor(options = {}) { | ||
| /* c8 ignore start */ | ||
| this.receiptsEndpoint = options.receiptsEndpoint ?? receiptsEndpoint | ||
| this.retries = options.retries ?? REQUEST_RETRIES | ||
| this.fetch = options.fetch ?? globalThis.fetch.bind(globalThis) | ||
| /* c8 ignore stop */ | ||
|
There was a problem hiding this comment. nit: IMHO it's overkill to use a class here, since there's no state that changes for the lifetime of the instance and in usage you're never storing the instance to a variable (i.e. You could just export 2 methods, There was a problem hiding this comment. alright sounds good. addressed as well |
||
| } | ||
|
|
||
| /** | ||
| * Polls for a receipt for an executed task by its CID. | ||
| * | ||
| * @param {import('multiformats').UnknownLink} taskCid | ||
| * @returns {Promise<import('@ucanto/interface').Receipt>} | ||
| */ | ||
| async poll(taskCid) { | ||
| return await retry( | ||
| async () => { | ||
| const res = await this.get(taskCid) | ||
| if (res.error) { | ||
| // @ts-ignore | ||
| if (res.error.name === 'ReceiptNotFound') { | ||
| // throw an error that will cause `p-retry` to retry with | ||
| throw new ReceiptNotFound(taskCid) | ||
joaosa marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } else { | ||
| throw new AbortError( | ||
| new Error('failed to fetch blob/accept receipt', { | ||
| cause: res.error, | ||
| }) | ||
| ) | ||
| } | ||
| } | ||
| return res.ok | ||
| }, | ||
| { | ||
| onFailedAttempt: console.warn, | ||
| /* c8 ignore next */ | ||
| retries: this.retries ?? REQUEST_RETRIES, | ||
| } | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Get a receipt for an executed task by its CID. | ||
| * | ||
| * @param {import('multiformats').UnknownLink} taskCid | ||
| * @returns {Promise<import('@ucanto/client').Result<import('@ucanto/interface').Receipt, Error>>} | ||
| */ | ||
| async get(taskCid) { | ||
| // Fetch receipt from endpoint | ||
| const url = new URL(taskCid.toString(), this.receiptsEndpoint) | ||
| const workflowResponse = await this.fetch(url) | ||
| /* c8 ignore start */ | ||
| if (!workflowResponse.ok && workflowResponse.status === 404) { | ||
joaosa marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return { | ||
| error: new ReceiptNotFound(taskCid), | ||
|
There was a problem hiding this comment. shouldn't this only be on not response ok + Status 404? |
||
| } | ||
| } | ||
| /* c8 ignore stop */ | ||
| // Get receipt from Message Archive | ||
| const agentMessageBytes = new Uint8Array( | ||
| await workflowResponse.arrayBuffer() | ||
| ) | ||
| // Decode message | ||
| const agentMessage = await CAR.request.decode({ | ||
| body: agentMessageBytes, | ||
| headers: {}, | ||
| }) | ||
| // Get receipt from the potential multiple receipts in the message | ||
| const receipt = agentMessage.receipts.get(taskCid.toString()) | ||
|
There was a problem hiding this comment. nit: It's kinda odd that this endpoint returns an I wonder if this should just always return an agent message (but with no receipts in it if not found) and then you wouldn't have to check for HTTP 404 status as well. There was a problem hiding this comment. This is because we in the past decided to redirect to the workflow object in S3, so there is really no way to know it exists, unless we would do redundant HEAD Request... We will need to UCANify the gets for workflows/receipts and, we may do changes at that point to the endpoint |
||
| if (!receipt) { | ||
| return { | ||
| error: new ReceiptMissing(taskCid), | ||
| } | ||
| } | ||
| return { | ||
| ok: receipt, | ||
| } | ||
| } | ||
| } | ||
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You should check for
errorand then you don't need tots-ignorehere.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think I need at all anymore, as previously the receipt acquisition method could return null. Now it's either a receipt or it throws.