Skip to content

Add reentrancy warning and summary table to Orleans request scheduling docs#52123

Open
Copilot wants to merge 3 commits intomainfrom
copilot/add-summary-table-reentrancy
Open

Add reentrancy warning and summary table to Orleans request scheduling docs#52123
Copilot wants to merge 3 commits intomainfrom
copilot/add-summary-table-reentrancy

Conversation

Copy link
Contributor

Copilot AI commented Mar 9, 2026

The Orleans reentrancy section lacked a quick-reference overview and no upfront signal that it's an advanced, footgun-prone feature.

Changes

  • Warning admonition — Added at the top of the ## Reentrancy section flagging race conditions, state corruption, and diagnostic difficulty from misuse.
  • Summary table — Inserted after the intro bullet list, consolidating all five reentrancy mechanisms with scope and description for at-a-glance comparison:
Option Scope Description
[Reentrant] Grain class All methods freely interleave
[AlwaysInterleave] Interface method Marked method always interleaves with any request
[ReadOnly] Interface method Concurrent with other [ReadOnly] methods
[MayInterleave] Grain class Predicate determines interleaving per call
AllowCallChainReentrancy() Call site Scoped call-chain reentrancy
  • Frontmatter — Updated ms.date and added ai-usage: ai-assisted.
Original prompt

This section details on the original issue you should resolve

<issue_title>Add summary table and advanced feature warning to Request Scheduling reentrancy section in the Orleans docs</issue_title>
<issue_description>### Describe the issue or suggestion

The Request scheduling - Reentrancy section would benefit from a summary table that consolidates the various reentrancy options in one place, making it easier for developers to quickly understand and compare them.

Also, add a warning admonition at the beginning of the Reentrancy section:
Reentrancy is an advanced feature that requires a solid understanding of concurrency concepts. Incorrect use can lead to race conditions, state corruption, or subtle bugs that are difficult to diagnose. Ensure you understand the implications before enabling reentrancy on your grains.


Document Details

Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.


Associated WorkItem - 556418</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.


Internal previews

📄 File 🔗 Preview link
docs/orleans/grains/request-scheduling.md Request scheduling

Co-authored-by: meaghanlewis <10103121+meaghanlewis@users.noreply.github.com>
Copilot AI changed the title [WIP] Add summary table and warning to reentrancy section Add reentrancy warning and summary table to Orleans request scheduling docs Mar 9, 2026
@meaghanlewis meaghanlewis marked this pull request as ready for review March 9, 2026 18:37
Copilot AI review requested due to automatic review settings March 9, 2026 18:37
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Orleans request scheduling documentation to make the Reentrancy section safer and easier to scan by adding an upfront warning and a quick-reference comparison of reentrancy mechanisms.

Changes:

  • Added a WARNING admonition at the start of the Reentrancy section to flag the risks of incorrect reentrancy usage.
  • Added a summary table comparing the available reentrancy/interleaving options, including scope and intent.
  • Updated frontmatter metadata (ms.date) and added ai-usage: ai-assisted.

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add summary table and advanced feature warning to Request Scheduling reentrancy section in the Orleans docs

3 participants