Add embeddable via saved object example #61692

stacey-gammon · 2020-03-27T19:47:50Z

This PR:

Adds sample data when the Embeddable Explorer is run so users can see a saved object listed in the add panel flyout. There is a test for this functionality.
Changes container PanelState from

 { 
  type: string
  savedObjectId?: string
  explicitInput: {...}
 }

to

 { 
  type: string
  explicitInput: {
   savedObjectId?: string
  }
 }

Removes addSavedObjectEmbeddable from the container interface. Now the function addNewEmbeddable can be used for both use cases.

A follow up will be to remove the factory.createFromSavedObject function as that should not be needed anymore.

elasticmachine · 2020-03-27T19:47:54Z

Pinging @elastic/kibana-app-arch (Team:AppArch)

…bed-example-saved-object

streamich

Nice to see createFromSavedObject go away. PR LGTM, checked on Mac/Chrome.

examples/embeddable_examples/public/todo/todo_ref_embeddable_factory.tsx

…bed-example-saved-object

majagrubic

This is such a great change 🙌
I've tested this in Chrome 80 on Mac OS. I was focusing on the existing Dashboard flow - adding a new visualization, replacing a panel - works as expected.
Tested todo example - works well.

Left a few questions for my own understanding, but they shouldn't block merging this.

majagrubic · 2020-04-07T18:20:56Z

src/plugins/dashboard/public/application/dashboard_app_controller.tsx

              const type = $routeParams[DashboardConstants.ADD_EMBEDDABLE_TYPE];
              const id = $routeParams[DashboardConstants.ADD_EMBEDDABLE_ID];
-              container.addSavedObjectEmbeddable(type, id);
+              container.addNewEmbeddable<SavedObjectEmbeddableInput>(type, { savedObjectId: id });


majagrubic · 2020-04-07T18:21:31Z

