[Visualization] Get rid of saved object loader and use savedObjectClient resolve #113121

VladLasitsa · 2021-09-27T14:00:48Z

Summary

Get rid of SavedObjectLoader in Visualization. This work is done because the SavedObject class has been deprecated and will be removed in Kibana 8

What was done:

🏁 Created a simple functions for get/save visualization and use it from all external plugins instead of SavedObjectLoader
🏁 savedObject.get was replaced to savedObject.resolve
🏁 added handling of cases when we get conflict and aliasMatch

…ethods

…object_loader

src/plugins/visualizations/public/utils/saved_visualize_utils.ts

VladLasitsa · 2021-09-30T16:55:20Z

@elasticmachine merge upstream

flash1293

Not finished yet, but noticed one thing I want to change in general

src/plugins/visualizations/public/index.ts

VladLasitsa · 2021-10-01T14:15:40Z

@elasticmachine merge upstream

src/plugins/visualizations/public/types.ts

src/plugins/visualizations/public/utils/saved_visualize_utils.ts

elasticmachine · 2021-10-06T08:02:11Z

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

flash1293 · 2021-10-06T08:02:19Z

@elasticmachine merge upstream

flash1293 · 2021-10-06T08:30:32Z

This looks mostly good to me. However just yesterday evening a unified error component got merged to guide the user into the right direction to delete the alias: #112606

This is how it looks right now:

This is how it should look:

See for example the usage in Lens:

kibana/x-pack/plugins/lens/public/embeddable/embeddable.tsx

Line 283 in a9a923d

