[Graph] Switch to SavedObjectClient.resolve #109617

mbondyra · 2021-08-23T11:13:39Z

Summary

Fixes partially #105812

Screenshots

aliasMatch

conflict

How to test this

Create your own graph and export the saved object or use this one:
graph2.ndjson.zip
Follow the instructions from here to get the staging data and add it via Dev Tools to your kibana.
Using that staging data, I could test with these links (they are with my basePath wju, modify accordingly):

Graph, exactMatch - http://localhost:5601/wju/s/test1/app/graph#/workspace/ff959d40-b880-11e8-a6d9-e546fe2bba5f-test1
Graph, aliasMatch - http://localhost:5601/wju/s/test2/app/graph#/workspace/ff959d40-b880-11e8-a6d9-e546fe2bba5f-test2 -> redirects you to the new ID for that object
Graph, conflict - http://localhost:5601/wju/s/test3/app/graph#/workspace/ff959d40-b880-11e8-a6d9-e546fe2bba5f-test3 -> clicking the button redirects you to the conflicting object that has a new ID

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

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—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—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

elasticmachine · 2021-09-07T13:02:21Z

Pinging @elastic/kibana-vis-editors (Team:VisEditors)

elasticmachine · 2021-09-07T13:21:22Z

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

LeeDr · 2021-09-07T13:57:41Z

Graph, exactMatch - http://localhost:5601/wju/s/test1/app/graph#/workspace/92c872e0-0cca-11ec-a0d4-73239d2f1d3c-test1
Graph, aliasMatch - http://localhost:5601/wju/s/test2/app/graph#/workspace/92c872e0-0cca-11ec-a0d4-73239d2f1d3c-test2 -> redirects you to the new ID for that object
Graph, conflict - http://localhost:5601/wju/s/test3/app/graph#/workspace/92c872e0-0cca-11ec-a0d4-73239d2f1d3c-test3 -> clicking the button redirects you to the conflicting object that has a new ID

I'm confused by this. There are 2 screenshots and 3 test cases. I guess the first test case doesn't have a screenshot because it's just the graph with no dialogs or messages on it?

It would be nice if the screenshots included the browser address bar so we could tell what URL was entered and what it was redirected to if that's what is happening.

I don't understand the complete flow for the 3rd case.

How can one URL have 2 objects associated with it? I can't wrap my head around that statement. Do I only see this if I open a URL from a browser bookmark? Or do I also see it if I open a graph from the listing page?
What happens if I click the Dismiss button? Will I see this every time I open this graph URL? If not, do other people who open the same link see it?
What happens when I click Go to other graph?

I might answer some of these questions by reading the developer guide for sharing saved objects, but looking at this from the end-user perspective I'm very confused.

mbondyra · 2021-09-07T14:19:30Z

Hi @LeeDr, the behavior is shared across all the saved objects (not just Graph ones) so I didn't include all the information. To get some context, it is worth to look at Joe's Sharing Saved Object guide.

I've updated the screenshots with the labels, but basically exactMatch behaves as before, the app is just loaded. The aliasMatch gets redirected and shows redirection toast. The conflict shows a notification.

How can one URL have 2 objects associated with it? I can't wrap my head around that statement. Do I only see this if I open a URL from a browser bookmark? Or do I also see it if I open a graph from the listing page?

This is very well explained in this section of the guide and there's a great example here

What happens if I click the Dismiss button? Will I see this every time I open this graph URL? If not, do other people who open the same link see it?

If you click the Dismiss button, the notification disappears but when you refresh, it shows up again. You will see this everytime you open this graph. It happens because we want the user to be sure they look at the correct saved object. Quoting: "By informing the consumer that this is a conflict, the consumer can render an appropriate UI to the end-user explaining that this might not be the object they are actually looking for." so I understand it as we want the user to react and remove the one that is not correct (probably the other one).

What happens when I click Go to other graph?

You get redirected to the other graph.

LeeDr · 2021-09-07T19:27:47Z

I reviewed the developer guide and chatted with Joe about the functionality again. It seems very unlikely anyone should hit the conflict case. They would probably either have to use the saved objects API in some strange way or hack docs in Es to get into that state. I'm still concerned that we don't really give users any clear way to "fix" the conflict case. They would either have to go into Saved Objects and delete the conflicting object. Or maybe delete an alias directly from the .kibana index. Likely would become a support case. In any case, this PR is just following the dev guide.

jportner · 2021-09-07T20:34:09Z

I'm still concerned that we don't really give users any clear way to "fix" the conflict case. They would either have to go into Saved Objects and delete the conflicting object. Or maybe delete an alias directly from the .kibana index. Likely would become a support case. In any case, this PR is just following the dev guide.

