fix(v2): refactor routes.ts + add route hash for chunkNames key #3001
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
slorber
added
pr: bug fix
|
Deploy preview for docusaurus-2 ready! Built with commit 9beb8c9 |
slorber
commented
Jun 26, 2020
| // Important: the layout component should not end with /, | ||
| // as it conflicts with the home doc | ||
| // Workaround fix for https://github.com/facebook/docusaurus/issues/2917 | ||
| const docsPath = docsBaseRoute === '/' ? '' : docsBaseRoute; |
There was a problem hiding this comment.
feature permits to remove that temporary hack that's not needed anymore
slorber
commented
Jun 26, 2020
| @@ -21,7 +24,8 @@ function ComponentCreator(path: string): ReturnType<typeof Loadable> { | |||
| }); | |||
| } | |||
|
|
|||
| const chunkNames = routesChunkNames[path]; | |||
| const chunkNamesKey = `${path}-${hash}`; | |||
There was a problem hiding this comment.
I prefered reconstructing the chunkNamesKey with the same logic on client because chunkNamesKey already contains the path so this would look more messy if user inspects .docusaurus folder, and would also take more place
slorber
commented
Jun 26, 2020
| routesPaths.push(routePath); | ||
| } | ||
|
|
||
| function genRouteChunkNames( |
There was a problem hiding this comment.
fn extracted, not really modified
slorber
commented
Jun 26, 2020
| : '' | ||
| }}`; | ||
| return str; | ||
| }; |
There was a problem hiding this comment.
trying to encapsulate all string codegen here
slorber
commented
Jun 26, 2020
| : '' | ||
| } | ||
| `, | ||
| ), |
There was a problem hiding this comment.
warning I put recently, can be removed now because conflits are unlikely to happen
|
ready to review |
yangshun
approved these changes
Jun 30, 2020
| @@ -187,3 +157,44 @@ export default [ | |||
| routesPaths, | |||
| }; | |||
| } | |||
|
|
|||
| function genRouteChunkNames( | |||
| // TODO instead of passing a mutating the registre, return a registry slice? | |||
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.
Motivation
See #2917
Fix potential weird merge behavior when a parent route and its child has the exact same path.
To avoid potential conflicts, smallHash(route) is added at the end of the chunknames key.
Also refactors the routes.ts file by splitting a bit the logic and trying to make it more readable than before (inline code generation strings do not help for readability)
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
tests + preview