fix(): treat the incremental render as performed even if all sub-routes missed

[weareoutman]

依赖检查

组件之间的依赖声明，是微服务组件架构下的重要信息，请确保其正确性。

请勾选以下两组选项其中之一：

• 本次 MR 没有使用上游组件（例如框架、后台组件等）的较新版本提供的特性。

或者：

• 本次 MR 使用了上游组件（例如框架、后台组件等）的较新版本提供的特性。
• 在对应的文件中更新了该上游组件的依赖版本（或确认了当前声明的依赖版本已包含本次 MR 使用的新特性）。

提交信息检查

Git 提交信息将决定包的版本发布及自动生成的 CHANGELOG，请检查工作内容与提交信息是否相符，并在以下每组选项中都依次确认。

破坏性变更是针对于下游使用者而言，可以通过本次改动对下游使用者的影响来识别变更类型：

• 下游使用者不做任何改动，仍可以正常工作时，那么它属于普通变更。
• 反之，下游使用者不做改动就无法正常工作时，那么它属于破坏性变更。

例如，构件修改了一个属性名，小产品 Storyboard 中需要使用新属性名才能工作，那么它就是破坏性变更。
又例如，构件还没有任何下游使用者，那么它的任何变更都是普通变更。

破坏性变更：

• ⚠️ 本次 MR 包含破坏性变更的提交，请继续确认以下所有选项：
• 没有更好的兼容方案，必须做破坏性变更。
• 使用了 feat 作为提交类型。
• 标注了 BREAKING CHANGE: 你的变更说明。
• 同时更新了本仓库中所有下游使用者的调用。
• 同时更新了本仓库中所有下游使用者对该子包的依赖为即将发布的 major 版本。
• 同时为其它仓库的 Migrating 做好了准备，例如文档或批量改动的方法。
• 手动验证过破坏性变更在 Migrate 后可以正常工作。
• 破坏性变更所在的提交没有意外携带其它子包的改动。

新特性：

• 本次 MR 包含新特性的提交，且该提交不带有破坏性变更，并使用了 feat 作为提交类型。
• 给新特性添加了单元测试。
• 手动验证过新特性可以正常工作。

问题修复：

• 本次 MR 包含问题修复的提交，且该提交不带有新特性或破坏性变更，并使用了 fix 作为提交类型。
• 给问题修复添加了单元测试。
• 手动验证过问题修复得到解决。

杂项工作：

即所有对下游使用者无任何影响、且没有必要显示在 CHANGELOG 中的改动，例如修改注释、测试用例、开发文档等：

• 本次 MR 包含杂项工作的提交，且该提交不带有问题修复、新特性或破坏性变更，并使用了 chore, docs, test 等作为提交类型。

Summary by CodeRabbit

• 新功能

  • 改进了增量渲染的处理，确保即使未匹配所有子路由，仍然能一致返回结果。
  • 更新了子砖块的渲染逻辑，采用新的异步函数来处理每个子插槽。

• 文档

  • 更新了 RouteHelper 接口的文档，明确了错误处理和路由行为。
  • 增强了 dispose 方法的文档，确保生命周期管理的清晰性和正确性。

[coderabbitai]

Walkthrough

此拉取请求对Renderer.ts和RendererContext.ts文件进行了多项修改。Renderer.ts中的renderRoutes和renderBricks函数进行了更新，以改善增量渲染的处理和子砖块的渲染逻辑。RendererContext.ts中的LocationChangeCallback类型和RouteHelper接口也进行了修正和文档更新，确保更清晰的生命周期管理和渲染逻辑。整体上，这些更改旨在提高代码的可维护性和准确性。

Changes

文件路径	更改摘要
packages/runtime/src/internal/Renderer.ts	更新了renderRoutes和renderBricks函数的逻辑，简化了控制流，增强了子砖块的处理，添加了routeSlotFromIndexToSlotId映射。多处函数签名已更新以反映逻辑修改。
packages/runtime/src/internal/RendererContext.ts	更新了LocationChangeCallback类型，修改了RouteHelper接口的catch方法文档，调整了didPerformIncrementalRender方法的逻辑，增强了dispose方法的功能。

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 62b92d3 and 5af96e2.

📒 Files selected for processing (2)

• packages/runtime/src/internal/Renderer.ts (1 hunks)
• packages/runtime/src/internal/RendererContext.ts (4 hunks)

🧰 Additional context used

🔇 Additional comments (5)

packages/runtime/src/internal/Renderer.ts (1)

964-965: 请确保在所有子路由未匹配时增量渲染返回true的行为是正确的

在第 964-965 行，您修改了代码，使得即使所有子路由都未匹配，增量渲染仍然返回 true。请确保此更改不会对调用该函数的逻辑产生负面影响，特别是依赖返回值的上游或下游代码。

