feat: add usage field to workflow runs and histories

[chyroc]

• Add usage field to workflows_runs.go for tracking resource consumption
• Enhance workflows_runs_histories.go with usage data support
• Update tests in workflows_runs_test.go to cover usage field functionality

🤖 Generated with Claude Code

Summary by CodeRabbit

• New Features

  • Added detailed token usage information to workflow run responses and workflow run history, allowing users to view token consumption for each run.

• Bug Fixes

  • Ensured that token usage data is optional and correctly handled in workflow run responses.

• Tests

  • Expanded test coverage to verify correct parsing and display of token usage details in workflow run responses.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes remove the WorkflowRunResult struct and extend several response structs by adding an optional Usage field of type pointer to ChatUsage to provide token consumption details. Corresponding tests are updated and added to validate the presence and parsing of the new Usage field in workflow run responses.

Changes

Cohort / File(s)	Change Summary
Workflow Run Struct Updates workflows_runs.go	Removed the WorkflowRunResult struct; added optional Usage *ChatUsage field to WorkflowEventMessage struct.
Workflow Run History Struct Updates workflows_runs_histories.go	Added optional Usage *ChatUsage field to both RunWorkflowsResp and WorkflowRunHistory structs.
Workflow Run Usage Tests workflows_runs_test.go	Added a subtest for creating workflow runs with the Usage field; updated existing tests to check for optional presence of Usage.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant WorkflowEngine

    Client->>API: POST /v1/workflow/run
    API->>WorkflowEngine: Execute workflow
    WorkflowEngine-->>API: Execution result (+ optional Usage)
    API-->>Client: Response (includes Usage if available)

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

A struct retired, a field appears,
Usage counts tokens, allays our fears.
Tests now check what Usage brings,
Workflows run with data wings.
Code hops ahead, neat and bright—
Another patch, another byte!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 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 5f816af and e0b5fdf.

📒 Files selected for processing (3)

• workflows_runs.go (1 hunks)
• workflows_runs_histories.go (2 hunks)
• workflows_runs_test.go (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/workflow-updates

---

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.
  • Explain this complex logic.
  • 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 explain this code block.
• 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 explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests 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.