Skip to content

docs: update session persistence file-locking docs for graceful fcntl-missing degradation#490

Merged
MervinPraison merged 2 commits into
mainfrom
claude/issue-488-20260602-1903
Jun 3, 2026
Merged

docs: update session persistence file-locking docs for graceful fcntl-missing degradation#490
MervinPraison merged 2 commits into
mainfrom
claude/issue-488-20260602-1903

Conversation

@MervinPraison
Copy link
Copy Markdown
Owner

Summary

Updates documentation to reflect the graceful fcntl-missing degradation changes from PraisonAI PR #1792:

  • Updated Cross-Platform Support section in docs/features/persistence-json.mdx

    • Extended Mermaid diagram to show graceful degradation path for environments without fcntl
    • Added fourth row to platform table covering Pyodide/WASM/embedded Python environments
    • Added Note callout with exact warning message text for grep-ability
  • Updated Multi-Process Safety section in docs/features/session-persistence.mdx

    • Added bullet for environments without fcntl support
    • Added Warning callout explaining single-process-only behavior
    • Included exact warning text users will see in logs

Key Changes

  1. Platform Support Matrix: Now documents behavior on exotic Python distributions where fcntl is unavailable
  2. Warning Message: Documents the exact warning text: File locking unavailable on this platform (fcntl not available); concurrent writers may corrupt session files.
  3. Graceful Degradation: Explains that the store continues to work but without multi-process safety guarantees

Test Plan

  • Verify Mermaid diagrams render correctly with standard color scheme
  • Confirm all warning text matches SDK implementation
  • Check that progressive disclosure maintains user-friendly approach
  • Ensure no SDK internals leak into user-facing prose

Fixes #488

Generated with Claude Code

…-missing degradation (fixes #488)

- Update Cross-Platform Support section in persistence-json.mdx
- Add fourth platform row for Pyodide/WASM/embedded environments
- Update Mermaid diagram to show graceful degradation path
- Add Note callout with exact warning message text
- Update Multi-Process Safety section in session-persistence.mdx
- Add Warning callout for fcntl unavailable scenarios
- Document single-process only behavior for exotic environments

Reflects changes from PraisonAI PR #1792 that improved fcntl import handling
with try/except ImportError for better cross-platform compatibility.

Co-authored-by: Mervin Praison <MervinPraison@users.noreply.github.com>
@qodo-code-review
Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 2, 2026

Warning

Review limit reached

@MervinPraison, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 51 minutes and 15 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 968b6efe-5bc3-4625-af41-3853a0556f8f

📥 Commits

Reviewing files that changed from the base of the PR and between 2fa183d and a25f154.

📒 Files selected for processing (2)
  • docs/features/persistence-json.mdx
  • docs/features/session-persistence.mdx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/issue-488-20260602-1903

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation to describe how the session store behaves on platforms where file locking is unavailable (such as Pyodide or WASM), detailing the fallback to single-process mode and the logging of a one-time warning. The review comments correctly identify that the documented warning text in both files does not match the actual warning logged in the SDK code ("File locking unavailable on this platform (no fcntl/msvcrt); concurrent writers may corrupt session files.") and should be updated for accuracy.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

locking — single-process usage remains safe, but concurrent writers may
corrupt session files. The exact warning text is:

`File locking unavailable on this platform (fcntl not available); concurrent writers may corrupt session files.`
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The documented warning text does not match the actual warning logged in the SDK code. In praisonaiagents/session/store.py, the warning message is: "File locking unavailable on this platform (no fcntl/msvcrt); concurrent writers may corrupt session files." Please update the documentation to match the exact warning text for better searchability/grep-ability.

<Warning>
If `fcntl` is unavailable at import time, the store logs this warning **once** the first time `FileLock.acquire()` is called:

`File locking unavailable on this platform (fcntl not available); concurrent writers may corrupt session files.`
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The documented warning text does not match the actual warning logged in the SDK code. In praisonaiagents/session/store.py, the warning message is: "File locking unavailable on this platform (no fcntl/msvcrt); concurrent writers may corrupt session files." Please update the documentation to match the exact warning text for better searchability/grep-ability.

@MervinPraison MervinPraison merged commit a80fbfb into main Jun 3, 2026
1 check was pending
@MervinPraison MervinPraison deleted the claude/issue-488-20260602-1903 branch June 3, 2026 05:02
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.

docs: update session persistence file-locking docs for graceful fcntl-missing degradation (PraisonAI #1792)

1 participant