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: Set max height for Table Data property control #39409

Merged
merged 1 commit into from
Feb 24, 2025

Conversation

hetunandu
Copy link
Member

@hetunandu hetunandu commented Feb 24, 2025

Description

Updates the Table Widget Property config to use the maxHeight property. This ensures that when users paste in huge amounts of static json, the content DOM elements dont overload the system

Fixes #39405

Automation

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

🔍 Cypress test results

Tip

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


Mon, 24 Feb 2025 07:14:31 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features
    • Added a configurable maximum height for table controls, ensuring a consistent display with a fixed maximum size of 400px.

Copy link
Contributor

coderabbitai bot commented Feb 24, 2025

Walkthrough

A new property maxHeight with the value "400px" has been added to the controlConfig object within the tableData configuration array in the Table Widget V2. This update allows the control associated with tableData to have a defined maximum height without affecting any existing functionality.

Changes

File Change Summary
app/client/.../propertyConfig/contentConfig.ts Added maxHeight: "400px" to the controlConfig of the tableData configuration array.

Suggested labels

Widgets Product, Task, Table Widget V2, ok-to-test, Widgets & Accelerators Pod, Query & Widgets Pod

Suggested reviewers

  • jacquesikot

Poem

In our code's delightful quest,
A new property now stands the test.
maxHeight shines at "400px" tall,
Enhancing the table widget for all.
Cheers to code that makes us smile, one line at a time!

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product Property Pane Issues related to the behaviour of the property pane Task A simple Todo UI Building Product Issues related to the UI Building experience Widget Property Issues related to adding / modifying widget properties across widgets Widgets & Accelerators Pod Issues related to widgets & Accelerators Widgets Product This label groups issues related to widgets labels Feb 24, 2025
@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Feb 24, 2025
@hetunandu hetunandu added the ok-to-test Required label for CI label Feb 24, 2025
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/widgets/TableWidgetV2/widget/propertyConfig/contentConfig.ts (1)

38-38: Consider making the maxHeight value configurable.

Instead of hardcoding "400px", consider making this value configurable through a property control to allow customization based on different use cases.

-      maxHeight: "400px",
+      propertyName: "tableDataMaxHeight",
+      label: "Max height",
+      controlType: "INPUT_TEXT",
+      defaultValue: "400px",
+      isBindProperty: true,
+      isTriggerProperty: false,
+      validation: {
+        type: ValidationTypes.TEXT,
+        params: {
+          regex: /^\d+px$/,
+        },
+      },
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9e59d98 and b67e2f9.

📒 Files selected for processing (1)
  • app/client/src/widgets/TableWidgetV2/widget/propertyConfig/contentConfig.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: perform-test / client-build / client-build
  • GitHub Check: perform-test / server-build / server-unit-tests
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-build / client-build
  • GitHub Check: client-prettier / prettier-check
🔇 Additional comments (1)
app/client/src/widgets/TableWidgetV2/widget/propertyConfig/contentConfig.ts (1)

36-39: LGTM! The maxHeight addition aligns with the PR objective.

The implementation will help prevent system overload when users input large amounts of static JSON data.

@vsvamsi1
Copy link
Contributor

/build-deploy-preview skip-tests=true

Copy link

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

@vsvamsi1
Copy link
Contributor

Hi @hetunandu will lots of static data within that field, can you check the dom nodes are limited by inspecting that field. I want to check if virtualisation is working for that field or not.

Copy link

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

@rahulbarwal
Copy link
Contributor

Hi @hetunandu will lots of static data within that field, can you check the dom nodes are limited by inspecting that field. I want to check if virtualisation is working for that field or not.

@vsvamsi1 Virtualization Right now is enabled only when table is server side paginated and cell wrapping is turned on/off. (https://github.com/appsmithorg/appsmith/blob/release/app/client/src/widgets/TableWidgetV2/component/Table.tsx#L338)

For static data, We paginate the table using the page size which is calculated based on table ID. So technically the problem of too many nodes never arises for static data.

@rahulbarwal
Copy link
Contributor

@hetunandu
From what I know, if you paste a lot of static data, the rows are adjusted according to the table height and it should not add a lot of rows. Can you share a short video of the problem?

@hetunandu
Copy link
Member Author

@vsvamsi1 @rahulbarwal Please check the video. This can be tested on the DP as well. It is seen that even when 500+ records are pasted inside the TableData field, only a few rows are actually available in the dom, and they update when codemirror is scrolled hence proving the presence of virtualisation

Screen.Recording.2025-02-24.at.12.45.04.PM.mov

@rahulbarwal
Copy link
Contributor

Oh thanks, got it. This makes sense. I assumed you were talking about the actual table widget, my bad.

@rahulbarwal
Copy link
Contributor

Although this begs the question, shouldn't this control type(& similar) have a default max height?

@vsvamsi1
Copy link
Contributor

@hetunandu thanks for verifying it , what i meant by the excess dom nodes issue is at the "Table Data" field not at the actual table widget. From the screen recording it looks it has been resolved, thanks for resolving this issue.

@hetunandu hetunandu merged commit 0401607 into release Feb 24, 2025
47 checks passed
@hetunandu hetunandu deleted the chore/prop-pane-code-editor-max-height branch February 24, 2025 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product ok-to-test Required label for CI Property Pane Issues related to the behaviour of the property pane skip-changelog Adding this label to a PR prevents it from being listed in the changelog Task A simple Todo UI Building Product Issues related to the UI Building experience Widget Property Issues related to adding / modifying widget properties across widgets Widgets & Accelerators Pod Issues related to widgets & Accelerators Widgets Product This label groups issues related to widgets
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task]: Table Data field should have a max height
3 participants