[Dashboard First] Unlink from Library Action With ReferenceOrValueEmbeddable #74905

ThomThomson · 2020-08-12T21:14:57Z

Summary

Counterpart / Opposite of #75098

Adds an embeddable panel action to unlink by reference embeddables from their library item, turning them into by value embeddables. This action should work with any embeddable that implements the ReferenceOrValueEmbeddable interface from #74302.

How to test this?

This is just one part of a much larger change, so all changes in this PR are hidden behind a configuration value. In order for the 'by value' workflow to be made default, some architectural changes need to be completed including #67931, #71499, and #61663

you'll need to set the allowByValueEmbeddables config value to true:

kibana/src/plugins/dashboard/config.ts

Line 23 in 5b64a4c

allowByValueEmbeddables: schema.boolean({ defaultValue: false }),
There are no production ready embeddables that implement the ReferenceOrValueEmbeddable yet so you will have to start the developer examples. yarn start --run-examples
Open a dashboard, and use the add panels functionality to add a Book embeddable. You should be able to then unlink it from its library item.

Checklist

Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

…tic#73870 to show the option

…kFromLibraryAction2

elastic#73870

…can be treated as either by reference or by value

…tions to test the referenceOrValueEmbeddable interface.

…enceOrvalueInterface

…omson/kibana into feature/unlinkFromLibraryAction2

…kFromLibraryAction2

… interface

…kFromLibraryActionWithInterface

elasticmachine · 2020-08-13T16:31:31Z

Pinging @elastic/kibana-app (Team:KibanaApp)

majagrubic · 2020-08-14T09:13:09Z

examples/embeddable_examples/public/book/book_embeddable.tsx

@@ -103,7 +104,12 @@ export class BookEmbeddable extends Embeddable<BookEmbeddableInput, BookEmbeddab
  };

  getInputAsValueType = async (): Promise<BookByValueInput> => {
-    return this.attributeService.getInputAsValueType(this.input);
+    const input =


can we simplify this statement a bit?

I realized that getting the explicitInput of an embeddable will be a common enough task.
The reason this is needed is so that the 'unlink' or 'add' actions don't make inherited input into explicit input.

I added a helper to the attribute service in the add to library PR #75098.:

kibana/src/plugins/dashboard/public/attribute_service/attribute_service.tsx

Lines 126 to 133 in b41eae8

public getExplicitInputFromEmbeddable(embeddable: IEmbeddable): ValType | RefType {

return embeddable.getRoot() &&

(embeddable.getRoot() as Container).getInput().panels[embeddable.id].explicitInput

? ((embeddable.getRoot() as Container).getInput().panels[embeddable.id].explicitInput as

| ValType

| RefType)

: (embeddable.getInput() as ValType | RefType);

}

It can be simplified a little bit with optional chaining, and I will update it to reflect that over there.

majagrubic

I tested this according to instructions and can confirm adding and removing from library works as expected. Love the unit test with different scenarios, which make it very easy to follow the expected flow.

Two questions:

If the panel is "by value", why is it still showing in the list of panels when adding a new panel? It shouldn't live outside of the dashboard, right?
What happens if we save two panels with the same title? Eg:

I have a panel, it's by value
I clone it -> clone is by value
I add an original to the library -> works as expected
I add a clone to the library -> this works
We normally don't allow saving two visualizations with the same name. Is this just an example that works like this? Or will this be an expected flow from now on?

src/plugins/dashboard/public/application/actions/unlink_from_library_action.test.tsx

majagrubic · 2020-08-14T09:28:00Z

src/plugins/dashboard/public/application/actions/unlink_from_library_action.tsx

+      type: embeddable.type,
+      explicitInput: { ...newInput, id: uuid.v4() },
+    };
+    dashboard.replacePanel(panelToReplace, newPanel);


not related to this PR, but really shows how much we need an updatePanel rather than replacePanel functionality 😞

I absolutely agree, fingers crossed that this #74253 will handle it.

ThomThomson · 2020-08-14T21:57:58Z

@elasticmachine merge upstream

ppisljar

code LGTM

…kFromLibraryActionWithInterface

ThomThomson · 2020-08-17T17:10:08Z

Answers to the above questions from @majagrubic

If the panel is "by value", why is it still showing in the list of panels when adding a new panel?
This action is an unlink from library action, it does not remove the saved object. After un-linking, the saved object still exists, and it will show up in the library, but any edits to the by value version that is now on the dashboard will not affect the original library item because the link has been broken. With this functionality the library can almost become a home for 'templates'
What happens if we save two panels with the same title?
This is a little bit confusing, because we're testing this with the book_embeddable. The Book Embeddable has an 'add book to library action'. which (in this PR) doesn't have duplicate detection. Additionally, the 'add book to library' action only works on books, and is supposed to be used in the example plugins. In the Add to Library PR, [Dashboard First] Add to Library Action #75098 the action does come with duplicate detection (via the attribute service)

