v0.47.0 release notes for browser

[ankur22]

What?

This adds the changes to the v1.1.0 tagged browser module to the release notes. It doesn't add the changes for cookies and page.on since they are being added by two other PRs.

Why?

We need to update our users of what changes we have made to the browser module.

Checklist

• I have performed a self-review of my code.
• I have added tests for my changes. (NA)
• I have run linter locally (make ci-like-lint) and all checks pass.
• I have run tests locally (make tests) and all tests pass. (NA)
• I have commented on my code, particularly in hard-to-understand areas. (NA)

Related PR(s)/Issue(s)

Related: #3353 & #3352.

[codebien]

@ankur22 the branch for release notes is https://github.com/grafana/k6/tree/release-notes-v0.47.0. You have to use it as the base branch.

[codecov-commenter]

Codecov Report

All modified lines are covered by tests ✅

❗ No coverage uploaded for pull request base (release-notes-v0.47.0@9f812a3). Click here to learn what that means.

❗ Current head 821f4f9 differs from pull request most recent head b761f40. Consider uploading reports for the commit b761f40 to get more accurate results

Additional details and impacted files

@@                   Coverage Diff                    @@
##             release-notes-v0.47.0    #3356   +/-   ##
========================================================
  Coverage                         ?   72.95%           
========================================================
  Files                            ?      261           
  Lines                            ?    20018           
  Branches                         ?        0           
========================================================
  Hits                             ?    14604           
  Misses                           ?     4487           
  Partials                         ?      927           

Flag	Coverage Δ
ubuntu	72.89% <0.00%> (?)
windows	72.80% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[inancgumus]

LGTM 👍 Thanks for helping me 🙇 Some small suggestions.

Are we missing #1010: Fix FrameSession.executionContextForID and #1009: Add Page.executionContextForID?

[ankur22]

Are we missing grafana/xk6-browser#1010 and grafana/xk6-browser#1009?

@inancgumus I was waiting for a response on this comment. Added it now in 6b447e1. Good spot though! 😄

[inancgumus]

By the way, we need reverse this syntax as it doesn't look like a link:

Allows users to register a handler to be executed every time the console API methods are called from within the page's JavaScript context. The arguments passed into the handler are defined by the (ConsoleMessage)[https://k6.io/docs/javascript-api/k6-experimental/browser/consolemessage/] class.

Into:

...[ConsoleMessage](https://k6.io/docs/javascript-api/k6-experimental/browser/consolemessage/) class.

Do you think we should also add an example here? @ka3de WDYT?

[ka3de]

By the way, we need reverse this syntax as it doesn't look like a link:

This was fixed already in release-notes-v0.47.0. So a rebase should fix it here too 🙂

Do you think we should also add an example here? @ka3de WDYT?

We should have discussed that in its own PR 😄 We can add it here, but for me the release notes is a small announcement on what is new, just a small introduction, adding examples to every feature/change might make it too long. If we still want to add an example, would this make sense to you?

    page.on('console', msg => {
      check(msg, {
          'assertConsoleMessageType': msg => msg.type() == 'log',
          'assertConsoleMessageText': msg => msg.text() == 'this is a console.log message 42',
          'assertConsoleMessageArgs0': msg => msg.args()[0].jsonValue() == 'this is a console.log message',
          'assertConsoleMessageArgs1': msg => msg.args()[1].jsonValue() == 42,
      });
  });

  page.evaluate(() => console.log('this is a console.log message', 42));

BTW should we d try to add comments associated to source code changes, so we can resolve the conversations and they do not pollute so much the PR ☹️ ?