Skip to content

Conversation

@betterdancing
Copy link
Contributor

@betterdancing betterdancing commented Jan 26, 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

  1. 区块创建、修改、删除和发布后,区块列表没有及时更新,需要切换到别的分组在切换回来才会重新请求,或刷新整个页面;
  2. 区块创建时指定了分组然后发布,如果此时消费端也就是物料区块正好选择了这个分组,该分组下的区块列表没有实时更新,需要切换到别的分组在切换回来才会重新请求;
  3. 区块修改分类后,再次点击编辑区块,设置的分类并没有选中

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 grid component configuration with row identifier
    • Improved category and group handling in block configuration
    • Added new category management functionality for block lists
  • Bug Fixes

    • Streamlined block list update and category selection processes
    • Improved refresh mechanism for block group management
  • Refactor

    • Simplified category and block list management logic
    • Consolidated block-related state management functions

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 26, 2025

Walkthrough

This pull request introduces modifications across multiple files in the block management system. The changes primarily focus on enhancing category and block list handling, introducing new reactive state management, and improving the control flow for block-related operations. The modifications streamline how categories are processed, update block lists more efficiently, and ensure proper state synchronization when performing actions like adding or publishing blocks.

Changes

File Change Summary
packages/common/component/BlockHistoryList.vue Added row-id="id" attribute to <tiny-grid> component
packages/plugins/block/src/BlockConfig.vue Updated category handling logic with conditional assignment based on shouldReplaceCategoryWithGroup()
packages/plugins/block/src/Main.vue Simplified changeCategory method and added setCurrentCategory function
packages/plugins/block/src/js/blockSetting.jsx Introduced currentCategory reactive reference, updated updateBlockList, delBlock, and publishBlock methods
packages/plugins/materials/src/meta/block/src/BlockGroupPanel.vue Added isRefresh state update after adding blocks

Sequence Diagram

sequenceDiagram
    participant User
    participant BlockConfig
    participant BlockSetting
    participant BlockList

    User->>BlockConfig: Select Category/Group
    BlockConfig->>BlockSetting: setCurrentCategory()
    BlockSetting->>BlockList: updateBlockList()
    BlockList-->>User: Refresh Block List
Loading

Possibly related PRs

Suggested labels

bug, refactor-main

Suggested reviewers

  • hexqi
  • chilingling

Poem

🐰 Blocks dance and categories sway,
Code refactored in a rabbit's play,
Grids align with rows so neat,
Efficiency makes my code heartbeat!
Hop, hop, refactor's delight! 🌟

✨ 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
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: 3

🧹 Nitpick comments (3)
packages/plugins/block/src/js/blockSetting.jsx (3)

57-57: Consider initializing currentCategory with null instead of empty string.

An empty string as the initial value might not clearly represent "no category selected" state. Using null would be more semantically correct for representing an unselected state.

-const currentCategory = ref('')
+const currentCategory = ref(null)

280-282: Add validation in setCurrentCategory.

The setCurrentCategory function directly sets the value without any validation. Consider adding type checking and validation to ensure data consistency.

 export const setCurrentCategory = (categoryId) => {
+  if (categoryId !== null && typeof categoryId !== 'string' && typeof categoryId !== 'number') {
+    console.warn('Invalid category ID type. Expected string, number, or null.')
+    return
+  }
   currentCategory.value = categoryId
 }

369-369: Cache the app ID to avoid repeated API calls.

The getAppId function is called frequently throughout the code. Consider caching the result to improve performance.

+let cachedAppId = null
 const getAppId = () => {
+  if (cachedAppId) return cachedAppId
+  cachedAppId = getMetaApi(META_SERVICE.GlobalService).getBaseInfo().id
+  return cachedAppId
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b5789c5 and 648c089.

📒 Files selected for processing (5)
  • packages/common/component/BlockHistoryList.vue (1 hunks)
  • packages/plugins/block/src/BlockConfig.vue (4 hunks)
  • packages/plugins/block/src/Main.vue (2 hunks)
  • packages/plugins/block/src/js/blockSetting.jsx (9 hunks)
  • packages/plugins/materials/src/meta/block/src/BlockGroupPanel.vue (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check
🔇 Additional comments (5)
packages/common/component/BlockHistoryList.vue (1)

2-2: LGTM! Good addition of row identifier.

Adding the row-id attribute improves the grid's data management by providing unique row identification.

packages/plugins/block/src/BlockConfig.vue (3)

41-41: LGTM! Good dynamic attribute binding.

The multiple attribute is correctly bound to the result of shouldReplaceCategoryWithGroup(), allowing flexible selection behavior.


170-175: LGTM! Improved category initialization logic.

The conditional logic properly handles both group and category scenarios:

  • For groups: Maps group IDs to an array
  • For categories: Uses the first category ID

246-249: LGTM! Enhanced category change handling.

The changes improve the category update logic by:

  • Dynamically selecting the correct ID key
  • Supporting both single and array values for categories
packages/plugins/block/src/Main.vue (1)

351-352: LGTM! Well-structured refactoring.

The category change handling has been simplified and modularized by:

  1. Moving the logic to a dedicated setCurrentCategory function
  2. Separating the concerns of category setting and list updating

@hexqi hexqi merged commit bfc9fea into opentiny:release/v2.2.0 Jan 26, 2025
4 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Jan 26, 2025
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants