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

chore: Refactor JS and Query List context switching #30834

Merged
merged 5 commits into from
Feb 2, 2024

Conversation

hetunandu
Copy link
Member

@hetunandu hetunandu commented Feb 1, 2024

Refactor the context switching for JS List and Query List to handle scenarios in EE

Fixes #30820

Summary by CodeRabbit

  • New Features
    • Added new routing paths for JavaScript Editor files, enhancing navigation within the IDE.
    • Implemented new redirect logic for entity deletion, improving user experience during development.
  • Enhancements
    • Updated focus elements and selectors for better interaction with JavaScript objects and queries in the IDE.
    • Improved URL generation for JavaScript entities, facilitating easier access and management.
  • Refactor
    • Streamlined the handling of focus elements and entity redirection, making the codebase more efficient and maintainable.
    • Externalized a utility function for broader use across modules, enhancing code reusability.
  • Bug Fixes
    • Corrected the focus entity mapping, ensuring accurate navigation and selection within the IDE environment.

Copy link
Contributor

coderabbitai bot commented Feb 1, 2024

Walkthrough

Walkthrough

The changes primarily focus on improving the navigation and entity management within the application IDE, particularly around JavaScript (JS) objects and queries. This includes updates to how entities are identified, selected, and redirected within the IDE, streamlining the focus and selection mechanisms. Additionally, there's an introduction of new utilities and modifications to routing to support these enhancements. The modifications aim to enhance the developer experience within the IDE by making entity management more intuitive and efficient.

Changes

File(s) Change Summary
app/client/src/ce/navigation/FocusElements/AppIDE.ts, .../FocusSelectors.ts, .../FocusSetters.ts, .../selectors/appIDESelectors.ts, .../selectors/jsPaneSelectors.ts, .../selectors/queryPaneSelectors.ts Updated focus elements, selectors, and setters to improve entity identification and selection. Removed outdated selectors and imports.
app/client/src/ce/pages/Editor/IDE/EditorPane/JS/utils.ts, .../ee/pages/Editor/IDE/EditorPane/JS/utils.ts Introduced utility functions for JS entity URL generation.
app/client/src/ce/pages/Editor/IDE/MainPane/useRoutes.ts Altered routing to include new paths for JS Editor File handling.
app/client/src/ce/sagas/JSActionSagas.ts, .../sagas/ActionSagas.ts, .../sagas/IDESaga.tsx Modified sagas to support new entity redirection logic and removed outdated imports.
app/client/src/navigation/FocusEntity.ts Updated FocusStoreHierarchy to correct the mapping for JS module instances.

Assessment against linked issues

Objective Addressed Explanation
Fix context retention and default selection of module instances (#30820)
Introduce "Modules" section and manage different module types (#29588) The provided changes focus on navigation and entity management improvements rather than introducing new module types or a "Modules" section.

Related issues

  • IA changes #29588: The changes in this PR do not directly address the introduction of a "Modules" section or the management of different module types as described. However, the improvements in entity management and navigation could indirectly support the groundwork for such features. This issue might benefit from these changes for future iterations or extensions of the IDE's functionality.

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.

@github-actions github-actions bot added IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE skip-changelog Adding this label to a PR prevents it from being listed in the changelog labels Feb 1, 2024
@hetunandu
Copy link
Member Author

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

Copy link

github-actions bot commented Feb 1, 2024

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/7740176126.
Workflow: Appsmith External Integration Test Workflow.
Tags: @tag.Sanity, @tag.IDE.

Copy link

github-actions bot commented Feb 1, 2024

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

@hetunandu hetunandu merged commit 725bbbd into release Feb 2, 2024
16 checks passed
@hetunandu hetunandu deleted the fix/module-context-switching branch February 2, 2024 05:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Fix context retention and default selection of module instances
2 participants