Skip to content

fix(grid): fix bug after refactor #3527

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

Merged
merged 4 commits into from
Jun 24, 2025
Merged

fix(grid): fix bug after refactor #3527

merged 4 commits into from
Jun 24, 2025

Conversation

gimmyhehe
Copy link
Member

@gimmyhehe gimmyhehe commented Jun 23, 2025

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Style
    • Centered text in empty table grid blocks for better visual alignment.
    • Adjusted background positioning in table grid borders for precise gradient alignment.

Copy link

coderabbitai bot commented Jun 23, 2025

## Walkthrough

The changes update the styling for the `.tiny-grid__empty-block` element in two theme packages by centering its text horizontally and adjust the background-position for a grid column style. A safety check was added in a keyboard-related method to prevent errors when querying DOM elements. The `cacheColumnMap` method was modified to accept external cache data instead of building it internally. No public API changes were made except for the updated method signature of `cacheColumnMap`.

## Changes

| File(s)                                         | Change Summary                                                                                       |
|------------------------------------------------|----------------------------------------------------------------------------------------------------|
| packages/theme-saas/src/grid/table.less         | Adjusted `.tiny-grid-body__column` background-position to `100%`; added Tailwind `text-center` to `.tiny-grid__empty-block`. |
| packages/theme/src/grid/table.less              | Added `text-align: center;` to `.tiny-grid__empty-block`.                                          |
| packages/vue/src/grid/src/keyboard/src/methods.ts | Added a null check before querying `.col__index-checked` elements to avoid errors in `_clearIndexChecked`. |
| packages/vue/src/grid/src/table/src/methods.ts | Modified `cacheColumnMap` to accept external `options` with `columnCaches` instead of internal iteration; updated method signature. |

## Poem

> In the land where empty grids reside,  
> A tweak now lets their text align with pride.  
> Centered words in a table’s embrace,  
> Bringing symmetry to the empty space.  
> Safe checks guard the keyboard’s flow,  
> And caches come from places we know.  
> The rabbit hops with CSS delight—  
> Centered grids just feel so right!  
> 🐇✨

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7fbfbda and 9139054.

📒 Files selected for processing (1)
  • packages/theme-saas/src/grid/table.less (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/theme-saas/src/grid/table.less
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
  • GitHub Check: PR Unit Test

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@github-actions github-actions bot added the bug Something isn't working label Jun 23, 2025
@gimmyhehe gimmyhehe changed the title fix(grid): fix bug after refactor [wip] fix(grid): fix bug after refactor Jun 23, 2025
@github-actions github-actions bot removed the bug Something isn't working label Jun 23, 2025
@gimmyhehe gimmyhehe changed the title [wip] fix(grid): fix bug after refactor fix(grid): fix bug after refactor Jun 24, 2025
@github-actions github-actions bot added the bug Something isn't working label Jun 24, 2025
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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2662841 and 7fbfbda.

📒 Files selected for processing (1)
  • packages/vue/src/grid/src/table/src/methods.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*`: 用于写产品需求和开发文档的文件,需求应尽量写得简单清晰易懂。 在需求设计阶段应遵从逐步迭代的原则,早期版本可以尽量简洁。

**/*: 用于写产品需求和开发文档的文件,需求应尽量写得简单清晰易懂。
在需求设计阶段应遵从逐步迭代的原则,早期版本可以尽量简洁。

  • packages/vue/src/grid/src/table/src/methods.ts
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: PR Unit Test
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (1)
packages/vue/src/grid/src/table/src/methods.ts (1)

410-410: Document the breaking change in method signature.

The method signature change from cacheColumnMap() to cacheColumnMap(options) is a breaking change that affects the public API. Ensure all call sites are updated and consider adding JSDoc comments to document the expected parameter structure.

Run the following script to verify all usages of this method have been updated:

#!/bin/bash
# Description: Find all usages of cacheColumnMap to ensure they pass the required options parameter

# Search for method calls
rg -A 3 "cacheColumnMap\(" --type ts --type js

# Search for method references
rg "cacheColumnMap" --type ts --type js

Comment on lines +410 to 420
cacheColumnMap(options) {
const { fullColumnMap } = this
const fullColumnIdData = {}
this.fullColumnIdData = fullColumnIdData
Map.prototype.clear.apply(fullColumnMap)
fullColumn.forEach((column, index) => {
let colCache = { colid: column.id, column, index }
fullColumnIdData[column.id] = colCache
fullColumnMap.set(column, colCache)
fullColumnMap.clear()

options.columnCaches.forEach((cache) => {
fullColumnIdData[cache.colid] = cache
fullColumnMap.set(cache.column, cache)
})
},
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add input validation and error handling for robustness.

The method now accepts external cache data but lacks proper validation, which could cause runtime errors if options or options.columnCaches is undefined or malformed.

Apply this diff to add proper input validation:

-  cacheColumnMap(options) {
+  cacheColumnMap(options) {
+    if (!options || !Array.isArray(options.columnCaches)) {
+      throw new Error('cacheColumnMap requires options.columnCaches to be an array')
+    }
+    
     const { fullColumnMap } = this
     const fullColumnIdData = {}
     this.fullColumnIdData = fullColumnIdData
     fullColumnMap.clear()

     options.columnCaches.forEach((cache) => {
+      if (!cache || !cache.colid || !cache.column) {
+        throw new Error('Invalid cache object: must have colid and column properties')
+      }
       fullColumnIdData[cache.colid] = cache
       fullColumnMap.set(cache.column, cache)
     })
   },
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
cacheColumnMap(options) {
const { fullColumnMap } = this
const fullColumnIdData = {}
this.fullColumnIdData = fullColumnIdData
Map.prototype.clear.apply(fullColumnMap)
fullColumn.forEach((column, index) => {
let colCache = { colid: column.id, column, index }
fullColumnIdData[column.id] = colCache
fullColumnMap.set(column, colCache)
fullColumnMap.clear()
options.columnCaches.forEach((cache) => {
fullColumnIdData[cache.colid] = cache
fullColumnMap.set(cache.column, cache)
})
},
cacheColumnMap(options) {
if (!options || !Array.isArray(options.columnCaches)) {
throw new Error('cacheColumnMap requires options.columnCaches to be an array')
}
const { fullColumnMap } = this
const fullColumnIdData = {}
this.fullColumnIdData = fullColumnIdData
fullColumnMap.clear()
options.columnCaches.forEach((cache) => {
if (!cache || !cache.colid || !cache.column) {
throw new Error('Invalid cache object: must have colid and column properties')
}
fullColumnIdData[cache.colid] = cache
fullColumnMap.set(cache.column, cache)
})
},
🤖 Prompt for AI Agents
In packages/vue/src/grid/src/table/src/methods.ts around lines 410 to 420, the
cacheColumnMap method lacks validation for the options parameter and its
columnCaches property, which may cause runtime errors if they are undefined or
malformed. Add checks to verify that options is an object and
options.columnCaches is an array before proceeding. If validation fails, handle
the error gracefully, for example by returning early or logging a warning, to
ensure robustness.

@zzcr zzcr merged commit aad34ce into dev Jun 24, 2025
8 of 10 checks passed
@zzcr zzcr deleted the cgm/refactor-bug branch June 24, 2025 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants