Refactor how we calculate section and link counts #1103
Merged
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
This commit moves the logic of determining how many sections and links are on a given page to a new module, which has more granular functions to extract all the necessary bits from a page to make a decision. This refactoring aims at making it clearer what the steps are. Ideally, each rendering application would set these counts in a meta tag and this code would only read from it, but it's a bit more complicated than that, especially for JS-driven finders.
|
|
||
| PageContent.getNumberOfLinks = function () { | ||
| switch(true) { | ||
| case isNavigationGridPage(): |
There was a problem hiding this comment.
Is there any reason for this specific order that might not be obvious to the next person to touch this?
There was a problem hiding this comment.
Good question. Before, the order was important because of document collections. They are both navigation pages and content pages, so the return statement needed a specific order. But with this switch statement, we look for navigation pages first (and they are findable in a deterministic way now since alphagov/whitehall#3358), and default to a content page at the bottom. That means we don't rely on ordering anymore.
whoojemaflip
approved these changes
Jul 28, 2017
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.
This commit moves the logic of determining how many sections and links
are on a given page to a new module, which has more granular functions
to extract all the necessary bits from a page to make a decision.
This refactoring aims at making it clearer what the steps are. Ideally,
each rendering application would set these counts in a meta tag and this
code would only read from it, but it's a bit more complicated than that,
especially for JS-driven finders.
What do you think?