bug: updating env from trigger v3 SDK

[zvikarp]

The SDK fails when I try to update env without a task context, with this error: ReferenceError: name is not defined.

Here is my code with "@trigger.dev/sdk": "3.0.0-beta.48"

		configure({ secretKey: process.env.TRIGGER_SECRET_KEY });
		const triggerRes = await envvars.update(
			process.env.TRIGGER_PROJECT_REF,
			'dev',
			accessTokenKey,
			{ value: 'test' }
		);

I think I found the issue and proposing the fix in this PR. I didn't test it and currently don't have the bandwidth to do so.

✅ Checklist

• I have followed every step in the contributing guide
• The PR title follows the convention.
• I ran and tested the code works

---

Testing

Calling the API directly with the same variables is successful.

---

Changelog

N/A

---

Screenshots

N/A

💯

Summary by CodeRabbit

• New Features
  • Enhanced validation for input parameters in the update function, ensuring that a name is required for successful execution.
• Bug Fixes
  • Improved error handling by throwing an error when the required name parameter is missing.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 8ab5b83

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[coderabbitai]

Walkthrough

The changes introduce a validation check in the update function of the envvars.ts file to ensure that the nameOrRequestOptions parameter is provided. If this parameter is missing, an error is thrown with the message "name is required." Additionally, the assignment of the $name variable has been updated to use nameOrRequestOptions directly. These modifications enhance the function's error handling and clarify the expected input.

Changes

File Path	Change Summary
packages/trigger-sdk/src/v3/envvars.ts	Updated the update function to include a validation check for nameOrRequestOptions.

Poem

In the code where rabbits play,
A check was added, hip-hip-hooray!
"Name is required," it now will say,
To guide our paths in a clearer way.
With hops and jumps, we code all day! 🐰✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7652d8e and 8ab5b83.

Files selected for processing (1)

• packages/trigger-sdk/src/v3/envvars.ts (1 hunks)

Additional comments not posted (2)

packages/trigger-sdk/src/v3/envvars.ts (2)

355-357: LGTM!

The validation check for the nameOrRequestOptions parameter is a valuable addition. It enhances the function's error handling by enforcing the presence of a required input and provides a clear error message to guide the user.

---

365-365: Looks good!

The updated assignment of the $name variable directly using nameOrRequestOptions is a cleaner approach. It clarifies the expected input and reduces the reliance on non-null assertion operators.

---

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.