Update waiting condition for full page screenshots #362
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
ArturWierzbicki
approved these changes
Aug 17, 2022
| (isFullPage) => { | ||
| if (isFullPage) { | ||
| const panelCount = document.querySelectorAll('[data-panelId]').length; | ||
| const totalPanelsRendered = document.querySelectorAll('.panel-content').length + document.querySelectorAll('.dashboard-row').length; |
There was a problem hiding this comment.
its probably worth adding a comment what .panel-content refers to (ie. when exactly does a component with panel-content class show up), and why do we add the .dashboard-row
| return page.waitForFunction( | ||
| () => { | ||
| (isFullPage) => { | ||
| if (isFullPage) { |
There was a problem hiding this comment.
should we add a comment explaining why full page screenshots require a different waiting logic?
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 condition that we are using for individual panels isn't working for full page screenshots.
panelsRenderedvalue is increased every time a panel is rendered. But a panel could be renderer several times when scrolling. For example, when a panel is partially visible increasespanelsRendered, and when scroll, it increases this value again.So
(window as any).panelsRendered >= panelCountcould be success even if we have any panel loading data. If we have a slow query, the result could be a screenshot with a loading panel, when we are expecting to see data.The condition for full pages is the following:
[data-panelId]as total panels of the dashboard (rendered or not). It includes rows and panels..dashboard-rowreturns the number of rows..panel-contentreturns the value of RENDERED panels excluding rows (rows don't have this class).So the condition is going to wait to all panels to render OR reach the timeout.