[Asset Manager] Creates baseline public asset client for use in public plugins #167191

jasonrhodes · 2023-09-25T19:15:46Z

Summary

Adds a public asset client available in the setup lifecycle hook for plugins that depend on this one. getHosts is the only method available on this client for now.

TODO, before merge:

Add docs for the server client
Add docs for the public client
Remove REST docs from plugin docs, not needed
Add unit tests for public client

Testing this PR

One way of testing this new client is to apply the attached test-assets.patch file locally, adjust the date range in the getHosts query that is added in the infra plugin, and then start Kibana and navigate to the infra app. You should see print out in the browser console.

test-assets.patch

apmmachine · 2023-09-25T19:16:04Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

/oblt-deploy : Deploy a Kibana instance using the Observability test environments.
/oblt-deploy-serverless : Deploy a serverless Kibana instance using the Observability test environments.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

jbudz

limits.yml

klacabane · 2023-09-27T11:14:38Z

x-pack/plugins/asset_manager/docs/development.md

+The "enabled" tests are NOT run by CI yet, to prevent blocking Kibana development for a
+test failure in this alpha, tech preview plugin. They will be moved into the right place
+to make them run for CI before the plugin is enabled by default. To run them manually:
+
+```shell
+$ node scripts/functional_tests_server --config x-pack/test/api_integration/apis/asset_manager/config.ts
+$ node scripts/functional_test_runner --config=x-pack/test/api_integration/apis/asset_manager/config.ts


The original config.ts test was split in two configurations, one for testing apis with assets source and the other for signals. Currently the signals test suite is enabled

Oh ok good call out, I'll take a look and maybe adjust slightly in my next PR

x-pack/plugins/asset_manager/public/lib/public_assets_client.test.ts

klacabane · 2023-09-27T11:45:42Z

x-pack/plugins/asset_manager/docs/api.md

+any Kibana plugin without any dependency restrictions. To gain access to the asset data,
+this component or tool can require the appropriate asset client to be passed in.
+
+TODO: need to move main client types to a package so that they can be depended on by


can the packages import types from assetmanager plugin instead ?

Should packages import from plugins? That sounds wrong, but maybe it's allowed for types only? Not sure it's a good idea...

packages already do that (eg kbn-data-service, alert_details..) but I don't know if that's recommended

Ok, I'll try to poke around and think on that a bit.

klacabane

LGTM

packages/kbn-optimizer/limits.yml

jasonrhodes · 2023-09-27T17:01:59Z

This recently merged PR is going to cause conflicts for this PR -- I'll fix.

…fix'

…ocs'

…fix'

x-pack/plugins/asset_manager/public/plugin.ts

neptunian · 2023-09-28T14:43:33Z

I think there is an issue with public access to the config. I can't seem to enable the public plugin because my config isn't being read.

legrego

Change to test/plugin_functional/test_suites/core_plugins/rendering.ts LGTM

jrodewig · 2023-09-28T19:44:50Z

@kibanamachine run elasticsearch-ci/docs

jasonrhodes · 2023-09-28T19:53:04Z

@kibanamachine run elasticsearch-ci/docs

kibana-ci · 2023-09-28T20:26:25Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 97c88db

Failed CI Steps

FTR Configs #36

Test Failures

[job] [logs] FTR Configs #36 / serverless security UI Case View page "before all" hook for "should show the case view page correctly"

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`assetManager`	-	6	+6

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
`assetManager`	2	9	+7

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`assetManager`	0	2	+2

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`assetManager`	-	2.2KB	+2.2KB

Unknown metric groups

API count

id	before	after	diff
`assetManager`	2	9	+7

History

💔 Build #163680 failed e402d28
💔 Build #163645 failed 167f69c
💔 Build #163547 failed c1efc0a
💚 Build #163116 succeeded a56171a
💔 Build #162642 failed 759b999670e8ddc588b8f97e101818ee93882727

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

jasonrhodes force-pushed the create-asset-client branch from 6dd1ac9 to 64602d7 Compare September 25, 2023 19:22

jasonrhodes marked this pull request as ready for review September 26, 2023 14:51

jasonrhodes requested a review from a team as a code owner September 26, 2023 14:51

jasonrhodes requested a review from a team as a code owner September 26, 2023 16:13

jbudz approved these changes Sep 26, 2023

View reviewed changes

klacabane reviewed Sep 27, 2023

View reviewed changes

x-pack/plugins/asset_manager/public/lib/public_assets_client.test.ts Outdated Show resolved Hide resolved

klacabane reviewed Sep 27, 2023

View reviewed changes

x-pack/plugins/asset_manager/public/lib/public_assets_client.test.ts Outdated Show resolved Hide resolved

klacabane reviewed Sep 27, 2023

View reviewed changes

klacabane approved these changes Sep 27, 2023

View reviewed changes

neptunian reviewed Sep 27, 2023

View reviewed changes

packages/kbn-optimizer/limits.yml Show resolved Hide resolved

jasonrhodes and others added 14 commits September 27, 2023 13:52

Renamed AssetAccessor to AssetClient, fixed type bugs

15dfb34

Renamed file asset_accessor -> asset_client

364c3cb

Abstracts types to prepare for public browser client

63bdcee

Clarifying elasticsearch and saved objects clients

0eac9df

Baseline public assets client ready, with getHosts

1826319

Exports instantiated client from plugin, not class

9e07450

Moves REST route paths to common for sharing with client

bf2aa2c

Adds unit tests for getHosts client method

25a82d3

Restructures docs for plugin

28c71aa

Fixes linting issues

919fbad

Updates tsconfig to add public directory

4769d5e

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

f0f3b49

…fix'

[CI] Auto-commit changed files from 'node scripts/build_plugin_list_d…

ff1c0ef

…ocs'

More linting and type checking updates

fc0efe8

jasonrhodes and others added 4 commits September 27, 2023 13:52

Adding asset manager to size limit file

9766ec7

Adds docs and includes fixes found by adding docs :)

32d2173

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

735f394

…fix'

Fixes type errors after moving type to new file

2738219

jasonrhodes force-pushed the create-asset-client branch from 759b999 to 2738219 Compare September 27, 2023 17:52

Merge branch 'main' into create-asset-client

a56171a

neptunian reviewed Sep 27, 2023

View reviewed changes

x-pack/plugins/asset_manager/public/plugin.ts Show resolved Hide resolved

Updates tests based on review feedback

8da985d

jasonrhodes added 4 commits September 28, 2023 10:54

Merging in upstream/main and fixes conflicts with metrics data client PR

c1efc0a

Fixes public config for asset manager plugin

f1fc25e

Changes asset manager public logs to debug level

167f69c

Fixes TS error after merge

e402d28

jasonrhodes enabled auto-merge (squash) September 28, 2023 18:46

neptunian approved these changes Sep 28, 2023

View reviewed changes

Fixes exposeToBrowser test to add newly-exposed alphaEnabled config

97c88db

jasonrhodes requested a review from a team as a code owner September 28, 2023 19:24

legrego approved these changes Sep 28, 2023

View reviewed changes

jasonrhodes merged commit 859ae9e into elastic:main Sep 28, 2023

kibanamachine added v8.11.0 backport:skip This commit does not require backporting labels Sep 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Asset Manager] Creates baseline public asset client for use in public plugins #167191

[Asset Manager] Creates baseline public asset client for use in public plugins #167191

jasonrhodes commented Sep 25, 2023 •

edited

Loading

apmmachine commented Sep 25, 2023

jbudz left a comment

klacabane Sep 27, 2023

jasonrhodes Sep 27, 2023

klacabane Sep 27, 2023

jasonrhodes Sep 27, 2023

klacabane Sep 27, 2023

jasonrhodes Sep 27, 2023

klacabane left a comment

jasonrhodes commented Sep 27, 2023

neptunian commented Sep 28, 2023

legrego left a comment

jrodewig commented Sep 28, 2023

jasonrhodes commented Sep 28, 2023

kibana-ci commented Sep 28, 2023

API count

[Asset Manager] Creates baseline public asset client for use in public plugins #167191

[Asset Manager] Creates baseline public asset client for use in public plugins #167191

Conversation

jasonrhodes commented Sep 25, 2023 • edited Loading

Summary

Testing this PR

apmmachine commented Sep 25, 2023

🤖 GitHub comments

jbudz left a comment

Choose a reason for hiding this comment

klacabane Sep 27, 2023

Choose a reason for hiding this comment

jasonrhodes Sep 27, 2023

Choose a reason for hiding this comment

klacabane Sep 27, 2023

Choose a reason for hiding this comment

jasonrhodes Sep 27, 2023

Choose a reason for hiding this comment

klacabane Sep 27, 2023

Choose a reason for hiding this comment

jasonrhodes Sep 27, 2023

Choose a reason for hiding this comment

klacabane left a comment

Choose a reason for hiding this comment

jasonrhodes commented Sep 27, 2023

neptunian commented Sep 28, 2023

legrego left a comment

Choose a reason for hiding this comment

jrodewig commented Sep 28, 2023

jasonrhodes commented Sep 28, 2023

kibana-ci commented Sep 28, 2023

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Public APIs missing comments

Public APIs missing exports

Page load bundle

API count

History

jasonrhodes commented Sep 25, 2023 •

edited

Loading