feat(canvas): add the renderer extension capability

[hexqi]

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

Other information

[coderabbitai[bot]]

[!WARNING]

Rate limit exceeded

@hexqi has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 40 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between b7261072384a8d88deca732bd9a7aa63bbb488b3 and f396562fdfb266e229a24d0cf297b99faab50549.

Walkthrough

The recent changes encompass updates to several components and modules, enhancing functionality and control flow. Key modifications include conditional rendering in the CanvasMenu.vue, improved computed getter processing in RenderMain.js, lifecycle management in runner.js, robustness in ProgressBar.vue, and the addition of a new function for batch material handling in useMaterial.js. These adjustments collectively aim to improve the application's responsiveness and maintainability.

Changes

Files	Change Summary
packages/canvas/container/src/components/CanvasMenu.vue	Conditional rendering of SaveNewBlock based on hasBlock property, which is now reactive and derived from getMetaApi(META_SERVICE.Block).
packages/canvas/render/src/RenderMain.js	Replaced dynamic getter evaluation with parseData, introduced defaultRenderer, getRenderer, setRenderer, and setRendererMounted for enhanced rendering logic.
packages/canvas/render/src/runner.js	Updated create function to be asynchronous, allowing lifecycle hooks for beforeAppCreate and appCreated to be executed during the rendering process.
packages/common/component/ProgressBar.vue	Safeguarded retrieval of getEditBlock from getMetaApi, preventing runtime errors by checking for truthiness before destructuring.
packages/plugins/materials/src/composable/useMaterial.js	Introduced addMaterials function for batch addition of materials, expanding the module's capabilities without altering existing functions.

Possibly related PRs

• #492: Changes in CanvasAction.vue involve conditional rendering and control flow that may relate to the CanvasMenu.vue modifications.
• #506: Introduction of meta.js for plugins and refactoring of plugin ID references may connect with the changes in CanvasMenu.vue.
• #509: Addition of metadata for HTTP, theme, and SVG plugins could relate to the overall structure and rendering logic in the main PR.
• #510: Modifications in the CLI template creation process may indirectly relate to the rendering logic changes in the main PR.
• #514: Changes in the designer demo and introduction of new components may connect with the rendering logic in CanvasMenu.vue.
• #515: Refactoring of the init function may relate to the overall structure and rendering logic in the main PR.
• #527: Addition of componentsMap to the app Schema may connect with changes in CanvasMenu.vue.
• #536: Migration of meta components may relate to changes in CanvasMenu.vue.
• #545: Refactoring of the material management plugin may connect with changes in CanvasMenu.vue.
• #550: Addition of hooks entry may relate to rendering logic changes in the main PR.
• #551: Update to the registry may connect with changes in CanvasMenu.vue.
• #552: Re-export of canvas entry may relate to rendering logic changes in the main PR.
• #566: Addition of a build step may connect with overall structure and rendering logic in the main PR.
• #569: Move of composables to a module may relate to changes in CanvasMenu.vue.
• #572: Update to the template may connect with rendering logic changes in the main PR.
• #575: Layout changes may relate to rendering logic in CanvasMenu.vue.
• #586: Refactoring of the events meta app may connect with rendering logic changes in the main PR.
• #590: Extraction of CanvasLayout may directly relate to changes in CanvasMenu.vue.
• #591: Decoupling of useResource may connect with rendering logic changes in the main PR.
• #601: Migration of meta components may relate to changes in CanvasMenu.vue.
• #604: Fix for the canvas meta app may connect with rendering logic changes in the main PR.
• #615: Addition of a simple plugin template may relate to overall structure and rendering logic in the main PR.
• #624: Addition of the @opentiny/tiny-engine-theme-base package may connect with rendering logic changes in the main PR.
• #632: Optimization of the plugin panel may relate to rendering logic changes in the main PR.
• #634: Replacement of getPluginApi with getMetaApi may connect with rendering logic changes in the main PR.
• #635: Removal of the material package dependency may relate to rendering logic changes in the main PR.

Suggested labels

ospp-2024

Poem

🐰 In the meadow, changes bloom,
With menus that now find more room.
Blocks appear with a gentle grace,
As materials dance in their place.
A rabbit hops with joy so bright,
Celebrating code in morning light! 🌼

---

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 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 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.