[Streams] Dashboard linking #204309

dgieselaar · 2024-12-14T09:07:07Z

Links dashboard to Streams.

Changes:

Introduces IndexStorageAdapter to manage ES indices - see https://github.com/dgieselaar/kibana/blob/streams-app-asset-linking/x-pack/solutions/observability/packages/utils_server/es/storage/README.md for motivation
Introduces AssetClient and AssetService to manage asset links with IndexStorageAdapter
RepositorySupertestClient to make it easier to use @kbn/server-route-repository with FTR tests
refactors related to above changes

… fork conditions

…ocs'

…fix'

…into init-streams-plugin

…fix'

…eams-app-plugin

simianhacker

Found an issue when you delete a linked Dashboard (from the Dashboard plugin) then reload the stream. When a dashboard is "missing" or "not found" the SavedObject interface returns an error object.

From a code style / organization perspective... All the dashboard routes are in the same file where all the other APIs each individual route is in a separate file. I don't care which way we go but I think we should try to maintain consistency.

simianhacker · 2025-01-06T19:07:24Z

x-pack/solutions/observability/plugins/streams/server/lib/streams/assets/asset_client.ts

+
+              return idsByType.dashboard.flatMap((dashboardId): Asset[] => {
+                const dashboard = dashboardsById[dashboardId];
+                if (dashboard) {


Suggested change

if (dashboard) {

if (dashboard && dashboard.error == null) {

When I delete the dashboard Saved Object, dashboard will become:

{ id: 'ca635bdd-5f15-44a0-93d1-d4edbe24d98e', type: 'dashboard', error: { statusCode: 404, error: 'Not Found', message: 'Saved object [dashboard/ca635bdd-5f15-44a0-93d1-d4edbe24d98e] not found' } }

thanks for catching! will add an API test for this as well

simianhacker · 2025-01-06T19:52:25Z

x-pack/solutions/observability/plugins/streams_app/public/hooks/use_dashboards_fetch.ts

+import { useStreamsAppFetch } from './use_streams_app_fetch';
+
+export const useDashboardsFetch = (id?: string) => {
+  const { signal } = useAbortController();


Is there a reason to use signal from const { signal } = useAbortController() vs useStreamsAppFetch((signal) => ...)?

I assume it's not intentional, it's mostly something Joe wrote. I'll change and confirm with him

…et-linking

dgieselaar · 2025-01-07T08:33:21Z

@simianhacker re:

From a code style / organization perspective... All the dashboard routes are in the same file where all the other APIs each individual route is in a separate file. I don't care which way we go but I think we should try to maintain consistency.

should have elaborated - I use {folder}/route.ts because that allows us to configure an ESLint rule to require explicit return types for the route handlers. The reason for that is that a route repository is a very heavy type, as it contains all the routes. if there's types in there that need to be inferred (from e.g. the handler function body), TypeScript ends up re-evaluating a lot of this code anything changes in the routes, which hurts TS responsiveness (a lot). So ideally we should use route.ts (and enable the linting rule:

kibana/.eslintrc.js

Line 1002 in ca5a08d

files: ['x-pack/solutions/observability/plugins/apm/server/**/route.ts'],

. Are you OK with that as a follow-up? I'll also add docs in @kbn/server-route-repository.

miltonhultgren · 2025-01-07T10:21:09Z

x-pack/solutions/observability/packages/utils_server/es/storage/README.md

+    storageSettings
+  );
+
+  // get the client (which is shared across all adapters)


(which is shared across all adapters)

What does this mean?

its interface, will update the comment

simianhacker

Thanks for fixing the dashboard deletion bug.

…et-linking

## Summary So that it can be used from `streams_app` (o11y). See #204309 Steps to relocate: 1. Fetch latest `main` 2. Update the `group` and/or `visibility` in the module's manifest. 3. Run `node scripts/relocate --moveOnly @kbn/saved-objects-tagging-plugin`

…et-linking

kibanamachine · 2025-01-07T21:05:00Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/12659295244

elasticmachine · 2025-01-07T21:05:30Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`streamsApp`	178	200	+22

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
`streams`	9	13	+4

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`streamsApp`	182.2KB	190.3KB	+8.1KB

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
`streams`	2	8	+6

Unknown metric groups

API count

id	before	after	diff
`streams`	9	13	+4

References to deprecated APIs

id	before	after	diff
`streamsApp`	0	2	+2

History

💔 Build #264870 failed f0739fb
💔 Build #264632 failed 7680759
💔 Build #264622 failed 57699d9
💔 Build #264385 failed 0dfc7a1
💚 Build #263501 succeeded 119c17c

kibanamachine · 2025-01-07T21:15:07Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 204309

Questions ?

Please refer to the Backport tool documentation

## Summary So that it can be used from `streams_app` (o11y). See elastic#204309 Steps to relocate: 1. Fetch latest `main` 2. Update the `group` and/or `visibility` in the module's manifest. 3. Run `node scripts/relocate --moveOnly @kbn/saved-objects-tagging-plugin`

Links dashboard to Streams. Changes: - Introduces `IndexStorageAdapter` to manage ES indices - see https://github.com/dgieselaar/kibana/blob/streams-app-asset-linking/x-pack/solutions/observability/packages/utils_server/es/storage/README.md for motivation - Introduces `AssetClient` and `AssetService` to manage asset links with `IndexStorageAdapter` - `RepositorySupertestClient` to make it easier to use `@kbn/server-route-repository` with FTR tests - refactors related to above changes --------- Co-authored-by: Chris Cowan <[email protected]> Co-authored-by: Joe Reuter <[email protected]> Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

dgieselaar · 2025-01-08T08:58:34Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

Links dashboard to Streams. Changes: - Introduces `IndexStorageAdapter` to manage ES indices - see https://github.com/dgieselaar/kibana/blob/streams-app-asset-linking/x-pack/solutions/observability/packages/utils_server/es/storage/README.md for motivation - Introduces `AssetClient` and `AssetService` to manage asset links with `IndexStorageAdapter` - `RepositorySupertestClient` to make it easier to use `@kbn/server-route-repository` with FTR tests - refactors related to above changes --------- Co-authored-by: Chris Cowan <[email protected]> Co-authored-by: Joe Reuter <[email protected]> Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]> (cherry picked from commit 28414ce) # Conflicts: # .github/CODEOWNERS # x-pack/test/tsconfig.json

## Summary So that it can be used from `streams_app` (o11y). See elastic#204309 Steps to relocate: 1. Fetch latest `main` 2. Update the `group` and/or `visibility` in the module's manifest. 3. Run `node scripts/relocate --moveOnly @kbn/saved-objects-tagging-plugin` (cherry picked from commit a8579bb) # Conflicts: # .github/CODEOWNERS # packages/kbn-relocate/utils/relocate.ts

## Summary So that it can be used from `streams_app` (o11y). See elastic#204309 Steps to relocate: 1. Fetch latest `main` 2. Update the `group` and/or `visibility` in the module's manifest. 3. Run `node scripts/relocate --moveOnly @kbn/saved-objects-tagging-plugin`

Links dashboard to Streams. Changes: - Introduces `IndexStorageAdapter` to manage ES indices - see https://github.com/dgieselaar/kibana/blob/streams-app-asset-linking/x-pack/solutions/observability/packages/utils_server/es/storage/README.md for motivation - Introduces `AssetClient` and `AssetService` to manage asset links with `IndexStorageAdapter` - `RepositorySupertestClient` to make it easier to use `@kbn/server-route-repository` with FTR tests - refactors related to above changes --------- Co-authored-by: Chris Cowan <[email protected]> Co-authored-by: Joe Reuter <[email protected]> Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

simianhacker and others added 30 commits November 1, 2024 11:22

Initial setup for streams plugin

5fe1078

migrating to the streams naming schema; adding an abstraction for the…

6f940eb

… fork conditions

ensure forked streams are marked root:false

9b33808

Commit entities plugins

c8cd0f7

Move files into streams_*

7e8f2d7

Rename stuff & remove stuff

999dfef

stream management

d99a3ff

add delete and listing endpoint

0e89345

cleanup

9dd5fde

add resync endpoint

7400a3b

Remove cruft, handle package relocation

5140687

Streams table

797c93d

Only fetch histogram when DS exists

fcce628

more fixes

9d37219

more adjustments

d622fa1

some more fixes

fbc6c2a

Merge remote-tracking branch 'upstream/main' into init-streams-plugin

45787d0

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

e810f53

…ocs'

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

e93ac17

…fix'

add limits

cf9f349

Merge branch 'init-streams-plugin' of github.com:simianhacker/kibana …

0d676ed

…into init-streams-plugin

Add streams to left nav

7b0a4e5

fix permissions

34f3c44

remove feature completely

0b7de24

cleanup

76ed81d

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

2427d2e

…fix'

Merge branch 'main' into init-streams-plugin

2ad08f4

Merge branch 'main' into init-streams-plugin

c8d99ed

Merge commit '0d676edfc0681f18d3804e079bad09053bf32247' into init-str…

8c707d1

…eams-app-plugin

[Observability] Split up observability-utils package

e6bb640

simianhacker requested changes Jan 6, 2025

View reviewed changes

Merge branch 'main' of github.com:elastic/kibana into streams-app-ass…

287528f

…et-linking

dgieselaar added 2 commits January 7, 2025 09:58

Fix issue w/ deleted dashboard, usage example for storage index adapter

57699d9

Use signal from fetch hookC

7680759

gsoldevila mentioned this pull request Jan 7, 2025

Make saved_objects_tagging plugin shared #205695

Merged

miltonhultgren reviewed Jan 7, 2025

View reviewed changes

simianhacker approved these changes Jan 7, 2025

View reviewed changes

dgieselaar added 2 commits January 7, 2025 16:57

Clarify comment

1266ea0

Merge branch 'main' of github.com:elastic/kibana into streams-app-ass…

f0739fb

…et-linking

dgieselaar enabled auto-merge (squash) January 7, 2025 15:59

Merge branch 'main' of github.com:elastic/kibana into streams-app-ass…

068e60f

…et-linking

dgieselaar merged commit 28414ce into elastic:main Jan 7, 2025
10 checks passed

kibanamachine mentioned this pull request Jan 7, 2025

Sustainable Kibana Architecture: Move content management related packages #205593

Merged

kibanamachine mentioned this pull request Jan 7, 2025

[chore] Delete deprecated avatars #205448

Merged

dgieselaar mentioned this pull request Jan 8, 2025

[8.x] [Streams] Dashboard linking (#204309) #205842

Open

kibanamachine mentioned this pull request Jan 8, 2025

[Streams] Make root stream selectively immutable #205609

Merged

This was referenced Jan 8, 2025

🌊 Stream overview page #204079

Merged

SKA: Categorise remaining packages #205875

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Streams] Dashboard linking #204309

[Streams] Dashboard linking #204309

dgieselaar commented Dec 14, 2024 •

edited by kibanamachine

Loading

simianhacker left a comment

simianhacker Jan 6, 2025

simianhacker Jan 6, 2025

dgieselaar Jan 7, 2025

simianhacker Jan 6, 2025

dgieselaar Jan 7, 2025

dgieselaar commented Jan 7, 2025

miltonhultgren Jan 7, 2025

dgieselaar Jan 7, 2025

simianhacker left a comment

kibanamachine commented Jan 7, 2025

elasticmachine commented Jan 7, 2025

API count

References to deprecated APIs

kibanamachine commented Jan 7, 2025

dgieselaar commented Jan 8, 2025

[Streams] Dashboard linking #204309

[Streams] Dashboard linking #204309

Conversation

dgieselaar commented Dec 14, 2024 • edited by kibanamachine Loading

simianhacker left a comment

Choose a reason for hiding this comment

simianhacker Jan 6, 2025

Choose a reason for hiding this comment

simianhacker Jan 6, 2025

Choose a reason for hiding this comment

dgieselaar Jan 7, 2025

Choose a reason for hiding this comment

simianhacker Jan 6, 2025

Choose a reason for hiding this comment

dgieselaar Jan 7, 2025

Choose a reason for hiding this comment

dgieselaar commented Jan 7, 2025

miltonhultgren Jan 7, 2025

Choose a reason for hiding this comment

dgieselaar Jan 7, 2025

Choose a reason for hiding this comment

simianhacker left a comment

Choose a reason for hiding this comment

kibanamachine commented Jan 7, 2025

elasticmachine commented Jan 7, 2025

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

API count

References to deprecated APIs

History

kibanamachine commented Jan 7, 2025

💔 All backports failed

Manual backport

Questions ?

dgieselaar commented Jan 8, 2025

💚 All backports created successfully

Questions ?

dgieselaar commented Dec 14, 2024 •

edited by kibanamachine

Loading