if (sharingSavedObjectProps?.outcome === 'conflict' && this.deps.spaces) {

We can do this on a separate PR to get this one merged, but we should definitely align here.

flash1293

Tested and didn't notice any weird behavior anymore, LGTM

Added some nits about anys in there (we should not introduce them anymore)

src/plugins/visualize/public/application/utils/get_visualization_instance.test.ts

src/plugins/visualizations/public/types.ts

src/plugins/visualizations/public/plugin.ts

VladLasitsa · 2021-10-07T07:56:07Z

@elasticmachine merge upstream

jportner · 2021-10-10T05:41:20Z

src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx

+      if (savedObject.sharingSavedObjectProps?.outcome === 'conflict') {
+        return new ErrorEmbeddable(
+          i18n.translate('visualizations.embeddable.legacyURLConflict.errorMessage', {
+            defaultMessage: `This visualization has the same URL as a legacy alias. Disable the alias to resolve this error : {json}`,
+            values: { json: savedObject.sharingSavedObjectProps?.errorJSON },
+          }),
+          input,
+          parent
+        );
+      }


As @flash1293 mentioned in #113121 (comment), the Spaces plugin now provides a component for this. Whether you want to change it in this PR or leave it for a follow-on PR, I just wanted to leave a note and let you know that I made some additional changes to it in #114172.
You can load this component with spaces.ui.components.getEmbeddableLegacyUrlConflict; you can see how Lens consumes it here:

kibana/x-pack/plugins/lens/public/embeddable/embeddable.tsx

Lines 283 to 296 in 961fe75

if (sharingSavedObjectProps?.outcome === 'conflict' && this.deps.spaces) {

const conflictError = {

shortMessage: i18n.translate('xpack.lens.embeddable.legacyURLConflict.shortMessage', {

defaultMessage: `You've encountered a URL conflict`,

}),

longMessage: (

<this.deps.spaces.ui.components.getEmbeddableLegacyUrlConflict

targetType={DOC_TYPE}

sourceId={sharingSavedObjectProps.sourceId!}

/>

),

};

this.errors = this.errors ? [...this.errors, conflictError] : [conflictError];

}

The sourceId is the ID of the saved object.

flash1293 · 2021-10-10T18:43:26Z

@elasticmachine merge upstream

kibanamachine · 2021-10-10T20:51:42Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`visualizations`	107	108	+1

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
`visualizations`	257	286	+29

Async chunks

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

id	before	after	diff
`visualizations`	72.6KB	72.7KB	+84.0B
`visualize`	51.9KB	53.1KB	+1.2KB
total			+1.3KB

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
`visualizations`	15	16	+1

Page load bundle

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

id	before	after	diff
`visualizations`	33.0KB	39.0KB	+6.0KB
`visualize`	16.0KB	15.9KB	-47.0B
total			+6.0KB

Unknown metric groups

API count

id	before	after	diff
`visualizations`	275	304	+29

References to deprecated APIs

id	before	after	diff
`visualizations`	104	102	-2

History

💚 Build #158791 succeeded 2679dca
💔 Build #158777 failed 91b0e71
💚 Build #158764 succeeded ff5463b
💚 Build #158443 succeeded bfd5947
💚 Build #158322 succeeded 0522ded

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

…ent resolve (elastic#113121) * First step: create saved_visualize_utils, starting use new get/save methods * Use new util methods in embeddable * move findListItem in utils * some clean up * clean up * Some fixes * Fix saved object tags * Some types fixes * Fix unit tests * Clean up code * Add unit tests for new utils * Fix lint * Fix tagging * Add unit tests * Some fixes * Clean up code * Fix lint * Fix types * put new methods in start contract * Fix imports * Fix lint * Fix comments * Fix lint * Fix CI * use local url instead of full path * Fix unit test * Some clean up * Fix nits * fix types Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

…ent resolve (#113121) (#114442) * First step: create saved_visualize_utils, starting use new get/save methods * Use new util methods in embeddable * move findListItem in utils * some clean up * clean up * Some fixes * Fix saved object tags * Some types fixes * Fix unit tests * Clean up code * Add unit tests for new utils * Fix lint * Fix tagging * Add unit tests * Some fixes * Clean up code * Fix lint * Fix types * put new methods in start contract * Fix imports * Fix lint * Fix comments * Fix lint * Fix CI * use local url instead of full path * Fix unit test * Some clean up * Fix nits * fix types Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

VladLasitsa added 10 commits September 20, 2021 14:48

First step: create saved_visualize_utils, starting use new get/save m…

277f7ae

…ethods

Use new util methods in embeddable

2424506

move findListItem in utils

cd3c1a9

some clean up

1560e50

clean up

7cd5973

Some fixes

cda436d

Merge remote-tracking branch 'upstream/master' into get_rid_of_saved_…

6bbcf88

…object_loader

Fix saved object tags

ab285e1

Some types fixes

58f3c58

Fix unit tests

7af8213

VladLasitsa mentioned this pull request Sep 27, 2021

Get rid of saved object loader #112635

Closed

VladLasitsa added 3 commits September 28, 2021 11:12

Clean up code

af5fa95

Add unit tests for new utils

facd0ad

Fix lint

e01d539

VladLasitsa requested review from alexwizp and flash1293 September 29, 2021 08:48

VladLasitsa added 3 commits September 29, 2021 18:12

Fix tagging

e916aaf

Add unit tests

196e3d0

Some fixes

c0c81e1

alexwizp reviewed Sep 30, 2021

View reviewed changes

src/plugins/visualizations/public/utils/saved_visualize_utils.ts Outdated Show resolved Hide resolved

alexwizp reviewed Sep 30, 2021

View reviewed changes

src/plugins/visualizations/public/utils/saved_visualize_utils.ts Outdated Show resolved Hide resolved

VladLasitsa added 3 commits September 30, 2021 17:46

Clean up code

733e4db

Fix lint

dd6d5e2

Fix types

c5d1dc1

Merge branch 'master' into get_rid_of_saved_object_loader

9197198

flash1293 reviewed Oct 1, 2021

View reviewed changes

src/plugins/visualizations/public/index.ts Outdated Show resolved Hide resolved

VladLasitsa added 2 commits October 1, 2021 17:13

put new methods in start contract

620dced

Fix imports

0debc03

VladLasitsa added the v8.0.0 label Oct 5, 2021

VladLasitsa requested review from flash1293, mbondyra and alexwizp October 5, 2021 14:06

alexwizp reviewed Oct 5, 2021

View reviewed changes

src/plugins/visualizations/public/types.ts Outdated Show resolved Hide resolved

alexwizp reviewed Oct 5, 2021

View reviewed changes

src/plugins/visualizations/public/utils/saved_visualize_utils.ts Outdated Show resolved Hide resolved

flash1293 marked this pull request as ready for review October 6, 2021 08:02

flash1293 requested a review from a team as a code owner October 6, 2021 08:02

Merge branch 'master' into get_rid_of_saved_object_loader

0522ded

VladLasitsa added the release_note:skip Skip the PR/issue when compiling release notes label Oct 6, 2021

Some clean up

bfd5947

flash1293 approved these changes Oct 7, 2021

View reviewed changes

src/plugins/visualize/public/application/utils/get_visualization_instance.test.ts Outdated Show resolved Hide resolved

src/plugins/visualizations/public/types.ts Outdated Show resolved Hide resolved

src/plugins/visualizations/public/plugin.ts Outdated Show resolved Hide resolved

kibanamachine and others added 3 commits October 7, 2021 03:56

Merge branch 'master' into get_rid_of_saved_object_loader

ff5463b

Fix nits

91b0e71

fix types

2679dca

VladLasitsa requested a review from alexwizp October 7, 2021 12:45

jportner reviewed Oct 10, 2021

View reviewed changes

jportner mentioned this pull request Oct 10, 2021

Legacy url conflict UI improvements #114172

Merged

Merge branch 'master' into get_rid_of_saved_object_loader

ca40c99

VladLasitsa merged commit 41c813b into elastic:master Oct 11, 2021

VladLasitsa mentioned this pull request Oct 11, 2021

[7.x] [Visualization] Get rid of saved object loader and use savedObjectClient resolve (#113121) #114442

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Visualization] Get rid of saved object loader and use savedObjectClient resolve #113121

[Visualization] Get rid of saved object loader and use savedObjectClient resolve #113121

VladLasitsa commented Sep 27, 2021 •

edited

Loading

VladLasitsa commented Sep 30, 2021

flash1293 left a comment

VladLasitsa commented Oct 1, 2021

elasticmachine commented Oct 6, 2021

flash1293 commented Oct 6, 2021

flash1293 commented Oct 6, 2021

flash1293 left a comment

VladLasitsa commented Oct 7, 2021

jportner Oct 10, 2021 •

edited

Loading

flash1293 commented Oct 10, 2021

kibanamachine commented Oct 10, 2021

API count

References to deprecated APIs

	if (sharingSavedObjectProps?.outcome === 'conflict' && this.deps.spaces) {
	const conflictError = {
	shortMessage: i18n.translate('xpack.lens.embeddable.legacyURLConflict.shortMessage', {
	defaultMessage: `You've encountered a URL conflict`,
	}),
	longMessage: (
	<this.deps.spaces.ui.components.getEmbeddableLegacyUrlConflict
	targetType={DOC_TYPE}
	sourceId={sharingSavedObjectProps.sourceId!}
	/>
	),
	};
	this.errors = this.errors ? [...this.errors, conflictError] : [conflictError];
	}

[Visualization] Get rid of saved object loader and use savedObjectClient resolve #113121

[Visualization] Get rid of saved object loader and use savedObjectClient resolve #113121

Conversation

VladLasitsa commented Sep 27, 2021 • edited Loading

Summary

VladLasitsa commented Sep 30, 2021

flash1293 left a comment

Choose a reason for hiding this comment

VladLasitsa commented Oct 1, 2021

elasticmachine commented Oct 6, 2021

flash1293 commented Oct 6, 2021

flash1293 commented Oct 6, 2021

flash1293 left a comment

Choose a reason for hiding this comment

VladLasitsa commented Oct 7, 2021

jportner Oct 10, 2021 • edited Loading

Choose a reason for hiding this comment

flash1293 commented Oct 10, 2021

kibanamachine commented Oct 10, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

References to deprecated APIs

History

VladLasitsa commented Sep 27, 2021 •

edited

Loading

jportner Oct 10, 2021 •

edited

Loading