Fix a bug with async prop value validation

[bzwrk]

WHY

Summary by CodeRabbit

• Bug Fixes
  • Improved validation for string properties in asynchronous contexts
• Version Update
  • Bumped package version to 1.0.0-preview.21

[linear]

DJ-2822 Fix connect-react bug with stringPropErrors

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	⬜️ Ignored (Inspect)			Jan 17, 2025 7:51pm
pipedream-docs	⬜️ Ignored (Inspect)			Jan 17, 2025 7:51pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Jan 17, 2025 7:51pm

[coderabbitai]

Walkthrough

This pull request focuses on a bug fix in the @pipedream/connect-react package, specifically addressing asynchronous property value validation for string properties. The changes involve updating the version from 1.0.0-preview.20 to 1.0.0-preview.21, modifying the stringPropErrors function in the component utility to correctly evaluate the valueOpt variable. The update aims to improve the validation process for string properties in asynchronous contexts.

Changes

File	Change Summary
packages/connect-react/CHANGELOG.md	Added new entry for version 1.0.0-preview.21 documenting bug fix for string property validation
packages/connect-react/package.json	Version bumped from 1.0.0-preview.20 to 1.0.0-preview.21
packages/connect-react/src/utils/component.ts	Modified stringPropErrors function to check valueOpt instead of value for undefined condition

Possibly related PRs

• fix(sdk+connect-react): string_options -> stringOptions #14867: Changes related to stringOptions casing
• fix: Enforce string limits #14953: Validation logic for string properties and enforcing string limits
• Treat empty string prop value as a valid input #15325: Handling empty string prop values as valid inputs

Suggested labels

bug, dependencies, tracked internally, prioritized

Suggested reviewers

• adolfo-pd

Poem

🐰 A rabbit's tale of code so bright,
Where strings dance in validation's light
One small change, a variable's might
From value to valueOpt, we take flight
Async props now validated right! 🔍✨

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/connect-react/src/utils/component.ts (1)

101-101: LGTM! Consider adding type validation.

The fix correctly validates the raw option value (valueOpt) instead of the processed value, which resolves the async prop validation issue. However, consider adding type validation to ensure the value is actually a string when present.

 if (!prop.default && (valueOpt == null || typeof valueOpt === "undefined")) return [
   "required",
 ]
+const value = valueFromOption(valueOpt)
+if (value != null && typeof value !== "string") return [
+  "not a string",
+]

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6e6631e and b6a7d37.

⛔ Files ignored due to path filters (2)

• packages/connect-react/examples/nextjs/package-lock.json is excluded by !**/package-lock.json
• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (3)

• packages/connect-react/CHANGELOG.md (1 hunks)
• packages/connect-react/package.json (1 hunks)
• packages/connect-react/src/utils/component.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• packages/connect-react/package.json

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

• GitHub Check: pnpm publish
• GitHub Check: Lint Code Base

🔇 Additional comments (1)

packages/connect-react/CHANGELOG.md (1)

4-7: LGTM! Clear and concise changelog entry.

The changelog entry accurately describes the bug fix and follows the established format. The version bump is appropriate for a bug fix in a preview release.