Agree this is not ideal, but also we decided not to invest too much time in building a UI that is probably never going to be used.
Since I designed the conflict callout, we also added a docs page for legacy URL aliases, which at least gives an escape hatch to manually fix the situation (by calling an API).
The docs team has asked me to make some tweaks to the callout body text, which is in the Spaces plugin, so I plan to do that here soon an add a link to those docs too.

jportner

Code review only, the test steps you have outlined look great.
Just a couple of nits in the comments below!

x-pack/plugins/graph/kibana.json

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

x-pack/plugins/graph/public/helpers/use_workspace_loader.test.tsx

mbondyra · 2021-09-08T11:22:57Z

@elasticmachine merge upstream

jportner

Test locally and LGTM!

dimaanj

Great work! Tested locally, found one issue with redirect. Once it solved, should be ready.

x-pack/plugins/graph/public/apps/workspace_route.tsx

x-pack/plugins/graph/public/helpers/use_workspace_loader.ts

x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx

…vedObjectClientResolve

kibanamachine · 2021-09-09T17:55:18Z

💚 Build Succeeded

Metrics [docs]

Async chunks

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

id	before	after	diff
`graph`	644.5KB	646.0KB	+1.5KB

Page load bundle

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

id	before	after	diff
`graph`	11.2KB	11.2KB	+27.0B

History

💚 Build #151775 succeeded 66bb543
💚 Build #151746 succeeded 60fba05
💚 Build #151520 succeeded 0d63e9c
💔 Build #151482 failed 8508c8a
💚 Build #151298 succeeded 5ba145215dbf2b973b6401d09773fc75a209ea3f

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

dimaanj

LGTM! Tested locally one more time.

kertal

LGTM, also did a quick test in MacOS, Chrome

kibanamachine · 2021-09-10T13:49:46Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

…-link-to-kibana-app * 'master' of github.com:elastic/kibana: (120 commits) [TSVB] Support custom field format (elastic#101245) [VisEditors] Add code ownership to the functional tests (elastic#111680) [Lens] Make Lens saved object share-capable (elastic#111403) [Graph] Make Graph saved object share-capable (elastic#111404) [Stack Monitoring] Add breadcrumb support (elastic#111850) Update Jira Cloud to use OAuth2.0 (elastic#111493) Show warning message when attempting to create an APM alert in stack management (elastic#111781) Skip suite blocking ES snapshot promotion (elastic#111907) Respect `auth_provider_hint` if session is not authenticated. (elastic#111521) Added in 'Responses' field in alert telemetry & updated test (elastic#111892) [Usage collection] refactor cloud detector collector (elastic#110439) Make classnames a shared dep (elastic#111636) Fix link to e2e tests in APM testing.md (elastic#111869) [Security Solution] Add host.os.name.caseless mapping and runtime field (elastic#111455) [APM] Removes the beta label from APM tutorial (elastic#111499) (elastic#111828) [RAC] [Observability] Expand Observability alerts page functional tests (elastic#111297) Fix extra white space on the alert table whe page size is 50 or 100 (elastic#111568) [Metrics UI] Add Inventory Timeline open/close state to context and URL state (elastic#111034) [Graph] Switch to SavedObjectClient.resolve (elastic#109617) [APM] Adding lambda icon (elastic#111834) ... # Conflicts: # x-pack/plugins/reporting/public/management/__snapshots__/report_listing.test.tsx.snap

kibanamachine · 2021-09-14T13:52:29Z

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

Co-authored-by: Marta Bondyra <[email protected]>

mbondyra added Feature:Graph Graph application feature Team:Visualizations Visualization editors, elastic-charts and infrastructure v8.0.0 release_note:skip Skip the PR/issue when compiling release notes labels Aug 23, 2021

mbondyra changed the title ~~[Graph] replace get with resolve~~ [Graph] Switch to SavedObjectClient.resolve Sep 4, 2021

elastic deleted a comment from kibanamachine Sep 4, 2021

mbondyra added the v7.16.0 label Sep 4, 2021

mbondyra force-pushed the graph/savedObjectClientResolve branch 2 times, most recently from 2497a6e to 5ba1452 Compare September 6, 2021 13:50

mbondyra added 4 commits September 7, 2021 14:59

use resolve instead of get

8a83041

graph step 3 (tests missing)

fcdaff4

tests

2203f6b

moving the functionality to workspace_route

8508c8a

mbondyra force-pushed the graph/savedObjectClientResolve branch from 5ba1452 to 8508c8a Compare September 7, 2021 13:00

mbondyra marked this pull request as ready for review September 7, 2021 13:02

mbondyra requested a review from a team as a code owner September 7, 2021 13:02

mbondyra requested a review from jportner September 7, 2021 13:02

mbondyra added Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. and removed Team:Visualizations Visualization editors, elastic-charts and infrastructure labels Sep 7, 2021

removing unnecessary mock

0d63e9c

mbondyra mentioned this pull request Sep 7, 2021

[Graph] Make Graph saved object share-capable #111404

Merged

2 tasks

mbondyra marked this pull request as draft September 7, 2021 20:38

mbondyra marked this pull request as ready for review September 7, 2021 20:38

jportner reviewed Sep 7, 2021

View reviewed changes

x-pack/plugins/graph/kibana.json Outdated Show resolved Hide resolved

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

x-pack/plugins/graph/public/helpers/use_workspace_loader.test.tsx Outdated Show resolved Hide resolved

make spaces optional & add negative test

60fba05

kertal requested a review from dimaanj September 8, 2021 09:27

Merge branch 'master' into graph/savedObjectClientResolve

66bb543

jportner self-requested a review September 8, 2021 14:01

jportner approved these changes Sep 8, 2021

View reviewed changes

dimaanj suggested changes Sep 9, 2021

View reviewed changes

x-pack/plugins/graph/public/apps/workspace_route.tsx Outdated Show resolved Hide resolved

x-pack/plugins/graph/public/helpers/use_workspace_loader.ts Show resolved Hide resolved

x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx Show resolved Hide resolved

mbondyra added 2 commits September 9, 2021 15:57

Merge commit '334f129bcbffb1502d408f8be1c6c13a60c68635' into graph/sa…

e1d2a46

…vedObjectClientResolve

feedback from cr

889b608

dimaanj approved these changes Sep 10, 2021

View reviewed changes

kertal approved these changes Sep 10, 2021

View reviewed changes

mbondyra added the auto-backport Deprecated - use backport:version if exact versions are needed label Sep 10, 2021

mbondyra merged commit 7fff05f into elastic:master Sep 10, 2021

mbondyra deleted the graph/savedObjectClientResolve branch September 10, 2021 13:47

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Sep 10, 2021

[Graph] Switch to SavedObjectClient.resolve (elastic#109617)

5c46181

kibanamachine mentioned this pull request Sep 10, 2021

[7.x] [Graph] Switch to SavedObjectClient.resolve (#109617) #111862

Merged

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Sep 14, 2021

kibanamachine added a commit that referenced this pull request Sep 14, 2021

[Graph] Switch to SavedObjectClient.resolve (#109617) (#111862)

92a9a49

Co-authored-by: Marta Bondyra <[email protected]>

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Sep 14, 2021

mbondyra mentioned this pull request Sep 30, 2021

[Graph] Workspace breaks with no user message when index pattern was removed #113548

Closed

mbondyra mentioned this pull request Oct 13, 2021

[Graph] Unhandled error after index pattern removal #110235

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Graph] Switch to SavedObjectClient.resolve #109617

[Graph] Switch to SavedObjectClient.resolve #109617

mbondyra commented Aug 23, 2021 •

edited

Loading

elasticmachine commented Sep 7, 2021

elasticmachine commented Sep 7, 2021

LeeDr commented Sep 7, 2021

mbondyra commented Sep 7, 2021 •

edited

Loading

LeeDr commented Sep 7, 2021

jportner commented Sep 7, 2021 •

edited

Loading

jportner left a comment

mbondyra commented Sep 8, 2021

jportner left a comment

dimaanj left a comment

kibanamachine commented Sep 9, 2021

dimaanj left a comment

kertal left a comment •

edited

Loading

kibanamachine commented Sep 10, 2021

kibanamachine commented Sep 14, 2021

[Graph] Switch to SavedObjectClient.resolve #109617

[Graph] Switch to SavedObjectClient.resolve #109617

Conversation

mbondyra commented Aug 23, 2021 • edited Loading

Summary

Screenshots

How to test this

Checklist

Risk Matrix

elasticmachine commented Sep 7, 2021

elasticmachine commented Sep 7, 2021

LeeDr commented Sep 7, 2021

mbondyra commented Sep 7, 2021 • edited Loading

LeeDr commented Sep 7, 2021

jportner commented Sep 7, 2021 • edited Loading

jportner left a comment

Choose a reason for hiding this comment

mbondyra commented Sep 8, 2021

jportner left a comment

Choose a reason for hiding this comment

dimaanj left a comment

Choose a reason for hiding this comment

kibanamachine commented Sep 9, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

History

dimaanj left a comment

Choose a reason for hiding this comment

kertal left a comment • edited Loading

Choose a reason for hiding this comment

kibanamachine commented Sep 10, 2021

💚 Backport successful

kibanamachine commented Sep 14, 2021

mbondyra commented Aug 23, 2021 •

edited

Loading

mbondyra commented Sep 7, 2021 •

edited

Loading

jportner commented Sep 7, 2021 •

edited

Loading

kertal left a comment •

edited

Loading