Fixed issue with asResponse and withResponse not working on runs.retrieve

[ericallam]

Summary by CodeRabbit

• Dependencies

  • Patched @trigger.dev/sdk and @trigger.dev/core

• Bug Fixes

  • Resolved issues with runs.retrieve function
  • Improved data handling for API responses

• Enhancements

  • Added more flexible type handling for API client options
  • Simplified run retrieval process

[changeset-bot]

🦋 Changeset detected

Latest commit: 6620021

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

This PR includes changesets to release 12 packages

Name	Type
@trigger.dev/sdk	Patch
@trigger.dev/core	Patch
@trigger.dev/build	Patch
trigger.dev	Patch
@internal/redis-worker	Patch
@internal/zod-worker	Patch
@trigger.dev/react-hooks	Patch
@trigger.dev/rsc	Patch
@trigger.dev/database	Patch
@trigger.dev/otlp-importer	Patch
references-nextjs-realtime	Patch
@internal/testcontainers	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]

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/trigger-sdk/src/v3/runs.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

packages/core/src/v3/apiClient/core.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

packages/core/src/v3/apiClient/index.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

This pull request introduces patches for the @trigger.dev/sdk and @trigger.dev/core dependencies. The changes primarily focus on enhancing type flexibility and data handling in the API client. Modifications include updating the ZodFetchOptions type, introducing a new AnyZodFetchOptions type, and refining the retrieveRun function's data preparation and return mechanism. The updates aim to improve type safety and provide more robust data processing capabilities.

Changes

File	Change Summary
.changeset/lazy-carpets-reply.md	Patch applied to @trigger.dev/sdk and @trigger.dev/core
packages/core/src/v3/apiClient/core.ts	- Added generic type parameter to ZodFetchOptions - Introduced AnyZodFetchOptions type - Updated zodfetch function signature - Added data preparation option in _doZodFetch
packages/core/src/v3/apiClient/index.ts	- Added AnyZodFetchOptions type - Updated mergeRequestOptions method signature
packages/trigger-sdk/src/v3/runs.ts	- Refined type import for ApiPromise - Modified retrieveRun function to include prepareData - Simplified run retrieval return statement

Possibly related PRs

• fix: cleanup ttl expire run graphile jobs #1373: Handling task runs with a TTL, potentially related to run retrieval fixes
• Multiple streams can now be consumed at the same time #1522: Introducing multiple stream consumption in @trigger.dev/core
• Fix cancelled runs breaking realtime subscriptions #1533: Addressing issues with cancelled runs and real-time subscriptions
• Handle errors thrown by requests in Realtime react hooks #1599: Enhancing error handling in real-time React hooks

Poem

🐰 Patches hopping, types so bright,
SDK dancing with delight!
Flexible fetching, data's new flight,
CodeRabbit's magic takes its might!
Runs retrieved with elegant grace 🚀

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a24b2a7 and 6620021.

📒 Files selected for processing (4)

• .changeset/lazy-carpets-reply.md (1 hunks)
• packages/core/src/v3/apiClient/core.ts (3 hunks)
• packages/core/src/v3/apiClient/index.ts (2 hunks)
• packages/trigger-sdk/src/v3/runs.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
• GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
• GitHub Check: typecheck / typecheck
• GitHub Check: units / 🧪 Unit Tests
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (10)

packages/trigger-sdk/src/v3/runs.ts (3)

17-17: LGTM!

The import of ApiPromise is correctly added to support the type changes in the retrieveRun function.

---

190-192: LGTM! Proper data preparation setup.

The prepareData option is correctly set to resolvePayloadAndOutputUrls, ensuring that payload and output URLs are resolved before the data is returned.

---

197-197: LGTM! Simplified return statement.

The return statement now correctly returns the API promise, enabling asResponse and withResponse to work properly.

packages/core/src/v3/apiClient/core.ts (4)

29-37: LGTM! Enhanced type safety with generic parameter.

The ZodFetchOptions type now correctly includes a generic type parameter and the prepareData function, improving type safety and enabling data transformation.

---

39-40: LGTM! Added flexible options type.

The AnyZodFetchOptions type provides a convenient way to use the options when the exact type isn't needed.

---

73-74: LGTM! Improved type inference in zodfetch.

The zodfetch function now correctly uses the schema's output type for its options parameter.

---

203-206: LGTM! Added data preparation handling.

The function now correctly processes the data through prepareData if provided, enabling custom data transformations.

packages/core/src/v3/apiClient/index.ts (2)

35-35: LGTM! Added new type import.

The AnyZodFetchOptions import is correctly added to support the updated function signature.

---

867-869: LGTM! Updated function signature.

The mergeRequestOptions function now correctly uses AnyZodFetchOptions for better type flexibility.

.changeset/lazy-carpets-reply.md (1)

1-6: LGTM! Clear and concise changeset.

The changeset correctly documents the patch updates and provides a clear description of the fix.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 generate docstrings to generate docstrings for this PR. (Beta)
• @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]

@trigger.dev/build

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1648

@trigger.dev/react-hooks

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/react-hooks@1648

trigger.dev

npm i https://pkg.pr.new/triggerdotdev/trigger.dev@1648

@trigger.dev/rsc

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/rsc@1648

@trigger.dev/core

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1648

@trigger.dev/sdk

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1648

commit: 6620021