E2E testing: Use JSON serialization for getAllBlocks #31199
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
david-szabo97
added
[Tool] E2E Test Utils
|
Size Change: -4 B (0%) Total Size: 1.39 MB
ℹ️ View Unchanged
|
david-szabo97
changed the title
|
The PR is scoped down to only affect I wonder what others think, should we add this to |
david-szabo97
requested review from
vindl,
jeyip,
mattwiebe,
Addison-Stavlo,
Copons,
creativecoder and
gziolo
I'd agree with your intuition here. I only see
I can also imagine others running into the same problem in the future, so I'd vote for making the change to |
jeyip
approved these changes
Apr 26, 2021
|
|
I think we can restrict this to We should not forget that both are public APIs and are used outside of GB as well. Since there are no created issues for either of them, IMO it's okay to land the only needed change for |
That makes sense 👍 . In that case, could we leave more explicit documentation somewhere? It seems easy to overlook the fact that |
Agreed! We can do this in a follow up. I'll merge this though now, as is needed for #30804 Thanks for all the work here! |
7 tasks
7 tasks
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.
Description
page.evaluateused inwpDataSelect, returnsundefinedwhen we return a non-serializable value from the evaluation. Non-serializable values arefunction,DOM elementetc.Reference:
https://pptr.dev/#?product=Puppeteer&version=v9.0.0&show=api-pageevaluatepagefunction-args
For a real world example, we store
validationIssuesin theblock-editorstore for each block. When we have a validation issue, we store the ref and owner (DOM element handles). Those are non-serializable so the evaluation returns withundefined. Which is causing the tests to fail.As a fix, we turn the result into a JSON string, then we parse it. JSON replaces all unserializable values with
null, so the evaluation can return safely.Reference:
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
This PR ensures we are returning an object that is serializable by Puppeteer.
How has this been tested?
Tests are passing
Types of changes
E2E tests consistency
Checklist:
*.native.jsfiles for terms that need renaming or removal).