Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[7.17] [Reporting] update puppeteer to version 23.3.1 (#192345) #193396

Merged
merged 1 commit into from
Sep 20, 2024

Conversation

eokoneyo
Copy link
Contributor

Backport

This will backport the following commits from main to 7.17:

Questions ?

Please refer to the Backport tool documentation

\r\n\r\n\r\n### How to verify linux headless build\r\n- clone the following repo\r\nhttps://github.com/tsullivan/kibana-dev-docker\r\n- pull this particular PR\r\n- follow the steps outlined in the repo, replacing any occurrence of\r\n`kibana--SNAPSHOT-linux-aarch64.tar.gz` from the repo above's\r\nstep with the output of running build on this changeset.\r\n- before running step 4, modify the `kibana.yml` file from the\r\n`kibana-dev-docker` repo and include the following so we might be able\r\nto verify the version of chromium running;\r\n ```yaml\r\n logging.loggers:\r\n - name: plugins.reporting\r\n level: debug\r\n ```\r\n- complete the steps outlined in the README, you'll have a linux distro\r\nof kibana running on port `5601`\r\n- Attempt creating exports of PDF and PNG reports, in dashboard, canvas,\r\nand visualizations, on report creation attempt we would see a log output\r\nthat prints out the chromium version exactly matching this;\r\n\r\n

\"Screenshot

\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine ","sha":"91ca8ab95c01f88ea2d79779f3670c88bf269da0","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:SharedUX","backport:prev-major","v8.16.0","backport:version","v8.15.2"],"number":192345,"url":"https://github.com//pull/192345","mergeCommit":{"message":"[Reporting] update puppeteer to version 23.3.1 (#192345)\n\n## Summary\r\n\r\nUpdate for puppeteer, the following changeset updates puppeteer to\r\nversion `23.3.1`.\r\n\r\nThe chromium version required for this version of puppeteer is\r\n`128.0.6613.137` from revision `1331488`, as such the chromium binary\r\nincluded for windows and darwin platforms either match or were the\r\nclosest revision to the expectation. The linux headless binary was built\r\nfrom commit `fe621c5aa2d6b987e964fb1b5066833da5fb613d` of the same\r\nrevision.\r\n\r\n_**N.B.**_ Puppeteer 23.0.0 is earmarked as containing breaking changes\r\nsee\r\n[here](https://github.com/puppeteer/puppeteer/blob/abda5dcc9912f4fa2c5a566403108db783f48538/packages/puppeteer-core/CHANGELOG.md#2300-2024-08-07),\r\nthis PR considers the outlined changes and makes relevant adjustments so\r\nreporting continues working as is.\r\n\r\n\r\n\r\n\r\n### How to verify linux headless build\r\n- clone the following repo\r\nhttps://github.com/tsullivan/kibana-dev-docker\r\n- pull this particular PR\r\n- follow the steps outlined in the repo, replacing any occurrence of\r\n`kibana--SNAPSHOT-linux-aarch64.tar.gz` from the repo above's\r\nstep with the output of running build on this changeset.\r\n- before running step 4, modify the `kibana.yml` file from the\r\n`kibana-dev-docker` repo and include the following so we might be able\r\nto verify the version of chromium running;\r\n ```yaml\r\n logging.loggers:\r\n - name: plugins.reporting\r\n level: debug\r\n ```\r\n- complete the steps outlined in the README, you'll have a linux distro\r\nof kibana running on port `5601`\r\n- Attempt creating exports of PDF and PNG reports, in dashboard, canvas,\r\nand visualizations, on report creation attempt we would see a log output\r\nthat prints out the chromium version exactly matching this;\r\n\r\n

\"Screenshot

\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine ","sha":"91ca8ab95c01f88ea2d79779f3670c88bf269da0"}},"sourceBranch":"main","suggestedTargetBranches":["8.15"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com//pull/192345","number":192345,"mergeCommit":{"message":"[Reporting] update puppeteer to version 23.3.1 (#192345)\n\n## Summary\r\n\r\nUpdate for puppeteer, the following changeset updates puppeteer to\r\nversion `23.3.1`.\r\n\r\nThe chromium version required for this version of puppeteer is\r\n`128.0.6613.137` from revision `1331488`, as such the chromium binary\r\nincluded for windows and darwin platforms either match or were the\r\nclosest revision to the expectation. The linux headless binary was built\r\nfrom commit `fe621c5aa2d6b987e964fb1b5066833da5fb613d` of the same\r\nrevision.\r\n\r\n_**N.B.**_ Puppeteer 23.0.0 is earmarked as containing breaking changes\r\nsee\r\n[here](https://github.com/puppeteer/puppeteer/blob/abda5dcc9912f4fa2c5a566403108db783f48538/packages/puppeteer-core/CHANGELOG.md#2300-2024-08-07),\r\nthis PR considers the outlined changes and makes relevant adjustments so\r\nreporting continues working as is.\r\n\r\n\r\n\r\n\r\n### How to verify linux headless build\r\n- clone the following repo\r\nhttps://github.com/tsullivan/kibana-dev-docker\r\n- pull this particular PR\r\n- follow the steps outlined in the repo, replacing any occurrence of\r\n`kibana--SNAPSHOT-linux-aarch64.tar.gz` from the repo above's\r\nstep with the output of running build on this changeset.\r\n- before running step 4, modify the `kibana.yml` file from the\r\n`kibana-dev-docker` repo and include the following so we might be able\r\nto verify the version of chromium running;\r\n ```yaml\r\n logging.loggers:\r\n - name: plugins.reporting\r\n level: debug\r\n ```\r\n- complete the steps outlined in the README, you'll have a linux distro\r\nof kibana running on port `5601`\r\n- Attempt creating exports of PDF and PNG reports, in dashboard, canvas,\r\nand visualizations, on report creation attempt we would see a log output\r\nthat prints out the chromium version exactly matching this;\r\n\r\n

\"Screenshot

\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine ","sha":"91ca8ab95c01f88ea2d79779f3670c88bf269da0"}},{"branch":"8.x","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":false,"url":"https://github.com//pull/193357","number":193357,"state":"OPEN"},{"branch":"8.15","label":"v8.15.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->

## Summary

Update for puppeteer, the following changeset updates puppeteer to
version `23.3.1`.

The chromium version required for this version of puppeteer is
`128.0.6613.137` from revision `1331488`, as such the chromium binary
included for windows and darwin platforms either match or were the
closest revision to the expectation. The linux headless binary was built
from commit `fe621c5aa2d6b987e964fb1b5066833da5fb613d` of the same
revision.

_**N.B.**_ Puppeteer 23.0.0 is earmarked as containing breaking changes
see
[here](https://github.com/puppeteer/puppeteer/blob/abda5dcc9912f4fa2c5a566403108db783f48538/packages/puppeteer-core/CHANGELOG.md#2300-2024-08-07),
this PR considers the outlined changes and makes relevant adjustments so
reporting continues working as is.

<!--
### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |

### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
-->

### How to verify linux headless build
- clone the following repo
https://github.com/tsullivan/kibana-dev-docker
- pull this particular PR
- follow the steps outlined in the repo, replacing any occurrence of
`kibana-<version>-SNAPSHOT-linux-aarch64.tar.gz` from the repo above's
step with the output of running build on this changeset.
- before running step 4, modify the `kibana.yml` file from the
`kibana-dev-docker` repo and include the following so we might be able
to verify the version of chromium running;
   ```yaml
     logging.loggers:
       - name: plugins.reporting
         level: debug
   ```
- complete the steps outlined in the README, you'll have a linux distro
of kibana running on port `5601`
- Attempt creating exports of PDF and PNG reports, in dashboard, canvas,
and visualizations, on report creation attempt we would see a log output
that prints out the chromium version exactly matching this;

<img width="1326" alt="Screenshot 2024-09-18 at 14 50 19"
src="https://github.com/user-attachments/assets/7206781a-e8f9-469c-ad65-fd13749766b2">

---------

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>
(cherry picked from commit 91ca8ab)

# Conflicts:
#	package.json
#	x-pack/plugins/screenshotting/server/browsers/chromium/driver.ts
#	x-pack/plugins/screenshotting/server/browsers/chromium/driver_factory/index.ts
#	yarn.lock
@eokoneyo eokoneyo force-pushed the backport/7.17/pr-192345 branch from e2c0a67 to 453eebe Compare September 19, 2024 09:19
@eokoneyo eokoneyo enabled auto-merge (squash) September 19, 2024 09:34
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

  • 💔 Build #235483 failed e2c0a67abf17b9d66ca078bcc382e3beb27d77c2

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@eokoneyo eokoneyo requested a review from tsullivan September 20, 2024 09:49
@eokoneyo eokoneyo merged commit ed788cd into elastic:7.17 Sep 20, 2024
28 checks passed
@eokoneyo eokoneyo deleted the backport/7.17/pr-192345 branch September 20, 2024 23:36
@eokoneyo eokoneyo self-assigned this Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants