Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature(wren-ui): add planning stage #1222

Merged
merged 1 commit into from
Jan 24, 2025
Merged

Conversation

wwwy3y3
Copy link
Member

@wwwy3y3 wwwy3y3 commented Jan 24, 2025

Description

Add planning stage to asking flow

Screenshot 2025-01-23 at 6 41 58 PM

Summary by CodeRabbit

  • New Features

    • Added a new "Planning" state to the task processing workflow
    • Enhanced task status tracking with a more granular representation of task stages
  • Improvements

    • Expanded processing state management across multiple components
    • Updated GraphQL schema and type definitions to support the new planning status

Copy link
Contributor

coderabbitai bot commented Jan 24, 2025

Walkthrough

This pull request introduces a new PLANNING status across multiple files in the Wren UI project. The changes consistently add the PLANNING status to various enums and components, expanding the representation of task processing states. The modifications span GraphQL types, server models, client-side components, and utility enums, ensuring a comprehensive update to handle a new planning phase in the application's workflow.

Changes

File Change Summary
wren-ui/src/apollo/client/graphql/__types__.ts Added PLANNING to AskingTaskStatus enum
wren-ui/src/apollo/server/models/adaptor.ts Added PLANNING to AskResultStatus enum
wren-ui/src/apollo/server/schema.ts Added PLANNING to AskingTaskStatus enum
wren-ui/src/components/pages/home/prompt/Result.tsx Added Planning constant and updated getDefaultStateComponent
wren-ui/src/components/pages/home/prompt/index.tsx Updated convertAskingTaskToProcessState to map PLANNING status
wren-ui/src/hooks/useAskProcessState.tsx Modified getIsProcessing to include PLANNING state
wren-ui/src/utils/enum/home.ts Added PLANNING to PROCESS_STATE enum, removed FAILED and NO_RESULT

Sequence Diagram

sequenceDiagram
    participant User
    participant UI
    participant AskingTask
    User->>UI: Initiate Task
    UI->>AskingTask: Set Status to PLANNING
    AskingTask-->>UI: Update Task State
    UI->>UI: Render Planning State
Loading

Possibly related PRs

Suggested labels

module/ai-service, ci/ai-service

Poem

🐰 A Rabbit's Ode to Planning 🌱

In the realm of tasks, a new state arrives,
PLANNING whispers of thoughts that thrive,
Hopping through code with graceful might,
Bringing clarity, making futures bright!
A status that dances between dream and do 🚀

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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
🪧 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. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
wren-ui/src/components/pages/home/prompt/Result.tsx (1)

153-153: Ensure consistent user messaging for the new “Planning” state.

While "Organizing thoughts" nicely captures the planning concept, consider using language that aligns more closely with adjacent states such as "Understanding question" or "Searching data" for consistency and clarity.

wren-ui/src/apollo/server/schema.ts (1)

539-539: Add test coverage for new AskingTaskStatus PLANNING.

Introducing a new enum member requires ensuring it’s accurately handled in resolvers and tested in queries/mutations. Make sure server-side logic and integration tests account for the new PLANNING status flow.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a928f3c and fdb215e.

📒 Files selected for processing (7)
  • wren-ui/src/apollo/client/graphql/__types__.ts (1 hunks)
  • wren-ui/src/apollo/server/models/adaptor.ts (1 hunks)
  • wren-ui/src/apollo/server/schema.ts (1 hunks)
  • wren-ui/src/components/pages/home/prompt/Result.tsx (2 hunks)
  • wren-ui/src/components/pages/home/prompt/index.tsx (1 hunks)
  • wren-ui/src/hooks/useAskProcessState.tsx (1 hunks)
  • wren-ui/src/utils/enum/home.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Analyze (go)
🔇 Additional comments (5)
wren-ui/src/hooks/useAskProcessState.tsx (1)

7-7: Good inclusion of PROCESS_STATE.PLANNING in getIsProcessing.
This ensures that the planning phase is now correctly recognized as an active process.

wren-ui/src/apollo/server/models/adaptor.ts (1)

74-74: Enum extension with PLANNING looks appropriate.
This addition offers a clearer representation of the planning stage in the overall ask workflow.

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

64-64: Well-integrated mapping of AskingTaskStatus.PLANNING to PROCESS_STATE.PLANNING.
This maintains consistency across the system and ensures the UI can fully manage the new planning phase.

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

273-273: Confirm that the PLANNING state is properly integrated in all relevant components.

Adding PROCESS_STATE.PLANNING here is a good expansion, but verify downstream references (like logs, analytics, or any relevant place where states are tracked) to ensure no missing references.

✅ Verification successful

PLANNING state is properly integrated across all components

The state is consistently implemented across GraphQL schema, state management, and UI components with proper mappings and transitions.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for references to PLANNING usage to confirm consistent handling across the codebase
rg -A3 "PLANNING"

Length of output: 2078

wren-ui/src/apollo/client/graphql/__types__.ts (1)

45-45: Enum extension looks correct.

The addition of PLANNING aligns with other states. No immediate issues found.

@wwwy3y3 wwwy3y3 changed the title Feature(wren-ui): add planning stage (#464) Feature(wren-ui): add planning stage Jan 24, 2025
@wwwy3y3 wwwy3y3 merged commit 9dc59cb into main Jan 24, 2025
5 checks passed
@wwwy3y3 wwwy3y3 deleted the feature/add-planning-stage-to-ask branch January 24, 2025 02:46
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.

3 participants