feat(ssu): handle dependence changing while watching

[stormslowly]

1. 定义 SSU 两个状态，FirstBuilding Updating 状态，FirstBuild 完之后进入到 Updating 状态
2. FirstBuild 完之后，会决定 SSU 的缓存是否可用
3. 如果缓存不可用，那么 Mako 进入到普通的 dev 执行状态；热更逻辑
4. 如果缓存可用，用户未引入新的依赖，缓存一直可用；用户修改代码舍弃了部分依赖，缓存也依旧可用
5. 如果用户引入了新的依赖，SSU 的缓存失效，除了构建新引入的依赖以外，还需要重新构建因为缓存未失效前没有构建的模块；所有的构建完成后，Mako 进入到普通的 dev 执行状态。

一句话总结，
在没有模块 build 缓存的情况下，SSU 可以理解成，延迟依赖构建的方式来，提升启动速度的方案。

Summary by CodeRabbit

• 新功能

  • 增强了模块更新和依赖解析的功能。
  • 引入了新的生命周期方法 after_update，允许插件在更新后执行必要操作。
  • 采用新的枚举 SSUScanStage 来管理扫描阶段，改进了缓存和重建逻辑。

• 修复

  • 改进了模块依赖变化的检测逻辑，确保模块状态的准确性。

• 文档

  • 更新了与插件系统和模块更新相关的文档说明。

[petercat-assistant]

Walkthrough

此PR引入了对SSU（延迟依赖构建）状态的管理，定义了两个状态：FirstBuilding和Updating。通过这些状态的转换，决定SSU缓存的可用性，并在依赖发生变化时进行相应的处理，以提升启动速度。

Changes

文件路径	摘要
crates/mako/src/dev/update.rs	添加了对插件驱动的调用以支持更新后的操作，并调整了模块依赖的处理逻辑。
crates/mako/src/plugin.rs	增加了after_update函数以支持插件在更新后的操作。
crates/mako/src/plugins/ssu.rs	引入了SSUScanStage枚举以管理SSU的状态，并调整了缓存和重建逻辑。

[coderabbitai]

Walkthrough

此次更改主要集中在 update.rs、plugin.rs 和 ssu.rs 文件中，增强了 Compiler 结构及其方法的功能。update 方法现在包括一个新的调用，以整合插件系统。引入了 Diff 结构以处理依赖关系的比较，并增加了 after_update 方法到 Plugin 特性中，以便在更新后执行必要的操作。同时，SUPlus 结构进行了重构，改进了缓存和扫描机制的逻辑。

Changes

文件路径	更改摘要
crates/mako/src/dev/update.rs	更新了 Compiler 结构的方法，包括 update 和 build_by_modify，引入 Diff 结构及其方法。
crates/mako/src/plugin.rs	添加了 after_update 方法到 Plugin 特性，更新了 PluginDriver 以实现该方法，新增 NextBuildParam 结构。
crates/mako/src/plugins/ssu.rs	引入 SSUScanStage 枚举，更新了 SUPlus 结构及其方法，改进了缓存和扫描机制的逻辑。

Possibly related PRs

• fix(update): async module update miss async deps #1437: 此 PR 也修改了 update.rs 文件，并增强了依赖管理逻辑，与主 PR 中对 Diff 结构和依赖处理的更新相一致。
• fix(update): 🐛 no unnessary chunk group in update #1503: 此 PR 涉及对 update.rs 文件的修改，特别是与依赖管理相关的内容，与主 PR 的重点相符。
• fix: should not re-group when span changed #1654: 此 PR 更新了 update.rs 中的 dependence_changed 方法，直接与主 PR 中关于依赖跟踪和解析的更改相关。
• chore(SSU): add process.env.SOCKET_SERVER define to prevent process polyfill require too early #1655: 尽管主要集中在 SUPlus 结构上，此 PR 还包括对 next_build 方法的更改，与主 PR 中讨论的插件系统集成相关。

Suggested reviewers

• sorrycc
• Jinbao1001

🐇 在更新中跳跃，功能更强大，
插件协作，依赖无忧，
缓存机制，扫描更妙，
代码重构，逻辑清晰，
兔子欢呼，庆祝新生！ 🎉

---

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

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 82 lines in your changes missing coverage. Please review.

Project coverage is 55.45%. Comparing base (eacee04) to head (e316d9f).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
crates/mako/src/plugins/ssu.rs	0.00%	62 Missing ⚠️
crates/mako/src/dev/update.rs	0.00%	11 Missing ⚠️
crates/mako/src/plugin.rs	0.00%	9 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1690      +/-   ##
==========================================
- Coverage   55.64%   55.45%   -0.19%     
==========================================
  Files         173      173              
  Lines       17530    17588      +58     
==========================================
- Hits         9754     9753       -1     
- Misses       7776     7835      +59     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (9)

crates/mako/src/plugin.rs (2)

186-189: 在 Plugin trait 中添加了新的生命周期方法

这个新增的 after_update 方法为插件提供了在更新后执行操作的机会，与 PR 中提到的依赖变更处理功能相符。建议添加方法文档说明其具体用途和调用时机。

建议添加如下文档注释：

