Browser 20.4.0

Most important enhancements

Several small issues found while auditing the docs against the code (#5135)

This issue covers several fixes:

Security

• Storage keywords built JavaScript by string interpolation. The six local/session storage keywords embedded the key straight into the expression evaluated in the page, so a key containing " did not merely break the syntax, it executed: x"), (window.pwned = 42), window.localStorage.getItem("y runs that assignment. The three sites using repr() instead had a quieter failure — for any non-printable code point above U+FFFF, repr() emits \U000e0001, which JavaScript reads as an identity escape, so the page silently addressed a different key. All six now use json.dumps.
• Get Credential wrote the WebAuthn private key to playwright-log.txt. The Node side logged the whole credential object, and that log is written under default configuration. The Python side already wraps the key material in Secret() to keep it out of the RF log; the Node line defeated that. It logs the id only.

Bugs

• JavaScript extension keywords always required an open browser. getActiveBrowser() throws when nothing is open, so the optional chaining guarding it never ran — including for a keyword whose only argument is playwright. atest/.../funky.js's createRemoteBrowser is exactly that shape, and only passes today because an earlier test leaves a browser open. The browser is now resolved only when the keyword asks for page, context or browser.
• Add Locator Handler Custom emptied the spec it was given. It popped keys out of the caller's dictionary, so a &{dict} variable could be used once; the second call failed with Action must be defined in the handler specification, and the variable stayed broken for the rest of the suite. Listing the same dictionary twice in one call failed the same way. It works on a copy now.
• Merge Coverage Reports discarded name= when config_file= was also given. ⚠️ The one change that can alter a passing suite — see below.

Documentation

• Emulate Media was annotated -> None but returns a dict, and RF drops a None return type from the spec entirely, so the keyword reference said it returned nothing. Get Page Errors was annotated -> dict but returns a list. Both now declare what they return; no runtime change.
• getElement and findLocator still documented the element= selector syntax, removed in 17.0.0. Comments only.

One behavior change

Merge Coverage Reports now honours an explicit name when a config_file is also supplied. Previously the name was overwritten with the default report title, so name= worked without a config file and was silently ignored with one — contradicting the function's own merge order, where keyword arguments override the config file for every other option.

Raise minimum needed Robot Framework version to 7.1.1 (#5133)

To be able to ease the work needed for making Python support easier, it was decided to drop support for Robot Framework 6.1.x. This also allowed us to clean some internal conversion logic and architecture of the library better. I understand if someone sees this a backwards incompatible change, but the 6.1.1 was released 28. July 2023, which is over three years ago. If you have not been able to update your Robot Framework version, you can still use the older version of Browser library, but we strongly encourage you to update.

Set Presenter Mode silently fall back to defaults, when invalid dict given (#5143)

The keyword Set Presenter Mode and the init arg enable_presenter_mode just silently ignored everything that is not 100% correct.

Any Strings were just True and therefore 100% default. Any actual dict, must be correct, otherwise it failed.

*** Test Cases ***All following calls will end up in full default config.  Set Presenter Mode    {"color": "red"}   #does not have all keys, therefore full defaults  Set Presenter Mode    {"duration": "5 seconds", "width": "6px", "style": "dotted", "color": "red"    #missing closing {  Set Presenter Mode    What ever you put in here, except of an invalid dict.    #will also be a string... and therefore Truthy

The documentation however was talking about default which did actually only exist in case of a Truthy non-dict given.

Keywords called from Python convert plain values, like they do in Robot Framework (#5145)

The Browser library keyword have been part of the public API for the start, but using keyword that example takes Enums or timedelta are unnecessary hard from Python side. But they are excellent when used Robot Framework test data, because Robot Framework does automatic conversion and IDE have good support for Enum types. So all that makes the usage great from Robot Framework side, makes it harder from Python side. With this change when keyword methods are called from Python, we now accept string, like the usage from Robot Framework side. Example

browser.click("//button", "middle")                    # was: MouseButton.middlebrowser.click_with_options("//button", delay="1.5s")   # was: timedelta(seconds=1.5)browser.get_text("h1", "==", "Login Page")             # was: AssertionOperator["=="]

Full list of fixes and enhancements

Altogether 15 issues. View on the issue tracker.