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

  • Improved loading of scripts in different environments: in development, scripts are loaded via URL; in production, scripts are inlined for better performance.

• Refactor

  • Streamlined the way bundled code is exported, removing unnecessary encoding steps for efficiency.

[coderabbitai]

Walkthrough

The changes update the logic for embedding a script in an HTML template and modify a Vite plugin's code export mechanism. In the HTML template initialization, the script tag is now conditionally generated based on the environment: it inlines the script content in production and uses a script source in development. In the Vite plugin, the code export is simplified by removing base64 encoding and directly JSON-stringifying the code, along with a minor type annotation update.

Changes

File(s)	Change Summary
packages/canvas/init-canvas/init-canvas.ts	Updated HTML script tag insertion to be conditional: inlines script in production, uses src in dev.
packages/canvas/scripts/vite-plugin-separate-build.ts	Removed base64/data URI export; now exports code as JSON string. Added type annotation to parameter.

Poem

A script once linked, now sometimes inlined,
Depending on mode, by logic defined.
Plugins less tangled, base64 set free,
Type-safe and tidy as code ought to be.
The canvas prepares for a future so bright—
With every small change, things work just right!
🐇✨

---

📜 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 030ece7 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 added.

Good addition of explicit type annotation for the cleanUrl function parameter. This enhances type safety and code readability.

---

91-92: Performance improvement: Removed base64 encoding.

The previous implementation was encoding the bundle code as a base64 data URI, which added processing overhead. The simplified approach of directly JSON-stringifying the code is more efficient and aligns with the PR objective of improving performance.

This change works in conjunction with the updates in init-canvas.ts where the script content is now directly inlined in production mode.

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

12-18: Environment-specific script loading strategy.

Good implementation of a conditional script loading strategy:

• In development: Uses external script with src attribute to support better debugging and hot module replacement
• In production: Inlines the script content directly to eliminate an HTTP request and improve performance

This change works well with the modified Vite plugin that now directly exports the stringified code without base64 encoding.

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