mirror of
https://github.com/coder/coder.git
synced 2026-06-02 20:48:20 +00:00
Susana Ferreira
0766cc3097
## Description Adds automatic key failover for passthrough routes for the Anthropic and OpenAI providers. A new `keyFailoverTransport` wraps the reverse-proxy transport: centralized requests walk the configured key pool and retry with the next key on key-specific failures (401/403/429), reusing the same key-marking semantics as the bridged routes. BYOK passthrough requests run as a single attempt with no failover. ## Changes - New `keypool.KeyFailoverConfig` carrying the `Pool` to walk and the provider-specific closures (`IsBYOK`, `InjectAuthKey`, `MarkKey`, `BuildExhaustedResponse`). - New `keypool.NewKeyFailoverTransport`: wraps an inner `http.RoundTripper`. Returns `inner` unchanged when `Pool` is nil, otherwise produces a transport that buffers the request body once, walks the pool per request, and replays each attempt with the next key. - New `Provider.KeyFailoverConfig(logger)` interface method. Anthropic injects `X-Api-Key`; OpenAI injects `Authorization: Bearer ...`; Copilot returns an empty config. - `passthrough.go` wires `NewKeyFailoverTransport` around the existing apidump middleware, so every retry attempt is recorded. ## Related Issues Related to: https://github.com/coder/internal/issues/1446 Related to: https://linear.app/codercom/issue/AIGOV-197/aibridge-automatic-key-failover-for-bridged-and-passthrough-routes ## Follow-up PRs - Remove dead `Provider.InjectAuthHeader` method now that all auth is applied per-attempt by `KeyFailoverTransport`. - Bedrock multi-key support. - Refactor provider vs interceptor config separation. - Record the actually-used key in the interception credential hint after failover. > [!NOTE] > Initially generated by Claude Opus 4.7, modified and reviewed by @ssncferreira
70 lines
1.7 KiB
Go
70 lines
1.7 KiB
Go
package keypool_test
|
|
|
|
import (
|
|
"net/http"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"golang.org/x/xerrors"
|
|
|
|
"github.com/coder/coder/v2/aibridge/keypool"
|
|
"github.com/coder/quartz"
|
|
)
|
|
|
|
// errFakeRoundTripperCalled is returned by fakeRoundTripper if it
|
|
// ever gets invoked. The constructor identity tests should never
|
|
// trigger a RoundTrip call.
|
|
var errFakeRoundTripperCalled = xerrors.New("fakeRoundTripper should not be invoked")
|
|
|
|
// fakeRoundTripper is a no-op http.RoundTripper used to check
|
|
// constructor identity in tests.
|
|
type fakeRoundTripper struct{}
|
|
|
|
func (*fakeRoundTripper) RoundTrip(*http.Request) (*http.Response, error) {
|
|
return nil, errFakeRoundTripperCalled
|
|
}
|
|
|
|
func TestNewKeyFailoverTransport(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
pool, err := keypool.New([]string{"k0"}, quartz.NewMock(t))
|
|
require.NoError(t, err)
|
|
|
|
tests := []struct {
|
|
name string
|
|
// Constructor input.
|
|
config keypool.KeyFailoverConfig
|
|
// Whether the constructor returns inner unchanged.
|
|
expectSame bool
|
|
}{
|
|
{
|
|
// Pool is nil: failover is disabled, inner is returned unchanged.
|
|
name: "pool_nil_returns_inner",
|
|
config: keypool.KeyFailoverConfig{},
|
|
expectSame: true,
|
|
},
|
|
{
|
|
// Pool is set: inner is wrapped in a key-failover transport.
|
|
name: "pool_set_returns_wrapper",
|
|
config: keypool.KeyFailoverConfig{Pool: pool},
|
|
expectSame: false,
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
inner := &fakeRoundTripper{}
|
|
got := keypool.NewKeyFailoverTransport(inner, tc.config)
|
|
|
|
if tc.expectSame {
|
|
assert.Same(t, inner, got)
|
|
} else {
|
|
assert.NotSame(t, inner, got)
|
|
}
|
|
})
|
|
}
|
|
}
|