-
Notifications
You must be signed in to change notification settings - Fork 413
fix(web): make root->dev-ui redirect reverse-proxy-prefix-aware #1463
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
luissilva-mollie
wants to merge
1
commit into
google:main
Choose a base branch
from
luissilva-mollie:fix/redirect-prefix-aware
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+79
−4
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
72 changes: 72 additions & 0 deletions
72
dev/src/test/java/com/google/adk/web/AdkWebServerReverseProxyTest.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /* | ||
| * Copyright 2025 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.adk.web; | ||
|
|
||
| import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; | ||
| import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.redirectedUrl; | ||
| import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.redirectedUrlPattern; | ||
| import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.boot.test.context.SpringBootTest; | ||
| import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc; | ||
| import org.springframework.test.web.servlet.MockMvc; | ||
|
|
||
| /** | ||
| * Verifies that the root ("/") -> "dev-ui" redirect (see {@link AdkWebServer#addViewControllers}) | ||
| * is reverse-proxy-prefix-aware once Spring's ForwardedHeaderFilter is enabled via {@code | ||
| * server.forward-headers-strategy=framework}. | ||
| * | ||
| * <p>This is a regression test for the redirect target being context-relative ("dev-ui") rather | ||
| * than root-relative ("/dev-ui"): only a context-relative sendRedirect() target is passed through | ||
| * {@link org.springframework.util.StringUtils#applyRelativePath}, which is what makes {@code | ||
| * ForwardedHeaderFilter} splice an {@code X-Forwarded-Prefix} header's value back into the redirect | ||
| * Location. A root-relative target bypasses that codepath entirely and would leave this test's | ||
| * "with X-Forwarded-Prefix" case failing. | ||
| * | ||
| * <p>Uses a dedicated test class (rather than adding to {@link AdkWebServerUITest}) because {@code | ||
| * server.forward-headers-strategy} is a server-wide property, kept separate here so enabling it | ||
| * doesn't affect the default context {@link AdkWebServerUITest} runs against. | ||
| */ | ||
| @SpringBootTest(properties = "server.forward-headers-strategy=framework") | ||
| @AutoConfigureMockMvc | ||
| public class AdkWebServerReverseProxyTest { | ||
|
|
||
| @Autowired private MockMvc mockMvc; | ||
|
|
||
| /** | ||
| * With no Forwarded/X-Forwarded-* headers on the request, Spring's ForwardedHeaderFilter doesn't | ||
| * wrap the response at all (verified by running this test), so behavior matches the property | ||
| * being off entirely: the redirect is the raw, unresolved "dev-ui" string. | ||
| */ | ||
| @Test | ||
| public void rootRedirect_withoutForwardedHeaders_isUnchanged() throws Exception { | ||
| mockMvc | ||
| .perform(get("/")) | ||
| .andExpect(status().is3xxRedirection()) | ||
| .andExpect(redirectedUrl("dev-ui")); | ||
| } | ||
|
|
||
| @Test | ||
| public void rootRedirect_withForwardedPrefixHeader_restoresPathPrefix() throws Exception { | ||
| mockMvc | ||
| .perform(get("/").header("X-Forwarded-Prefix", "/my-app-prefix")) | ||
| .andExpect(status().is3xxRedirection()) | ||
| .andExpect(redirectedUrlPattern("http://*/my-app-prefix/dev-ui")); | ||
| } | ||
| } | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice — writing an actual reverse-proxy test is the right instinct, and it's what led me to check this on a real container.
Problem: this test passes on unpatched main. So it isn't currently guarding the fix.
I ran the real dev server (embedded Tomcat, not MockMvc) behind a real prefix-stripping proxy that sets
X-Forwarded-Prefix/-Host/-Proto, on both trees. Location the browser receives:Identical in both configurations. With the strategy on,
ForwardedHeaderFilteralready rewrites the root-relative target. With it off, both forms lose the prefix equally — a context-relative target can't recover a prefix the container never saw, because after the proxy strips it the request URI is just/.That also contradicts the javadoc above: "A root-relative target bypasses that codepath entirely and would leave this test's 'with X-Forwarded-Prefix' case failing." On main, that case passes — so as written the javadoc documents Spring behaviour that doesn't hold. Worth correcting or dropping whatever happens to the redirect change itself, since it'd otherwise stay in the tree as guidance.
So the edit looks like a no-op for the proxied case in both configurations. It'd help to know what the failing deployment actually runs — but whichever it is, this doesn't look like the thing that fixes it. Happy to be shown a setup where it does; if you have one, that's the test worth adding here.