Auto-resolve payload/output presigned urls when retrieving a run

[ericallam]

When a task run has a large payload or output, we store it in an object store like s3 or r2, to prevent very large JSON objects getting in our database (and causing event loop lags on serialize/deserialize).

Currently, when you retrieve a run using runs.retrieve(), if that run has stored the payload/output in the object store, we return a payloadPresignedUrl and/or a outputPresignedUrl, which can then be fetched separately. This has a couple problems:

• Makes client code pretty complicated having to deal with this (@jacobparis)
• This is really an implementation detail that's being exposed to users
• The content type of the JSON object in the store might be stored as superjson, so the downloaded data from the presigned URL still needs to be put through superjson to get back the original value.

This PR makes it so runs.retrieve() will automatically "resolve" the payload and output presigned urls, and pass them through superjson if needed. This also makes it so the type-safety of runs.retrieve() when passing a run handle or providing the typeof the task as a generic param works correctly.

Note that payloadPresignedUrl and outputPresignedUrl are still left on the result, for backwards compat reasons.

Summary by CodeRabbit

• New Features

  • Automatic resolution of payload and output presigned URLs when retrieving a run, enhancing user experience.
  • Introduction of a new task to generate and manage large JSON payloads, improving SDK capabilities.

• Improvements

  • Streamlined retrieval of run data, simplifying the process for users.
  • Enhanced handling of presigned URLs for better efficiency and clarity.

[changeset-bot]

🦋 Changeset detected

Latest commit: c78fa88

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
@trigger.dev/sdk	Patch
@trigger.dev/core	Patch
@trigger.dev/build	Patch
trigger.dev	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a feature that automatically resolves presigned URLs for payload and output when retrieving a run via the runs.retrieve method. This includes the addition of a new asynchronous function to handle URL resolution, modifications to existing methods for improved control flow, and enhancements to the SDK's task management capabilities. Overall, the updates streamline the process of accessing run results and improve code maintainability.

Changes

File Path	Change Summary
.changeset/polite-tables-exercise.md	Introduced auto-resolve functionality for payload/output presigned URLs in the runs.retrieve method.
packages/core/src/v3/utils/ioSerialization.ts	Added resolvePresignedPacketUrl function to fetch data from presigned URLs and process the response.
packages/trigger-sdk/src/v3/runs.ts	Added resolvePayloadAndOutputUrls function to streamline retrieval of run data and handle presigned URLs. Modified retrieveRun for improved control flow.
references/v3-catalog/src/trigger/sdkUsage.ts	Modified sdkChild task to return payload and added autoResolvePayloadAndOutput task to handle large JSON payloads and manage task execution lifecycle.

Possibly related PRs

• Auto-resolve payload/output presigned urls when retrieving a run #1317: The main PR introduces a feature that automatically resolves payload and output presigned URLs when retrieving a run using the runs.retrieve method, which directly aligns with the objectives of PR Auto-resolve payload/output presigned urls when retrieving a run #1317 that also focuses on enhancing the runs.retrieve() function to automatically handle these URLs.

Suggested reviewers

• (No suggested reviewers provided)

Poem

🐇 In the meadow where bunnies play,
New features hop in, brightening the day!
Presigned URLs, now easy to find,
With every run, a treasure to unwind.
So let’s celebrate, with joy and cheer,
For smoother paths, we hold so dear! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai generate interesting stats about this repository and render them as a table.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[pkg-pr-new]

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1317

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev@1317

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1317

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1317

commit: c78fa88