docs: update session-hierarchy + session-persistence for PR #1781 (smart cache invalidation)#489
docs: update session-hierarchy + session-persistence for PR #1781 (smart cache invalidation)#489MervinPraison wants to merge 1 commit into
Conversation
…art cache invalidation + set_title concurrent-write safety) - Restructure session-hierarchy.mdx with agent-centric Quick Start - Add smart cache invalidation subsection with mtime-based cache validity explanation - Add concurrent write scenario sequence diagram for UI set_title + worker race - Add performance characteristics Note and operation safety table - Update session-persistence.mdx Multi-Process Safety section with mtime-cache note - Follow AGENTS.md standards: hero diagram, Steps/AccordionGroup/CardGroup components - Include copy-paste runnable examples with proper imports - Use standard color scheme (#8B0000, #189AB4, #10B981) with white text Fixes #485 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Mervin Praison <MervinPraison@users.noreply.github.com>
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
|
Warning Review limit reached
More reviews will be available in 59 minutes and 23 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 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 configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly updates the documentation for "Session Hierarchy" and "Session Persistence", adding detailed guides, Mermaid diagrams, concurrency safety explanations, and best practices. The review feedback points out two issues in the "Best Practices" code snippets where the session variable is used without being defined, and where a potential AttributeError could occur if session.title is None.
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.
| # Good: Fork before exploring alternatives | ||
| main_conversation_complete = len(session.messages) >= 10 | ||
| if main_conversation_complete: | ||
| experimental_id = store.fork_session(session_id, title="Alternative Solution") |
There was a problem hiding this comment.
In this example, the session variable is used without being defined first. To make this code snippet correct and robust, you should retrieve the session object from the store using store.get_extended_session(session_id).
# Good: Fork before exploring alternatives
session = store.get_extended_session(session_id)
main_conversation_complete = len(session.messages) >= 10
if main_conversation_complete:
experimental_id = store.fork_session(session_id, title="Alternative Solution")
| # Export important sessions | ||
| important_data = store.export_session(session_id) | ||
|
|
||
| # Clean up test sessions | ||
| if session.title.startswith("Test-"): |
There was a problem hiding this comment.
The session variable is used here without being defined. Additionally, since session.title can be None, calling startswith() directly on it could raise an AttributeError. You should retrieve the session first and safely check if session.title is not None before calling startswith().
important_data = store.export_session(session_id)
# Clean up test sessions
session = store.get_extended_session(session_id)
if session.title and session.title.startswith("Test-"):
store.delete_session(session_id)
1 participant
Updates documentation for PR MervinPraison/PraisonAI#1781 which introduced smart cache invalidation and concurrency safety fixes to HierarchicalSessionStore.
Changes
docs/features/session-hierarchy.mdx
docs/features/session-persistence.mdx
Technical Content
Documents the key improvements from PR #1781:
Standards Compliance
Fixes #485
Generated with Claude Code