fix(wren-ui): allow process state transition skipped when understanding

[andreashimin]

Description

allow process state transition skipped when understanding

Summary by CodeRabbit

• New Features
  • Improved process state management now delivers a consistent and unified view for users during various stages of processing.
  • Expanded transitions between processing stages enhance responsiveness, ensuring a smoother interface regardless of processing delays.

[coderabbitai]

Walkthrough

The changes update the handling of process states in the UI and underlying state machine. In the UI component, the Result.tsx file now maps the PROCESS_STATE.PLANNING and PROCESS_STATE.GENERATING states to the IntentionFinished component and adds a clarifying comment regarding polling skips for the PROCESS_STATE.SEARCHING state. In the hook, useAskProcessState.tsx expands the transition from PROCESS_STATE.UNDERSTANDING to include PLANNING and GENERATING alongside SEARCHING.

Changes

File(s)	Change Summary
wren-ui/.../Result.tsx	Updated getDefaultStateComponent to map PROCESS_STATE.PLANNING and PROCESS_STATE.GENERATING to IntentionFinished; added a comment about polling limitations.
wren-ui/.../useAskProcessState.tsx	Modified ProcessStateMachine to allow transitions from PROCESS_STATE.UNDERSTANDING to include PROCESS_STATE.PLANNING and PROCESS_STATE.GENERATING in addition to SEARCHING.

Sequence Diagram(s)

sequenceDiagram
    participant PS as ProcessStateMachine
    participant UI as UI Renderer
    participant ST as PROCESS_STATE

    Note over PS, ST: State starts at UNDERSTANDING
    PS->>ST: Request possible next state
    alt Next state options available
        ST-->>PS: SEARCHING
        ST-->>PS: PLANNING
        ST-->>PS: GENERATING
    end
    PS->>UI: Invoke getDefaultStateComponent(chosen state)
    UI-->>PS: Render IntentionFinished component for valid states

Loading

Possibly related PRs

• Feature(wren-ui): add planning stage #1222: Introduced the PROCESS_STATE.PLANNING state in various enums and UI components, aligning closely with these modifications.

Suggested labels

module/ui

Suggested reviewers

• onlyjackfrost
• wwwy3y3

Poem

I'm a bunny of code, hopping along the lane,
Tweaking UI states with a playful refrain,
From UNDERSTANDING to PLANNING, my paths are aligned,
Rendering IntentionFinished with a design refined,
Skipping states like SEARCHING in a rhythmic bunny dance!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2c336eb and 7947583.

📒 Files selected for processing (2)

• wren-ui/src/components/pages/home/prompt/Result.tsx (1 hunks)
• wren-ui/src/hooks/useAskProcessState.tsx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Analyze (go)

🔇 Additional comments (2)

wren-ui/src/hooks/useAskProcessState.tsx (1)

94-100: Approval: Good enhancement to handle state skipping during polling

This change adequately addresses the situation where polling delays might cause the AI to process faster than the UI can update, resulting in skipped states. The expanded transition allowances from UNDERSTANDING to multiple states (SEARCHING, PLANNING, GENERATING) makes the state machine more robust.

wren-ui/src/components/pages/home/prompt/Result.tsx (1)

260-264: Consistent UI treatment for additional processing states

This change correctly handles the UI representation for the PLANNING and GENERATING states by mapping them to the IntentionFinished component, ensuring a consistent user experience when states are skipped. The added comment is helpful for understanding why these changes were needed.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.