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

Retrieve messages from AI block via wsh #2064

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

oqoqqo
Copy link

@oqoqqo oqoqqo commented Mar 16, 2025

Related to #2063

@CLAassistant
Copy link

CLAassistant commented Mar 16, 2025

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

coderabbitai bot commented Mar 16, 2025

Walkthrough

The pull request introduces a new command-line interface command designed to retrieve messages from an AI block. The new command, which accepts an optional block identifier and a limit flag to cap the number of returned messages, is integrated into the CLI with its own execution function. Across multiple components, corresponding RPC methods and types have been added to support this functionality. On the client side, an API method was implemented to handle the remote procedure call while ensuring the retrieval of messages, which are then processed and returned in a structured format. Additionally, new type definitions were introduced to standardize the data for AI messages and the associated parameters, while the backend RPC packages were updated with a constant command identifier and methods for handling the new message retrieval command. Error handling and JSON marshalling are incorporated to manage communication and data formatting consistently.

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.
✨ 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
🪧 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 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 (1)
cmd/wsh/cmd/wshcmd-ai.go (1)

211-215: Consider pretty-printing JSON for better human readability.

The JSON output is printed without formatting, which may be difficult to read if used directly by humans.

-    jsonBytes, err := json.Marshal(response)
-    if err != nil {
-        return fmt.Errorf("marshalling response: %w", err)
-    }
-    fmt.Print(string(jsonBytes))
+    jsonBytes, err := json.MarshalIndent(response, "", "  ")
+    if err != nil {
+        return fmt.Errorf("marshalling response: %w", err)
+    }
+    fmt.Println(string(jsonBytes))
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 83edffb and 4c23d3b.

📒 Files selected for processing (6)
  • cmd/wsh/cmd/wshcmd-ai.go (2 hunks)
  • frontend/app/store/wshclientapi.ts (1 hunks)
  • frontend/app/view/waveai/waveai.tsx (1 hunks)
  • frontend/types/gotypes.d.ts (1 hunks)
  • pkg/wshrpc/wshclient/wshclient.go (1 hunks)
  • pkg/wshrpc/wshrpctypes.go (3 hunks)
🔇 Additional comments (13)
pkg/wshrpc/wshclient/wshclient.go (1)

25-29: Well-implemented RPC command function.

The AiGetMessagesCommand function follows the established pattern of other command functions in this file, properly utilizing the generic sendRpcRequestCallHelper with the appropriate command name and return type.

frontend/app/store/wshclientapi.ts (1)

15-18: Correctly implemented API method.

This TypeScript implementation of the AiGetMessagesCommand properly mirrors the Go implementation, maintaining consistency across the frontend and backend. The function signature with appropriate types and return value matches the pattern used throughout the codebase.

frontend/app/view/waveai/waveai.tsx (1)

63-71: Properly implemented handler with appropriate message transformation.

The handle_aigetmessages method correctly:

  1. Retrieves messages from the global store
  2. Handles the limit parameter with a default fallback to 10
  3. Maps the internal message format (user/text) to the expected response format (role/content)
  4. Returns the transformed messages via the response helper

This implementation ensures clients can retrieve a configurable number of the most recent AI messages.

frontend/types/gotypes.d.ts (2)

44-46: Properly defined request type with optional parameter.

The AiGetMessagesData type definition correctly includes the optional limit parameter, matching the structure used in the Go implementation and allowing for flexible API usage.


49-52: Well-structured message type definition.

The AiMessage type correctly defines the structure for AI messages with role and content properties, providing a clear contract for the data returned by the aigetmessages command.

pkg/wshrpc/wshrpctypes.go (4)

140-140: Command constant added correctly.

The new command constant follows the existing naming convention and is placed in the appropriate section of the file.


259-259: Interface method added correctly.

The AiGetMessagesCommand method is properly added to the WshRpcInterface with appropriate parameter and return types, following the established pattern for RPC methods.


686-689: Type definition for AiMessage is well-structured.

The AiMessage struct provides a clear data structure with appropriate JSON tags for AI message representation.


691-693: Type definition for AiGetMessagesData is properly documented.

The AiGetMessagesData struct includes a helpful comment explaining the default behavior when the limit is 0.

cmd/wsh/cmd/wshcmd-ai.go (4)

17-17: Import added correctly.

The encoding/json import is appropriately added for JSON marshaling functionality.


165-172: Command definition is well-structured.

The aigetCmd follows the Cobra command pattern consistently, with clear usage instructions and descriptions.


176-179: Command registration and flag setup is proper.

The initialization correctly adds the command to the root command and sets up the limit flag with an appropriate default value that matches the struct's documented behavior.


181-210: Command implementation follows best practices.

The aigetRun function properly handles error reporting, default values, and communicates with the server using the appropriate RPC methods.

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.

2 participants