Add SO import hook / warnings API by pgayvallet · Pull Request #87996 · elastic/kibana

pgayvallet · 2021-01-12T11:05:20Z

Summary

This PR adds hook support to SO imports. Type owners can now register an import hook using the new SavedObjectType.onImport property when registering their type via registerType.

The import hooks currently only support a single feature: returning import warnings that will be displayed to the user when the import succeeds.

API usage example

public setup(core: CoreSetup, plugins: SetupDeps) {
  core.savedObjects.registerType({
    name: 'my_type',
    hidden: false,
    namespaceType: 'single',
    mappings: { /* [...] */ },
    management: {
        importableAndExportable: true,
        onImport: async (objects) => {
          if(await someActionIsNeeded(objects)) {
            return {
              warnings: [
                { type: 'simple', message: 'Just some basic warning about the import' },
                {
                  type: 'action_required',
                  message: 'Alerts have been imported, but are disabled',
                  actionUrl: '/app/dashboards?foo=bar',
                  buttonLabel: 'Enabled here',
                },
              ],
            };
          }
          return {};
      },
      // [...]
    },
  });

  return {};
}

Screenshots

How to test

I personally used this diff to add warnings to dashboards during testing

Index: src/plugins/dashboard/server/plugin.ts
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/src/plugins/dashboard/server/plugin.ts b/src/plugins/dashboard/server/plugin.ts
--- a/src/plugins/dashboard/server/plugin.ts	(revision 0ba9aea5f2aa9b7afe885a2bd364610656db8376)
+++ b/src/plugins/dashboard/server/plugin.ts	(date 1610725322281)
@@ -49,13 +49,30 @@
   public setup(core: CoreSetup, plugins: SetupDeps) {
     this.logger.debug('dashboard: Setup');
 
-    core.savedObjects.registerType(
-      createDashboardSavedObjectType({
-        migrationDeps: {
-          embeddable: plugins.embeddable,
+    const dashboardType = createDashboardSavedObjectType({
+      migrationDeps: {
+        embeddable: plugins.embeddable,
+      },
+    });
+    core.savedObjects.registerType({
+      ...dashboardType,
+      management: {
+        ...dashboardType.management,
+        onImport: (dashboards) => {
+          return {
+            warnings: [
+              { type: 'simple', message: 'Just some basic warning about the import' },
+              {
+                type: 'action_required',
+                message: 'Alerts have been imported, but are disabled',
+                actionPath: '/app/dashboards?foo=bar',
+                buttonLabel: 'Enable here',
+              },
+            ],
+          };
         },
-      })
-    );
+      },
+    });
     core.capabilities.registerProvider(capabilitiesProvider);
 
     registerDashboardUsageCollector(plugins.usageCollection, plugins.embeddable);

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

…rt-warnings

elasticmachine · 2021-01-14T14:02:54Z

Pinging @elastic/kibana-core (Team:Core)

…rt-warnings

src/core/server/saved_objects/import/saved_objects_importer.ts

mikecote

I tested the functionality in the context of alerting's needs and LGTM 👍

azasypkin

Changes in Spaces plugin tests LGTM and Copy to Space API/UI can be updated in a follow-up.

…rt-warnings

joshdover

Very little to add here. Follows a similar structure to #87807 so it's quite easy to follow. Let's make sure to track Alerting's and SIEM's integration with this once these two PRs are merged.

joshdover · 2021-01-20T11:46:56Z

src/core/server/saved_objects/import/types.ts

+  /** The path (without the basePath) that the user should be redirect to to address this warning. */
+  actionUrl: string;


Should we name this actionPath instead of URL to make this more clear that it should be an in-app path and cannot be an external URL?

…rt-warnings

kibanamachine · 2021-01-20T18:20:08Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 1717c3e

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
`savedObjectsManagement`	190.6KB	192.9KB	+2.3KB

Page load bundle

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

id	before	after	diff
`core`	562.3KB	563.6KB	+1.3KB
`savedObjectsManagement`	72.0KB	72.0KB	+33.0B
total			+1.3KB

History

💚 Build #100009 succeeded 6d999f3
💚 Build #99874 succeeded 09a4b51
💚 Build #99085 succeeded a46740d
💔 Build #99052 failed 5e699b1
💚 Build #98797 succeeded 85709cb

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

* initial commit * adapt client-side signatures * more type fixes * adapt api IT asserts * fix some unit tests * fix more test usages * fix integration tests * fix FT test assertions * fix FT test assertions * add FTR API integ test suite * create the plugin_api_integration test suite * adapt and fix flyout tests * update documentation * update generated doc * add unit tests for `executeImportHooks` * wire resolve_import_errors and add unit tests * move hooks registration to SO type API * update generated doc * design integration * update generated doc * Add FTR tests for import warnings * deletes plugins api integ tests * self review * move onImport to management definition * update license header * rename actionUrl to actionPath

Fix merge conflicts from elastic#87996.

* initial commit * adapt client-side signatures * more type fixes * adapt api IT asserts * fix some unit tests * fix more test usages * fix integration tests * fix FT test assertions * fix FT test assertions * add FTR API integ test suite * create the plugin_api_integration test suite * adapt and fix flyout tests * update documentation * update generated doc * add unit tests for `executeImportHooks` * wire resolve_import_errors and add unit tests * move hooks registration to SO type API * update generated doc * design integration * update generated doc * Add FTR tests for import warnings * deletes plugins api integ tests * self review * move onImport to management definition * update license header * rename actionUrl to actionPath

initial commit

87d3f79

pgayvallet mentioned this pull request Jan 12, 2021

Saved-object import warnings #84977

Closed

pgayvallet added Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// v7.12.0 v8.0.0 labels Jan 12, 2021

pgayvallet added 23 commits January 12, 2021 12:30

adapt client-side signatures

71563ec

more type fixes

5797031

adapt api IT asserts

c3c5c93

fix some unit tests

f1f3c6d

fix more test usages

5f7218f

fix integration tests

fd5dbee

fix FT test assertions

d23bc86

fix FT test assertions

5882f16

add FTR API integ test suite

a604701

create the plugin_api_integration test suite

e663d8c

Merge remote-tracking branch 'upstream/master' into kbn-84977-so-impo…

c518903

…rt-warnings

adapt and fix flyout tests

bd36869

update documentation

6cb90fd

update generated doc

73d08df

add unit tests for executeImportHooks

8b6d82b

wire resolve_import_errors and add unit tests

ab0f7b2

move hooks registration to SO type API

c385889

update generated doc

7ba9973

design integration

ed0ca1f

update generated doc

9c6db93

Add FTR tests for import warnings

8a50aeb

deletes plugins api integ tests

736f62d

Merge remote-tracking branch 'upstream/master' into kbn-84977-so-impo…

8c6686b

…rt-warnings

pgayvallet marked this pull request as ready for review January 14, 2021 14:02

pgayvallet requested review from a team as code owners January 14, 2021 14:02

pgayvallet requested review from mdefazio and mikecote January 14, 2021 14:03

pgayvallet mentioned this pull request Jan 15, 2021

add SavedObject export hooks #87807

Merged

2 tasks

pgayvallet added 3 commits January 15, 2021 09:27

Merge remote-tracking branch 'upstream/master' into kbn-84977-so-impo…

7654d54

…rt-warnings

move onImport to management definition

5e699b1

Merge remote-tracking branch 'upstream/master' into kbn-84977-so-impo…

a46740d

…rt-warnings

mikecote reviewed Jan 15, 2021

View reviewed changes

src/core/server/saved_objects/import/saved_objects_importer.ts Show resolved Hide resolved

mikecote approved these changes Jan 15, 2021

View reviewed changes

azasypkin approved these changes Jan 18, 2021

View reviewed changes

pgayvallet requested review from joshdover and rudolf January 18, 2021 15:35

pgayvallet added 2 commits January 20, 2021 08:22

Merge remote-tracking branch 'upstream/master' into kbn-84977-so-impo…

9d0d647

…rt-warnings

update license header

09a4b51

joshdover approved these changes Jan 20, 2021

View reviewed changes

rudolf approved these changes Jan 20, 2021

View reviewed changes

pgayvallet added 3 commits January 20, 2021 15:12

Merge remote-tracking branch 'upstream/master' into kbn-84977-so-impo…

e759c12

…rt-warnings

rename actionUrl to actionPath

6d999f3

Merge remote-tracking branch 'upstream/master' into kbn-84977-so-impo…

1717c3e

…rt-warnings

pgayvallet merged commit edb338a into elastic:master Jan 20, 2021

pgayvallet mentioned this pull request Jan 20, 2021

[7.x] Add SO import hook / warnings API (#87996) #88887

Merged

jportner added a commit to jportner/kibana that referenced this pull request Jan 20, 2021

Merge branch 'master' into pr/jportner/80945

0b934ca

Fix merge conflicts from elastic#87996.

ymao1 mentioned this pull request Mar 9, 2021

[Alerting][Connectors] Import rules and connectors #94152

Closed

rudolf mentioned this pull request Jun 30, 2022

[saved objects] Create RFC for referencing user profiles from SOs #134595

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SO import hook / warnings API#87996

Add SO import hook / warnings API#87996
pgayvallet merged 33 commits intoelastic:masterfrom
pgayvallet:kbn-84977-so-import-warnings

pgayvallet commented Jan 12, 2021 •

edited

Loading

Uh oh!

elasticmachine commented Jan 14, 2021

Uh oh!

Uh oh!

mikecote left a comment

Uh oh!

azasypkin left a comment

Uh oh!

joshdover left a comment

Uh oh!

joshdover Jan 20, 2021

Uh oh!

kibanamachine commented Jan 20, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

		/** The path (without the basePath) that the user should be redirect to to address this warning. */
		actionUrl: string;

Conversation

pgayvallet commented Jan 12, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

API usage example

Screenshots

How to test

Checklist

Uh oh!

elasticmachine commented Jan 14, 2021

Uh oh!

Uh oh!

mikecote left a comment

Choose a reason for hiding this comment

Uh oh!

azasypkin left a comment

Choose a reason for hiding this comment

Uh oh!

joshdover left a comment

Choose a reason for hiding this comment

Uh oh!

joshdover Jan 20, 2021

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented Jan 20, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

pgayvallet commented Jan 12, 2021 •

edited

Loading