[Cases] Add Generic Page attachment type for cases by dominiqueclarke · Pull Request #224308 · elastic/kibana

dominiqueclarke · 2025-06-17T17:04:40Z

Summary

This PR defines a generic "page" attachment type which can be used to attach any page in Kibana to a case.

This PR defines the base schema, with more features to be developed in the future.

Overview

The goal is to create an attachment type that is generic enough to use across Kibana, but useful enough to facilitate meaningful analysis during an investigation. As part of the goal, we are targeting the following features as part of the attachment.

A link back to the attached page - This enables users save a relevant page while providing a mechanism to dive back into the in-app or platform experience as the incident progresses
[Coming soon] A screenshot of the attached page - This provides with an "at a glance" view of what's behind the link, enabling quick understanding of the attachment. It also provides a snapshot of the page at the time of the incident, which is helpful is helpful when your data has been ILMed away
[Coming soon] Screen context - Screen context provides helpful plain-language summaries of the page. This is what is used by our AI assistants in order to have context of what the user is looking at when interacting with the AI assistant. By persisting screen context we can provide LLMs with an understanding of the attachment that is not possible with just the link or screenshot. Since screen context is a developer constructed description pf the page, It's important to note that screen context can be saved without having access to an LLM (if a user has not enabled assistants). That way, if a user enables an AI connector at a later date, they can get the benefit from this screen context right away
[Coming soon] Summary - An AI-generated summary of the page, which was constructed using the screen context at the time attachment was created
TBD some way to register a custom component to render for certain pages (Not well defined yet)

Only bullet point 1 is included in this PR.

Background

This idea originally spawned from a desire to develop a Dashboard link attachment type. As we considered the Dashboards use-case, we wanted to expand to allow our attachment to support any link. Further, as we considered the value of this attachment type, we wanted to enrich the link with more helpful information such as a screenshot, screen context, and summary.

Because this idea spawned from a Dashboard link, Dashboards is the first place we implemented this. However, if the Dashboard team is not satisfied with the UX or dev implementation, we are happy to remove this feature for now in favor or merging just the attachment schema.

Technical details

