History

feat(plugin): add schema-v3 stream chunk contract to omit payload request bodies

- Bump plugin schema to version 3 and introduce `SchemaVersionStreamChunkOmitRequestBody`. - Treat missing plugin schema versions as legacy during RPC registration (`0 -> 1`) and expose schema on plugin descriptors. - In stream interception, keep request headers/bodies on header-init chunk and stop re-sending them on payload chunks for schema-v3+ plugins, with per-chunk cloning for legacy plugins.

Luis Pater committed 3 months ago

Commit ba5ab791 parent 5d9b62910 files · +297 −33Browse files

Unified · Split

10 files
  1. internal/pluginhost/adapters_interceptors.go +32 −2
  2. internal/pluginhost/adapters_test.go +79 −0
  3. internal/pluginhost/rpc_client.go +7 −1
  4. internal/pluginhost/rpc_schema_test.go +8 −1
  5. sdk/api/handlers/handlers_interceptors.go +19 −0
  6. sdk/api/handlers/handlers_interceptors_test.go +82 −6
  7. sdk/api/handlers/handlers_stream.go +45 −18
  8. sdk/pluginabi/types.go +7 −1
  9. sdk/pluginabi/types_test.go +5 −2
  10. sdk/pluginapi/types.go +13 −2
internal/pluginhost/adapters_interceptors.go+32−2
@@ -10,6 +10,7 @@ import ( · 9 unmodified lines
10 "strings"10 "strings"
11 11
12 coreauth "github.com/router-for-me/CLIProxyAPI/v7/sdk/cliproxy/auth"12 coreauth "github.com/router-for-me/CLIProxyAPI/v7/sdk/cliproxy/auth"
13 "github.com/router-for-me/CLIProxyAPI/v7/sdk/pluginabi"
13 "github.com/router-for-me/CLIProxyAPI/v7/sdk/pluginapi"14 "github.com/router-for-me/CLIProxyAPI/v7/sdk/pluginapi"
14 log "github.com/sirupsen/logrus"15 log "github.com/sirupsen/logrus"
15)16)
@@ -211,8 +212,15 @@ func (h *Host) InterceptStreamChunkExcept(ctx context.Context, req pluginapi.Str · 195 unmodified lines
211 nextReq := req212 nextReq := req
212 nextReq.RequestHeaders = cloneHeader(req.RequestHeaders)213 nextReq.RequestHeaders = cloneHeader(req.RequestHeaders)
213 nextReq.ResponseHeaders = cloneHeader(current.Headers)214 nextReq.ResponseHeaders = cloneHeader(current.Headers)
214 nextReq.OriginalRequest = bytes.Clone(req.OriginalRequest)215 // Schema v3+ omits request bodies on payload chunks to avoid re-sending multi-MB
215 nextReq.RequestBody = bytes.Clone(req.RequestBody)216 // prompts across cgo/JSON for every frame. Legacy plugins still receive them.
217 if req.ChunkIndex != pluginapi.StreamChunkHeaderInitIndex && streamChunkOmitsRequestBodies(record.plugin.SchemaVersion) {
218 nextReq.OriginalRequest = nil
219 nextReq.RequestBody = nil
220 } else {
221 nextReq.OriginalRequest = bytes.Clone(req.OriginalRequest)
222 nextReq.RequestBody = bytes.Clone(req.RequestBody)
223 }
216 nextReq.Body = bytes.Clone(current.Body)224 nextReq.Body = bytes.Clone(current.Body)
217 nextReq.HistoryChunks = cloneByteSlices(req.HistoryChunks)225 nextReq.HistoryChunks = cloneByteSlices(req.HistoryChunks)
218 nextReq.Metadata = cloneInterceptorMetadata(req.Metadata)226 nextReq.Metadata = cloneInterceptorMetadata(req.Metadata)
@@ -244,6 +252,28 @@ func (h *Host) HasStreamInterceptors() bool { · 25 unmodified lines
244 return false252 return false
245}253}
246 254
255// StreamChunkPayloadIncludesRequestBody reports whether any active stream chunk
256// interceptor still requires OriginalRequest/RequestBody on payload chunks
257// (schema_version < SchemaVersionStreamChunkOmitRequestBody).
258func (h *Host) StreamChunkPayloadIncludesRequestBody() bool {
259 if h == nil {
260 return false
261 }
262 for _, record := range h.activeRecords() {
263 if h.isPluginFused(record.id) || record.plugin.Capabilities.StreamChunkInterceptor == nil {
264 continue
265 }
266 if !streamChunkOmitsRequestBodies(record.plugin.SchemaVersion) {
267 return true
268 }
269 }
270 return false
271}
272
273func streamChunkOmitsRequestBodies(schemaVersion uint32) bool {
274 return schemaVersion >= pluginabi.SchemaVersionStreamChunkOmitRequestBody
275}
276
247func (h *Host) HasRequestInterceptors() bool {277func (h *Host) HasRequestInterceptors() bool {
248 if h == nil {278 if h == nil {
249 return false279 return false
internal/pluginhost/adapters_test.go+79−0
@@ -19,6 +19,7 @@ import ( · 18 unmodified lines
19 coreauth "github.com/router-for-me/CLIProxyAPI/v7/sdk/cliproxy/auth"19 coreauth "github.com/router-for-me/CLIProxyAPI/v7/sdk/cliproxy/auth"
20 coreexecutor "github.com/router-for-me/CLIProxyAPI/v7/sdk/cliproxy/executor"20 coreexecutor "github.com/router-for-me/CLIProxyAPI/v7/sdk/cliproxy/executor"
21 coreusage "github.com/router-for-me/CLIProxyAPI/v7/sdk/cliproxy/usage"21 coreusage "github.com/router-for-me/CLIProxyAPI/v7/sdk/cliproxy/usage"
22 "github.com/router-for-me/CLIProxyAPI/v7/sdk/pluginabi"
22 "github.com/router-for-me/CLIProxyAPI/v7/sdk/pluginapi"23 "github.com/router-for-me/CLIProxyAPI/v7/sdk/pluginapi"
23 sdktranslator "github.com/router-for-me/CLIProxyAPI/v7/sdk/translator"24 sdktranslator "github.com/router-for-me/CLIProxyAPI/v7/sdk/translator"
24)25)
@@ -1691,6 +1692,84 @@ func TestHasStreamInterceptorsReflectsActiveStreamInterceptors(t *testing.T) { · 1666 unmodified lines
1691 }1692 }
1692}1693}
1693 1694
1695func TestStreamChunkRequestBodyPolicyBySchemaVersion(t *testing.T) {
1696 var legacyGot, modernGot pluginapi.StreamChunkInterceptRequest
1697 host := newHostWithRecords(
1698 capabilityRecord{
1699 id: "legacy",
1700 plugin: pluginapi.Plugin{
1701 SchemaVersion: 2,
1702 Capabilities: pluginapi.Capabilities{
1703 StreamChunkInterceptor: responseInterceptorFunc{
1704 interceptStreamChunk: func(ctx context.Context, req pluginapi.StreamChunkInterceptRequest) (pluginapi.StreamChunkInterceptResponse, error) {
1705 legacyGot = req
1706 return pluginapi.StreamChunkInterceptResponse{Body: req.Body}, nil
1707 },
1708 },
1709 },
1710 },
1711 },
1712 capabilityRecord{
1713 id: "modern",
1714 plugin: pluginapi.Plugin{
1715 SchemaVersion: pluginabi.SchemaVersionStreamChunkOmitRequestBody,
1716 Capabilities: pluginapi.Capabilities{
1717 StreamChunkInterceptor: responseInterceptorFunc{
1718 interceptStreamChunk: func(ctx context.Context, req pluginapi.StreamChunkInterceptRequest) (pluginapi.StreamChunkInterceptResponse, error) {
1719 modernGot = req
1720 return pluginapi.StreamChunkInterceptResponse{Body: req.Body}, nil
1721 },
1722 },
1723 },
1724 },
1725 },
1726 )
1727 if !host.StreamChunkPayloadIncludesRequestBody() {
1728 t.Fatal("StreamChunkPayloadIncludesRequestBody() = false, want true when legacy stream interceptor is active")
1729 }
1730
1731 _ = host.InterceptStreamChunk(context.Background(), pluginapi.StreamChunkInterceptRequest{
1732 OriginalRequest: []byte("original"),
1733 RequestBody: []byte("request"),
1734 Body: []byte("chunk"),
1735 ChunkIndex: 0,
1736 })
1737 if string(legacyGot.OriginalRequest) != "original" || string(legacyGot.RequestBody) != "request" {
1738 t.Fatalf("legacy payload bodies = original:%q body:%q, want preserved", legacyGot.OriginalRequest, legacyGot.RequestBody)
1739 }
1740 if len(modernGot.OriginalRequest) != 0 || len(modernGot.RequestBody) != 0 {
1741 t.Fatalf("modern payload bodies = original:%q body:%q, want omitted", modernGot.OriginalRequest, modernGot.RequestBody)
1742 }
1743
1744 legacyGot = pluginapi.StreamChunkInterceptRequest{}
1745 modernGot = pluginapi.StreamChunkInterceptRequest{}
1746 _ = host.InterceptStreamChunk(context.Background(), pluginapi.StreamChunkInterceptRequest{
1747 OriginalRequest: []byte("original"),
1748 RequestBody: []byte("request"),
1749 ChunkIndex: pluginapi.StreamChunkHeaderInitIndex,
1750 })
1751 if string(legacyGot.OriginalRequest) != "original" || string(modernGot.OriginalRequest) != "original" {
1752 t.Fatalf("header-init bodies not preserved: legacy=%q modern=%q", legacyGot.OriginalRequest, modernGot.OriginalRequest)
1753 }
1754
1755 modernOnly := newHostWithRecords(capabilityRecord{
1756 id: "modern-only",
1757 plugin: pluginapi.Plugin{
1758 SchemaVersion: pluginabi.SchemaVersionStreamChunkOmitRequestBody,
1759 Capabilities: pluginapi.Capabilities{
1760 StreamChunkInterceptor: responseInterceptorFunc{
1761 interceptStreamChunk: func(ctx context.Context, req pluginapi.StreamChunkInterceptRequest) (pluginapi.StreamChunkInterceptResponse, error) {
1762 return pluginapi.StreamChunkInterceptResponse{}, nil
1763 },
1764 },
1765 },
1766 },
1767 })
1768 if modernOnly.StreamChunkPayloadIncludesRequestBody() {
1769 t.Fatal("StreamChunkPayloadIncludesRequestBody() = true, want false for schema v3+ only")
1770 }
1771}
1772
1694func TestHasRequestInterceptorsReflectsActiveRequestInterceptors(t *testing.T) {1773func TestHasRequestInterceptorsReflectsActiveRequestInterceptors(t *testing.T) {
1695 responseOnly := newHostWithRecords(capabilityRecord{1774 responseOnly := newHostWithRecords(capabilityRecord{
1696 id: "response",1775 id: "response",
internal/pluginhost/rpc_client.go+7−1
@@ -68,8 +68,14 @@ func registerRPCPlugin(ctx context.Context, host *Host, id string, client plugin · 67 unmodified lines
68 return pluginapi.Plugin{}, fmt.Errorf("plugin schema version %d is not supported", resp.SchemaVersion)68 return pluginapi.Plugin{}, fmt.Errorf("plugin schema version %d is not supported", resp.SchemaVersion)
69 }69 }
70 adapter := &rpcPluginAdapter{id: id, host: host, client: client}70 adapter := &rpcPluginAdapter{id: id, host: host, client: client}
71 schemaVersion := resp.SchemaVersion
72 if schemaVersion == 0 {
73 // Missing schema_version is treated as the original contract.
74 schemaVersion = 1
75 }
71 plugin := pluginapi.Plugin{76 plugin := pluginapi.Plugin{
72 Metadata: resp.Metadata,77 Metadata: resp.Metadata,
78 SchemaVersion: schemaVersion,
73 Capabilities: pluginapi.Capabilities{79 Capabilities: pluginapi.Capabilities{
74 FrontendAuthProviderExclusive: resp.Capabilities.FrontendAuthProvider && resp.Capabilities.FrontendAuthProviderExclusive,80 FrontendAuthProviderExclusive: resp.Capabilities.FrontendAuthProvider && resp.Capabilities.FrontendAuthProviderExclusive,
75 ExecutorModelScope: resp.Capabilities.ExecutorModelScope,81 ExecutorModelScope: resp.Capabilities.ExecutorModelScope,
internal/pluginhost/rpc_schema_test.go+8−1
@@ -108,12 +108,16 @@ func TestRegisterRPCPluginSendsHostSchemaVersion(t *testing.T) { · 107 unmodified lines
108 registerResult: validTestPlugin("schema"),108 registerResult: validTestPlugin("schema"),
109 })109 })
110 110
111 if _, errRegister := registerRPCPlugin(context.Background(), nil, "schema", lookup, pluginabi.MethodPluginRegister, []byte("mode: test")); errRegister != nil {111 registered, errRegister := registerRPCPlugin(context.Background(), nil, "schema", lookup, pluginabi.MethodPluginRegister, []byte("mode: test"))
112 if errRegister != nil {
112 t.Fatalf("registerRPCPlugin() error = %v", errRegister)113 t.Fatalf("registerRPCPlugin() error = %v", errRegister)
113 }114 }
114 if lookup.lastLifecycle.SchemaVersion != pluginabi.SchemaVersion {115 if lookup.lastLifecycle.SchemaVersion != pluginabi.SchemaVersion {
115 t.Fatalf("lifecycle schema_version = %d, want %d", lookup.lastLifecycle.SchemaVersion, pluginabi.SchemaVersion)116 t.Fatalf("lifecycle schema_version = %d, want %d", lookup.lastLifecycle.SchemaVersion, pluginabi.SchemaVersion)
116 }117 }
118 if registered.SchemaVersion != pluginabi.SchemaVersion {
119 t.Fatalf("registered SchemaVersion = %d, want %d", registered.SchemaVersion, pluginabi.SchemaVersion)
120 }
117 if string(lookup.lastLifecycle.ConfigYAML) != "mode: test" {121 if string(lookup.lastLifecycle.ConfigYAML) != "mode: test" {
118 t.Fatalf("lifecycle config = %q, want input config", lookup.lastLifecycle.ConfigYAML)122 t.Fatalf("lifecycle config = %q, want input config", lookup.lastLifecycle.ConfigYAML)
119 }123 }
@@ -146,6 +150,9 @@ func TestRegisterRPCPluginAcceptsModelRouterOnSchema1(t *testing.T) { · 26 unmodified lines
146 if registered.Capabilities.ModelRouter == nil {150 if registered.Capabilities.ModelRouter == nil {
147 t.Fatal("ModelRouter = nil, want adapter")151 t.Fatal("ModelRouter = nil, want adapter")
148 }152 }
153 if registered.SchemaVersion != 1 {
154 t.Fatalf("registered SchemaVersion = %d, want 1", registered.SchemaVersion)
155 }
149}156}
150 157
151func TestRPCModelRouteUsesAdapter(t *testing.T) {158func TestRPCModelRouteUsesAdapter(t *testing.T) {
sdk/api/handlers/handlers_interceptors.go+19−0
@@ -32,6 +32,25 @@ type streamInterceptorDetector interface { · 31 unmodified lines
32 HasStreamInterceptors() bool32 HasStreamInterceptors() bool
33}33}
34 34
35// streamChunkRequestBodyPolicy reports whether payload stream-chunk interceptors
36// still require OriginalRequest/RequestBody (legacy schema_version < 3).
37type streamChunkRequestBodyPolicy interface {
38 StreamChunkPayloadIncludesRequestBody() bool
39}
40
41// streamChunkPayloadIncludesRequestBody returns true when at least one active
42// stream interceptor needs per-chunk request bodies. Evaluated per call so
43// mid-stream plugin reloads stay correct. Unknown hosts default to true.
44func streamChunkPayloadIncludesRequestBody(host PluginInterceptorHost) bool {
45 if host == nil {
46 return false
47 }
48 if policy, ok := host.(streamChunkRequestBodyPolicy); ok {
49 return policy.StreamChunkPayloadIncludesRequestBody()
50 }
51 return true
52}
53
35type requestInterceptorDetector interface {54type requestInterceptorDetector interface {
36 HasRequestInterceptors() bool55 HasRequestInterceptors() bool
37}56}
sdk/api/handlers/handlers_interceptors_test.go+82−6
@@ -26,6 +26,8 @@ type handlerInterceptorTestHost struct { · 25 unmodified lines
26 interceptResponse func(context.Context, pluginapi.ResponseInterceptRequest) pluginapi.ResponseInterceptResponse26 interceptResponse func(context.Context, pluginapi.ResponseInterceptRequest) pluginapi.ResponseInterceptResponse
27 interceptStreamChunk func(context.Context, pluginapi.StreamChunkInterceptRequest) pluginapi.StreamChunkInterceptResponse27 interceptStreamChunk func(context.Context, pluginapi.StreamChunkInterceptRequest) pluginapi.StreamChunkInterceptResponse
28 completeRequest func(context.Context, pluginapi.RequestCompletion)28 completeRequest func(context.Context, pluginapi.RequestCompletion)
29 // includeStreamChunkRequestBodies simulates legacy schema_version < 3 plugins.
30 includeStreamChunkRequestBodies bool
29}31}
30 32
31type handlerInterceptorNoStreamTestHost struct {33type handlerInterceptorNoStreamTestHost struct {
@@ -82,6 +84,15 @@ func (h *handlerInterceptorTestHost) CompleteRequest(ctx context.Context, comple · 50 unmodified lines
82 }84 }
83}85}
84 86
87// StreamChunkPayloadIncludesRequestBody implements streamChunkRequestBodyPolicy.
88// Default false simulates schema_version >= 3 (omit request bodies on payload chunks).
89func (h *handlerInterceptorTestHost) StreamChunkPayloadIncludesRequestBody() bool {
90 if h == nil {
91 return false
92 }
93 return h.includeStreamChunkRequestBodies
94}
95
85type interceptorCaptureExecutor struct {96type interceptorCaptureExecutor struct {
86 provider string97 provider string
87 98
@@ -905,17 +916,23 @@ func TestHandlerStreamInterceptorRewritesAndDropsChunks(t *testing.T) { · 817 unmodified lines
905 if req.RequestHeaders.Get("X-Stage") != "after" {916 if req.RequestHeaders.Get("X-Stage") != "after" {
906 t.Fatalf("stream request headers = %#v, want after-auth header", req.RequestHeaders)917 t.Fatalf("stream request headers = %#v, want after-auth header", req.RequestHeaders)
907 }918 }
908 if string(req.OriginalRequest) != `{"stage":"after-stream"}` {
909 t.Fatalf("stream original request = %q, want after-auth body", req.OriginalRequest)
910 }
911 if string(req.RequestBody) != `{"stage":"after-stream"}` {
912 t.Fatalf("stream request body = %q, want after-auth body", req.RequestBody)
913 }
914 if req.ChunkIndex == pluginapi.StreamChunkHeaderInitIndex {919 if req.ChunkIndex == pluginapi.StreamChunkHeaderInitIndex {
920 if string(req.OriginalRequest) != `{"stage":"after-stream"}` {
921 t.Fatalf("stream original request = %q, want after-auth body", req.OriginalRequest)
922 }
923 if string(req.RequestBody) != `{"stage":"after-stream"}` {
924 t.Fatalf("stream request body = %q, want after-auth body", req.RequestBody)
925 }
915 headers := cloneHeader(req.ResponseHeaders)926 headers := cloneHeader(req.ResponseHeaders)
916 headers.Set("X-Stream", "plugin")927 headers.Set("X-Stream", "plugin")
917 return pluginapi.StreamChunkInterceptResponse{Headers: headers}928 return pluginapi.StreamChunkInterceptResponse{Headers: headers}
918 }929 }
930 if len(req.OriginalRequest) != 0 {
931 t.Fatalf("payload chunk OriginalRequest = %q, want omitted for schema v3+", req.OriginalRequest)
932 }
933 if len(req.RequestBody) != 0 {
934 t.Fatalf("payload chunk RequestBody = %q, want omitted for schema v3+", req.RequestBody)
935 }
919 if req.ResponseHeaders.Get("X-Upstream") != "stream" {936 if req.ResponseHeaders.Get("X-Upstream") != "stream" {
920 t.Fatalf("stream response headers = %#v, want upstream header", req.ResponseHeaders)937 t.Fatalf("stream response headers = %#v, want upstream header", req.ResponseHeaders)
921 }938 }
@@ -957,6 +974,65 @@ func TestHandlerStreamInterceptorRewritesAndDropsChunks(t *testing.T) { · 35 unmodified lines
957 }974 }
958}975}
959 976
977func TestHandlerStreamInterceptorLegacySchemaClonesRequestBodiesOnPayloadChunks(t *testing.T) {
978 model := "handler-interceptor-stream-legacy-clone-model"
979 executor := &interceptorCaptureExecutor{
980 stream: func(ctx context.Context, auth *coreauth.Auth, req coreexecutor.Request, opts coreexecutor.Options) (*coreexecutor.StreamResult, error) {
981 chunks := make(chan coreexecutor.StreamChunk, 2)
982 chunks <- coreexecutor.StreamChunk{Payload: []byte("first")}
983 chunks <- coreexecutor.StreamChunk{Payload: []byte("second")}
984 close(chunks)
985 return &coreexecutor.StreamResult{
986 Headers: http.Header{"X-Upstream": []string{"stream"}},
987 Chunks: chunks,
988 }, nil
989 },
990 }
991 handler := newInterceptorHandler(t, model, executor, &sdkconfig.SDKConfig{PassthroughHeaders: true})
992 var payloadBodies [][]byte
993 handler.SetPluginHost(&handlerInterceptorTestHost{
994 includeStreamChunkRequestBodies: true,
995 interceptRequestAfterAuth: func(ctx context.Context, req pluginapi.RequestInterceptRequest) pluginapi.RequestInterceptResponse {
996 return pluginapi.RequestInterceptResponse{Body: []byte(`{"stage":"legacy-stream"}`)}
997 },
998 interceptStreamChunk: func(ctx context.Context, req pluginapi.StreamChunkInterceptRequest) pluginapi.StreamChunkInterceptResponse {
999 if req.ChunkIndex == pluginapi.StreamChunkHeaderInitIndex {
1000 if string(req.OriginalRequest) != `{"stage":"legacy-stream"}` || string(req.RequestBody) != `{"stage":"legacy-stream"}` {
1001 t.Fatalf("header-init bodies = original:%q body:%q", req.OriginalRequest, req.RequestBody)
1002 }
1003 // Mutate delivered slices; later chunks must not observe this mutation.
1004 req.OriginalRequest[0] = 'X'
1005 req.RequestBody[0] = 'Y'
1006 return pluginapi.StreamChunkInterceptResponse{}
1007 }
1008 if string(req.OriginalRequest) != `{"stage":"legacy-stream"}` {
1009 t.Fatalf("payload OriginalRequest = %q, want isolated clone of after-auth body", req.OriginalRequest)
1010 }
1011 if string(req.RequestBody) != `{"stage":"legacy-stream"}` {
1012 t.Fatalf("payload RequestBody = %q, want isolated clone of after-auth body", req.RequestBody)
1013 }
1014 payloadBodies = append(payloadBodies, req.OriginalRequest)
1015 req.OriginalRequest[0] = 'Z'
1016 return pluginapi.StreamChunkInterceptResponse{Body: req.Body}
1017 },
1018 })
1019
1020 dataChan, _, errChan := handler.ExecuteStreamWithAuthManager(context.Background(), "openai", model, []byte(fmt.Sprintf(`{"model":%q}`, model)), "")
1021 for range dataChan {
1022 }
1023 for msg := range errChan {
1024 if msg != nil {
1025 t.Fatalf("unexpected stream error: %+v", msg)
1026 }
1027 }
1028 if len(payloadBodies) != 2 {
1029 t.Fatalf("payload body deliveries = %d, want 2", len(payloadBodies))
1030 }
1031 if &payloadBodies[0][0] == &payloadBodies[1][0] {
1032 t.Fatal("payload OriginalRequest slices alias across chunks; want fresh clones")
1033 }
1034}
1035
960func TestHandlerStreamInterceptorInitializesHeadersBeforeReturn(t *testing.T) {1036func TestHandlerStreamInterceptorInitializesHeadersBeforeReturn(t *testing.T) {
961 model := "handler-interceptor-stream-header-before-return-model"1037 model := "handler-interceptor-stream-header-before-return-model"
962 initStarted := make(chan struct{})1038 initStarted := make(chan struct{})
sdk/api/handlers/handlers_stream.go+45−18
@@ -81,19 +81,28 @@ func (h *BaseAPIHandler) streamWithPluginExecutor(ctx context.Context, entryProt · 80 unmodified lines
81 streamInterceptorsActive := streamInterceptorsEnabled(interceptorHost)81 streamInterceptorsActive := streamInterceptorsEnabled(interceptorHost)
82 rawStreamHeaders := cloneHeader(streamResult.Headers)82 rawStreamHeaders := cloneHeader(streamResult.Headers)
83 baseStreamHeaders := cloneHeader(streamResult.Headers)83 baseStreamHeaders := cloneHeader(streamResult.Headers)
84 // Request headers and request bodies are stream-invariant. Keep a private snapshot
85 // and clone into each interceptor call so plugins cannot mutate shared storage.
86 // Schema v3+ payload chunks omit these bodies (host also strips per plugin).
87 var streamRequestHeaders http.Header
88 var streamOriginalRequest []byte
89 var streamRequestBody []byte
84 applyStreamHeaders := func(headers http.Header) {90 applyStreamHeaders := func(headers http.Header) {
85 rawStreamHeaders = finalInterceptorHeaders(rawStreamHeaders, headers)91 rawStreamHeaders = finalInterceptorHeaders(rawStreamHeaders, headers)
86 }92 }
87 if streamInterceptorsActive {93 if streamInterceptorsActive {
94 streamRequestHeaders = cloneHeader(opts.Headers)
95 streamOriginalRequest = cloneBytes(opts.OriginalRequest)
96 streamRequestBody = cloneBytes(req.Payload)
88 intercepted := interceptStreamChunk(ctx, interceptorHost, pluginapi.StreamChunkInterceptRequest{97 intercepted := interceptStreamChunk(ctx, interceptorHost, pluginapi.StreamChunkInterceptRequest{
89 RequestID: lifecycle.requestID(),98 RequestID: lifecycle.requestID(),
90 SourceFormat: responseProtocol,99 SourceFormat: responseProtocol,
91 Model: modelName,100 Model: modelName,
92 RequestedModel: originalRequestedModel,101 RequestedModel: originalRequestedModel,
93 RequestHeaders: cloneHeader(opts.Headers),102 RequestHeaders: cloneHeader(streamRequestHeaders),
94 ResponseHeaders: cloneHeader(rawStreamHeaders),103 ResponseHeaders: cloneHeader(rawStreamHeaders),
95 OriginalRequest: cloneBytes(opts.OriginalRequest),104 OriginalRequest: cloneBytes(streamOriginalRequest),
96 RequestBody: cloneBytes(req.Payload),105 RequestBody: cloneBytes(streamRequestBody),
97 ChunkIndex: pluginapi.StreamChunkHeaderInitIndex,106 ChunkIndex: pluginapi.StreamChunkHeaderInitIndex,
98 Metadata: opts.Metadata,107 Metadata: opts.Metadata,
99 }, execOptions.SkipInterceptorPluginID)108 }, execOptions.SkipInterceptorPluginID)
@@ -161,20 +170,25 @@ func (h *BaseAPIHandler) streamWithPluginExecutor(ctx context.Context, entryProt · 61 unmodified lines
161 }170 }
162 payload := cloneBytes(chunk.Payload)171 payload := cloneBytes(chunk.Payload)
163 if streamInterceptorsActive {172 if streamInterceptorsActive {
164 intercepted := interceptStreamChunk(ctx, interceptorHost, pluginapi.StreamChunkInterceptRequest{173 chunkReq := pluginapi.StreamChunkInterceptRequest{
165 RequestID: lifecycle.requestID(),174 RequestID: lifecycle.requestID(),
166 SourceFormat: responseProtocol,175 SourceFormat: responseProtocol,
167 Model: modelName,176 Model: modelName,
168 RequestedModel: originalRequestedModel,177 RequestedModel: originalRequestedModel,
169 RequestHeaders: cloneHeader(opts.Headers),178 RequestHeaders: cloneHeader(streamRequestHeaders),
170 ResponseHeaders: cloneHeader(rawStreamHeaders),179 ResponseHeaders: cloneHeader(rawStreamHeaders),
171 OriginalRequest: cloneBytes(opts.OriginalRequest),
172 RequestBody: cloneBytes(req.Payload),
173 Body: payload,180 Body: payload,
174 HistoryChunks: cloneByteSlices(historyChunks),181 HistoryChunks: cloneByteSlices(historyChunks),
175 ChunkIndex: chunkIndex,182 ChunkIndex: chunkIndex,
176 Metadata: opts.Metadata,183 Metadata: opts.Metadata,
177 }, execOptions.SkipInterceptorPluginID)184 }
185 // Re-evaluate each chunk so mid-stream plugin reloads stay correct.
186 // Schema v3+ omits bodies here (one header-init clone only).
187 if streamChunkPayloadIncludesRequestBody(interceptorHost) {
188 chunkReq.OriginalRequest = cloneBytes(streamOriginalRequest)
189 chunkReq.RequestBody = cloneBytes(streamRequestBody)
190 }
191 intercepted := interceptStreamChunk(ctx, interceptorHost, chunkReq, execOptions.SkipInterceptorPluginID)
178 applyStreamHeaders(intercepted.Headers)192 applyStreamHeaders(intercepted.Headers)
179 if len(intercepted.Body) > 0 {193 if len(intercepted.Body) > 0 {
180 payload = cloneBytes(intercepted.Body)194 payload = cloneBytes(intercepted.Body)
@@ -323,6 +337,12 @@ func (h *BaseAPIHandler) executeStreamWithAuthManagerFormats(ctx context.Context · 142 unmodified lines
323 streamClosedBeforeRead := false337 streamClosedBeforeRead := false
324 streamCanceledBeforeRead := false338 streamCanceledBeforeRead := false
325 streamHeaderInitialized := false339 streamHeaderInitialized := false
340 // Request headers/bodies are stream-invariant after after-auth capture. Keep a private
341 // snapshot and clone into each interceptor call so plugins cannot mutate shared storage.
342 // Schema v3+ payload chunks omit these bodies (host also strips per plugin).
343 var streamRequestHeaders http.Header
344 var streamOriginalRequest []byte
345 var streamRequestBody []byte
326 346
327 applyStreamHeaders := func(headers http.Header) {347 applyStreamHeaders := func(headers http.Header) {
328 rawStreamHeaders = finalInterceptorHeaders(rawStreamHeaders, headers)348 rawStreamHeaders = finalInterceptorHeaders(rawStreamHeaders, headers)
@@ -333,15 +353,18 @@ func (h *BaseAPIHandler) executeStreamWithAuthManagerFormats(ctx context.Context · 4 unmodified lines
333 return353 return
334 }354 }
335 executedReq, executedOpts := executedRequest()355 executedReq, executedOpts := executedRequest()
356 streamRequestHeaders = cloneHeader(executedOpts.Headers)
357 streamOriginalRequest = cloneBytes(executedOpts.OriginalRequest)
358 streamRequestBody = cloneBytes(executedReq.Payload)
336 intercepted := interceptStreamChunk(ctx, interceptorHost, pluginapi.StreamChunkInterceptRequest{359 intercepted := interceptStreamChunk(ctx, interceptorHost, pluginapi.StreamChunkInterceptRequest{
337 RequestID: lifecycle.requestID(),360 RequestID: lifecycle.requestID(),
338 SourceFormat: responseProtocol,361 SourceFormat: responseProtocol,
339 Model: normalizedModel,362 Model: normalizedModel,
340 RequestedModel: originalRequestedModel,363 RequestedModel: originalRequestedModel,
341 RequestHeaders: cloneHeader(executedOpts.Headers),364 RequestHeaders: cloneHeader(streamRequestHeaders),
342 ResponseHeaders: cloneHeader(rawStreamHeaders),365 ResponseHeaders: cloneHeader(rawStreamHeaders),
343 OriginalRequest: cloneBytes(executedOpts.OriginalRequest),366 OriginalRequest: cloneBytes(streamOriginalRequest),
344 RequestBody: cloneBytes(executedReq.Payload),367 RequestBody: cloneBytes(streamRequestBody),
345 ChunkIndex: pluginapi.StreamChunkHeaderInitIndex,368 ChunkIndex: pluginapi.StreamChunkHeaderInitIndex,
346 Metadata: executedOpts.Metadata,369 Metadata: executedOpts.Metadata,
347 }, execOptions.SkipInterceptorPluginID)370 }, execOptions.SkipInterceptorPluginID)
@@ -353,21 +376,25 @@ func (h *BaseAPIHandler) executeStreamWithAuthManagerFormats(ctx context.Context · 5 unmodified lines
353 applyStreamHeaderInit()376 applyStreamHeaderInit()
354 payload = cloneBytes(payload)377 payload = cloneBytes(payload)
355 if streamInterceptorsActive {378 if streamInterceptorsActive {
356 executedReq, executedOpts := executedRequest()379 chunkReq := pluginapi.StreamChunkInterceptRequest{
357 intercepted := interceptStreamChunk(ctx, interceptorHost, pluginapi.StreamChunkInterceptRequest{
358 RequestID: lifecycle.requestID(),380 RequestID: lifecycle.requestID(),
359 SourceFormat: responseProtocol,381 SourceFormat: responseProtocol,
360 Model: normalizedModel,382 Model: normalizedModel,
361 RequestedModel: originalRequestedModel,383 RequestedModel: originalRequestedModel,
362 RequestHeaders: cloneHeader(executedOpts.Headers),384 RequestHeaders: cloneHeader(streamRequestHeaders),
363 ResponseHeaders: cloneHeader(rawStreamHeaders),385 ResponseHeaders: cloneHeader(rawStreamHeaders),
364 OriginalRequest: cloneBytes(executedOpts.OriginalRequest),
365 RequestBody: cloneBytes(executedReq.Payload),
366 Body: payload,386 Body: payload,
367 HistoryChunks: cloneByteSlices(historyChunks),387 HistoryChunks: cloneByteSlices(historyChunks),
368 ChunkIndex: *chunkIndex,388 ChunkIndex: *chunkIndex,
369 Metadata: executedOpts.Metadata,389 Metadata: opts.Metadata,
370 }, execOptions.SkipInterceptorPluginID)390 }
391 // Re-evaluate each chunk so mid-stream plugin reloads stay correct.
392 // Schema v3+ omits bodies here (one header-init clone only).
393 if streamChunkPayloadIncludesRequestBody(interceptorHost) {
394 chunkReq.OriginalRequest = cloneBytes(streamOriginalRequest)
395 chunkReq.RequestBody = cloneBytes(streamRequestBody)
396 }
397 intercepted := interceptStreamChunk(ctx, interceptorHost, chunkReq, execOptions.SkipInterceptorPluginID)
371 applyStreamHeaders(intercepted.Headers)398 applyStreamHeaders(intercepted.Headers)
372 if len(intercepted.Body) > 0 {399 if len(intercepted.Body) > 0 {
373 payload = cloneBytes(intercepted.Body)400 payload = cloneBytes(intercepted.Body)
sdk/pluginabi/types.go+7−1
@@ -7,7 +7,13 @@ const ( · 6 unmodified lines
7 ABIVersion uint32 = 17 ABIVersion uint32 = 1
8 // SchemaVersion tracks the RPC JSON contract exchanged at plugin.register.8 // SchemaVersion tracks the RPC JSON contract exchanged at plugin.register.
9 // Version 2 adds request lifecycle completion and active request termination.9 // Version 2 adds request lifecycle completion and active request termination.
10 SchemaVersion uint32 = 210 // Version 3 omits OriginalRequest/RequestBody on payload stream chunks
11 // (ChunkIndex >= 0); those fields remain on StreamChunkHeaderInitIndex only.
12 // Plugins that still need per-chunk request bodies should keep schema_version < 3.
13 SchemaVersion uint32 = 3
14 // SchemaVersionStreamChunkOmitRequestBody is the first schema version that omits
15 // request bodies on payload stream-chunk interceptor calls.
16 SchemaVersionStreamChunkOmitRequestBody uint32 = 3
11)17)
12 18
13const (19const (
sdk/pluginabi/types_test.go+5−2
@@ -27,8 +27,11 @@ func TestEnvelopeRoundTrip(t *testing.T) { · 26 unmodified lines
27}27}
28 28
29func TestMethodNamesAreStable(t *testing.T) {29func TestMethodNamesAreStable(t *testing.T) {
30 if SchemaVersion != 2 {30 if SchemaVersion != 3 {
31 t.Fatalf("SchemaVersion = %d, want 2", SchemaVersion)31 t.Fatalf("SchemaVersion = %d, want 3", SchemaVersion)
32 }
33 if SchemaVersionStreamChunkOmitRequestBody != 3 {
34 t.Fatalf("SchemaVersionStreamChunkOmitRequestBody = %d, want 3", SchemaVersionStreamChunkOmitRequestBody)
32 }35 }
33 if MethodPluginRegister != "plugin.register" {36 if MethodPluginRegister != "plugin.register" {
34 t.Fatalf("MethodPluginRegister = %q", MethodPluginRegister)37 t.Fatalf("MethodPluginRegister = %q", MethodPluginRegister)
sdk/pluginapi/types.go+13−2
@@ -15,6 +15,9 @@ type Plugin struct { · 14 unmodified lines
15 Metadata Metadata15 Metadata Metadata
16 // Capabilities declares the optional integration points implemented by the plugin.16 // Capabilities declares the optional integration points implemented by the plugin.
17 Capabilities Capabilities17 Capabilities Capabilities
18 // SchemaVersion is the plugin contract version negotiated at registration.
19 // Zero means unset (treated as legacy by the host).
20 SchemaVersion uint32
18}21}
19 22
20// Metadata describes a plugin for registry, logging, and diagnostics.23// Metadata describes a plugin for registry, logging, and diagnostics.
@@ -1087,9 +1090,17 @@ type StreamChunkInterceptRequest struct { · 1066 unmodified lines
1087 RequestedModel string1090 RequestedModel string
1088 RequestHeaders http.Header1091 RequestHeaders http.Header
1089 ResponseHeaders http.Header1092 ResponseHeaders http.Header
1093 // OriginalRequest contains the raw client request body.
1094 // Always populated on header-init (ChunkIndex == StreamChunkHeaderInitIndex), as a fresh clone.
1095 // On payload chunks (ChunkIndex >= 0):
1096 // - schema_version >= 3: omitted (nil); cache from header-init or request intercept hooks
1097 // - schema_version < 3: populated as a fresh clone each call (legacy compatibility)
1098 // Callers must treat this slice as read-only; hosts clone before delivery to keep snapshots isolated.
1090 OriginalRequest []byte1099 OriginalRequest []byte
1091 RequestBody []byte1100 // RequestBody contains the provider/executed request payload.
1092 Body []byte1101 // Same population / cloning / schema-version rules as OriginalRequest.
1102 RequestBody []byte
1103 Body []byte
1093 // HistoryChunks contains a bounded recent history of chunks already delivered downstream.1104 // HistoryChunks contains a bounded recent history of chunks already delivered downstream.
1094 // The host currently retains at most 64 chunks and 1 MiB total history bytes.1105 // The host currently retains at most 64 chunks and 1 MiB total history bytes.
1095 HistoryChunks [][]byte1106 HistoryChunks [][]byte

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t