Skip to content

Conversation

@jverce
Copy link
Contributor

@jverce jverce commented Jan 8, 2025

WHY

When toggling an optional prop in the Connect React lib, we discard any previously configured values. This change fixed that, so if a prop is disabled after configuring it, re-enabling it again will use the previoulsy configured value.

Summary by CodeRabbit

  • Chores

    • Updated package version of @pipedream/connect-react from 1.0.0-preview.17 to 1.0.0-preview.18
  • Improvements

    • Enhanced form context management for optional properties, allowing restoration of previous property values when re-enabling

When toggling an optional prop in the Connect React lib, we discard any
previously configured values. This change fixed that, so if a prop is
disabled after configuring it, re-enabling it again will use the
previoulsy configured value.
@jverce jverce added bug Something isn't working javascript Pull requests that update Javascript code tracked internally Issue is also tracked in our internal issue tracker prioritized Prioritized issue labels Jan 8, 2025
@jverce jverce self-assigned this Jan 8, 2025
@jverce jverce requested a review from tjk January 8, 2025 22:30
@vercel
Copy link

vercel bot commented Jan 8, 2025

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

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jan 9, 2025 0:23am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 8, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request involves two primary changes: updating the version of the @pipedream/connect-react package to 1.0.0-preview.18 and modifying the optionalPropSetEnabled function in the form-context.tsx file. The version update is straightforward, while the function modification enhances the handling of optional properties within the form context by restoring previous values when a property is re-enabled.

Changes

File Change Summary
packages/connect-react/package.json Version bumped from 1.0.0-preview.17 to 1.0.0-preview.18
packages/connect-react/src/hooks/form-context.tsx Enhanced optionalPropSetEnabled function to restore previous values of optional properties when re-enabled

Possibly related PRs

Suggested labels

dependencies

Suggested reviewers

  • adolfo-pd

Poem

🐰 A rabbit's tale of code so bright,
Version bumped with gentle might,
Optional props now dance and sing,
Restored with each enabling wing!
Code hops forward, clean and light 🌟

Finishing Touches

  • 📝 Generate Docstrings

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
🪧 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.

@vercel
Copy link

vercel bot commented Jan 8, 2025

@jverce is attempting to deploy a commit to the Pipedreamers Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/connect-react/src/hooks/form-context.tsx (1)

346-350: LGTM! The implementation correctly preserves optional prop values.

The changes effectively solve the issue by restoring previously configured values when an optional prop is re-enabled. The implementation is type-safe and maintains proper error handling.

Consider adding a comment to explain the preservation behavior for future maintainers:

    } else if (__configuredProps?.[prop.name as keyof ConfiguredProps<T>] !== undefined) {
+     // Restore previously configured value when re-enabling an optional prop
      setConfiguredProp(
        idx,
        __configuredProps[prop.name as keyof ConfiguredProps<T>],
      );
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7246f75 and d1003d4.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • packages/connect-react/package.json (1 hunks)
  • packages/connect-react/src/hooks/form-context.tsx (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

@jverce jverce merged commit e549fad into PipedreamHQ:master Jan 9, 2025
7 of 8 checks passed
@jverce jverce deleted the fix/optional-prop-toggle branch January 9, 2025 00:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working javascript Pull requests that update Javascript code prioritized Prioritized issue tracked internally Issue is also tracked in our internal issue tracker

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants