fix: Api pane and settings responsiveness

[hetunandu]

Description

Various style and layout changes for side by side responsiveness

Fixes #33249

Automation

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

🔍 Cypress test results

Tip

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

Communication

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

• Yes
• No

[hetunandu]

/build-deploy-preview

[github-actions]

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9005105157.
Workflow: On demand build Docker image and deploy preview.
skip-tests: . env: .
PR: 33297.
recreate: .

[github-actions]

Failed server tests

• com.appsmith.server.services.ce.ActionServiceCE_Test#moveAction_forGitConnectedApp_defaultResourceIdsUpdateSuccess

[github-actions]

Deploy-Preview-URL: https://ce-33297.dp.appsmith.com

[coderabbitai]

Walkthrough

Walkthrough

This update refactors and enhances various components related to API settings in a web application. Modifications include changes to the import statements, method updates for selecting subtabs, and updates to CSS selectors. Additionally, adjustments have been made to the layout and responsiveness of components to improve the user interface in side-by-side views.

Changes

File Path	Change Summary
.../API_DefaultContentType_spec.js	Updated imports and method for selecting subtabs.
.../ApiEditor.js	Updated CSS selectors; removed jsonBodyTab.
.../ApiPage.ts	Replaced _bodySubTab with new selection methods for body type.
.../KeyValueFieldArray.tsx	Dynamic setting of size prop based on hasType.
.../GoogleSheetsSettingsConfig.ts, .../QuerySettingsConfig.ts	Added width: "270px" to certain configurations.
.../ApiAuthentication.tsx, .../Pagination.tsx, .../PostBodyData.tsx	Adjusted styling and component functionalities for better UI responsiveness and functionality.

Assessment against linked issues

Objective	Addressed	Explanation
Settings overflow outside bounds [#33249]	❌	The changes do not explicitly address the overflow issue in settings.
API Authentication - Button alignment [#33249]	❌	No specific changes addressing button alignment were noted.
API Pagination - UI overflowing below sidebar [#33249]	❌	Although UI changes were made, it is unclear if they directly address the overflow issue.
Google sheet settings alignment issue [#33249]	❌	The added width property does not directly address alignment issues.

Possibly related issues

• [Task]: Fix cypress test suite failures caused by PR #29794 #30378: The changes in API_DefaultContentType_spec.js and updates in ApiPage.ts might address the test failures mentioned due to changes in selectors and methods, which could potentially resolve the test suite failures related to API components.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 07854ca and de02d20.

Files ignored due to path filters (12)

• app/server/appsmith-plugins/amazons3Plugin/src/main/resources/setting.json is excluded by !**/*.json
• app/server/appsmith-plugins/anthropicPlugin/src/main/resources/setting.json is excluded by !**/*.json
• app/server/appsmith-plugins/appsmithAiPlugin/src/main/resources/setting.json is excluded by !**/*.json
• app/server/appsmith-plugins/firestorePlugin/src/main/resources/setting.json is excluded by !**/*.json
• app/server/appsmith-plugins/googleAiPlugin/src/main/resources/setting.json is excluded by !**/*.json
• app/server/appsmith-plugins/googleSheetsPlugin/src/main/resources/setting.json is excluded by !**/*.json
• app/server/appsmith-plugins/mongoPlugin/src/main/resources/setting.json is excluded by !**/*.json
• app/server/appsmith-plugins/mssqlPlugin/src/main/resources/setting.json is excluded by !**/*.json
• app/server/appsmith-plugins/mysqlPlugin/src/main/resources/setting.json is excluded by !**/*.json
• app/server/appsmith-plugins/openAiPlugin/src/main/resources/setting.json is excluded by !**/*.json
• app/server/appsmith-plugins/oraclePlugin/src/main/resources/setting.json is excluded by !**/*.json
• app/server/appsmith-plugins/postgresPlugin/src/main/resources/setting.json is excluded by !**/*.json

Files selected for processing (9)

• app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_DefaultContentType_spec.js (3 hunks)
• app/client/cypress/locators/ApiEditor.js (1 hunks)
• app/client/cypress/support/Pages/ApiPage.ts (2 hunks)
• app/client/src/components/editorComponents/form/fields/KeyValueFieldArray.tsx (2 hunks)
• app/client/src/constants/AppsmithActionConstants/formConfig/GoogleSheetsSettingsConfig.ts (1 hunks)
• app/client/src/constants/AppsmithActionConstants/formConfig/QuerySettingsConfig.ts (1 hunks)
• app/client/src/pages/Editor/APIEditor/ApiAuthentication.tsx (3 hunks)
• app/client/src/pages/Editor/APIEditor/Pagination.tsx (6 hunks)
• app/client/src/pages/Editor/APIEditor/PostBodyData.tsx (2 hunks)

Files skipped from review due to trivial changes (2)

• app/client/src/constants/AppsmithActionConstants/formConfig/GoogleSheetsSettingsConfig.ts
• app/client/src/constants/AppsmithActionConstants/formConfig/QuerySettingsConfig.ts

Additional comments not posted (11)

app/client/cypress/locators/ApiEditor.js (1)

26-26: Update to bodyTypeSelected locator looks good.

Verification successful

---

The verification script was executed to check if the old locator .t--api-body-tab-switch .rc-select-selection-item is still being used in any JavaScript files within the codebase. The script did not find any occurrences of the old locator, which suggests that the update to the bodyTypeSelected locator has been consistently applied across the codebase.

Given this information, it appears that the update has been successfully integrated, and there are no remnants of the old locator usage that could lead to inconsistencies or errors in the test suite.

---

Update to bodyTypeSelected locator has been successfully integrated across the test suite.

• No occurrences of the old locator were found, indicating a consistent update.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify that the updated locator is used consistently across all test files.

# Test: Search for the old locator usage. Expect: No occurrences of the old locator.
rg --type js '.t--api-body-tab-switch .rc-select-selection-item'

Length of output: 66

app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_DefaultContentType_spec.js (2)

9-9: Import of apiPage aligns with the updated method calls for selecting subtabs.

---

19-19: Replacement of direct tab selections with SelectSubTab method enhances test clarity.

Also applies to: 38-38

app/client/src/pages/Editor/APIEditor/ApiAuthentication.tsx (2)

36-38: Styling adjustments to AuthContainer improve layout consistency.

---

119-123: Simplification by using Text instead of DescriptionText reduces complexity and potential styling conflicts.

app/client/src/pages/Editor/APIEditor/PostBodyData.tsx (2)

26-37: Replacement of SegmentedControl with Select and Option components aligns with other parts of the application, improving UI consistency.

---

29-37: Styling adjustments in PostBodyContainer enhance layout management.

app/client/src/pages/Editor/APIEditor/Pagination.tsx (2)

52-60: Styling adjustments in PaginationSection improve layout consistency and visual flow.

---

Line range hint 84-218: Introduction of GifPlayer provides a helpful visual guide for users, enhancing the user experience.

app/client/src/components/editorComponents/form/fields/KeyValueFieldArray.tsx (1)

Line range hint 119-150: Dynamic sizing of components based on the hasType prop improves space management and user interface usability.

app/client/cypress/support/Pages/ApiPage.ts (1)

64-68: Updates to _bodyTypeSelect and _bodyTypeToSelect methods use new selectors and provide clearer functionality for selecting body types.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

[github-actions]

Failed server tests

• com.appsmith.server.services.ce.ActionServiceCE_Test#testActionWithGraphQLDatasourceMoustacheBinding