Skip to content

Conversation

@mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Dec 11, 2024

Description

修复在表格已设置自动调整高度时,偶发性地出现高度计算错误的问题。
fix #5035
fix #5015

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@changeset-bot
Copy link

changeset-bot bot commented Dec 11, 2024

⚠️ No Changeset found

Latest commit: e7aae8b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 11, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/effects/common-ui/src/components/page/page.vue

Oops! Something went wrong! :(

ESLint: 9.16.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

Walkthrough

The changes in the page.vue component focus on the contentStyle computed property, simplifying the logic for setting the height style. The previous conditional check based on shouldAutoHeight has been removed, allowing for a consistent calculation of height using a CSS variable. The calcContentHeight function is now called unconditionally on component mount to ensure accurate height calculation. Overall, the control flow and error handling remain unchanged.

Changes

File Path Change Summary
packages/effects/common-ui/src/components/page/page.vue Simplified contentStyle computed property logic for height calculation; calcContentHeight called unconditionally on mount.

Assessment against linked issues

Objective Addressed Explanation
Fix height calculation issue when AJAX response is fast (#5035)
Fix height calculation issue when switching tabs on the same page (#5015)

Possibly related PRs

  • fix: Page header class in fixed mode #5023: This PR modifies the page.vue component, specifically enhancing the header styling, which is directly related to the changes made in the main PR regarding the contentStyle computed property in the same component.
  • fix: page prop type check #5067: This PR also involves changes to the Props interface in page.vue, specifically reintroducing the fixedHeader property, which connects to the overall functionality and styling adjustments made in the main PR.

Suggested labels

bug

Suggested reviewers

  • anncwb
  • vince292007

Poem

In the land of code, where rabbits play,
We fixed the heights, come what may.
With styles so neat, and logic clear,
Our tables now dance, full of cheer!
Hop along, dear friends, let’s celebrate,
For every bug fixed, we elevate! 🐇✨


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. (Experiment)
  • @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
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

🧹 Outside diff range and nitpick comments (2)
packages/effects/common-ui/src/components/page/page.vue (2)

Line range hint 53-56: Consider replacing setTimeout with nextTick for more reliable timing.

The current implementation uses a 30ms setTimeout to set shouldAutoHeight, which might still be too short for very quick AJAX responses. Using nextTick would be more reliable as it ensures proper DOM updates.

  async function calcContentHeight() {
    if (!autoContentHeight) {
      return;
    }
    await nextTick();
    headerHeight.value = headerRef.value?.offsetHeight || 0;
    footerHeight.value = footerRef.value?.offsetHeight || 0;
-   setTimeout(() => {
+   await nextTick();
      shouldAutoHeight.value = true;
-   }, 30);
  }

41-44: Add error handling for height calculations.

The height calculation lacks error handling for cases where the CSS variable might be undefined or when height calculations fail.

  const contentStyle = computed<StyleValue>(() => {
    if (autoContentHeight) {
+     try {
+       const cssVar = getComputedStyle(document.documentElement)
+         .getPropertyValue(CSS_VARIABLE_LAYOUT_CONTENT_HEIGHT);
+       if (!cssVar) {
+         console.warn(`CSS variable ${CSS_VARIABLE_LAYOUT_CONTENT_HEIGHT} not found`);
+         return {};
+       }
        return {
          height: `calc(var(${CSS_VARIABLE_LAYOUT_CONTENT_HEIGHT}) - ${headerHeight.value}px)`,
          overflowY: shouldAutoHeight.value ? 'auto' : 'unset',
        };
+     } catch (error) {
+       console.error('Failed to calculate content height:', error);
+       return {};
+     }
    }
    return {};
  });
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between eec6f41 and e7aae8b.

📒 Files selected for processing (1)
  • packages/effects/common-ui/src/components/page/page.vue (1 hunks)
🔇 Additional comments (1)
packages/effects/common-ui/src/components/page/page.vue (1)

42-42: LGTM! The height calculation change addresses the reported issues.

The unconditional height calculation using CSS variables should resolve the table height issues when AJAX responses are quick (<100ms) or when switching tabs.

@mynetfan mynetfan merged commit 4a20156 into vbenjs:main Dec 11, 2024
15 checks passed
@mynetfan mynetfan deleted the fix/table-auto-height branch December 11, 2024 05:46
@anncwb anncwb added the bug Something isn't working label Dec 12, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Jan 12, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

bug Something isn't working

Projects

None yet

2 participants