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

feat: Added unit test for query/js delete - next item selection #31915

Merged
merged 2 commits into from Mar 19, 2024

Conversation

albinAppsmith
Copy link
Collaborator

@albinAppsmith albinAppsmith commented Mar 19, 2024

Description

This PR added unit test to validate getNextEntityAfterDelete

Fixes #31864

Automation

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

🔍 Cypress test results

Important

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/8340217451
Commit: 81950b382c97f2634a44d9f64eef904104df8390
Cypress dashboard url: Click here!
All cypress tests have passed 🎉🎉🎉

Summary by CodeRabbit

  • Refactor
    • Improved internal handling of redirection after deleting an entity to ensure a smoother user experience.
  • Tests
    • Added tests for better reliability in navigating between entities after deletions.

Copy link
Contributor

coderabbitai bot commented Mar 19, 2024

Walkthrough

Walkthrough

This update introduces enhancements to the delete functionality for JavaScript and queries within the application. The key changes involve making the RedirectAction enum and getNextEntityAfterDelete function publicly accessible, facilitating better handling of focus redirection after an entity is deleted. This ensures a smoother user experience by automatically focusing on the next appropriate entity, whether it's within the same group or elsewhere, thereby addressing specific deletion scenarios effectively.

Changes

File Path Change Summary
app/client/src/sagas/IDESaga.tsx Exported RedirectAction enum and getNextEntityAfterDelete function.
app/client/src/sagas/getNextEntityAfterDelete.test.ts Added tests for getNextEntityAfterDelete function to handle various deletion scenarios.

Assessment against linked issues

Objective Addressed Explanation
Delete functionality for JS & Queries (#31864) The changes directly support the objective by improving how the application handles deletion of JavaScript and queries, focusing on the user experience post-deletion without requiring additional input.

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>.
    • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added IDE Infra Issues related to the IDE infrastructure like saving changes IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod https://app.zenhub.com/workspaces/new-developers-pod-60507ad1d4b98d00150a2858/board Low An issue that is neither critical nor breaks a user flow New Developers Pod Issues that new developers face while exploring the IDE Release Task A simple Todo Enhancement New feature or request labels Mar 19, 2024
@albinAppsmith albinAppsmith added the ok-to-test Required label for CI label Mar 19, 2024
@github-actions github-actions bot removed the ok-to-test Required label for CI label Mar 19, 2024
@@ -111,7 +111,7 @@ interface RedirectActionDescription {
payload?: EntityItem;
}

function getNextEntityAfterDelete(
export function getNextEntityAfterDelete(
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider adding comprehensive documentation for the getNextEntityAfterDelete function. While the code is clear, detailed comments explaining the function's purpose, parameters, and return values would enhance maintainability and readability for future developers.

+ /**
+  * Determines the next entity to focus on after an entity is deleted.
+  *
+  * @param {string} deletedId The ID of the deleted entity.
+  * @param {EntityItem[]} allItems A list of all entities.
+  * @return {RedirectActionDescription} An object describing the redirect action to take.
+  */
export function getNextEntityAfterDelete(
  deletedId: string,
  allItems: EntityItem[],
): RedirectActionDescription {

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
export function getNextEntityAfterDelete(
/**
* Determines the next entity to focus on after an entity is deleted.
*
* @param {string} deletedId The ID of the deleted entity.
* @param {EntityItem[]} allItems A list of all entities.
* @return {RedirectActionDescription} An object describing the redirect action to take.
*/
export function getNextEntityAfterDelete(
deletedId: string,
allItems: EntityItem[],
): RedirectActionDescription {

@albinAppsmith albinAppsmith merged commit 8f70909 into release Mar 19, 2024
47 of 48 checks passed
@albinAppsmith albinAppsmith deleted the test-js-query-delete branch March 19, 2024 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request IDE Infra Issues related to the IDE infrastructure like saving changes IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod https://app.zenhub.com/workspaces/new-developers-pod-60507ad1d4b98d00150a2858/board Low An issue that is neither critical nor breaks a user flow New Developers Pod Issues that new developers face while exploring the IDE Release Task A simple Todo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Delete functionality for JS & Queries
2 participants