feat: add context to CoT actions for cleaner memory output

[Matth26]

Previously, actions lacked contextualized outputs, resulting in ambiguous memory storage.
This PR introduces 'context' field, generated by the agent, for each action, ensuring cleaner and more organized memory registration.

Handlers now include context in their output for clarity:

dreams.registerOutput({
    role: HandlerRole.ACTION,
    name: "EXECUTE_READ",
    handler: async (action: any) => {
        const result = await starknetChain.read(action.payload);
        return `[EXECUTE_READ] ${action.context}: ${JSON.stringify(result, null, 2)}`;
    },
    schema: ...
});

dreams.registerOutput({
    name: "EXECUTE_TRANSACTION",
    handler: async (action: any) => {
      const result = await starknetChain.write(action.payload);
      return `[EXECUTE_TRANSACTION] ${action.context}. STATUS: ${result.statusReceipt}`;
    },
    schema: ...
});

Summary by CodeRabbit

• New Features

  • Enhanced action execution by adding context property to actions
  • Improved metadata handling for action-based workflows

• Documentation

  • Clarified payload and context description in method documentation

The changes introduce a more flexible and informative action execution process, allowing actions to carry additional contextual information.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
daydreams	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 28, 2025 6:28pm

[coderabbitai]

Walkthrough

The pull request introduces a new context property to the ChainOfThought action execution mechanism. This change enhances the action handling capabilities by allowing actions to carry contextual information. The modification spans two files: chain-of-thought.ts and types/index.ts, updating the method signature and interface definition to support the new contextual metadata. The change aims to provide more detailed information during action execution, potentially improving the system's decision-making process.

Changes

File	Change Summary
packages/core/src/core/types/index.ts	Updated CoTAction interface to include context: string property
packages/core/src/core/chain-of-thought.ts	Modified executeAction method signature to accept context in action parameter

Possibly related PRs

• feat: add separate contract read action handler #11: Introduction of READ_CONTRACT action type and starknetReadAction handler, which relates to the expanded action handling framework

Poem

🐰 A rabbit's tale of context bright,
Where actions dance with insight's might,
A string of wisdom, small but keen,
Enhancing what the code can glean,
Context leaps, a playful sprite! 🌟

✨ 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

• 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. (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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

packages/core/src/core/types/index.ts (1)

29-29: Add JSDoc documentation for the new context field.

The new context field lacks documentation explaining its purpose and expected content.

Add JSDoc comments to document the field:

 export interface CoTAction {
     type: string;
+    /** Contextual description or metadata related to the action's execution. */
     context: string;
     payload: Record<string, any>;
 }

packages/core/src/core/chain-of-thought.ts (1)

1058-1058: Enhance error handling for the new context field.

While the implementation is correct, consider improving error handling to provide clearer feedback when the context field is missing or invalid.

Consider adding specific error messages:

 public async executeAction(action: CoTAction): Promise<string> {
     this.logger.debug("executeAction", "Executing action", { action });
+    if (!action.context) {
+        const error = "Missing required context field in action";
+        this.logger.error("executeAction", error, { action });
+        throw new Error(error);
+    }
     this.emit("action:start", action);

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0bc8420 and 7c4523e.

📒 Files selected for processing (2)

• packages/core/src/core/chain-of-thought.ts (3 hunks)
• packages/core/src/core/types/index.ts (1 hunks)

🔇 Additional comments (3)

packages/core/src/core/types/index.ts (1)

29-29: Breaking Change: New required field added to CoTAction interface.

Adding a required context field to the CoTAction interface is a breaking change that will require updates to all existing implementations.

Let's verify the impact on existing implementations:

packages/core/src/core/chain-of-thought.ts (2)

1201-1205: LGTM! Clear and well-structured documentation.

The added documentation clearly explains the context requirement for actions and maintains consistency with the interface changes.

---

1263-1263: LGTM! Proper schema validation for the new context field.

The schema validation correctly enforces the new required context field, maintaining type safety.