2.4: ng: support path_prefix at router level (#4423) #4549
Merged
Conversation
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
Summary:
Generated with `git restore -s origin/master .travis.yml .github/ ci/`,
plus the following manual changes:
- removed the `build-data-server-pip` CI job, since 2.4 doesn’t have
any Rust packages to build;
- reinstated `flake8` for Python 3.5;
- removed CI check for absence of `"@npm_angular_bazel//:index.bzl"`;
- downgraded CI Bazel to 2.1.0 to match WORKSPACE file;
- cherry-picked `test_pip_package.sh` changes for `--tf-version notf`.
Test Plan:
CI test run passed:
<https://github.com/tensorflow/tensorboard/runs/1699068256>
wchargin-branch: ci-backport-2.4
wchargin-source: a6833768fb4e5c516f426d5c32b4044063fcfefc
Problem: TensorBoard has a flag, path_prefix, which serves frontend and the data endpoints at your specified, if the flag is passed, pathname. While exact use case slips my mind, it is certainly used by dependents. Now, the problem is that new Angular based TensorBoard has a custom router for in-app navigation (we may add new routes for experiment list and others) it is unaware of the path prefix. Router works by matching set of predefined routes to current pathname and finds a match. However, the configuration is unaware (rightfully) of the path prefix and it results in zero match, which in turn cause navigation to the default path, "/". This totally breaks the assumption of the path prefix as all the request from the frontend will be sent to "/data/..." as opposed to "[path_prefix]/data/..." Remediation: Previously, there was no reason to propagate the prefix information to the frontend. Application only did hash changes and never required a navigation. With this change, we now: - server side render `<meta>` tag that depicts the relative path to the root of the application. - bootstrap Angular app from the relative root path and uses that information for matching routes and navigation
stephanwlee
approved these changes
Jan 14, 2021
Contributor
stephanwlee
left a comment
stephanwlee
left a comment
There was a problem hiding this comment.
You write beautiful code :P
Contributor
Author
|
And so fast, too! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Backport of #4423 to 2.4. Cf. #4547.
Problem:
TensorBoard has a flag, path_prefix, which serves frontend and the data
endpoints at your specified, if the flag is passed, pathname. While
exact use case slips my mind, it is certainly used by dependents. Now,
the problem is that new Angular based TensorBoard has a custom router
for in-app navigation (we may add new routes for experiment list and
others) it is unaware of the path prefix.
Router works by matching set of predefined routes to current pathname
and finds a match. However, the configuration is unaware (rightfully) of
the path prefix and it results in zero match, which in turn cause
navigation to the default path, "/". This totally breaks the assumption
of the path prefix as all the request from the frontend will be sent to
"/data/..." as opposed to "[path_prefix]/data/..."
Remediation:
Previously, there was no reason to propagate the prefix information to
the frontend. Application only did hash changes and never required a
navigation. With this change, we now:
application
for matching routes and navigation
Tests:
Co-authored-by: Stephan Lee stephanwlee@gmail.com