kibanamachine · 2020-08-17T19:05:39Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 1060914

Build metrics

@kbn/optimizer bundle module count

id	value	diff	baseline
dashboard	175	+1	174

page load bundle size

id	value	diff	baseline
dashboard	694.6KB	+6.9KB	687.7KB

History

💚 Build #68520 succeeded 21c7e03
💚 Build #68255 succeeded 5798261
💚 Build #67933 succeeded 37cca10
💔 Build #67812 failed f8a672d139c5afbfdde1d18ca945d12d788fd26d
💔 Build #67802 failed 73c1cdd

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

majagrubic

Looks and works great!

…eddable (elastic#74905) * Added an unlink from library action which works with the ReferenceOrValue interface. Once

* master: Skip failing test in CI (elastic#75266) [Task Manager] time out work when it overruns in poller (elastic#74980) [Drilldowns] misc improvements & fixes (elastic#75276) Small README note on bumping memory for builds (elastic#75247) [Security Solution][Detections] Adds exception modal tests (elastic#74596) [Dashboard] Sample data link does not work (elastic#75262) [Dashboard First] Unlink from Library Action With ReferenceOrValueEmbeddable (elastic#74905) [Form lib] Fix issue where serializer on fields are called on every change (elastic#75166) convert processor labels to sentence case (elastic#75278) [Monaco] Refactor the way XJSON grammar checker gets registered (elastic#75160) Clarify no documents error message when filtering by is_training (elastic#75227) [Lens] Fix crash when two layers xychart switches to pie (elastic#75267) [Observability Homepage] Fix console error because of side effect (elastic#75258) [Usage Collection] Add `legacy=true` option to the /api/stats request in the docs (elastic#75146) [ML] Functional tests - re-activate DFA test suites (elastic#75257) GS providers improvements (elastic#75174) [Visualize] First version of by-value visualize editor (elastic#72256)

…eddable (#74905) (#75305) * Added an unlink from library action which works with the ReferenceOrValue interface. Once

…emove-header * saved-objects/version-on-create: (59 commits) remove version when loading sample data omit version from SO import/export Skip failing test in CI (elastic#75266) [Task Manager] time out work when it overruns in poller (elastic#74980) [Drilldowns] misc improvements & fixes (elastic#75276) Small README note on bumping memory for builds (elastic#75247) [Security Solution][Detections] Adds exception modal tests (elastic#74596) Revert "Revert "added missing core docs"" Revert "Revert "added version to saved object bulk creation"" [Dashboard] Sample data link does not work (elastic#75262) [Dashboard First] Unlink from Library Action With ReferenceOrValueEmbeddable (elastic#74905) [Form lib] Fix issue where serializer on fields are called on every change (elastic#75166) convert processor labels to sentence case (elastic#75278) [Monaco] Refactor the way XJSON grammar checker gets registered (elastic#75160) Clarify no documents error message when filtering by is_training (elastic#75227) [Lens] Fix crash when two layers xychart switches to pie (elastic#75267) [Observability Homepage] Fix console error because of side effect (elastic#75258) [Usage Collection] Add `legacy=true` option to the /api/stats request in the docs (elastic#75146) [ML] Functional tests - re-activate DFA test suites (elastic#75257) GS providers improvements (elastic#75174) ...

ThomThomson added 17 commits July 30, 2020 17:57

Got unlink action working properly. TODO: Use config option from elas…

b3c450d

…tic#73870 to show the option

Merge branch 'master' of github.com:elastic/kibana into feature/unlin…

77a7e94

…kFromLibraryAction2

fixed prettier, added more tests. Hid unlink action behind setting from

171268b

elastic#73870

Added a first pass for an interface that determines if an embeddable …

14dcd6a

…can be treated as either by reference or by value

type fix

6ba38d0

Moved attributeservice to dashboard plugin. Created add and unlink ac…

d21daef

…tions to test the referenceOrValueEmbeddable interface.

Merge branch 'master' of github.com:elastic/kibana into example/refer…

e8abb12

…enceOrvalueInterface

type fix

19b2bc0

Merge branch 'master' of github.com:elastic/kibana into example/refer…

98f3e56

…enceOrvalueInterface

Added error handling to the attribute_service save methods

230341d

Merge branch 'master' of github.com:elastic/kibana into example/refer…

3586923

…enceOrvalueInterface

Sorted out title issue

ed0cb93

Merge branch 'example/referenceOrvalueInterface' of github.com:ThomTh…

f01c5ac

…omson/kibana into feature/unlinkFromLibraryAction2

Merge branch 'master' of github.com:elastic/kibana into feature/unlin…

f2727aa

…kFromLibraryAction2

Upgraded unlink from library action to work with the ReferenceOrValue…

0ac821c

… interface

Upgraded unlink from library action to work with the ReferenceOrValue…

957b7d3

… interface

Merge branch 'master' of github.com:elastic/kibana into feature/unlin…

73c1cdd

…kFromLibraryActionWithInterface

ThomThomson added Feature:Dashboard Dashboard related features release_note:roadmap Team:Visualizations Visualization editors, elastic-charts and infrastructure v8.0.0 v7.10.0 labels Aug 12, 2020

ThomThomson mentioned this pull request Aug 12, 2020

[Dashboard First] Unlink from Library Action #73899

Closed

4 tasks

type fix

37cca10

ThomThomson force-pushed the feature/unlinkFromLibraryActionWithInterface branch from f8a672d to 37cca10 Compare August 13, 2020 14:35

ThomThomson marked this pull request as ready for review August 13, 2020 16:31

ThomThomson requested a review from a team August 13, 2020 16:31

ThomThomson requested a review from a team as a code owner August 13, 2020 16:31

majagrubic reviewed Aug 14, 2020

View reviewed changes

botelastic bot added the Feature:Embedding Embedding content via iFrame label Aug 14, 2020

majagrubic reviewed Aug 14, 2020

View reviewed changes

Merge branch 'master' into feature/unlinkFromLibraryActionWithInterface

5798261

ThomThomson mentioned this pull request Aug 14, 2020

[Dashboard First] Add to Library Action #75098

Merged

2 tasks

ppisljar approved these changes Aug 17, 2020

View reviewed changes

Merge branch 'master' of github.com:elastic/kibana into feature/unlin…

21c7e03

…kFromLibraryActionWithInterface

small cleanup

1060914

majagrubic approved these changes Aug 18, 2020

View reviewed changes

ThomThomson merged commit 2af2b60 into elastic:master Aug 18, 2020

ThomThomson mentioned this pull request Aug 18, 2020

[7.x] [Dashboard First] Unlink from Library Action With ReferenceOrValueEmbeddable (#74905) #75305

Merged

ThomThomson added a commit that referenced this pull request Aug 18, 2020

[Dashboard First] Unlink from Library Action With ReferenceOrValueEmb…

a20de8e

…eddable (#74905) (#75305) * Added an unlink from library action which works with the ReferenceOrValue interface. Once

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Dashboard First] Unlink from Library Action With ReferenceOrValueEmbeddable #74905

[Dashboard First] Unlink from Library Action With ReferenceOrValueEmbeddable #74905

ThomThomson commented Aug 12, 2020 •

edited

Loading

elasticmachine commented Aug 13, 2020

majagrubic Aug 14, 2020

ThomThomson Aug 17, 2020

majagrubic left a comment

majagrubic Aug 14, 2020

ThomThomson Aug 17, 2020

ThomThomson commented Aug 14, 2020

ppisljar left a comment

ThomThomson commented Aug 17, 2020

kibanamachine commented Aug 17, 2020

majagrubic left a comment

	public getExplicitInputFromEmbeddable(embeddable: IEmbeddable): ValType \| RefType {
	return embeddable.getRoot() &&
	(embeddable.getRoot() as Container).getInput().panels[embeddable.id].explicitInput
	? ((embeddable.getRoot() as Container).getInput().panels[embeddable.id].explicitInput as
	\| ValType
	\| RefType)
	: (embeddable.getInput() as ValType \| RefType);
	}

[Dashboard First] Unlink from Library Action With ReferenceOrValueEmbeddable #74905

[Dashboard First] Unlink from Library Action With ReferenceOrValueEmbeddable #74905

Conversation

ThomThomson commented Aug 12, 2020 • edited Loading

Summary

How to test this?

Checklist

For maintainers

elasticmachine commented Aug 13, 2020

majagrubic Aug 14, 2020

Choose a reason for hiding this comment

ThomThomson Aug 17, 2020

Choose a reason for hiding this comment

majagrubic left a comment

Choose a reason for hiding this comment

majagrubic Aug 14, 2020

Choose a reason for hiding this comment

ThomThomson Aug 17, 2020

Choose a reason for hiding this comment

ThomThomson commented Aug 14, 2020

ppisljar left a comment

Choose a reason for hiding this comment

ThomThomson commented Aug 17, 2020

kibanamachine commented Aug 17, 2020

💚 Build Succeeded

Build metrics

@kbn/optimizer bundle module count

page load bundle size

History

majagrubic left a comment

Choose a reason for hiding this comment

ThomThomson commented Aug 12, 2020 •

edited

Loading