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: split default tab logic #38414

Merged
merged 1 commit into from
Dec 30, 2024
Merged

Conversation

KelvinOm
Copy link
Collaborator

@KelvinOm KelvinOm commented Dec 30, 2024

Description

Split the logic for the plugin action tabs. Now the files in CE and EE repo for the ce folder are the same. Redefine the logic in EE hooks only.

EE PR — https://github.com/appsmithorg/appsmith-ee/pull/5840

Automation

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

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12546120368
Commit: 8fa499e
Cypress dashboard.
Tags: @tag.All
Spec:


Mon, 30 Dec 2024 13:26:11 UTC

Communication

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

  • Yes
  • No

Copy link
Contributor

coderabbitai bot commented Dec 30, 2024

Walkthrough

The pull request focuses on refactoring the PluginActionResponse component and introducing a new useDefaultTab hook. The changes simplify the tab selection logic by removing complex conditionals and introducing a centralized hook for managing default tab behavior. The modifications streamline the component's state management, particularly around schema and response tab handling, by reducing dependencies and creating a more straightforward approach to tab selection.

Changes

File Change Summary
app/client/src/PluginActionEditor/components/PluginActionResponse/PluginActionResponse.tsx Removed doesPluginRequireDatasource function and useShowSchema hook; Simplified context usage; Removed complex useEffect for tab selection
app/client/src/ce/PluginActionEditor/components/PluginActionResponse/hooks/useDefaultTab.tsx Introduced new custom hook to manage default tab selection based on plugin type and datasource requirements
app/client/src/ee/PluginActionEditor/components/PluginActionResponse/hooks/useDefaultTab.tsx Added wrapper function re-exporting CE_useDefaultTab functionality

Sequence Diagram

sequenceDiagram
    participant Component as PluginActionResponse
    participant Hook as useDefaultTab
    participant Redux as Redux Store
    
    Component->>Hook: Invoke useDefaultTab
    Hook->>Redux: Check plugin type
    Hook->>Redux: Determine tab visibility
    Hook->>Redux: Dispatch tab selection action
Loading

Possibly related PRs

Suggested labels

bug, enhancement, ide-product, task, ide-pod, ok-to-test, community-reported

Suggested reviewers

  • ankitakinger
  • albinAppsmith
  • hetunandu

Poem

🔧 Code refactored, logic refined,
Tabs dance smoothly, complexity resigned.
Hooks weave magic, state falls in line,
A symphony of code, simply divine!
🚀 Simplicity wins, complexity declines.


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 the Bug Something isn't working label Dec 30, 2024
Copy link

⚠️ Cyclic Dependency Check:

This PR has increased the number of cyclic dependencies by 1, when compared with the release branch.

Refer this document to identify the cyclic dependencies introduced by this PR.

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/PluginActionEditor/components/PluginActionResponse/PluginActionResponse.tsx (1)

73-73: Smooth integration of new hook
Invoking useDefaultTab here streamlines the default tab selection without cluttering the component-level logic.

Consider adding a short comment or docstring explaining the hook’s purpose, to aid future contributors in quickly understanding its role.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 692e394 and 8fa499e.

📒 Files selected for processing (3)
  • app/client/src/PluginActionEditor/components/PluginActionResponse/PluginActionResponse.tsx (2 hunks)
  • app/client/src/ce/PluginActionEditor/components/PluginActionResponse/hooks/useDefaultTab.tsx (1 hunks)
  • app/client/src/ee/PluginActionEditor/components/PluginActionResponse/hooks/useDefaultTab.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • app/client/src/ee/PluginActionEditor/components/PluginActionResponse/hooks/useDefaultTab.tsx
🔇 Additional comments (3)
app/client/src/ce/PluginActionEditor/components/PluginActionResponse/hooks/useDefaultTab.tsx (2)

13-19: Encapsulate default tab logic effectively
Good job abstracting the default tab logic into a dedicated hook. This improves maintainability by centralizing related state checks and dispatch logic.


20-37: Guard conditions for plugin requirement
Ensure there’s always a well-defined fallback in case neither showSchema nor (plugin.type === PluginType.API) conditions are satisfied. Consider adding an else block that documents the intentional no-op to avoid any confusion.

app/client/src/PluginActionEditor/components/PluginActionResponse/PluginActionResponse.tsx (1)

14-14: Clear separation of responsibilities
Importing useDefaultTab aligns well with the existing structure. This keeps the component focused on rendering and delegates tab logic to the hook, improving clarity.

@KelvinOm KelvinOm added the ok-to-test Required label for CI label Dec 30, 2024
@KelvinOm KelvinOm merged commit de2d5a4 into release Dec 30, 2024
88 checks passed
@KelvinOm KelvinOm deleted the fix/plugin-action-code-splitting branch December 30, 2024 14:47
@coderabbitai coderabbitai bot mentioned this pull request Dec 31, 2024
2 tasks
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Feb 7, 2025
## Description
Split the logic for the plugin action tabs. Now the files in CE and EE
repo for the `ce` folder are the same. Redefine the logic in EE hooks
only.

EE PR — appsmithorg/appsmith-ee#5840

## Automation

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

### 🔍 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/12546120368>
> Commit: 8fa499e
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12546120368&attempt=2"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.All`
> Spec:
> <hr>Mon, 30 Dec 2024 13:26:11 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working ok-to-test Required label for CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants