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: fetch actions and plugins before choosing which GQL editor tab to focus #33697

Conversation

danguilherme
Copy link
Contributor

@danguilherme danguilherme commented May 23, 2024

Description

FocusRetentionSaga is not respecting the GraphQL API editor subtype when the page is being loaded because it's running its focus management logic before knowing that the action being edited is in fact a GraphQL plugin action.

So now I am waiting for the app's actions and plugins to be loaded before the focus retention logic is run.

Before After
gql.headers.tab.bug.mp4
gql.headers.tab.bug.fixed.mp4

Fixes #33695

Automation

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

🔍 Cypress test results

Caution

If you modify the content in this section, you are likely to disrupt the CI result for your PR.

Communication

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

  • Yes
  • No

Copy link
Contributor

coderabbitai bot commented May 23, 2024

Walkthrough

Walkthrough

The recent changes in AppIDEFocusStrategy.ts aim to improve the focus behavior of the API Editor tabs by ensuring that actions and plugins are fetched before focusing. This involves importing all from "redux-saga/effects" and adding a conditional block to wait for FETCH_ACTIONS_SUCCESS and FETCH_PLUGINS_SUCCESS actions.

Changes

File Path Change Summary
app/client/src/ce/navigation/FocusStrategy/AppIDEFocusStrategy.ts Imported all from "redux-saga/effects" and added a new conditional block to wait for FETCH_ACTIONS_SUCCESS and FETCH_PLUGINS_SUCCESS before focusing on tabs in the API Editor.

Assessment against linked issues

Objective Addressed Explanation
Ensure the "Body" tab is the default one after reloading the GraphQL query editor (#33695) The changes ensure actions and plugins are fetched before focusing, but it is unclear if this guarantees the "Body" tab is set as the default after reload. Further validation is needed.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 63f9571 and 4a3d5ec.
Files selected for processing (1)
  • app/client/src/ce/navigation/FocusStrategy/AppIDEFocusStrategy.test.ts (2 hunks)
Additional comments not posted (2)
app/client/src/ce/navigation/FocusStrategy/AppIDEFocusStrategy.test.ts (2)

5-5: The addition of all from "redux-saga/effects" is appropriate for handling parallel effects in sagas, aligning well with the PR's objectives.


252-264: The new test case effectively ensures that actions and plugins are loaded before setting focus, which aligns with the PR's objectives to fix the focus issue on page reloads.


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 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 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 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.

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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

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.

@danguilherme
Copy link
Contributor Author

Hey @jsartisan, I'm tagging you as you were the person that reviewed my last PR. Could you please take a look at this one?

@jsartisan jsartisan requested a review from hetunandu May 23, 2024 12:12
@jsartisan
Copy link
Contributor

@hetunandu I think you would be the better person to review this PR.

hetunandu
hetunandu previously approved these changes May 23, 2024
@hetunandu
Copy link
Member

@danguilherme can you also add this scenario to the test case here

@danguilherme
Copy link
Contributor Author

@hetunandu done!

@hetunandu hetunandu added the ok-to-test Required label for CI label May 23, 2024
Copy link

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.

@github-actions github-actions bot added the Stale label May 30, 2024
@danguilherme
Copy link
Contributor Author

Hey there @hetunandu, any updates here? Commenting so it's not closed.

@github-actions github-actions bot removed the Stale label Jun 3, 2024
@hetunandu
Copy link
Member

All tests passed in the mirror PR. Merging this in

@hetunandu hetunandu merged commit ff237bc into appsmithorg:release Jun 5, 2024
135 of 138 checks passed
@danguilherme danguilherme deleted the bugfix/make-body-tab-the-default-on-reload-gql-query branch June 5, 2024 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Required label for CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: GraphQL query editor: Headers tab is the default one after a reload
3 participants