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: resolve block search exceptions #995

Merged
merged 3 commits into from
Jan 9, 2025

Conversation

SonyLeo
Copy link
Contributor

@SonyLeo SonyLeo commented Jan 7, 2025

English | 简体中文

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)
  • Built its own designer, fully self-validated

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:

Background and solution

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

  • New Features

    • Enhanced block list search functionality with dynamic filtering
    • Improved search capabilities that match block names, labels, and descriptions
  • Performance

    • Optimized block list display with responsive search filtering

Copy link
Contributor

coderabbitai bot commented Jan 7, 2025

Walkthrough

The pull request modifies the BlockGroupPanel.vue file to improve block list search functionality. The changes introduce a new computed property filteredBlocks that dynamically filters block lists based on user input. By utilizing the escapeRegExp utility function, the search mechanism now supports matching against block names, labels, and descriptions with enhanced regex-based filtering. The implementation provides a more responsive and flexible search experience for users interacting with block groups.

Changes

File Change Summary
packages/plugins/materials/src/meta/block/src/BlockGroupPanel.vue - Added filteredBlocks computed property for dynamic block filtering
- Modified block-group-transfer component binding
- Imported utils for escapeRegExp function
- Simplified tiny-search component template

Possibly related PRs

Suggested labels

bug, refactor-main

Suggested reviewers

  • hexqi

Poem

🐰 Blocks dance and filter with glee,
Searching through lists so free!
Regex magic, swift and bright,
Blocks find their path just right!
A rabbit's search, pure delight! 🔍


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.

@github-actions github-actions bot added bug Something isn't working refactor-main refactor/develop branch feature labels Jan 7, 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)
packages/plugins/materials/src/meta/block/src/BlockGroupPanel.vue (1)

110-121: Consider performance optimizations for the search implementation.

While the current implementation works, consider these improvements:

  1. Memoize the RegExp pattern creation to avoid rebuilding it on every filter operation
  2. Consider adding Unicode normalization for better Chinese character matching
  3. Add debouncing for large lists to prevent performance issues

Here's a suggested optimization:

+ import { useDebounceFn } from '@vueuse/core'
+ import { memoize } from 'lodash-es'

+ const createSearchPattern = memoize((searchValue) => 
+   new RegExp(escapeRegExp(searchValue), 'i')
+ )

  const filteredBlocks = computed(() => {
    if (!state.searchValue) {
      return state.blockList
    }

    const searchValue = state.searchValue.trim()
-   const pattern = new RegExp(escapeRegExp(searchValue), 'i')
+   const pattern = createSearchPattern(searchValue)

    return state.blockList.filter((block) => {
      return pattern.test(block?.name_cn) || 
             pattern.test(block?.label) || 
             pattern.test(block?.description)
    })
  })
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a14a508 and e143b39.

📒 Files selected for processing (1)
  • packages/plugins/materials/src/meta/block/src/BlockGroupPanel.vue (6 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check
🔇 Additional comments (4)
packages/plugins/materials/src/meta/block/src/BlockGroupPanel.vue (4)

Line range hint 13-20: LGTM! Good separation of concerns.

The change from direct state binding to using a computed property improves the component's reactivity and maintainability.


27-27: LGTM! Good use of utility functions.

The addition of escapeRegExp is essential for safely handling special characters in search patterns, which directly addresses the Chinese character support requirement.

Also applies to: 40-40, 84-85


274-274: LGTM! Proper exposure of the computed property.

The filteredBlocks computed property is correctly exposed to the template.


118-120: Verify Chinese character search functionality.

While the implementation looks correct, please ensure comprehensive testing with:

  1. Various Chinese characters (simplified and traditional)
  2. Mixed Chinese and English search terms
  3. Special characters within Chinese text
  4. Edge cases (empty search, whitespace-only search)
✅ Verification successful

Implementation verified for Chinese character search support

The search implementation in BlockGroupPanel.vue follows established patterns in the codebase for handling Chinese characters. The code:

  • Correctly handles Chinese characters through name_cn field
  • Provides multilingual support with label and description fallbacks
  • Uses proper error handling with optional chaining
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for existing test files related to block search
fd -e spec.js -e spec.ts -e test.js -e test.ts . | grep -i "block.*search\|search.*block"

# Look for existing Chinese character handling in the codebase
rg -l "[\u4e00-\u9fff]" --type ts --type vue

Length of output: 166


Script:

#!/bin/bash
# Add Vue file type and search for Chinese characters
rg --type-add 'vue:*.vue' -l '[\u4e00-\u9fff]' --type vue

# Search for block-related test files more broadly
fd -e spec.js -e spec.ts -e test.js -e test.ts . | grep -i "block"

# Look for BlockGroupPanel test file specifically
fd BlockGroupPanel -e spec.js -e spec.ts -e test.js -e test.ts .

# Search for existing search functionality tests
rg -l "test|describe|it.*search" --type ts --type js

Length of output: 17167

@hexqi hexqi merged commit fee84e6 into opentiny:refactor/develop Jan 9, 2025
3 checks passed
@gene9831 gene9831 mentioned this pull request Jan 10, 2025
14 tasks
SonyLeo added a commit to SonyLeo/tiny-engine that referenced this pull request Jan 10, 2025
hexqi pushed a commit that referenced this pull request Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working refactor-main refactor/develop branch feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants