Fix/canvas performance

[1degrees]

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?

• [x] 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: #1279

What is the new behavior?

Does this PR introduce a breaking change?

• [ ] Yes
• [x] No

Other information

Summary by CodeRabbit

• New Features

  • Added automated copying of the canvas.js asset into build outputs, ensuring it is available as a static file rather than an inlined resource.
  • Enabled direct import of the canvas asset via a new export path.

• Chores

  • Updated build configurations to support the new asset handling.
  • Added a development dependency for static asset copying.

[coderabbitai[bot]]

Walkthrough

This update introduces a new Vite plugin, vitePluginCopyCanvas, designed to copy a canvas.js asset into the build output, with its source path determined by build options. The plugin is integrated into the base Vite configuration for the engine, and related configuration options are refactored for consistency. The canvas package's build process is adjusted to generate and export the canvas.js asset as a file rather than an inlined base64 string, and the package's exports are updated to expose this new asset. The design-core package is also updated to include the static copy plugin for its own build process.

Changes

Files/Paths	Change Summary
packages/build/vite-config/src/default-config.js	Added import and integration of vitePluginCopyCanvas; refactored config destructuring and plugin usage.
packages/build/vite-config/src/vite-plugins/vitePluginCopyCanvas.js	New file: Implements the vitePluginCopyCanvas Vite plugin for copying the canvas asset.
packages/canvas/package.json	Added export subpath "./canvas" pointing to "./dist/assets/canvas.js".
packages/canvas/scripts/vite-plugin-separate-build.ts	Modified asset emission logic: emits canvas.js as file if needAsset is true, adjusts module export method.
packages/canvas/vite.config.ts	Added needAsset: true to Vite config to enable asset file output.
packages/design-core/package.json	Added vite-plugin-static-copy to devDependencies.
packages/design-core/vite.config.js	Added vite-plugin-static-copy to plugins to copy canvas.js into build output.

Sequence Diagram(s)

sequenceDiagram
    participant Builder as Vite Build Process
    participant CanvasPkg as @opentiny/tiny-engine-canvas
    participant CopyPlugin as vitePluginCopyCanvas
    participant Output as Build Output

    Builder->>CanvasPkg: Build canvas package (needAsset: true)
    CanvasPkg-->>Output: Emit assets/canvas.js
    Builder->>CopyPlugin: Execute vitePluginCopyCanvas
    CopyPlugin->>Output: Copy canvas.js to build output assets/

Poem

In the meadow of code where the canvas lies,
A rabbit hops, with assets to prize.
Copy and bundle, with plugins anew,
Canvas.js now shines, in the build it grew.
Exports expanded, configs aligned,
This bunny’s work is neatly designed! 🐇✨

---

📜 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 17e457001b4c1a3c89642e7fe6f921721f72f76d and 86237b3f132beec0f11d03bdf4a9e5a2d410aaf5.

📒 Files selected for processing (1)

• packages/design-core/package.json (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/design-core/package.json

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: push-check

---

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

• 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>, 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.
• @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.

[1degrees]

调整画布的编译策略，将canvas 独立编译，并以静态资源形式引入页面，且增加了配套插件vitePluginCopyCanvas进行复制。 1、源码方式编译发布 - 测试通过 2、pnpm安装包方式编译发布 - 测试通过 官方大佬审核下，酌情考量是否合并

[Issues-translate-bot]

Bot detected the issue body's language is not English, translate it automatically.

---

Adjust the compilation strategy of the canvas, compile canvas independently, and introduce the page in the form of static resources, and add the supporting plug-in vitePluginCopyCanvas for copying.

1. Source code method, compile and release test pass
2. Pnpm installation package method, compile and release test pass Under the review of the official boss, merge as appropriate

[Issues-translate-bot]

Bot detected the issue body's language is not English, translate it automatically.

---

Adjust the compilation strategy of the canvas, compile canvas independently, and introduce the page in the form of static resources, and add the supporting plug-in vitePluginCopyCanvas for copying.

1. Source code method, compile and release test pass
2. Pnpm installation package method, compile and release test pass Under the review of the official boss, merge as appropriate