Add test for detecting new and removed SO types #104507

joshdover · 2021-07-06T17:08:19Z

Summary

This adds a test that checks that any first-party SO types that are removed are added to our query for documents that should be removed on the next upgrade. In the future, we may explore automating this by only migrating known document types or adding a dedicated API (#104246).

I ran this test against 7.8+ to find any types that have been removed since then and I found these 5 types and added them to the query so they will be filtered out on subsequent upgrades:

apm-services-telemetry
background-session
cases-sub-case
file-upload-telemetry
ml-telemetry

This needs to be backported to 7.14 so that any users with these documents can successfully upgrade.

Checklist

Delete any items that are not applicable to this PR.

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

joshdover · 2021-07-06T17:08:51Z

src/core/server/saved_objects/migrations/core/elastic_index.test.ts

@@ -415,11 +415,31 @@ describe('ElasticIndex', () => {
          query: {
            bool: {
              must_not: [
+                {


This test probably needs to change so that we don't have to update every time a new type is added to REMOVED_TYPES

We could just import excludeUnusedTypesQuery for now to assert against, OTOH it would break once we register removed types at runtime, so...

joshdover · 2021-07-06T17:10:33Z

src/core/server/saved_objects/migrationsv2/integration_tests/type_registrations.test.ts

+import * as kbnTestServer from '../../../../test_helpers/kbn_server';
+
+// Types should NEVER be removed from this array
+const previouslyRegisteredTypes = [


I ran this test on all branches from 7.7 forward. We can and should do it for the prior 7.x versions but it will take some extra work since the typeRegistry API didn't exist yet. Will do as a follow up.

joshdover · 2021-07-06T17:11:17Z

src/core/server/saved_objects/migrations/core/elastic_index.ts

+/**
+ * Types that are no longer registered and need to be removed
+ */
+export const REMOVED_TYPES: string[] = [


Pretty basic for now, but can be improved in #104246

joshdover · 2021-07-06T17:11:54Z

src/core/server/saved_objects/saved_objects_service.ts

@@ -149,6 +149,7 @@ export interface SavedObjectsServiceSetup {
 */
 export interface InternalSavedObjectsServiceSetup extends SavedObjectsServiceSetup {
  status$: Observable<ServiceStatus<SavedObjectStatusMeta>>;
+  getTypeRegistry: () => ISavedObjectTypeRegistry;


Not strictly necessary, but makes the test faster since I don't have to wait for start to complete

The types are only guaranteed to be registered once all plugins completed their setup, but it's probably fine as long as we keep it internal

Yep, I'll just add that to the docstring to make it clear

joshdover · 2021-07-06T17:12:29Z

src/core/server/saved_objects/migrationsv2/integration_tests/type_registrations.test.ts

+].sort();
+
+describe('SO type registrations', () => {
+  it('does not remove types from registrations without updating unusedTypesQuery', async () => {


@pgayvallet any thoughts on this approach before I continue?

elasticmachine · 2021-07-07T15:26:54Z

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

pgayvallet

Don't really like that we need to maintain an hardcoded list in the test file, but I don't see any other option, so I guess it will have to do.

pgayvallet · 2021-07-07T14:48:44Z

src/core/server/saved_objects/migrations/core/elastic_index.test.ts

@@ -415,11 +415,31 @@ describe('ElasticIndex', () => {
          query: {
            bool: {
              must_not: [
+                {


We could just import excludeUnusedTypesQuery for now to assert against, OTOH it would break once we register removed types at runtime, so...

src/core/server/saved_objects/migrationsv2/initial_state.test.ts

pgayvallet · 2021-07-07T14:57:23Z

src/core/server/saved_objects/saved_objects_service.ts

@@ -149,6 +149,7 @@ export interface SavedObjectsServiceSetup {
 */
 export interface InternalSavedObjectsServiceSetup extends SavedObjectsServiceSetup {
  status$: Observable<ServiceStatus<SavedObjectStatusMeta>>;
+  getTypeRegistry: () => ISavedObjectTypeRegistry;


The types are only guaranteed to be registered once all plugins completed their setup, but it's probably fine as long as we keep it internal

src/core/server/saved_objects/migrationsv2/integration_tests/type_registrations.test.ts

…ration-tests

kibanamachine · 2021-07-08T12:18:08Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

💔 Build #136942 failed fa126ee
💚 Build #136835 succeeded 92ec28b
💔 Build #136642 failed a555b9a

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

kibanamachine · 2021-07-08T12:21:32Z

💚 Backport successful

Status	Branch	Result
✅	7.14
✅	7.x

The backport PRs will be merged automatically after passing CI.

Co-authored-by: Josh Dover <[email protected]>

…4859) * Add test for detecting new and removed SO types (#104507) * Remove type not present on 7.14 branch * Add additional old SO type from 7.6 to filter and test (#104913) Co-authored-by: Josh Dover <[email protected]>

joshdover commented Jul 6, 2021

View reviewed changes

joshdover force-pushed the migrations/registration-tests branch from 86e6dc9 to a555b9a Compare July 6, 2021 17:09

joshdover commented Jul 6, 2021

View reviewed changes

joshdover added 3 commits July 7, 2021 14:17

Add ml-telemetry type to unusedTypesQuery

dcffae3

Add REMOVED_TYPES array

c645572

Add test for detecting new and removed SO types

92ec28b

joshdover force-pushed the migrations/registration-tests branch from a555b9a to 92ec28b Compare July 7, 2021 12:18

joshdover added release_note:skip Skip the PR/issue when compiling release notes v7.14.0 v7.15.0 v8.0.0 Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc labels Jul 7, 2021

joshdover marked this pull request as ready for review July 7, 2021 15:26

joshdover requested a review from a team as a code owner July 7, 2021 15:26

joshdover added the auto-backport Deprecated - use backport:version if exact versions are needed label Jul 7, 2021

pgayvallet reviewed Jul 7, 2021

View reviewed changes

pgayvallet approved these changes Jul 7, 2021

View reviewed changes

Review comments

fdd7275

joshdover enabled auto-merge (squash) July 7, 2021 16:07

Add apm-services-telemetry

fa126ee

joshdover mentioned this pull request Jul 7, 2021

Filter out documents of unknown types during migrations #104690

Closed

pgayvallet added 2 commits July 8, 2021 12:00

fix state unit tests to ignore queries

6ba3699

Merge remote-tracking branch 'upstream/master' into migrations/regist…

cd47769

…ration-tests

joshdover merged commit 489a52b into elastic:master Jul 8, 2021

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jul 8, 2021

Add test for detecting new and removed SO types (elastic#104507)

cb06272

kibanamachine mentioned this pull request Jul 8, 2021

[7.14] Add test for detecting new and removed SO types (#104507) #104859

Merged

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jul 8, 2021

Add test for detecting new and removed SO types (elastic#104507)

3ffd23e

kibanamachine mentioned this pull request Jul 8, 2021

[7.x] Add test for detecting new and removed SO types (#104507) #104860

Merged

joshdover mentioned this pull request Jul 8, 2021

Add ml-telemetry type to unusedTypesQuery #104399

Closed

9 tasks

kibanamachine added a commit that referenced this pull request Jul 8, 2021

Add test for detecting new and removed SO types (#104507) (#104860)

9337283

Co-authored-by: Josh Dover <[email protected]>

pgayvallet mentioned this pull request Jul 13, 2021

Kibana migration to 7.13.2 issue #103111

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add test for detecting new and removed SO types #104507

Add test for detecting new and removed SO types #104507

joshdover commented Jul 6, 2021 •

edited

Loading

joshdover Jul 6, 2021

pgayvallet Jul 7, 2021

joshdover Jul 6, 2021

joshdover Jul 6, 2021

joshdover Jul 6, 2021

pgayvallet Jul 7, 2021

joshdover Jul 7, 2021

joshdover Jul 6, 2021

elasticmachine commented Jul 7, 2021

pgayvallet left a comment

pgayvallet Jul 7, 2021

pgayvallet Jul 7, 2021

kibanamachine commented Jul 8, 2021

kibanamachine commented Jul 8, 2021

Add test for detecting new and removed SO types #104507

Add test for detecting new and removed SO types #104507

Conversation

joshdover commented Jul 6, 2021 • edited Loading

Summary

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Jul 7, 2021

pgayvallet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibanamachine commented Jul 8, 2021

💚 Build Succeeded

Metrics [docs]

History

kibanamachine commented Jul 8, 2021

💚 Backport successful

joshdover commented Jul 6, 2021 •

edited

Loading