feat: remove code to base64 for performance issue

[chilingling]

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
  • The way the main script is included in the generated HTML now varies depending on the environment: in development, it is loaded via a script tag with a source URL; in other modes, the script is inlined directly into the HTML.
• Refactor
  • Simplified script bundling by removing base64 encoding and directly exporting the bundled code as a string.
• Style
  • Improved code clarity by explicitly typing a function parameter.

[coderabbitai]

Walkthrough

The changes introduce environment-dependent logic for script injection in the HTML template, altering how the main script is included based on whether the environment is in development or production. In development mode, the script is linked by URL, while in production, the script content is inlined as a module. Additionally, the build plugin was simplified by removing base64 encoding and returning the bundled code directly, and a function parameter was explicitly typed as a string.

Changes

File(s)	Change Summary
packages/canvas/init-canvas/init-canvas.ts	Modified script injection: now conditionally inlines or links the script based on environment mode.
packages/canvas/scripts/vite-plugin-separate-build.ts	Removed base64 encoding of bundled code; now returns raw code. Explicitly typed a function parameter as string.

Poem

In the meadow of code, a rabbit hops with glee,
Scripts now inline or linked, as the mode decrees!
No more base64—just raw and neat,
Type safety in the fields, a developer’s treat.
With every build, the garden grows,
As canvas magic gently flows.
🐇✨

---

📜 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 9de1275 and ff05a89.

📒 Files selected for processing (2)

• packages/canvas/init-canvas/init-canvas.ts (1 hunks)
• packages/canvas/scripts/vite-plugin-separate-build.ts (2 hunks)

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

• GitHub Check: push-check

🔇 Additional comments (3)

packages/canvas/scripts/vite-plugin-separate-build.ts (2)

8-8: Type annotation improvement

Adding the explicit string type to the cleanUrl parameter improves code clarity and TypeScript type safety.

---

91-92: Performance improvement by removing base64 encoding

This change successfully implements the PR objective by removing the base64 encoding step and directly returning the bundled code. This should improve performance by:

1. Eliminating unnecessary encoding/decoding operations
2. Reducing the size of the generated output (base64 encoding increases data size by ~33%)

The code is now simpler and more direct.

packages/canvas/init-canvas/init-canvas.ts (1)

12-18: Environment-aware script loading strategy

This change implements an environment-specific script loading approach:

• In development: loads the script via URL for better debugging experience
• In production: inlines the script content directly to reduce HTTP requests

This complements the removal of base64 encoding in the build plugin and should improve performance in production builds while maintaining a good developer experience.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

[chilingling]

legacy comments from #1236: