Better handling of URLs without trailing slash #24
Conversation
This file contains 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
|
I'll fix the tests. |
The current logic assumes that all URLs will end in a slash and thus generate report JSON files that look like URL_-TIMESTAMP.report.json. URLs that don't have a slash don't include that underscore, which breaks the create-report-index script (as reported on issue 22). This commit modifies the report core so that a URL's trailing slash is included in its report URL. This will impact live URLs, meaning that instead of pages like https://cfpb.github.io/cfgov-lighthouse/www_consumerfinance_gov-_about_us_blog/ we'll have URLs like https://cfpb.github.io/cfgov-lighthouse/www_consumerfinance_gov-_about_us_blog_/ (note the added trailing slash). This is probably more correct to account for hypothetical cases where you have two URLs that differ depending on the trailing slash.
chosak
force-pushed
the
fix/trailing-slash
branch
from
fd3cc18
to
7f54732
Compare
anselmbradford
approved these changes
Jan 5, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The current logic assumes that all URLs will end in a slash and thus generate report JSON files that look like
URL_-TIMESTAMP.report.json. URLs that don't have a slash don't include that underscore, which breaks the create-report-index script (as reported on #22).This commit modifies the report cord so that a URL's trailing slash is included in its report URL. This will impact live URLs, meaning that instead of pages like
https://cfpb.github.io/cfgov-lighthouse/www_consumerfinance_gov-_about_us_blog/
we'll have URLs like
https://cfpb.github.io/cfgov-lighthouse/www_consumerfinance_gov-_about_us_blog_/
(note the added trailing underscore).
This is probably more correct to account for hypothetical cases where you have two URLs that differ depending on the trailing slash.
I've also deleted report HTML files that will be renamed due to this change; I wonder if we should add a step that cleans the output HTML directory as part of the build to avoid having to do this?