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: Module instance delete navigation #31140

Merged
merged 4 commits into from Feb 20, 2024

Conversation

albinAppsmith
Copy link
Collaborator

@albinAppsmith albinAppsmith commented Feb 15, 2024

Description

This PR addresses the below issues,

  1. In App editor, deleting a package is not redirecting to add screen
  2. In package Editor, deleting a js/query should fall back to the main
  3. Icon not displaying for tabs of package instance

PR fixes following issue(s)

Fixes #30894

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Testing

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration.
Delete anything that is not relevant

  • Manual
  • JUnit
  • Jest
  • Cypress

Test Plan

Add Testsmith test cases links that relate to this PR

Issues raised during DP testing

Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR)

Checklist:

Dev activity

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • PR is being merged under a feature flag

QA activity:

  • Speedbreak features have been covered
  • Test plan covers all impacted features and areas of interest
  • Test plan has been peer reviewed by project stakeholders and other QA members
  • Manually tested functionality on DP
  • We had an implementation alignment call with stakeholders post QA Round 2
  • Cypress test cases have been added and approved by SDET/manual QA
  • Added Test Plan Approved label after Cypress tests were reviewed
  • Added Test Plan Approved label after JUnit tests were reviewed

Summary by CodeRabbit

  • New Features

    • Added IDE type detection for enhanced redirection logic in code editing workflows.
    • Introduced customizable module icons in the Explorer view for better visual differentiation.
  • Enhancements

    • Improved IDE tab management to support JavaScript and Query modules, ensuring a smoother development experience.

@github-actions github-actions bot added Bug Something isn't working IDE Issues related to the IDE IDE Navigation Issues/feature requests related to IDE navigation, and context switching Medium Issues that frustrate users due to poor UX Needs Triaging Needs attention from maintainers to triage New Developers Pod Issues that new developers face while exploring the IDE Production labels Feb 15, 2024
Copy link
Contributor

coderabbitai bot commented Feb 15, 2024

Walkthrough

The changes involve enhancements and bug fixes in the application's IDE functionality, particularly around JavaScript (JS) actions and module management. Key updates include importing utilities for better IDE type handling, improving the user experience with visual cues through customizable icons, and refining redirection logic after certain actions, such as deleting JS entities. These modifications aim to streamline the development process within the IDE, ensuring users are guided appropriately through the interface and improving the management of JS and query modules.

Changes

File Path Change Summary
app/client/src/ce/sagas/JSActionSagas.ts
app/client/src/sagas/ActionSagas.ts
Added imports for IDE utilities, introduced ideType variable, and updated redirection logic in relevant sagas.
app/client/src/pages/Editor/Explorer/ExplorerIcons.tsx Introduced a new ModuleIcon function for customizable icons.
app/client/src/sagas/IDESaga.tsx Enhanced support for JS_MODULE_INSTANCE and QUERY_MODULE_INSTANCE entities; updated redirection logic to include pageId.

Assessment against linked issues

Objective Addressed Explanation
#30894: Correct redirection after deleting a private entity in the JS module The changes in JSActionSagas.ts and ActionSagas.ts directly address the redirection issue by considering the IDE type before redirecting, ensuring the correct redirection behavior after deleting private entities in the JS module.

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.
  • 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 from git 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.

@@ -46,12 +52,12 @@ export function* handleJSEntityRedirect(deletedId: string) {
const redirectAction = getNextEntityAfterDelete(deletedId, allJsItems);
switch (redirectAction.action) {
case RedirectAction.CREATE:
history.push(jsCollectionAddURL({}));
history.push(jsCollectionAddURL({ pageId }));
Copy link
Member

Choose a reason for hiding this comment

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

Dont force page id here. This will eventually handle module and workflow use cases when they start using Editor Pane Segments

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is causing pageId not found error while deleting package instance.

…o package-related-delete-navigation-fixes
@albinAppsmith
Copy link
Collaborator Author

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

Copy link

Whoa, @tag.All spotted in your test suite! 🚀
While @tag.All is cool, like a catch-all net, why not try specific tags? 🏷️
Narrow down your suite with specific tags for quicker and more accurate tests! 🚀 Less waiting, more zipping through tests like a ninja!
Explore the tags documentation here

Copy link

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/7926163593.
Workflow: Appsmith External Integration Test Workflow.
Tags: ``.

Copy link

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

@albinAppsmith albinAppsmith merged commit 3757f31 into release Feb 20, 2024
15 checks passed
@albinAppsmith albinAppsmith deleted the package-related-delete-navigation-fixes branch February 20, 2024 05:01
albinAppsmith added a commit that referenced this pull request Feb 22, 2024
KelvinOm added a commit that referenced this pull request Feb 22, 2024
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 Issues related to the IDE Medium Issues that frustrate users due to poor UX Needs Triaging Needs attention from maintainers to triage New Developers Pod Issues that new developers face while exploring the IDE Production
Projects
None yet
2 participants