fix(v2): linking to asset or external html page -> don't use history.push() #3347
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.
Motivation
We should be able to use the existing webpack file-loaders when linking to assets in the static folder, and we should be able to link using the @site webpack alias.
We should only navigate to a markdown link using
history.push()
if that link is a known SPA route. We should not "navigate" to a pdf file (#3337), or an external HTML file that is not part of the SPA (#3309)In the future, maybe the Link component should be able to know if a path like
/javadoc
is internal or external by matching it to known routes, but I don't think it's ideal either because it has a runtime cost, and it would also opt-out of broken link detection, as unknown routes would be considered as external and bypass this check.The
pathname://
protocol is an escape hatch that permits to tell Link that a link is expected to be considered as external. It is more explicit.Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Unit tests
Dogfooding on a dedicated page: