feat: add knob to customise on{Request,Response}Headers StopIteration behavior#434
Merged
mpwarres merged 7 commits intoproxy-wasm:mainfrom Jul 13, 2025
Merged
Conversation
leonm1
approved these changes
Jul 11, 2025
Signed-off-by: Michael Warres <mpw@google.com>
mpwarres
force-pushed
the
request-headers-stop-iteration
branch
from
3ec2095 to
02239af
Compare
It was testing the same case twice. Signed-off-by: Michael Warres <mpw@google.com>
martijneken
requested changes
Jul 12, 2025
Contributor
martijneken
left a comment
martijneken
left a comment
There was a problem hiding this comment.
LGTM but please fix the option name
Rename option to allow_on_headers_stop_iteration and test onResponseHeaders behavior as well. Signed-off-by: Michael Warres <mpw@google.com>
Contributor
Author
Thanks for catching that--done. |
mpwarres
changed the title
Signed-off-by: Michael Warres <mpw@google.com>
Signed-off-by: Michael Warres <mpw@google.com>
Previously, the test was creating a new wasm_handle and plugin_handle for each request, which led to the WasmHandleBase destructor calling wasm_base_->startShutdown() mid-test. Apparently V8 tolerates this, but WAMR (correctly) does not. Signed-off-by: Michael Warres <mpw@google.com>
phlax
pushed a commit
to envoyproxy/envoy
that referenced
this pull request
Jul 15, 2025
Add PluginConfig.allow_on_headers_stop_iteration config field to control the behavior of WasmFilter when plugin onRequestHeaders and onResponseHeaders callbacks return a value of FilterHeadersStatus::StopIteration. If allow_on_headers_stop_iteration is false (the default), then in cases where a Wasm plugin onRequestHeaders or onResponseHeaders callback returns FilterHeadersStatus::StopIteration, WasmFilter will maintain its current behavior of translating that response code to FilterHeadersStatus::StopAllIterationAndWatermark. If allow_on_headers_stop_iteration is true, then WasmFilter will avoid any translation of FilterHeadersStatus::StopIteration, and will pass it through to HCM unmodified, which allows Wasm plugins to inspect request or response body data before deciding how to handle/transform request or response headers. For details, see [Envoy Wasm / Proxy-Wasm support for FilterHeadersStatus::StopIteration](https://docs.google.com/document/d/1Whd1C0k-H2NHrPOmlAqqauFz6ObSTP017juJIYyciB0/edit?usp=sharing). This PR implements [Option B: WasmFilter config knob](https://docs.google.com/document/d/1Whd1C0k-H2NHrPOmlAqqauFz6ObSTP017juJIYyciB0/edit?tab=t.0#bookmark=id.5wxldlapsp54), building on proxy-wasm/proxy-wasm-cpp-host#434. Note that this config knob is a stopgap until upcoming v0.3.0 of the Proxy-Wasm ABI adds more comprehensive support for StopIteration and body buffering, per proxy-wasm/spec#63. Additional Description: This change updates the proxy-wasm-cpp-host dependency since it depends on proxy-wasm/proxy-wasm-cpp-host#434, which was recently merged there. Signed-off-by: Michael Warres <mpw@google.com>
update-envoy Bot
added a commit
to envoyproxy/data-plane-api
that referenced
this pull request
Jul 15, 2025
Add PluginConfig.allow_on_headers_stop_iteration config field to control the behavior of WasmFilter when plugin onRequestHeaders and onResponseHeaders callbacks return a value of FilterHeadersStatus::StopIteration. If allow_on_headers_stop_iteration is false (the default), then in cases where a Wasm plugin onRequestHeaders or onResponseHeaders callback returns FilterHeadersStatus::StopIteration, WasmFilter will maintain its current behavior of translating that response code to FilterHeadersStatus::StopAllIterationAndWatermark. If allow_on_headers_stop_iteration is true, then WasmFilter will avoid any translation of FilterHeadersStatus::StopIteration, and will pass it through to HCM unmodified, which allows Wasm plugins to inspect request or response body data before deciding how to handle/transform request or response headers. For details, see [Envoy Wasm / Proxy-Wasm support for FilterHeadersStatus::StopIteration](https://docs.google.com/document/d/1Whd1C0k-H2NHrPOmlAqqauFz6ObSTP017juJIYyciB0/edit?usp=sharing). This PR implements [Option B: WasmFilter config knob](https://docs.google.com/document/d/1Whd1C0k-H2NHrPOmlAqqauFz6ObSTP017juJIYyciB0/edit?tab=t.0#bookmark=id.5wxldlapsp54), building on proxy-wasm/proxy-wasm-cpp-host#434. Note that this config knob is a stopgap until upcoming v0.3.0 of the Proxy-Wasm ABI adds more comprehensive support for StopIteration and body buffering, per proxy-wasm/spec#63. Additional Description: This change updates the proxy-wasm-cpp-host dependency since it depends on proxy-wasm/proxy-wasm-cpp-host#434, which was recently merged there. Signed-off-by: Michael Warres <mpw@google.com> Mirrored from https://github.com/envoyproxy/envoy @ 274d68f02971c1cf0da1628991126e8ebd307d25
Jing-ze
added a commit
to Jing-ze/proxy-wasm-cpp-host
that referenced
this pull request
Jan 23, 2026
… behavior (proxy-wasm#434) Add protected ContextBase::allow_on_headers_stop_iteration_ field that can be used by host implementations to control whether or not ContextBase propagates FilterHeaderStatus::StopIteration returned by onRequestHeaders() or onResponseHeaders() without modification. Follow-on envoyproxy/envoy#40213 adds an option in Envoy WasmFilter PluginConfig that sets the value of this field. For details, see [Envoy Wasm / Proxy-Wasm support for FilterHeadersStatus::StopIteration](https://docs.google.com/document/d/1Whd1C0k-H2NHrPOmlAqqauFz6ObSTP017juJIYyciB0/edit?usp=sharing). This PR is one part of implementing [Option B: WasmFilter config knob](https://docs.google.com/document/d/1Whd1C0k-H2NHrPOmlAqqauFz6ObSTP017juJIYyciB0/edit?tab=t.0#bookmark=id.5wxldlapsp54). Note that default behavior of proxy-wasm-cpp-host and ContextBase is unchanged. --------- Change-Id: I3dfe6cb850ec8e28ff69c0e07474affa4f80005c Co-developed-by: Cursor <noreply@cursor.com> Signed-off-by: Michael Warres <mpw@google.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add protected ContextBase::allow_on_headers_stop_iteration_ field that can be used by host implementations to control whether or not ContextBase propagates FilterHeaderStatus::StopIteration returned by onRequestHeaders() or onResponseHeaders() without modification.
Follow-on envoyproxy/envoy#40213 adds an option in Envoy WasmFilter PluginConfig that sets the value of this field.
For details, see Envoy Wasm / Proxy-Wasm support for FilterHeadersStatus::StopIteration. This PR is one part of implementing Option B: WasmFilter config knob.
Note that default behavior of proxy-wasm-cpp-host and ContextBase is unchanged.