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: kebab menu rename jumps to wrong tab #38346

Merged
merged 2 commits into from
Dec 24, 2024

Conversation

alex-golovanov
Copy link
Contributor

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

Description

Fixes an issue when renaming from context menu in JS objects, cursor always jumps to the first tab.

Fixes #38207

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/12480124658
Commit: 221119c
Cypress dashboard.
Tags: @tag.IDE
Spec:


Tue, 24 Dec 2024 10:31:34 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features
    • Improved context menu options with enhanced performance and clarity.
  • Bug Fixes
    • Added checks for the availability of the CodeMirror instance to prevent errors.
  • Refactor
    • Simplified state management by replacing useState with useBoolean.
    • Optimized context menu option generation using useMemo.

Copy link
Contributor

coderabbitai bot commented Dec 24, 2024

Walkthrough

The pull request modifies the AppJSEditorContextMenu.tsx file, focusing on improving state management and performance in the context menu component. The changes primarily involve replacing useState with useBoolean hook, updating dependency arrays, and implementing useMemo for optimizing context menu option generation. The modifications aim to enhance the component's efficiency and robustness in handling JS object interactions.

Changes

File Change Summary
app/client/src/pages/Editor/JSEditor/AppJSEditorContextMenu.tsx - Replaced useState with useBoolean hook
- Updated function dependency arrays
- Implemented useMemo for context menu options
- Added null check for CodeMirror instance

Assessment against linked issues

Objective Addressed Explanation
Prevent focus shift when renaming JSObject [#38207]

Possibly related PRs

Suggested labels

Bug, High, Release, IDE Product, Needs Triaging, IDE Pod, ok-to-test

Suggested reviewers

  • hetunandu
  • albinAppsmith

Poem

🖥️ In the realm of code so bright,
Hooks dance with memoized might,
Context menus now sleek and clean,
Performance gains, a coder's dream!
Refactoring with gentle care 🌟


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 Javascript Product Issues related to users writing javascript in appsmith JS Objects Issues related to JS Objects Medium Issues that frustrate users due to poor UX Needs Triaging Needs attention from maintainers to triage Production Query & JS Pod Issues related to the query & JS Pod labels Dec 24, 2024
@alex-golovanov alex-golovanov added the ok-to-test Required label for CI label Dec 24, 2024
@alex-golovanov
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/12480129862.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 38346.
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/AppJSEditorContextMenu.tsx (1)

104-104: Consider error handling on deletion.
If deleteJSCollectionRequest fails, you might want to surface an error message to the user or revert the confirm delete state gracefully.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f2733c6 and 221119c.

📒 Files selected for processing (1)
  • app/client/src/pages/Editor/JSEditor/AppJSEditorContextMenu.tsx (5 hunks)
🔇 Additional comments (6)
app/client/src/pages/Editor/JSEditor/AppJSEditorContextMenu.tsx (6)

1-2: Good use of useBoolean import.
This is a clean way to handle boolean states more expressively than using raw useState.


38-38: Type-only import for CodeMirror.
Great job adding type safety for the CodeMirror reference. This helps ensure proper editor-related operations.


51-55: Neat use of destructured helpers from useBoolean.
The setFalse, setValue, and value APIs make the confirm-delete state logic very straightforward.


72-72: Check rename behavior in different usage contexts.
Making sure the rename behavior addresses the intended tab focus is essential. Suggest verifying the triggered dispatch thoroughly.


109-222: Validate the extensive dependency array in useMemo.
While it’s good to list all dependencies, confirm that all entries (e.g. dispatch, setConfirmDelete) must re-trigger the memo. If some dependencies rarely change, consider passing stable references to prevent unnecessary re-renders.


227-227: Smart resetting of confirm delete state.
Using onMenuClose to revert confirmDelete ensures consistent behavior if the menu closes abruptly.

Copy link

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

@alex-golovanov alex-golovanov enabled auto-merge (squash) December 24, 2024 11:01
@alex-golovanov alex-golovanov merged commit c0d393a into release Dec 24, 2024
46 checks passed
@alex-golovanov alex-golovanov deleted the fix/38207-kebab-rename-wrong-tab branch December 24, 2024 12:23
NandanAnantharamu pushed a commit that referenced this pull request Dec 27, 2024
## Description
Fixes an issue when renaming from context menu in JS objects, cursor
always jumps to the first tab.

Fixes #38207 

## 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/12480124658>
> Commit: 221119c
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12480124658&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.IDE`
> Spec:
> <hr>Tue, 24 Dec 2024 10:31:34 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

- **New Features**
	- Improved context menu options with enhanced performance and clarity.
- **Bug Fixes**
- Added checks for the availability of the CodeMirror instance to
prevent errors.
- **Refactor**
- Simplified state management by replacing `useState` with `useBoolean`.
	- Optimized context menu option generation using `useMemo`.

<!-- 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 Javascript Product Issues related to users writing javascript in appsmith JS Objects Issues related to JS Objects Medium Issues that frustrate users due to poor UX Needs Triaging Needs attention from maintainers to triage ok-to-test Required label for CI Production Query & JS Pod Issues related to the query & JS Pod
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Action redesign: Focus shifts to another tab when renaming a JSObject
2 participants