chore: update maxim's plugin bifrost/core dependency to v1.1.0 #76

Pratham-Mishra04 · 2025-06-11T21:10:37Z

Update Bifrost Core Dependency to v1.1.0

This PR updates the Maxim plugin to work with Bifrost Core v1.1.0. The changes include:

Updated the PreHook method signature to match the new interface that returns an additional BifrostResponse parameter
Added a Cleanup method to properly flush the logger when the plugin is terminated
Updated message handling to work with the new schemas.MessageContent structure
Simplified message content extraction by using the standardized Content field

These changes ensure compatibility with the latest Bifrost Core while maintaining the plugin's functionality for tracing and logging requests.

coderabbitai · 2025-06-11T21:10:44Z

Summary by CodeRabbit

New Features
- Added a cleanup feature to improve resource management.
Bug Fixes
- Improved handling of chat message content, ensuring more robust extraction and processing of message text.
Chores
- Updated a core dependency to the latest version for improved stability and compatibility.
  """

Summary by CodeRabbit

New Features
- Introduced a cleanup capability for the plugin to ensure proper resource management.
Improvements
- Enhanced message handling for chat completion inputs, streamlining processing and improving consistency.
Compatibility
- Updated a core dependency to a newer version for improved support.
Tests
- Adjusted test cases to align with the updated message structure and cleanup process.

Walkthrough

The changes update the PreHook method signature in the Maxim plugin to return an additional response object, adjust message content handling, and add a Cleanup method. The dependency on bifrost/core is upgraded to v1.1.0, and related test cases are updated to match the new message structure and method signatures.

Changes

File(s)	Change Summary
plugins/maxim/go.mod	Updated `bifrost/core` dependency from v1.0.9 to v1.1.0.
plugins/maxim/main.go	Changed `PreHook` signature to return an extra response, simplified message handling, added `Cleanup`.
plugins/maxim/plugin_test.go	Updated test to use new message content structure and removed a comment.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Plugin
    participant Logger

    Client->>Plugin: PreHook(ctx, req)
    Plugin->>Logger: Log message content
    alt Generation ID exists
        Plugin-->>Client: Return early (req, nil, nil)
    else
        Plugin-->>Client: Return (req, nil, nil)
    end
    Client->>Plugin: Cleanup()
    Plugin->>Logger: Flush()
    Plugin-->>Client: nil

Possibly related PRs

feat: enhance plugin system with short-circuit capability and cleanup method #69: Updates the plugin interface to support short-circuiting and cleanup, which aligns with the changes made in this PR.
fix: update core version and improve tool message handling #56: Modifies the PreHook method and updates the core dependency version, similar to the changes in this PR.

Suggested reviewers

akshaydeo
danpiths

Poem

A hop and a skip, a signature grows,
PreHook returns more, as the interface flows.
Cleanup arrives, to tidy the den,
Messages streamlined, like tracks in the glen.
With dependencies fresh, and tests in the mix,
This rabbit’s code garden gets clever new tricks! 🐇✨
"""

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1c13e3e and d81b8db.

⛔ Files ignored due to path filters (1)