The type definition for the attachment persisted state
The attachment spec
The dashboard implementation
Transitioned some types to generics for more type safety.
The visualization attachment type was moved into a internal_attachments folder, alongside the new page attachment (Source of a lot of file changes
Swapped out security.userProfiles for userProfile. (Also a large source of file changes)
Removed an unused dashboard dependency from Triggers Actions UI to prevent circular dependencies.

Testing

Create a dashboard. If you need a few handy, you can use this ndjson file to upload saved objects
Visit a dashboard. Ensure you are in View mode
Click the Add to Case Button
Ensure the attachment is added successfully via toast. Click View Case
You should see the name of the dashboard hyperlinked in the attachment comment. You should also see a Go to Dashboard button in the comment actions. Lastly, you should see a Go To Dashboard button in the actions dropdown.
When you visit each link, you should be navigated back to the dashboard, with the time range as absolute value for the time range the user was viewing at the time they added the attachment.

Appendix

Persistable state attachment type docs

…ke/kibana into feat/cases-link-attachment

…ses-link-attachment

…apping'

…ke/kibana into feat/cases-link-attachment

…apping'

dominiqueclarke · 2025-06-17T17:04:50Z

/ci

dominiqueclarke · 2025-06-17T17:10:45Z

/ci

dominiqueclarke · 2025-06-17T18:12:08Z

/ci

dominiqueclarke · 2025-06-17T19:21:31Z

/ci

dominiqueclarke · 2025-06-17T20:21:24Z

/ci

…ses-page-attachment

…ke/kibana into feat/cases-page-attachment

dominiqueclarke · 2025-06-18T01:26:28Z

/ci

dominiqueclarke · 2025-06-18T13:53:25Z

/ci

dominiqueclarke · 2025-06-18T16:50:26Z

/ci

dominiqueclarke · 2025-06-18T17:08:37Z

/ci

elasticmachine · 2025-06-18T18:40:00Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: c7166c5

Failed CI Steps

FTR Configs #105

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`cases`	1022	1027	+5
`dashboard`	671	672	+1
total			+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
`cases`	109	112	+3
`triggersActionsUi`	539	538	-1
total			+2

Async chunks

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

id	before	after	diff
`cases`	1.3MB	1.3MB	+2.0KB
`dashboard`	618.5KB	620.7KB	+2.2KB
total			+4.2KB

Page load bundle

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

id	before	after	diff
`cases`	134.6KB	135.6KB	+1001.0B
`dashboard`	18.1KB	18.3KB	+154.0B
`triggersActionsUi`	111.8KB	111.7KB	-66.0B
total			+1.1KB

Unknown metric groups

API count

id	before	after	diff
`cases`	129	134	+5
`triggersActionsUi`	545	544	-1
total			+4

async chunk count

id	before	after	diff
`cases`	36	38	+2

ESLint disabled line counts

id	before	after	diff
`cases`	69	72	+3

References to deprecated APIs

id	before	after	diff
`cases`	32	26	-6

Total ESLint disabled count

id	before	after	diff
`cases`	87	90	+3

History

elasticmachine · 2025-06-18T20:04:42Z

Pinging @elastic/obs-ux-management-team (Team:obs-ux-management)

dominiqueclarke · 2025-06-18T19:41:28Z

x-pack/platform/plugins/shared/cases/public/containers/user_profiles/api.ts

-  security,
+  userProfile,
 }: GetCurrentUserProfileArgs): Promise<UserProfile> => {
-  return security.userProfiles.getCurrent({ dataPath: 'avatar' });


I was getting a reference error when developing against security, and security.userProfiles was marked as deprecated with the suggestion to use userProfile instead.

dominiqueclarke · 2025-06-19T03:39:15Z

src/platform/plugins/shared/dashboard/public/dashboard_app/dashboard_router.tsx

-          </Routes>
-        </HashRouter>
-      </DashboardMountContext.Provider>
+      <KibanaContextProvider


Needed to render the Add to Case modal

mgiota · 2025-06-19T09:19:53Z

x-pack/platform/plugins/shared/triggers_actions_ui/kibana.jsonc

      "dataViewEditor",
      "alerting",
      "actions",
-      "dashboard",


@dominiqueclarke Are we sure about this? I checked when this dependency was introduced and looks like it was introduced here

I checked with the Triggers Action team to confirm it's not in use. It was previously in use, but then some refactoring happened that removed the need for the dependency, but they forgot to remove it.

That's good news, because I faced a cycle dependency issue when I tried to add the cases plugin as a dependency of the dashboard plugin as part of this issue.

gsoldevila

LGTM (config review only)

kdelemme · 2025-06-19T12:22:08Z

...latform/plugins/shared/cases/public/components/internal_attachments/page/attachment.test.tsx

+  const attachmentViewProps: PersistableStateAttachmentViewProps<PageAttachmentPersistedState> = {
+    persistableStateAttachmentTypeId: PAGE_ATTACHMENT_TYPE,
+    persistableStateAttachmentState: {
+      pathname: '/test/path',


Why pathname is not part of url?

kdelemme · 2025-06-19T12:22:30Z

...latform/plugins/shared/cases/public/components/internal_attachments/page/attachment.test.tsx

+    persistableStateAttachmentState: {
+      pathname: '/test/path',
+      type: PAGE_ATTACHMENT_TYPE,
+      url: {


should we handle external url or is it only kibana link?

dominiqueclarke · 2025-06-26T13:21:22Z

Closed in favor of #225295

dominiqueclarke and others added 17 commits June 10, 2025 15:22

add link attachment type

77d172f

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

3bcb4d4

remove dashboard dependency from triggers actions ui

bc5c03d

Merge branch 'feat/cases-link-attachment' of github.com:dominiqueclar…

192116f

…ke/kibana into feat/cases-link-attachment

Merge branch 'main' of https://github.com/elastic/kibana into feat/ca…

8f3782f

…ses-link-attachment

integrate screenshot

0aeebda

merge upstream

6037685

adjust types

5266320

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

14e8f82

…apping'

quick checks

ac2ef57

Merge branch 'feat/cases-link-attachment' of github.com:dominiqueclar…

22cc56a

…ke/kibana into feat/cases-link-attachment

remove unnecessary dashboard dependency

9d0d253

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

b45cdba

…apping'

split and merge screenshot images

6d1c98b

add actions

5bd0383

merge upstream

d28a975

remove screenshot functionality

e9818ad

github-actions bot added the author:obs-ux-management PRs authored by the obs ux management team label Jun 17, 2025

adjust rendered component

b988b67

adjust types and linting

6565e1b

adjust types

711442b

adjust test

ad3b528

dominiqueclarke added 3 commits June 17, 2025 16:49

Merge branch 'main' of https://github.com/elastic/kibana into feat/ca…

beb55d4

…ses-page-attachment

Merge branch 'main' into feat/cases-page-attachment

f612f90

adjust types

072a087

Merge branch 'feat/cases-page-attachment' of github.com:dominiqueclar…

da1e7a7

…ke/kibana into feat/cases-page-attachment

adjust tests

d81aec3

dominiqueclarke force-pushed the feat/cases-page-attachment branch from 4d3ada9 to d81aec3 Compare June 18, 2025 16:05

adjust types

c7166c5

dominiqueclarke changed the title ~~Feat/cases page attachment~~ [Cases] [Dashboards] Add Generic Page attachment type and add Add to Case action to Dashboard Jun 18, 2025

dominiqueclarke added release_note:skip Skip the PR/issue when compiling release notes Team:actionable-obs Formerly "obs-ux-management", responsible for SLO, o11y alerting, significant events, & synthetics. v9.1.0 v8.19.0 backport:version Backport to applied version labels labels Jun 18, 2025

dominiqueclarke marked this pull request as ready for review June 18, 2025 20:04

dominiqueclarke requested review from a team as code owners June 18, 2025 20:04

dominiqueclarke commented Jun 19, 2025

View reviewed changes

mgiota reviewed Jun 19, 2025

View reviewed changes

gsoldevila approved these changes Jun 19, 2025

View reviewed changes

kdelemme reviewed Jun 19, 2025

View reviewed changes

jasonrhodes changed the title ~~[Cases] [Dashboards] Add Generic Page attachment type and add Add to Case action to Dashboard~~ [Cases] Add Generic Page attachment type for cases Jun 20, 2025

mgiota referenced this pull request in mgiota/kibana Jun 24, 2025

temp

9690ca2

dominiqueclarke closed this Jun 26, 2025

Conversation

dominiqueclarke commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Overview

Background

Technical details

Testing

Appendix

Uh oh!

dominiqueclarke commented Jun 17, 2025

Uh oh!

dominiqueclarke commented Jun 17, 2025

Uh oh!

dominiqueclarke commented Jun 17, 2025

Uh oh!

dominiqueclarke commented Jun 17, 2025

Uh oh!

dominiqueclarke commented Jun 17, 2025

Uh oh!

dominiqueclarke commented Jun 18, 2025

Uh oh!

dominiqueclarke commented Jun 18, 2025

Uh oh!

dominiqueclarke commented Jun 18, 2025

Uh oh!

dominiqueclarke commented Jun 18, 2025

Uh oh!

elasticmachine commented Jun 18, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

async chunk count

ESLint disabled line counts

References to deprecated APIs

Total ESLint disabled count

History

Uh oh!

elasticmachine commented Jun 18, 2025

Uh oh!

dominiqueclarke Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

dominiqueclarke Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

mgiota Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

dominiqueclarke Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

mgiota Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

gsoldevila left a comment

Choose a reason for hiding this comment

Uh oh!

kdelemme Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

kdelemme Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

dominiqueclarke commented Jun 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

dominiqueclarke commented Jun 17, 2025 •

edited

Loading