Mitigate risk of panic on parse of remote object during console.log #1129
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
ankur22
force-pushed
the
fix/panic-parse-remote-obj
branch
5 times, most recently
from
0073ba8
to
2b03672
Compare
ankur22
changed the title
ankur22
commented
Dec 11, 2023
These new functions are to be used when parsing the console message which is being printed by the website under test when it used console.log. Since these are string values that will be parsed and reprinted to stdout, we don't necessarily need to parse a json string into a go object (which is the main motivation for this change). This will avoid situations where k6 browser panics and causes the test run to end due to not being able to parse a json string. Other areas of the implementation (e.g. toJSON or eval) still require a go representation of the object and they will work with the existing parse functions.
Since a string is already a string, we don't need to marshal it back to a string. This will be used when working with console messages which are printed by the website under test.
Work with parseConsoleRemoteObject so that the browser module avoids trying to unmarshal objects from json to a go object. This doesn't feel like a worthwhile operation since the string will be printed to stdout.
Work with parseConsoleRemoteObject and strings rather than any types. The page.on API works with strings so there's no need to try to parse a json object to a go object and then back to a js object.
ankur22
force-pushed
the
fix/panic-parse-remote-obj
branch
from
2b03672
to
53d4730
Compare
ankur22
commented
Dec 11, 2023
ankur22
force-pushed
the
fix/panic-parse-remote-obj
branch
from
53d4730
to
2b028d3
Compare
inancgumus
previously approved these changes
Dec 13, 2023
Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>
This log is notifying the user of something that can't be changed or actioned on, so it's better represented as info rather than a warn.
ka3de
reviewed
Dec 14, 2023
This is just to clarify why these empty cases are there.
It's no longer being used.
ankur22
force-pushed
the
fix/panic-parse-remote-obj
branch
3 times, most recently
from
df89ca4
to
dbb0981
Compare
This particular test may run slower on other machines, so accounting for that scenario -- specifically in the CI.
ankur22
force-pushed
the
fix/panic-parse-remote-obj
branch
from
dbb0981
to
1a76aec
Compare
inancgumus
approved these changes
Dec 14, 2023
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.
What?
This change reduces the risk of a panic occurring when the website under test uses
console.logto print logs.Why?
Currently there is an unknown case where a panic can occur when an object from console.log is unmarshaled and fails with an invalid JSON error. So this isn't fixing the issue but mitigating the risk. This is done by not needing to parse the console.log text at all. The reason behind this choice is that when a user prints something to the console, they don't tend to need the object to be parsed.
Other areas of the module still rely on the existing parse logic which does still attempt to unmarshal the object which is returned when working with APIs such as
JSONValueandEval.Checklist
Related PR(s)/Issue(s)
Updates: #987