plugins/maxim/go.sum is excluded by !**/*.sum

📒 Files selected for processing (3)

plugins/maxim/go.mod (1 hunks)
plugins/maxim/main.go (5 hunks)
plugins/maxim/plugin_test.go (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

plugins/maxim/plugin_test.go (1)

Learnt from: Pratham-Mishra04
PR: maximhq/bifrost#54
File: core/schemas/bifrost.go:46-49
Timestamp: 2025-06-04T09:22:18.123Z
Learning: In core/schemas/bifrost.go, the RequestInput struct uses ChatCompletionInput *[]BifrostMessage (pointer-to-slice) rather than []BifrostMessage to properly represent union type semantics. For text completion requests, ChatCompletionInput should be nil to indicate "no chat payload at all", while for chat completion requests it should be non-nil (even if empty slice). This distinguishes between different request types rather than just empty vs non-empty chat messages.

🧬 Code Graph Analysis (2)

plugins/maxim/plugin_test.go (2)

core/schemas/bifrost.go (1)

MessageContent (158-161)

core/utils.go (1)

Ptr (5-7)

plugins/maxim/main.go (2)

core/schemas/bifrost.go (3)

BifrostRequest (59-69)

BifrostResponse (237-247)

ModelChatMessageRoleUser (29-29)

transports/bifrost-http/main.go (1)

CompletionRequest (111-118)

🔇 Additional comments (1)

plugins/maxim/main.go (1)

140-144:
❌ Incorrect review comment

Possible type mismatch for Content field

logging.CompletionRequest.Content previously accepted a string.
You are now passing the entire schemas.MessageContent struct, which will not compile unless the Maxim SDK changed its signature accordingly.
-				Content: message.Content,
+				Content: func() string {
+					if message.Content.ContentStr != nil {
+						return *message.Content.ContentStr
+					}
+					return "<non-string content>"
+				}(),
Please verify the expected type in github.com/maximhq/maxim-go/logging.
Compilation will fail otherwise.

🏁 Script executed:
#!/bin/bash
# Locate the field type of Content in CompletionRequest
ast-grep --pattern $'type CompletionRequest {$$$}' | grep -A3 -B2 'Content'
Length of output: 74

🏁 Script executed:
#!/bin/bash
set -e
# Clone the Maxim SDK to inspect CompletionRequest
git clone https://github.com/maximhq/maxim-go.git /tmp/maxim-go
# Show the CompletionRequest definition
grep -R "type CompletionRequest" -n /tmp/maxim-go/logging
# Show the Content field within that struct
grep -R "Content" -n /tmp/maxim-go/logging
Length of output: 2249
Incorrect assumption about CompletionRequest.Content type

The Content field on logging.CompletionRequest is declared as an empty interface (interface{}), not *string. Assigning your schemas.MessageContent struct to it will compile without errors:
type CompletionRequest struct {
    // …
    Content interface{} `json:"content"`
}
No change is required here—please disregard the previous suggestion.

Likely an incorrect or invalid review comment.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate Unit Tests

Create PR with Unit Tests
Commit Unit Tests in branch 06-12-chore_maxim_plugin_refactor_to_support_core_v1.1.0
Post Copyable Unit Tests in Comment

🪧 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.
- @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 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.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

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

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

Pratham-Mishra04 · 2025-06-11T21:10:53Z

This stack of pull requests is managed by Graphite. Learn more about stacking.

coderabbitai

Actionable comments posted: 4

🔭 Outside diff range comments (1)

plugins/maxim/main.go (1)

99-106: 🧹 Nitpick (assertive)

Doc-comment is outdated after signature change

The PreHook comment still claims the function returns “*BifrostRequest, error”.
Update the description to mention the additional *BifrostResponse return so that go doc stays accurate.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8b814ca and 1c13e3e.

⛔ Files ignored due to path filters (1)

plugins/maxim/go.sum is excluded by !**/*.sum

📒 Files selected for processing (3)

