nsuke opened a new pull request, #43297:
URL: https://github.com/apache/spark/pull/43297
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines:
https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR:
https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g.,
'[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a
faster review.
7. If you want to add a new configuration, please read the guideline first
for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the
guideline first in
'core/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section
is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster
reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class
hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other
DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
This makes redirect behavior for spark.ui.proxyBase more similar to other
hyperlinks in the UI and also adds an option to use path without host for HTTP
redirects in UI for more transparent proxy handling. The motivation is to make
it possible to host Spark UIs behind proxies where proxy hostname is not known
at the time of Spark app configuration.
##### prefix spark.ui.proxyBase to HTTP redirects
`createRedirectHandler` now prepends `spark.ui.proxyBase` in addition to
basePath that is in line with `prependBaseUri` used across other hyperlinks.
Previously this was only done if `spark.ui.redirectWithoutHost` is set. After
this change, proxies that rewrites redirect Location header hosts such as Envoy
work out-of-the-box without needing to set `spark.ui.proxyRedirectUri`.
##### spark.ui.redirectWithoutHost option
When enabled, Spark Web UI uses URI reference without scheme and host (e.g.,
"/jobs" instead of "https://example.org/jobs";). This makes it possible to
handle proxies transparently even those which do not intelligently rewrite
Location header.
The hostname in redirect was originally required in RFC 2616 in 1999, but
after RFC 7231 in 2014, it can be formally omitted as most browsers already
supported it (it is rather hard to find any browser that doesn't support it).
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
Currently, proxies can be made transparent for hyperlinks in Spark web UIs
with spark.ui.proxyRoot or X-Forwarded-Context header. However, HTTP redirects
(such as job/stage kill) currently requires explicit spark.ui.proxyRedirectUri
for handling proxy. This is not ideal as proxy hostname may not be known at the
time configuring Spark apps.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as
the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes
- provide the console output, description and/or an example to show the
behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to
the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
HTTP redirect paths (such as job/stage kill links -> `/jobs/`) will be
prefixed with `spark.ui.proxyRoot` system property (or X-Forwarded-Context
header) in addition to basePath if not empty. I cannot think of any use-case
that would be broken by this behavior, because since the other hyperlinks are
already prepending proxy path, it is extremely unlikely that users rely only on
the job/stage/app kill link behaviors that expose non-proxy host and path on
redirect.
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some
test cases that check the changes thoroughly including negative and positive
cases if possible.
If it was tested in a way different from regular unit tests, please clarify
how you tested step by step, ideally copy and paste-able, so that other
reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why
it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions
for the consistent environment, and the instructions could accord to:
https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
Added unit-tests.
### Was this patch authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this
patch, please include the
phrase: 'Generated-by: ' followed by the name of the tool and its version.
If no, write 'No'.
Please refer to the [ASF Generative Tooling
Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
-->
No
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
