SavedObjects bulkCreate API should return migrationVersion and strip the type & namespace from the id #65150

rudolf · 2020-05-04T19:08:13Z

Summary

Release notes

When bulk creating saved objects without specifying the id's of the objects to be created, the SavedObjectsClient Javascript API and HTTP API incorrectly returned the raw id in the response. In addition, these API's also didn't return the migrationVersion property of the saved objects that were bulk created. This fix ensures that a valid saved object id and the migrationVersion property are returned in the bulk create response.

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
This was checked for keyboard-only and screenreader accessibility
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser
This was checked for cross-browser compatibility, including a check against IE11

For maintainers

This was checked for breaking API changes and was labeled appropriately

elasticmachine · 2020-05-04T19:08:38Z

Pinging @elastic/kibana-platform (Team:Platform)

rudolf · 2020-05-05T20:00:04Z

test/api_integration/apis/saved_objects/bulk_create.js

@@ -72,6 +72,9 @@ export default function({ getService }) {
                  attributes: {
                    title: 'A great new dashboard',
                  },
+                  migrationVersion: {
+                    dashboard: resp.body.saved_objects[1].migrationVersion.dashboard,


This value will change anytime a new dashboard migration is added. This seems like the best workaround when using kbn-expect to prevent tests from failing anytime a new dashboard migration is added.

We should probably "modernize" these integration tests, but it felt like it's not enough of a priority to attempt this right now.

Yea, having jest toolbox for FTR tests would we really great. kbn-expect feels very old when compared to jest.

pgayvallet · 2020-05-06T08:28:30Z

test/api_integration/apis/saved_objects/bulk_create.js

@@ -72,6 +72,9 @@ export default function({ getService }) {
                  attributes: {
                    title: 'A great new dashboard',
                  },
+                  migrationVersion: {
+                    dashboard: resp.body.saved_objects[1].migrationVersion.dashboard,


Yea, having jest toolbox for FTR tests would we really great. kbn-expect feels very old when compared to jest.

src/core/server/saved_objects/service/lib/repository.ts

src/core/server/saved_objects/service/lib/repository.test.js

test/api_integration/apis/saved_objects/bulk_create.js

… explicit

…e-ids

src/core/server/saved_objects/service/lib/repository.test.js

x-pack/plugins/spaces/server/lib/copy_to_spaces/copy_to_spaces.test.ts

src/core/server/saved_objects/service/lib/repository.test.js

This reverts commit 9c2b743.

jportner

LGTM!

pgayvallet · 2020-05-07T21:33:22Z

src/core/server/saved_objects/service/lib/repository.test.js

+        expect(result.saved_objects[0].id).toEqual(
+          expect.not.stringMatching(/config|index-pattern|myspace/)
+        );
+        expect(result.saved_objects[1].id).toEqual(
+          expect.not.stringMatching(/config|index-pattern|myspace/)
+        );


Can't we use the uuid regexp ([0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}) as done L828 instead of asserting against the names of the types/spaces used in the test suite? I think that's a little more explicit?

obj2's id is logstash-* so I initially thought I'll try to keep these assertions the same. But I agree, a uuid regexp would be better, so I'll change the first match to use a regexp and the second match to match obj2.id.

src/core/server/saved_objects/service/lib/repository.ts

…the type & namespace from the id (elastic#65150) * Deserialize bulkCreate response to remove namespace type from id * Index operations don't return _source in response * Fix integration tests * repository: make id generation and seq_no/primary_term spreading more explicit * API Integration test for bulk create without ids * Fix copy_to_space snapshot * Revert "Fix copy_to_space snapshot" This reverts commit 9c2b743. * Move test into returns block * repository.test.js stricter regexp matching

…or-part-mvp-2 * 'master' of github.com:elastic/kibana: (259 commits) SavedObjects bulkCreate API should return migrationVersion and strip the type & namespace from the id (elastic#65150) Drilldown count tooltip (elastic#65105) plugins logs start with "plugins." prefix (elastic#65710) [ML] Fix pagination reset on search query update. (elastic#65668) [SIEM] Add types to the mappings objects so extra keys cannot be introduced [apm] Update machine learning flyout and service maps docs (elastic#65517) change api endpoint and throw error (elastic#65790) [Maps] remove SLA percentage metric (elastic#65718) [Reporting] APM integration for baseline performance measurements (elastic#59967) fix(NA): noParse regex for windows on kbn optimizer (elastic#65755) [ML] DFA: ensure at least one field is included in analysis before job can be created (elastic#65320) [Data plugin] cleanup - remove unused getRoutes / routes from indexPattern object (elastic#65683) Removed skip to enable test. (elastic#65575) [Lens] Type safe migrations (elastic#65576) [Canvas] Fix nav link behavior in Canvas (elastic#65590) [Event log] Fix flaky test (elastic#65658) [Alerting] changes preconfigured actions config from array to object (elastic#65397) remove immediate functions from esqueue worker cycles (elastic#65375) [Metrics UI] Fix isAbove to only display when threshold set (elastic#65540) draft search profiler accessibility tests (elastic#62357) ... # Conflicts: # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx

kibanamachine · 2020-05-08T10:02:20Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 5b4aa22

History

💚 Build #46465 succeeded 36356ab
💔 Build #46433 failed 5a729ba
💔 Build #46275 failed 40fc21e
💚 Build #45692 succeeded ecdaf68
💔 Build #45478 failed 9a41cd8

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

…the type & namespace from the id (#65150) (#65819) * Deserialize bulkCreate response to remove namespace type from id * Index operations don't return _source in response * Fix integration tests * repository: make id generation and seq_no/primary_term spreading more explicit * API Integration test for bulk create without ids * Fix copy_to_space snapshot * Revert "Fix copy_to_space snapshot" This reverts commit 9c2b743. * Move test into returns block * repository.test.js stricter regexp matching

…the type & namespace from the id (#65150) (#65820) * Deserialize bulkCreate response to remove namespace type from id * Index operations don't return _source in response * Fix integration tests * repository: make id generation and seq_no/primary_term spreading more explicit * API Integration test for bulk create without ids * Fix copy_to_space snapshot * Revert "Fix copy_to_space snapshot" This reverts commit 9c2b743. * Move test into returns block * repository.test.js stricter regexp matching

Deserialize bulkCreate response to remove namespace type from id

5935fe3

rudolf added bug Fixes for quality problems that affect the customer experience Feature:Saved Objects Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc labels May 4, 2020

rudolf added v7.8.0 v8.0.0 labels May 4, 2020

rudolf added the release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. label May 4, 2020

rudolf added 3 commits May 5, 2020 13:00

Index operations don't return _source in response

9a41cd8

Merge branch 'master' into so-bulk-create-ids

17a4cdd

Fix integration tests

ecdaf68

rudolf commented May 5, 2020

View reviewed changes

rudolf marked this pull request as ready for review May 5, 2020 20:26

rudolf requested a review from a team as a code owner May 5, 2020 20:26

pgayvallet reviewed May 6, 2020

View reviewed changes

rudolf added 3 commits May 7, 2020 14:16

repository: make id generation and seq_no/primary_term spreading more…

ccaa1c1

… explicit

API Integration test for bulk create without ids

d20949b

Merge branch 'master' into so-bulk-create-ids

40fc21e

rudolf requested a review from pgayvallet May 7, 2020 12:26

rudolf added 2 commits May 7, 2020 21:05

Fix copy_to_space snapshot

9c2b743

Merge branch 'master' of github.com:elastic/kibana into so-bulk-creat…

5a729ba

…e-ids

rudolf requested a review from a team as a code owner May 7, 2020 19:06

jportner self-assigned this May 7, 2020

jportner reviewed May 7, 2020

View reviewed changes

src/core/server/saved_objects/service/lib/repository.test.js Outdated Show resolved Hide resolved

x-pack/plugins/spaces/server/lib/copy_to_spaces/copy_to_spaces.test.ts Outdated Show resolved Hide resolved

src/core/server/saved_objects/service/lib/repository.test.js Show resolved Hide resolved

rudolf added 2 commits May 7, 2020 22:46

Revert "Fix copy_to_space snapshot"

e12c542

This reverts commit 9c2b743.

Move test into returns block

36356ab

jportner approved these changes May 7, 2020

View reviewed changes

rudolf added release_note:fix and removed release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. labels May 7, 2020

rudolf changed the title ~~Deserialize bulkCreate response to remove namespace type from id~~ SavedObjects bulkCreate API should return migrationVersion and strip the type & namespace from the id May 7, 2020

pgayvallet approved these changes May 7, 2020

View reviewed changes

repository.test.js stricter regexp matching

5b4aa22

rudolf merged commit 1baf0b0 into elastic:master May 8, 2020

rudolf deleted the so-bulk-create-ids branch May 8, 2020 08:08

This was referenced May 8, 2020

[7.x] SavedObjects bulkCreate API should return migrationVersion and strip the type & namespace from the id (#65150) #65819

Merged

[7.8] SavedObjects bulkCreate API should return migrationVersion and strip the type & namespace from the id (#65150) #65820

Merged

rudolf mentioned this pull request Jul 2, 2020

Search across spaces #67644

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SavedObjects bulkCreate API should return migrationVersion and strip the type & namespace from the id #65150

SavedObjects bulkCreate API should return migrationVersion and strip the type & namespace from the id #65150

rudolf commented May 4, 2020 •

edited

Loading

elasticmachine commented May 4, 2020

rudolf May 5, 2020

pgayvallet May 6, 2020

pgayvallet May 6, 2020

jportner left a comment

pgayvallet May 7, 2020

rudolf May 8, 2020 •

edited

Loading

kibanamachine commented May 8, 2020

SavedObjects bulkCreate API should return migrationVersion and strip the type & namespace from the id #65150

SavedObjects bulkCreate API should return migrationVersion and strip the type & namespace from the id #65150

Conversation

rudolf commented May 4, 2020 • edited Loading

Summary

Release notes

Checklist

For maintainers

elasticmachine commented May 4, 2020

rudolf May 5, 2020

Choose a reason for hiding this comment

pgayvallet May 6, 2020

Choose a reason for hiding this comment

pgayvallet May 6, 2020

Choose a reason for hiding this comment

jportner left a comment

Choose a reason for hiding this comment

pgayvallet May 7, 2020

Choose a reason for hiding this comment

rudolf May 8, 2020 • edited Loading

Choose a reason for hiding this comment

kibanamachine commented May 8, 2020

💚 Build Succeeded

History

rudolf commented May 4, 2020 •

edited

Loading

rudolf May 8, 2020 •

edited

Loading