plugins/maxim/go.mod (1 hunks)
plugins/maxim/main.go (4 hunks)
plugins/maxim/plugin_test.go (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

plugins/maxim/plugin_test.go (1)

Learnt from: Pratham-Mishra04
PR: maximhq/bifrost#54
File: core/schemas/bifrost.go:46-49
Timestamp: 2025-06-04T09:22:18.123Z
Learning: In core/schemas/bifrost.go, the RequestInput struct uses ChatCompletionInput *[]BifrostMessage (pointer-to-slice) rather than []BifrostMessage to properly represent union type semantics. For text completion requests, ChatCompletionInput should be nil to indicate "no chat payload at all", while for chat completion requests it should be non-nil (even if empty slice). This distinguishes between different request types rather than just empty vs non-empty chat messages.

🧬 Code Graph Analysis (2)

plugins/maxim/plugin_test.go (2)

core/schemas/bifrost.go (1)

MessageContent (158-161)

core/utils.go (1)

Ptr (5-7)

plugins/maxim/main.go (2)

core/schemas/bifrost.go (2)

BifrostRequest (59-69)

BifrostResponse (237-247)

transports/bifrost-http/main.go (1)

CompletionRequest (111-118)

🔇 Additional comments (1)

plugins/maxim/main.go (1)

140-144: Verify type expected by logging.CompletionRequest.Content

message.Content is a schemas.MessageContent struct.
If logging.CompletionRequest.Content still expects a string, this will not compile after the schema upgrade.
Please run go test ./... or go vet ./... to confirm the interface matches.
If a string is required, pass *message.Content.ContentStr instead (after nil-check).

plugins/maxim/go.mod

plugins/maxim/plugin_test.go

plugins/maxim/main.go

akshaydeo · 2025-06-12T08:16:55Z

Merge activity

Jun 12, 8:16 AM UTC: A user started a stack merge that includes this pull request via Graphite.
Jun 12, 8:17 AM UTC: @akshaydeo merged this pull request with Graphite.

Pratham-Mishra04 requested review from akshaydeo and danpiths June 11, 2025 21:10

Pratham-Mishra04 changed the title ~~chore: update bifrost/core dependency to v1.1.0~~ chore: update maxim's plugin bifrost/core dependency to v1.1.0 Jun 11, 2025

Pratham-Mishra04 marked this pull request as ready for review June 11, 2025 21:11

coderabbitai bot requested changes Jun 11, 2025

View reviewed changes

plugins/maxim/go.mod Show resolved Hide resolved

plugins/maxim/plugin_test.go Show resolved Hide resolved

plugins/maxim/main.go Show resolved Hide resolved

plugins/maxim/main.go Show resolved Hide resolved

chore: maxim plugin refactor to support core/v1.1.0

d81b8db

Pratham-Mishra04 force-pushed the 06-12-chore_maxim_plugin_refactor_to_support_core_v1.1.0 branch from 1c13e3e to d81b8db Compare June 11, 2025 21:22

coderabbitai bot approved these changes Jun 11, 2025

View reviewed changes

Pratham-Mishra04 mentioned this pull request Jun 12, 2025

bug: fixed provider level minor message parsing bugs #77

Merged

akshaydeo merged commit 2175eb6 into main Jun 12, 2025
2 checks passed

This was referenced Jun 22, 2025

feat: add plugin short-circuit control with fallback management with docs enhancement #105

Merged

feat: add auto-generated RPC wrapper system for plugins #112

Draft

chore: update maxim plugin core dependency to v1.1.5 #115

Merged

coderabbitai bot mentioned this pull request Jul 16, 2025

chore: update bifrost/core dependency to v1.1.8 #167

Merged

akshaydeo deleted the 06-12-chore_maxim_plugin_refactor_to_support_core_v1.1.0 branch August 31, 2025 17:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: update maxim's plugin bifrost/core dependency to v1.1.0 #76

chore: update maxim's plugin bifrost/core dependency to v1.1.0 #76

Uh oh!

Pratham-Mishra04 commented Jun 11, 2025

Uh oh!

coderabbitai bot commented Jun 11, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Pratham-Mishra04 commented Jun 11, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

akshaydeo commented Jun 12, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

chore: update maxim's plugin bifrost/core dependency to v1.1.0 #76

chore: update maxim's plugin bifrost/core dependency to v1.1.0 #76

Uh oh!

Conversation

Pratham-Mishra04 commented Jun 11, 2025

Update Bifrost Core Dependency to v1.1.0

Uh oh!

coderabbitai bot commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Summary by CodeRabbit

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Pratham-Mishra04 commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

akshaydeo commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot commented Jun 11, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

Pratham-Mishra04 commented Jun 11, 2025 •

edited

Loading

akshaydeo commented Jun 12, 2025 •

edited

Loading