refactor(materials): useResource spilt & Message notification for material loading life cycle

[wenmine]

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• [x] 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)
• [x] 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?

可改造的点

1. 有两个功能相对独立：1. 和全局appData相关 2. 初始化当前画布页面、区块，可以把两个独立的功能分开
2. 利用数据流的通信，将appData获取后发送事件通知
3. 由于useMaterial.initMaterial初始化物料模块只会在canvas ready时执行，将fetchResource调用useMaterial.initMaterial初始化物料模块提出到app.vue中，解耦useMaterial。
4. 由于initPageorBlock 初始化画布页面模块只会在canvas ready时执行，将 fetchResource调用 initPageorBlock 抽取出来，同2一样，使用事件通信
5. 将 handlePopStateEvent 抽取出来
6. 看一下APP.vue是一个什么样的角色，如果app.vue里可以调用上面的几个元服务，那么2，3，4都可以直接写在app.vue中。

Issue Number: N/A

What is the new behavior?

因此将其拆分成2个元服务以及将部分功能进行提取

元服务

• useAppData 作为存放全局数据（来源appData）
• usePageBlockSchema 作为初始化当前画布页面或者区块

功能提取

• 提取fetchResource里调用useMaterial.initMaterial初始化物料模块，解耦useMaterial。直接在design-core app.vue里调用。
• 提取fetchResource里调用 initPageorBlock 初始化物料模块，直接在design-core app.vue里调用。

Does this PR introduce a breaking change?

• [ ] Yes
• [x] No

Other information

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Introduced a new messaging function to enhance material data fetching processes.
  • Added a reactive state management solution for handling application resources.
  • Implemented internationalization support within a new application data composable.

• Improvements

  • Refined resource fetching and initialization logic for better performance and clarity.
  • Enhanced naming conventions for better understanding of functions related to schema and resources.
  • Updated services to focus on page block schema capabilities and improved data management.

• Bug Fixes

  • Improved the initialization process to ensure proper application state before resource operations.

• Documentation

  • Updated documentation to reflect new function names and improved functionalities in the materials module.

[coderabbitai[bot]]

Walkthrough

The recent updates across various files enhance resource management and initialization processes within the application. Key functions have been renamed and refactored for clarity, focusing on a schema-driven approach for handling materials and blocks. This restructuring streamlines data fetching and resource initialization, leading to a more coherent application state and improved maintainability.

Changes

Files & Summary
packages/design-core/src/App.vue - Updated handlePopStateEvent to use usePageBlockSchema() instead of useResource(). - Made watch() callback asynchronous for better initialization flow.
packages/plugins/materials/src/composable/useMaterial.js - Added publishMessage for enhanced messaging. - Renamed fetchMaterial to initUserMaterial, and getMaterialsRes to fetchUserMaterialData. - Updated generateNode to generateSchemaNode and refactored initMaterial.
packages/plugins/materials/src/composable/useResource.js - Simplified fetchResource by removing the isInit parameter. - Introduced initResource for initialization tasks.
packages/plugins/materials/src/meta/block/src/BlockList.vue - Renamed generateNode to generateSchemaNode for improved block management.
packages/common/composable/useAppData.js - Introduced a new composable for managing application data and internationalization with key functions like initAppData and fetchAppData.
packages/register/src/hooks.js - Removed useResource hook; added useAppData and usePageBlockSchema hooks for better data handling.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant UseMaterial
    participant UseResource

    App->>UseResource: initResource()
    UseResource->>UseMaterial: initMaterialModule()
    UseMaterial->>UseResource: fetchUserMaterialData()
    UseResource-->>App: Resource Initialized

🐰 In a world where changes bloom,
New functions dance and dispel gloom.
Fetch and init, a seamless flow,
With schema nodes, watch our blocks grow!
Clarity reigns where chaos was,
Hooray for progress! Hip, hip, hurrah! 🌼

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.