+    /// 在更新完成后被调用，允许插件执行必要的清理或状态更新操作
+    /// 
+    /// # 参数
+    /// * `compiler` - 编译器实例的引用，提供对编译上下文的访问
+    /// 
+    /// # 返回值
+    /// 返回 Result<()>，表示操作是否成功
     fn after_update(&self, _compiler: &Compiler) -> Result<()> {
         Ok(())
     }

---

Line range hint 197-202: NextBuildParam 结构体的设计合理

该结构体包含了构建过程中所需的关键信息，字段的生命周期标注正确。但建议添加结构体级别的文档说明其用途。

建议添加如下文档注释：

+/// 包含下一次构建所需的参数
+/// 
+/// 该结构体携带了当前模块、下一个文件以及资源解析器的引用，
+/// 用于在构建过程中追踪模块变更。
 #[derive(Debug)]
 pub struct NextBuildParam<'a> {
     pub current_module: &'a ModuleId,
     pub next_file: &'a File,
     pub resource: &'a ResolverResource,
 }

crates/mako/src/dev/update.rs (2)

334-335: 优化：重复的克隆操作

在第 334-335 行，您多次对 resolved_path 进行克隆：

let dep_module_id = ModuleId::new(resolved_path.clone());

考虑减少不必要的克隆操作，以提升性能。

---

338-338: 建议：处理可能的错误情况

在第 338 行的 Self::create_empty_module(&dep_module_id) 调用中，如果创建模块可能失败，请考虑添加错误处理，防止潜在的崩溃。

crates/mako/src/plugins/ssu.rs (5)

69-74: 建议为 SSUScanStage 添加文档注释

为了提高代码的可读性和维护性，建议为枚举 SSUScanStage 添加文档注释，说明各个阶段 FirstBuild 和 Updating 的含义。

---

77-79: 考虑使用原子类型替代 Arc<Mutex>

对于简单的布尔标志，如 cache_valid 和 will_full_rebuild，使用 Arc<AtomicBool> 可能比 Arc<Mutex<bool>> 更高效，减少锁的开销和线程同步的性能损耗。

---

246-253: 优化字符串处理以提高性能

在构造 hmr_runtime 时，连续调用了 to_string() 和多个 replace() 方法。可以考虑使用一次性格式化或使用模板字符串来减少字符串拷贝和临时对象的创建，从而提高性能。

---

Line range hint 319-370: 重构复杂逻辑以增强可读性

在 next_build 方法中的匹配逻辑较为复杂，嵌套了多层条件判断。建议将复杂的逻辑拆分为多个小函数，或者添加详细的注释，以提高代码的可读性和可维护性。

---

Line range hint 559-588: 注意动态生成的 JavaScript 代码的安全性

在 runtime_plugins 方法中，直接将序列化的 js_patch_map 和 css_patch_map 插入到 JavaScript 代码中。请确保这些数据在序列化和插入过程中不会引入安全漏洞，例如避免可能的代码注入风险。

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between eacee04 and e316d9f.

📒 Files selected for processing (3)

• crates/mako/src/dev/update.rs (3 hunks)
• crates/mako/src/plugin.rs (2 hunks)
• crates/mako/src/plugins/ssu.rs (14 hunks)

🔇 Additional comments (6)

crates/mako/src/plugin.rs (1)

435-440: PluginDriver 中的 after_update 实现符合预期

实现遵循了插件系统的一贯模式，正确处理了错误传播。代码结构清晰，无需修改。

crates/mako/src/dev/update.rs (3)

343-347: 验证：next_build 方法的调用是否符合预期

在调用 self.context.plugin_driver.next_build 时，确保：

• 所有传入的参数都已正确初始化，特别是 next_file 是否已正确创建。
• next_build 方法的执行不会引入性能瓶颈或阻塞。

---

258-260: ⚠️ Potential issue

注意：after_update 方法的错误处理

在 update 方法中新增了 self.context.plugin_driver.after_update(self)? 调用。请确保：

• 该方法可能返回的错误被正确处理，或者确认使用 ? 运算符在此处是合适的。
• 理解 after_update 方法的副作用，确保不会对后续流程产生未预期的影响。

---

334-347: 🛠️ Refactor suggestion

建议：在并发环境中确保插件调用的线程安全

在 build_by_modify 方法中，通过 par_iter 并行迭代时，您添加了对 self.context.plugin_driver.next_build 的调用。请注意：

• 确保 PluginDriver 及其插件实现是线程安全的，以避免数据竞争或其他并发问题。
• 验证 NextBuildParam 中传递的参数是否正确，如 current_module、next_file 和 resource 是否在并发环境下安全使用。
• 考虑对 next_build 方法的返回值进行错误处理或结果验证，确保其执行成功。

crates/mako/src/plugins/ssu.rs (2)

142-149: 检查多线程环境下的锁使用

在 in_building_stage 和 in_updating_stage 方法中，对 stage 字段进行加锁操作。请确保在多线程环境下，这些锁的使用不会导致死锁或资源竞争问题。

---

485-488: 确保缓存验证逻辑的正确性

在 after_generate_chunk_files 方法中，如果 cache_valid 为 true，函数将直接返回，跳过后续的文件生成步骤。请确认这符合预期行为，以避免可能的文件缺失或更新不完整的问题。

[coderabbitai]

⚠️ Potential issue

处理 after_update 方法中的可能错误

在 after_update 方法中，调用了 transform_modules，该方法可能返回错误。建议在调用后检查错误并进行适当的错误处理，以避免在运行时出现未捕获的异常。