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: compute heightByRows while loading #123

Merged
merged 3 commits into from
Jan 27, 2025
Merged

fix: compute heightByRows while loading #123

merged 3 commits into from
Jan 27, 2025

Conversation

javier-godoy
Copy link
Member

@javier-godoy javier-godoy commented Jan 27, 2025

Close #117

Summary by CodeRabbit

  • New Features
    • Updated test dependency for commons-demo to version 4.2.0 in the v24 profile
    • Enhanced grid helper functionality with improved height adjustment methods
    • Added responsive loading state height update for grid components

Copy link

coderabbitai bot commented Jan 27, 2025

Walkthrough

The pull request introduces changes to the pom.xml file by adding a new commons-demo dependency in the v24 profile and modifies the connector.js file in the fcGridHelper component. The changes focus on improving the setHeightByRows functionality by introducing a new _updateHeightByRows method and adding an event listener for the loading state. These modifications aim to address issues with grid height configuration and responsiveness.

Changes

File Change Summary
pom.xml Added commons-demo dependency (version 4.2.0) under v24 profile with test scope
src/main/resources/META-INF/frontend/fcGridHelper/connector.js - Added _updateHeightByRows method
- Modified setHeightByRows method
- Added event listener for loading-changed

Assessment against linked issues

Objective Addressed Explanation
Fix grid height display issue [#117]
Ensure grid height is set as configured [#117]

Possibly related PRs

Suggested reviewers

  • mlopezFC
  • paodb
✨ 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.

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

Copy link

@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)
src/main/resources/META-INF/frontend/fcGridHelper/connector.js (1)

Line range hint 80-103: Consider adding error handling for edge cases.

While the computation logic is solid, consider adding checks for:

  • Negative row numbers
  • Missing table elements (thead/tfoot)
  • Invalid offsetHeight values
 computeHeightByRows : function(n) {
+  if (n < 0) {
+    throw new Error('Number of rows must be non-negative');
+  }
   var height = 0;
   var rows = grid.shadowRoot.querySelectorAll("tbody tr");
   
   if (rows.length>0) {
     for(var i=0;i<n && i<rows.length;i++) {
       height += rows[i].offsetHeight;
     }
 
     if (rows.length<n) {
       height *= n/rows.length;
     }
   }
   
-  height += grid.shadowRoot.querySelector("thead").offsetHeight;
-  height += grid.shadowRoot.querySelector("tfoot").offsetHeight;
+  const thead = grid.shadowRoot.querySelector("thead");
+  const tfoot = grid.shadowRoot.querySelector("tfoot");
+  height += thead ? thead.offsetHeight : 0;
+  height += tfoot ? tfoot.offsetHeight : 0;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c197669 and b08c704.

📒 Files selected for processing (2)
  • pom.xml (1 hunks)
  • src/main/resources/META-INF/frontend/fcGridHelper/connector.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-vaadin24
🔇 Additional comments (3)
src/main/resources/META-INF/frontend/fcGridHelper/connector.js (2)

76-78: LGTM! Good extraction of height update logic.

Clean separation of concerns by moving the height computation and CSS property update into a dedicated method.


60-74: LGTM! Good improvements to height calculation during loading states.

The changes properly handle grid loading states and resize events. The cleanup of previous observers/listeners prevents memory leaks.

Let's verify the loading state behavior:

✅ Verification successful

✅ Loading state handling verified - no conflicts found

The loading-changed event handler is properly scoped and is the only one in the codebase, ensuring clean and predictable behavior during grid loading states.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if there are any other loading state handlers that might conflict
rg -A 3 'loading-changed' --type js

Length of output: 891

pom.xml (1)

566-571: LGTM! Verify compatibility with Vaadin 24.

The commons-demo dependency upgrade looks good, properly scoped for testing.

Let's verify version compatibility:

Copy link
Member

@paodb paodb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@paodb paodb merged commit 2f43515 into master Jan 27, 2025
5 checks passed
@paodb paodb deleted the fix-117 branch January 27, 2025 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Pending release
Development

Successfully merging this pull request may close these issues.

Bug with setHeightByRows feature
2 participants