请运行以下脚本以验证返回值的变更不会对代码库产生负面影响：

packages/runtime/src/internal/RendererContext.ts (4)

74-79: 更新 RouteHelper 接口中 catch 方法的文档

RouteHelper 接口的 catch 方法注释已更新，详细说明了在不同情况下的行为。这提高了代码的可读性和维护性。

---

234-237: 同步 reCatch 方法的文档更新

reCatch 方法的注释已更新，与 RouteHelper 接口的 catch 方法保持一致，明确了返回值和异常处理的行为。这有助于开发者更好地理解代码。

---

266-266: 澄清增量渲染结果的注释

注释已修改，更准确地描述了当 result 为 true 时，表示已执行增量渲染。这有助于避免混淆，确保开发人员正确理解代码逻辑。

---

40-40: 确保所有实现了 LocationChangeCallback 的函数返回类型一致

LocationChangeCallback 类型的返回值已更新为 Promise<boolean>。请确认所有实现此类型的回调函数的返回类型都已更新，以保持一致性并防止潜在的类型错误。

为验证所有实现都已更新，请运行以下脚本：

✅ Verification successful

验证通过：所有实现了 LocationChangeCallback 的回调函数均返回 Promise

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 描述：查找实现了 LocationChangeCallback 类型的函数，确保返回类型为 Promise<boolean>

# 测试：搜索使用 LocationChangeCallback 类型的变量或参数，并检查其返回类型
ast-grep --lang typescript --pattern $'const $_: LocationChangeCallback = ($_1, $_2) => {
  $$$
  return $_3 as Promise<boolean>;
}'

Length of output: 133

---

Script:

#!/bin/bash
# 描述：查找所有实现了 LocationChangeCallback 类型的函数，确保返回类型为 Promise<boolean>

# 查找使用 LocationChangeCallback 类型的函数声明，并检查返回类型
ast-grep --lang typescript --pattern $'function $_($_): $_ {
  $$$
}' | grep 'LocationChangeCallback' | grep -v 'Promise<boolean>'

# 查找使用 LocationChangeCallback 类型的箭头函数，并检查返回类型
ast-grep --lang typescript --pattern $'const $_: LocationChangeCallback = ($_1, $_2) => {
  $$$
  return $_ as Promise<boolean>;
}' | grep 'LocationChangeCallback' | grep -v 'Promise<boolean>'

Length of output: 321

---

Script:

#!/bin/bash
# 描述：查找所有实现了 LocationChangeCallback 类型的函数，确保返回类型为 Promise<boolean>

# 查找使用 LocationChangeCallback 类型的函数声明，检查返回类型
ast-grep --lang typescript --pattern $'function $_($_): Promise<boolean> { $$$ }'

# 查找使用 LocationChangeCallback 类型的异步函数声明，检查返回类型
ast-grep --lang typescript --pattern $'async function $_($_): Promise<boolean> { $$$ }'

# 查找使用 LocationChangeCallback 类型的箭头函数，检查返回类型
ast-grep --lang typescript --pattern $'const $_: LocationChangeCallback = async ($_1, $_2) => Promise<boolean> { $$$ }'

# 查找所有使用 LocationChangeCallback 类型的函数，并检查其返回类型是否为 Promise<boolean>
rg 'LocationChangeCallback' --files-with-matches | xargs -I {} ast-grep --lang typescript --pattern $'$_: LocationChangeCallback = ($_1, $_2) => { $$$ return Promise.boolean; }'

Length of output: 471

---

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.

[cypress]

next-core    Run #10670

Run Properties:   Passed #10670  •  8baa630d86 ℹ️: Merge 5af96e2d71f58276a2318bc9cb6e360c758f1d0e into 62b92d3ee62b983fdc59b60efbda...

Project	next-core
Run status	Passed #10670
Run duration	00m 23s
Commit	8baa630d86 ℹ️: Merge 5af96e2d71f58276a2318bc9cb6e360c758f1d0e into 62b92d3ee62b983fdc59b60efbda...
Committer	Shenwei Wang
View all properties for this run ↗︎

---

Test results
Failures	0
Flaky	0
Pending	0
Skipped	0
Passing	16

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.21%. Comparing base (62b92d3) to head (5af96e2).
Report is 2 commits behind head on v3.

Additional details and impacted files

@@           Coverage Diff           @@
##               v3    #4522   +/-   ##
=======================================
  Coverage   95.21%   95.21%           
=======================================
  Files         205      205           
  Lines        8860     8860           
  Branches     1682     1681    -1     
=======================================
  Hits         8436     8436           
  Misses        319      319           
  Partials      105      105           

Files with missing lines	Coverage Δ
packages/runtime/src/internal/Renderer.ts	94.23% <100.00%> (ø)
packages/runtime/src/internal/RendererContext.ts	98.68% <ø> (ø)