chore: Reordering response pane tabs to default to schema tab #37100
Conversation
WalkthroughThe changes made in the pull request focus on the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
github-actions
bot
added
IDE Pod
|
/build-deploy-preview skip-tests=true |
|
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/11516279025. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
app/client/src/ce/PluginActionEditor/components/PluginActionResponse/hooks/usePluginActionResponseTabs.tsx (2)
Line range hint
65-94: API plugin tabs should be ordered after schema tab.Based on the PR objectives to make schema tab the default, the API-specific tabs (Response and Headers) should be pushed after the schema tab to maintain consistent tab ordering.
Consider moving this block after the schema tab addition:
- if (plugin.type === PluginType.API) { - tabs.push( - { - key: DEBUGGER_TAB_KEYS.RESPONSE_TAB, - // ... response tab config - }, - { - key: DEBUGGER_TAB_KEYS.HEADER_TAB, - // ... header tab config - }, - ); - } if (showSchema) { tabs.push({ key: DEBUGGER_TAB_KEYS.SCHEMA_TAB, // ... schema tab config }); } + if (plugin.type === PluginType.API) { + tabs.push( + { + key: DEBUGGER_TAB_KEYS.RESPONSE_TAB, + // ... response tab config + }, + { + key: DEBUGGER_TAB_KEYS.HEADER_TAB, + // ... header tab config + }, + ); + }
Line range hint
113-141: Schema tab needs to be set as default.The hook returns the tabs array but doesn't specify which tab should be the default. This needs to be explicitly handled to meet the PR objective.
Consider adding a defaultTab property to the returned tabs:
return tabs; + return { + tabs, + defaultTab: DEBUGGER_TAB_KEYS.SCHEMA_TAB + };
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- app/client/src/ce/PluginActionEditor/components/PluginActionResponse/hooks/usePluginActionResponseTabs.tsx (5 hunks)
🔇 Additional comments (2)
app/client/src/ce/PluginActionEditor/components/PluginActionResponse/hooks/usePluginActionResponseTabs.tsx (2)
143-156: LGTM - Error and logs tabs placement.The placement of error and logs tabs at the end is correct and aligns with the PR objectives of maintaining schema tab prominence.
Line range hint
1-160: Verify tab order in consuming component.To ensure the schema tab becomes the default, we need to verify how these tabs are consumed in the parent component.
✅ Verification successful
Let me check how these tabs are being used in the parent component.
No tab order changes needed - order is already correctly handled
The parent component
PluginActionResponseuses the first tab as default throughselectedTab || tabs[0]?.key, and the schema tab is already being pushed first in theusePluginActionResponseTabshook when applicable. The tab order in the hook implementation matches the intended behavior.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Find the component that uses usePluginActionResponseTabs ast-grep --pattern 'const $_ = usePluginActionResponseTabs()'Length of output: 203
Script:
#!/bin/bash # Get the content of the parent component cat app/client/src/PluginActionEditor/components/PluginActionResponse/PluginActionResponse.tsxLength of output: 2240
|
Deploy-Preview-URL: https://ce-37100.dp.appsmith.com |
…thorg#37100) ## Description Reordering response pane tabs to default to schema tab Fixes [appsmithorg#37096](appsmithorg#37096) ## Automation /ok-to-test tags="@tag.Sanity" ### 🔍 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/11516522133> > Commit: 43d4785 > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=11516522133&attempt=1" target="_blank">Cypress dashboard</a>. > Tags: `@tag.Sanity` > Spec: > <hr>Fri, 25 Oct 2024 11:08:25 UTC <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Improved tab management for plugin action responses, ensuring consistent display of error and logs tabs for API plugins. - **Bug Fixes** - Streamlined handling of tab inclusion, enhancing the user experience with clearer and more reliable tab organization. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Description
Reordering response pane tabs to default to schema tab
Fixes #37096
Automation
/ok-to-test tags="@tag.Sanity"
🔍 Cypress test results
Tip
🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11516522133
Commit: 43d4785
Cypress dashboard.
Tags:
@tag.SanitySpec:
Fri, 25 Oct 2024 11:08:25 UTC
Communication
Should the DevRel and Marketing teams inform users about this change?
Summary by CodeRabbit
New Features
Bug Fixes