src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx

  isFullScreenMode: boolean;
  panels: {
-    [panelId: string]: DashboardPanelState;
+    [panelId: string]: DashboardPanelState<EmbeddableInput & { [k: string]: unknown }>;


what is [k: string]?

it's the key in the object: { [key: string]: unknown} is how it's often written.

It means that panel state can hold EmbeddableInput or additional data. I don't know a way to type is so that it's based of panel.type and that panel.explicitInput is Partial<EmbeddableInputForType>. so that if you did something like:

const input: DashboardContainerInput = { panels: { '1': { type: 'fooEmbeddable', explicitInput: { 'foo': 'bar' // Typescript should make sure `FooEmbeddableInput` has a `foo` attribute! } } } }

I've kind of given up on improving types to that regard. Without this edit here, typescript would warn on the above, even if foo was on FooEmbeddableInput.

majagrubic · 2020-04-07T18:32:59Z

examples/embeddable_examples/public/todo/todo_ref_embeddable.tsx

+      // Since this is an expensive task, we save a local copy of the previous
+      // savedObjectId locally and only retrieve the new saved object if the id
+      // actually changed.
+      if (this.savedObjectId !== this.input.savedObjectId) {


in which scenario would this happen?

If any user of this embeddable called embeddable.updateInput({ savedObjectId: 'newId' }).

Embeddables should be prepared to react appropriately to any of its input data changing during its lifetime.

This could possibly happen also if dashboard had an embeddable like this and someone hand edited the url to change the id.

examples/embeddable_examples/public/todo/todo_ref_embeddable.tsx

…bed-example-saved-object

stacey-gammon · 2020-04-09T12:05:30Z

@ppisljar will you be able to review this week? If not, would you mind if I merged with the existing reviews, and you can take a look after the fact? I have more PRs blocked on this one.

…bed-example-saved-object

kibanamachine · 2020-04-15T13:53:36Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 8b7fe62

History

💚 Build #39624 succeeded 9cdadc6
💚 Build #39309 succeeded 6f4bed6
💔 Build #39263 failed 14ba7f1
💚 Build #38901 succeeded b28648e
💔 Build #38845 failed 9399676

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

* Add embeddable via saved object example * give todoRefEmbed a different name from the by value one * fix types * fix order of unmounting Co-authored-by: Christos Nasikas <christos.nasikas@elastic.co>

* Add embeddable via saved object example * give todoRefEmbed a different name from the by value one * fix types * fix order of unmounting Co-authored-by: Christos Nasikas <christos.nasikas@elastic.co> Co-authored-by: Christos Nasikas <christos.nasikas@elastic.co>

* Add embeddable via saved object example * give todoRefEmbed a different name from the by value one * fix types * fix order of unmounting Co-authored-by: Christos Nasikas <christos.nasikas@elastic.co>

botelastic bot added Feature:Embedding Embedding content via iFrame Team:AppArch labels Mar 27, 2020

stacey-gammon force-pushed the 2020-03-27-embed-example-saved-object branch 13 times, most recently from 88bc0ed to 5c6c42c Compare March 28, 2020 13:05

stacey-gammon marked this pull request as ready for review March 28, 2020 15:47

stacey-gammon requested a review from a team March 28, 2020 15:47

stacey-gammon requested a review from a team as a code owner March 28, 2020 15:47

stacey-gammon changed the title ~~[WIP] Add embeddable via saved object example~~ Add embeddable via saved object example Mar 28, 2020

stacey-gammon added v7.8.0 v8.0.0 release_note:skip Skip the PR/issue when compiling release notes labels Mar 28, 2020

stacey-gammon force-pushed the 2020-03-27-embed-example-saved-object branch from 5c6c42c to 0bd8979 Compare March 30, 2020 15:36

stacey-gammon added the review label Mar 30, 2020

stacey-gammon mentioned this pull request Mar 31, 2020

More saved object embeddable examples #61749

Closed

stacey-gammon closed this Mar 31, 2020

stacey-gammon reopened this Apr 3, 2020

stacey-gammon force-pushed the 2020-03-27-embed-example-saved-object branch 2 times, most recently from 4ef738e to e5efc6b Compare April 3, 2020 17:48

stacey-gammon force-pushed the 2020-03-27-embed-example-saved-object branch 4 times, most recently from b7ea965 to 683939a Compare April 3, 2020 19:39

Add embeddable via saved object example

fa8395b

stacey-gammon force-pushed the 2020-03-27-embed-example-saved-object branch from 683939a to fa8395b Compare April 3, 2020 21:08

stacey-gammon requested review from majagrubic, ppisljar and streamich April 3, 2020 22:49

Stacey Gammon added 2 commits April 6, 2020 09:13

Merge branch 'master' of github.com:elastic/kibana into 2020-03-27-em…

9399676

…bed-example-saved-object

Merge branch 'master' of github.com:elastic/kibana into 2020-03-27-em…

b28648e

…bed-example-saved-object

stacey-gammon mentioned this pull request Apr 6, 2020

[WIP] More embeddable saved object examples #62698

Closed

streamich approved these changes Apr 7, 2020

View reviewed changes

examples/embeddable_examples/public/todo/todo_ref_embeddable_factory.tsx Outdated Show resolved Hide resolved

Stacey Gammon added 3 commits April 7, 2020 10:11

give todoRefEmbed a different name from the by value one

4e4c84a

Merge branch 'master' of github.com:elastic/kibana into 2020-03-27-em…

14ba7f1

…bed-example-saved-object

fix types

6f4bed6

majagrubic approved these changes Apr 7, 2020

View reviewed changes

Stacey Gammon added 2 commits April 8, 2020 11:30

Merge branch 'master' of github.com:elastic/kibana into 2020-03-27-em…

2958793

…bed-example-saved-object

fix order of unmounting

9cdadc6

stacey-gammon mentioned this pull request Apr 8, 2020

[Embeddable] Dashboard by reference embeddable #52680

Closed

stacey-gammon mentioned this pull request Apr 9, 2020

Remove special handling of savedObjectId in embeddables and containers #63139

Closed

Merge branch 'master' of github.com:elastic/kibana into 2020-03-27-em…

8b7fe62

…bed-example-saved-object

stacey-gammon merged commit d040448 into elastic:master Apr 15, 2020

stacey-gammon mentioned this pull request Apr 15, 2020

[7.x] Add embeddable via saved object example (#61692) #63613

Merged

ThomThomson added a commit to ThomThomson/kibana that referenced this pull request Apr 16, 2020

small change to allow cloning to work with elastic#61692

1a7bb9d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add embeddable via saved object example #61692

Add embeddable via saved object example #61692

Uh oh!

stacey-gammon commented Mar 27, 2020 •

edited

Loading

Uh oh!

elasticmachine commented Mar 27, 2020

Uh oh!

streamich left a comment

Uh oh!

Uh oh!

majagrubic left a comment •

edited

Loading

Uh oh!

majagrubic Apr 7, 2020

Uh oh!

majagrubic Apr 7, 2020

Uh oh!

stacey-gammon Apr 8, 2020

Uh oh!

majagrubic Apr 7, 2020

Uh oh!

stacey-gammon Apr 8, 2020

Uh oh!

Uh oh!

stacey-gammon commented Apr 9, 2020

Uh oh!

kibanamachine commented Apr 15, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Add embeddable via saved object example #61692

Add embeddable via saved object example #61692

Uh oh!

Conversation

stacey-gammon commented Mar 27, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elasticmachine commented Mar 27, 2020

Uh oh!

streamich left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

majagrubic left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

majagrubic Apr 7, 2020

Choose a reason for hiding this comment

Uh oh!

majagrubic Apr 7, 2020

Choose a reason for hiding this comment

Uh oh!

stacey-gammon Apr 8, 2020

Choose a reason for hiding this comment

Uh oh!

majagrubic Apr 7, 2020

Choose a reason for hiding this comment

Uh oh!

stacey-gammon Apr 8, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stacey-gammon commented Apr 9, 2020

Uh oh!

kibanamachine commented Apr 15, 2020

💚 Build Succeeded

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

stacey-gammon commented Mar 27, 2020 •

edited

Loading

majagrubic left a comment •

edited

Loading