Skip to content

[8.15] [Screenshotting] Server package for stateless code (#188390)#193231

Merged
tsullivan merged 3 commits intoelastic:8.15from
tsullivan:backport/8.15/pr-188390
Sep 18, 2024
Merged

[8.15] [Screenshotting] Server package for stateless code (#188390)#193231
tsullivan merged 3 commits intoelastic:8.15from
tsullivan:backport/8.15/pr-188390

Conversation

@tsullivan
Copy link
Copy Markdown
Member

Backport

This will backport the following commits from main to 8.15:

Questions ?

Please refer to the Backport tool documentation

## Summary

This PR moves code that is usually impacted by a Puppeteer/Chromium
upgrade to a package. The same work is happening to a lesser degree in
the 7.17 branch. Together, these changes will ease the manual labor of
backporting the upgrades from main to 7.17.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit bf673d9)

# Conflicts:
#	.github/CODEOWNERS
@tsullivan tsullivan added the backport This PR is a backport of another PR label Sep 17, 2024
@tsullivan tsullivan enabled auto-merge (squash) September 17, 2024 23:29
eokoneyo and others added 2 commits September 18, 2024 08:14
## Summary

This PR is a follow up to the work that's been done to make it
relatively straight forward to backport puppeteer updates to the 7.17
branch in elastic#188390.

This change ensures the archive path for chromium doesn't get installed
outside of the kibana directory, the previous expression resulted in an
archive path outside of the kibana directory which unfortunately could
result in a resolution of a path that kibana has no permissions to write
to, depending on where kibana is being executed from.

## How to test
 
- Pull this PR and delete the `.chromium` directory, for whatever
platform this PR is is been tested on we should get no errors about
installing the chromium and we should see the appropriate chromium
archive for the os platform available in the `.chromium` that would get
created.


<!--

### 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)
-->
@kibana-ci
Copy link
Copy Markdown

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
@kbn/screenshotting-server - 34 +34
Unknown metric groups

API count

id before after diff
@kbn/screenshotting-server - 35 +35

History

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

@tsullivan tsullivan requested a review from eokoneyo September 18, 2024 19:13
Copy link
Copy Markdown
Contributor

@eokoneyo eokoneyo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally!! Works as it should

@tsullivan tsullivan merged commit 5a522bf into elastic:8.15 Sep 18, 2024
@tsullivan tsullivan deleted the backport/8.15/pr-188390 branch September 18, 2024 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport This PR is a backport of another PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants