Skip to content

Conversation

bzwrk
Copy link
Contributor

@bzwrk bzwrk commented Jan 21, 2025

Add support for custom string input
Screenshot 2025-01-21 at 4 20 06 PM

Copy link

linear bot commented Jan 21, 2025

Copy link

vercel bot commented Jan 21, 2025

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 21, 2025 10:17pm
pipedream-docs ⬜️ Ignored (Inspect) Jan 21, 2025 10:17pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jan 21, 2025 10:17pm

Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

Walkthrough

This pull request introduces a new feature in the @pipedream/connect-react package that allows custom string input for remote options. The changes span across multiple files, including updating the changelog, package version, and modifying the ControlSelect and RemoteOptionsContainer components to support dynamically creating new options. The version has been bumped from 1.0.0-preview.21 to 1.0.0-preview.22.

Changes

File Change Summary
packages/connect-react/CHANGELOG.md Added entry for version [1.0.0-preview.22] with new feature for custom string input
packages/connect-react/package.json Updated package version from 1.0.0-preview.21 to 1.0.0-preview.22
packages/connect-react/src/components/ControlSelect.tsx Added handleCreate function to dynamically add new options and onCreateOption prop
packages/connect-react/src/components/RemoteOptionsContainer.tsx Added isCreatable property to ControlSelect component

Sequence Diagram

sequenceDiagram
    participant User
    participant ControlSelect
    participant Options Array

    User->>ControlSelect: Enter new option
    ControlSelect->>ControlSelect: handleCreate(inputValue)
    ControlSelect->>Options Array: Unshift new option
    Options Array-->>ControlSelect: Updated options list
    ControlSelect-->>User: Display updated select options
Loading

Possibly related PRs

Suggested labels

bug, dependencies, tracked internally, prioritized

Suggested reviewers

  • adolfo-pd
  • jverce

Poem

🐰 A rabbit's tale of select delight,
Where options spring with creative might!
Unshift and create, a dynamic dance,
Flexibility blooms with each new chance.
Code hops forward, no limits in sight! 🌟


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.

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: 2

🔭 Outside diff range comments (1)
packages/connect-react/src/components/ControlSelect.tsx (1)

Line range hint 13-19: Enhance type safety for creatable options.

The component allows creating new options with string values, but the generic type T doesn't enforce this constraint. This could lead to type mismatches when isCreatable is true.

Consider constraining the type when isCreatable is true:

type ControlSelectProps<T> = {
  isCreatable?: boolean;
  options: {label: string; value: T extends string ? T : never;}[];
  selectProps?: ReactSelectProps;
  showLoadMoreButton?: boolean;
  onLoadMore?: () => void;
};
🧹 Nitpick comments (1)
packages/connect-react/CHANGELOG.md (1)

4-7: Enhance changelog entry with more details.

The current entry is too brief and doesn't provide enough context about the feature's impact and usage.

Consider expanding the entry:

 # [1.0.0-preview.22] - 2025-01-21
 
-Allow custom string input for remote options
+### Added
+- Support for custom string input in remote options
+  - Users can now enter custom values when `isCreatable` is enabled
+  - Custom values are treated as both label and value
+
+### BREAKING CHANGES
+- Remote options are now creatable by default
+  - To maintain previous behavior, explicitly set `isCreatable={false}`
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8c278bf and 77eaee6.

⛔ 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 (4)
  • packages/connect-react/CHANGELOG.md (1 hunks)
  • packages/connect-react/package.json (1 hunks)
  • packages/connect-react/src/components/ControlSelect.tsx (2 hunks)
  • packages/connect-react/src/components/RemoteOptionsContainer.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 (1)
  • GitHub Check: pnpm publish

Comment on lines +100 to +105
const handleCreate = (inputValue: string) => {
options.unshift({
label: inputValue,
value: inputValue,
})
};
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Avoid direct array mutation and add input validation.

The handleCreate function directly mutates the options array, which could lead to unexpected behavior in React. Additionally, there's no validation of the input value.

Consider this safer implementation:

-  const handleCreate = (inputValue: string) => {
-    options.unshift({
-      label: inputValue,
-      value: inputValue,
-    })
-  };
+  const handleCreate = (inputValue: string) => {
+    if (!inputValue?.trim()) return;
+    const newOption = {
+      label: inputValue,
+      value: inputValue as T,
+    };
+    onChange([newOption, ...(Array.isArray(value) ? value : [])]);
+  };

Committable suggestion skipped: line range outside the PR's diff.


return (
<ControlSelect
isCreatable={true}
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

🛠️ Refactor suggestion

Confirmed: isCreatable needs to be configurable

The component's props interface (RemoteOptionsContainerProps) currently only includes queryEnabled and doesn't have any configuration for controlling the creatable behavior. Making isCreatable configurable through props would indeed improve component flexibility.

  • Add allowCustomInput?: boolean to RemoteOptionsContainerProps
  • Document the new prop's purpose and default behavior
🔗 Analysis chain

Make isCreatable configurable instead of hardcoded.

Hardcoding isCreatable to true forces all remote options to be creatable, which might not be appropriate for all use cases and could bypass server-side validation.

Consider making it configurable:

-      isCreatable={true}
+      isCreatable={prop.allowCustomInput}

This would require adding an allowCustomInput flag to the prop configuration schema.

Let's check if the prop configuration schema already supports this:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for prop configuration schema
rg -A 5 "type.*PropConfiguration" || rg -A 5 "interface.*PropConfiguration"

Length of output: 76


Script:

#!/bin/bash
# Check RemoteOptionsContainer.tsx for prop definitions
cat packages/connect-react/src/components/RemoteOptionsContainer.tsx | grep -A 10 "interface.*Props"

# Search for any remote options related types/interfaces
rg -g "*.ts*" -A 5 "interface.*Remote.*Props|type.*Remote.*Props"

Length of output: 760

@bzwrk bzwrk merged commit def58b8 into master Jan 21, 2025
8 checks passed
@bzwrk bzwrk deleted the biz/dj-2813-support-custom-input-strings-in-connect-react branch January 21, 2025 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants