Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: prevent menu content to be rendered when there are no options #38329

Merged
merged 1 commit into from
Dec 24, 2024

Conversation

alex-golovanov
Copy link
Contributor

@alex-golovanov alex-golovanov commented Dec 23, 2024

Description

Fixes an issue where JS run menu is being shown with no items in it.

Fixes #38151

Automation

/ok-to-test tags="@tag.IDE"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12468478974
Commit: f032137
Cypress dashboard.
Tags: @tag.IDE
Spec:


Mon, 23 Dec 2024 15:12:31 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • Bug Fixes
    • Improved dropdown menu rendering logic to prevent displaying an empty menu when no options are available.

Copy link
Contributor

coderabbitai bot commented Dec 23, 2024

Walkthrough

The pull request addresses a UI rendering issue in the JSFunctionRun component within the JS Editor Toolbar. The primary modification involves adding a conditional rendering check to prevent displaying an empty dropdown menu when no function options are available. This change ensures that the menu is only rendered when there are actual selectable options, improving the user interface's logical behavior.

Changes

File Change Summary
app/client/src/pages/Editor/JSEditor/JSEditorToolbar/components/JSFunctionRun.tsx Added conditional rendering check {!!props.options.length && ...} to prevent rendering empty menu

Assessment against linked issues

Objective Addressed Explanation
Prevent clickable dropdown with no functions [#38151]

Possibly related PRs

Suggested labels

Task, JS Objects

Suggested reviewers

  • albinAppsmith
  • hetunandu

Poem

🚀 Dropdown's dance, now with grace,
No more empty menus to misplace
Conditional logic takes the stage
Rendering options on the page
Code refactored with a smile 🌟


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.

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.

@github-actions github-actions bot added Bug Something isn't working IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product Low An issue that is neither critical nor breaks a user flow Needs Triaging Needs attention from maintainers to triage Release labels Dec 23, 2024
@alex-golovanov
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

@alex-golovanov alex-golovanov added the ok-to-test Required label for CI label Dec 23, 2024
Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/12468477995.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 38329.
recreate: .

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)
app/client/src/pages/Editor/JSEditor/JSEditorToolbar/components/JSFunctionRun.tsx (1)

75-79: Consider using a unique identifier instead of 'label' in the 'key' prop.
If labels can be duplicated or changed, it might lead to React rendering conflicts. Prefer using something guaranteed unique (like an ID) in the key.

-<JSFunctionItem
-  key={option.label}
-  onSelect={onFunctionSelect}
-  option={option}
/>
+<JSFunctionItem
+  key={option.value} // or option.id if available
+  onSelect={onFunctionSelect}
+  option={option}
/>
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e45cbdf and f032137.

📒 Files selected for processing (1)
  • app/client/src/pages/Editor/JSEditor/JSEditorToolbar/components/JSFunctionRun.tsx (1 hunks)
🔇 Additional comments (1)
app/client/src/pages/Editor/JSEditor/JSEditorToolbar/components/JSFunctionRun.tsx (1)

72-73: The conditional rendering approach looks good.
This short-circuit ensures the menu is displayed only if there are options, preventing an empty or unusable menu.

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)
app/client/src/pages/Editor/JSEditor/JSEditorToolbar/components/JSFunctionRun.tsx (1)

72-82: Use a More Descriptive Condition Check.

The double negation pattern (e.g., !!props.options.length) can be replaced by a more explicit comparison (e.g., props.options.length > 0) to improve clarity.

- {!!props.options.length && (
+ {props.options.length > 0 && (
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e45cbdf and f032137.

📒 Files selected for processing (1)
  • app/client/src/pages/Editor/JSEditor/JSEditorToolbar/components/JSFunctionRun.tsx (1 hunks)

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)
app/client/src/pages/Editor/JSEditor/JSEditorToolbar/components/JSFunctionRun.tsx (1)

72-73: Consider a clearer conditional expression.
Using the double negation (!!) makes sense functionally. However, a more explicit conditional like "props.options.length > 0" could be more readable.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e45cbdf and f032137.

📒 Files selected for processing (1)
  • app/client/src/pages/Editor/JSEditor/JSEditorToolbar/components/JSFunctionRun.tsx (1 hunks)
🔇 Additional comments (1)
app/client/src/pages/Editor/JSEditor/JSEditorToolbar/components/JSFunctionRun.tsx (1)

74-80: Ensure the key prop is truly unique.
Using option.label as the key works if its value is guaranteed unique. Otherwise, consider including a unique ID to avoid potential rendering issues.

Copy link

Deploy-Preview-URL: https://ce-38329.dp.appsmith.com

@alex-golovanov alex-golovanov enabled auto-merge (squash) December 24, 2024 07:11
@alex-golovanov alex-golovanov merged commit 52a394f into release Dec 24, 2024
50 checks passed
@alex-golovanov alex-golovanov deleted the fix/38151-js-run-function-menu branch December 24, 2024 08:49
NandanAnantharamu pushed a commit that referenced this pull request Dec 27, 2024
…38329)

## Description
Fixes an issue where JS run menu is being shown with no items in it.

Fixes #38151 

## Automation

/ok-to-test tags="@tag.IDE"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/12468478974>
> Commit: f032137
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12468478974&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.IDE`
> Spec:
> <hr>Mon, 23 Dec 2024 15:12:31 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Bug Fixes**
- Improved dropdown menu rendering logic to prevent displaying an empty
menu when no options are available.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product Low An issue that is neither critical nor breaks a user flow Needs Triaging Needs attention from maintainers to triage ok-to-test Required label for CI Release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Action Redesign : The function dropdown appears to be clickable even though no function is present
2 participants