[7.x] Resilient saved object migration algorithm (#78413)

docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc.md

@@ -20,5 +20,4 @@ export interface SavedObjectsRawDoc
 |  [\_primary\_term](./kibana-plugin-core-server.savedobjectsrawdoc._primary_term.md) | <code>number</code> |  |
 |  [\_seq\_no](./kibana-plugin-core-server.savedobjectsrawdoc._seq_no.md) | <code>number</code> |  |
 |  [\_source](./kibana-plugin-core-server.savedobjectsrawdoc._source.md) | <code>SavedObjectsRawDocSource</code> |  |
-|  [\_type](./kibana-plugin-core-server.savedobjectsrawdoc._type.md) | <code>string</code> |  |
 

src/core/public/public.api.md

@@ -7,6 +7,7 @@
 import { Action } from 'history';
 import { ApiResponse } from '@elastic/elasticsearch/lib/Transport';
 import Boom from '@hapi/boom';
+import { ConfigDeprecationProvider } from '@kbn/config';
 import { ConfigPath } from '@kbn/config';
 import { EnvironmentMode } from '@kbn/config';
 import { EuiBreadcrumb } from '@elastic/eui';
@@ -18,7 +19,6 @@ import { History } from 'history';
 import { Href } from 'history';
 import { IconType } from '@elastic/eui';
 import { KibanaClient } from '@elastic/elasticsearch/api/kibana';
-import { KibanaConfigType } from 'src/core/server/kibana_config';
 import { Location } from 'history';
 import { LocationDescriptorObject } from 'history';
 import { Logger } from '@kbn/logging';

src/core/server/elasticsearch/client/mocks.ts

@@ -22,7 +22,9 @@ import type { DeeplyMockedKeys } from '@kbn/utility-types/jest';
 import { ElasticsearchClient } from './types';
 import { ICustomClusterClient } from './cluster_client';
 
-const createInternalClientMock = (): DeeplyMockedKeys<Client> => {
+const createInternalClientMock = (
+  res?: MockedTransportRequestPromise<unknown>
+): DeeplyMockedKeys<Client> => {
   // we mimic 'reflection' on a concrete instance of the client to generate the mocked functions.
   const client = new Client({
     node: 'http://localhost',
@@ -59,7 +61,7 @@ const createInternalClientMock = (): DeeplyMockedKeys<Client> => {
       .filter(([key]) => !omitted.includes(key))
       .forEach(([key, descriptor]) => {
         if (typeof descriptor.value === 'function') {
-          obj[key] = jest.fn(() => createSuccessTransportRequestPromise({}));
+          obj[key] = jest.fn(() => res ?? createSuccessTransportRequestPromise({}));
         } else if (typeof obj[key] === 'object' && obj[key] != null) {
           mockify(obj[key], omitted);
         }
@@ -95,8 +97,8 @@ const createInternalClientMock = (): DeeplyMockedKeys<Client> => {
 
 export type ElasticsearchClientMock = DeeplyMockedKeys<ElasticsearchClient>;
 
-const createClientMock = (): ElasticsearchClientMock =>
-  (createInternalClientMock() as unknown) as ElasticsearchClientMock;
+const createClientMock = (res?: MockedTransportRequestPromise<unknown>): ElasticsearchClientMock =>
+  (createInternalClientMock(res) as unknown) as ElasticsearchClientMock;
 
 export interface ScopedClusterClientMock {
   asInternalUser: ElasticsearchClientMock;

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

@@ -312,7 +312,7 @@ function wrapWithTry(
       const failedTransform = `${type}:${version}`;
       const failedDoc = JSON.stringify(doc);
       log.warn(
-        `Failed to transform document ${doc}. Transform: ${failedTransform}\nDoc: ${failedDoc}`
+        `Failed to transform document ${doc?.id}. Transform: ${failedTransform}\nDoc: ${failedDoc}`
       );
       throw error;
     }

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

@@ -24,7 +24,7 @@
  * serves as a central blueprint for what migrations will end up doing.
  */
 
-import { Logger } from 'src/core/server/logging';
+import { Logger } from '../../../logging';
 import { MigrationEsClient } from './migration_es_client';
 import { SavedObjectsSerializer } from '../../serialization';
 import {

src/core/server/saved_objects/migrations/kibana/kibana_migrator.mock.ts

@@ -16,9 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import type { PublicMethodsOf } from '@kbn/utility-types';
-
-import { KibanaMigrator, KibanaMigratorStatus } from './kibana_migrator';
+import { IKibanaMigrator, KibanaMigratorStatus } from './kibana_migrator';
 import { buildActiveMappings } from '../core';
 const { mergeTypes } = jest.requireActual('./kibana_migrator');
 import { SavedObjectsType } from '../../types';
@@ -45,7 +43,16 @@ const createMigrator = (
     types: SavedObjectsType[];
   } = { types: defaultSavedObjectTypes }
 ) => {
-  const mockMigrator: jest.Mocked<PublicMethodsOf<KibanaMigrator>> = {
+  const mockMigrator: jest.Mocked<IKibanaMigrator> = {
+    kibanaVersion: '8.0.0-testing',
+    savedObjectsConfig: {
+      batchSize: 100,
+      scrollDuration: '15m',
+      pollInterval: 1500,
+      skip: false,
+      // TODO migrationsV2: remove/deprecate once we release migrations v2
+      enableV2: false,
+    },
     runMigrations: jest.fn(),
     getActiveMappings: jest.fn(),
     migrateDocument: jest.fn(),

src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts

@@ -23,6 +23,7 @@ import { KibanaMigratorOptions, KibanaMigrator } from './kibana_migrator';
 import { loggingSystemMock } from '../../../logging/logging_system.mock';
 import { SavedObjectTypeRegistry } from '../../saved_objects_type_registry';
 import { SavedObjectsType } from '../../types';
+import { errors as esErrors } from '@elastic/elasticsearch';
 
 const createRegistry = (types: Array<Partial<SavedObjectsType>>) => {
   const registry = new SavedObjectTypeRegistry();
@@ -89,38 +90,188 @@ describe('KibanaMigrator', () => {
       expect(options.client.cat.templates).toHaveBeenCalledTimes(1);
     });
 
-    it('emits results on getMigratorResult$()', async () => {
-      const options = mockOptions();
+    describe('when enableV2 = false', () => {
+      it('when enableV2 = false creates an IndexMigrator which retries NoLivingConnectionsError errors from ES client', async () => {
+        const options = mockOptions();
 
-      options.client.cat.templates.mockReturnValue(
-        elasticsearchClientMock.createSuccessTransportRequestPromise(
-          { templates: [] },
-          { statusCode: 404 }
-        )
-      );
-      options.client.indices.get.mockReturnValue(
-        elasticsearchClientMock.createSuccessTransportRequestPromise({}, { statusCode: 404 })
-      );
-      options.client.indices.getAlias.mockReturnValue(
-        elasticsearchClientMock.createSuccessTransportRequestPromise({}, { statusCode: 404 })
-      );
+        options.client.cat.templates.mockReturnValue(
+          elasticsearchClientMock.createSuccessTransportRequestPromise(
+            { templates: [] },
+            { statusCode: 404 }
+          )
+        );
+        options.client.indices.get.mockReturnValue(
+          elasticsearchClientMock.createSuccessTransportRequestPromise({}, { statusCode: 404 })
+        );
+        options.client.indices.getAlias.mockReturnValue(
+          elasticsearchClientMock.createSuccessTransportRequestPromise({}, { statusCode: 404 })
+        );
 
-      const migrator = new KibanaMigrator(options);
-      const migratorStatus = migrator.getStatus$().pipe(take(3)).toPromise();
-      await migrator.runMigrations();
-      const { status, result } = await migratorStatus;
-      expect(status).toEqual('completed');
-      expect(result![0]).toMatchObject({
-        destIndex: '.my-index_1',
-        elapsedMs: expect.any(Number),
-        sourceIndex: '.my-index',
-        status: 'migrated',
+        options.client.indices.create = jest
+          .fn()
+          .mockReturnValueOnce(
+            elasticsearchClientMock.createErrorTransportRequestPromise(
+              new esErrors.NoLivingConnectionsError('reason', {} as any)
+            )
+          )
+          .mockImplementationOnce(() =>
+            elasticsearchClientMock.createSuccessTransportRequestPromise('success')
+          );
+
+        const migrator = new KibanaMigrator(options);
+        const migratorStatus = migrator.getStatus$().pipe(take(3)).toPromise();
+        await migrator.runMigrations();
+
+        expect(options.client.indices.create).toHaveBeenCalledTimes(3);
+        const { status } = await migratorStatus;
+        return expect(status).toEqual('completed');
+      });
+
+      it('emits results on getMigratorResult$()', async () => {
+        const options = mockOptions();
+
+        options.client.cat.templates.mockReturnValue(
+          elasticsearchClientMock.createSuccessTransportRequestPromise(
+            { templates: [] },
+            { statusCode: 404 }
+          )
+        );
+        options.client.indices.get.mockReturnValue(
+          elasticsearchClientMock.createSuccessTransportRequestPromise({}, { statusCode: 404 })
+        );
+        options.client.indices.getAlias.mockReturnValue(
+          elasticsearchClientMock.createSuccessTransportRequestPromise({}, { statusCode: 404 })
+        );
+
+        const migrator = new KibanaMigrator(options);
+        const migratorStatus = migrator.getStatus$().pipe(take(3)).toPromise();
+        await migrator.runMigrations();
+        const { status, result } = await migratorStatus;
+        expect(status).toEqual('completed');
+        expect(result![0]).toMatchObject({
+          destIndex: '.my-index_1',
+          elapsedMs: expect.any(Number),
+          sourceIndex: '.my-index',
+          status: 'migrated',
+        });
+        expect(result![1]).toMatchObject({
+          destIndex: 'other-index_1',
+          elapsedMs: expect.any(Number),
+          sourceIndex: 'other-index',
+          status: 'migrated',
+        });
+      });
+    });
+    describe('when enableV2 = true', () => {
+      beforeEach(() => {
+        jest.clearAllMocks();
       });
-      expect(result![1]).toMatchObject({
-        destIndex: 'other-index_1',
-        elapsedMs: expect.any(Number),
-        sourceIndex: 'other-index',
-        status: 'migrated',
+
+      it('creates a V2 migrator that initializes a new index and migrates an existing index', async () => {
+        const options = mockV2MigrationOptions();
+        const migrator = new KibanaMigrator(options);
+        const migratorStatus = migrator.getStatus$().pipe(take(3)).toPromise();
+        await migrator.runMigrations();
+
+        // Basic assertions that we're creating and reindexing the expected indices
+        expect(options.client.indices.create).toHaveBeenCalledTimes(3);
+        expect(options.client.indices.create.mock.calls).toEqual(
+          expect.arrayContaining([
+            // LEGACY_CREATE_REINDEX_TARGET
+            expect.arrayContaining([expect.objectContaining({ index: '.my-index_pre8.2.3_001' })]),
+            // CREATE_REINDEX_TEMP
+            expect.arrayContaining([
+              expect.objectContaining({ index: '.my-index_8.2.3_reindex_temp' }),
+            ]),
+            // CREATE_NEW_TARGET
+            expect.arrayContaining([expect.objectContaining({ index: 'other-index_8.2.3_001' })]),
+          ])
+        );
+        // LEGACY_REINDEX
+        expect(options.client.reindex.mock.calls[0][0]).toEqual(
+          expect.objectContaining({
+            body: expect.objectContaining({
+              source: expect.objectContaining({ index: '.my-index' }),
+              dest: expect.objectContaining({ index: '.my-index_pre8.2.3_001' }),
+            }),
+          })
+        );
+        // REINDEX_SOURCE_TO_TEMP
+        expect(options.client.reindex.mock.calls[1][0]).toEqual(
+          expect.objectContaining({
+            body: expect.objectContaining({
+              source: expect.objectContaining({ index: '.my-index_pre8.2.3_001' }),
+              dest: expect.objectContaining({ index: '.my-index_8.2.3_reindex_temp' }),
+            }),
+          })
+        );
+        const { status } = await migratorStatus;
+        return expect(status).toEqual('completed');
+      });
+      it('emits results on getMigratorResult$()', async () => {
+        const options = mockV2MigrationOptions();
+        const migrator = new KibanaMigrator(options);
+        const migratorStatus = migrator.getStatus$().pipe(take(3)).toPromise();
+        await migrator.runMigrations();
+
+        const { status, result } = await migratorStatus;
+        expect(status).toEqual('completed');
+        expect(result![0]).toMatchObject({
+          destIndex: '.my-index_8.2.3_001',
+          sourceIndex: '.my-index_pre8.2.3_001',
+          elapsedMs: expect.any(Number),
+          status: 'migrated',
+        });
+        expect(result![1]).toMatchObject({
+          destIndex: 'other-index_8.2.3_001',
+          elapsedMs: expect.any(Number),
+          status: 'patched',
+        });
+      });
+      it('rejects when the migration state machine terminates in a FATAL state', () => {
+        const options = mockV2MigrationOptions();
+        options.client.indices.get.mockReturnValue(
+          elasticsearchClientMock.createSuccessTransportRequestPromise(
+            {
+              '.my-index_8.2.4_001': {
+                aliases: {
+                  '.my-index': {},
+                  '.my-index_8.2.4': {},
+                },
+                mappings: { properties: {}, _meta: { migrationMappingPropertyHashes: {} } },
+                settings: {},
+              },
+            },
+            { statusCode: 200 }
+          )
+        );
+
+        const migrator = new KibanaMigrator(options);
+        return expect(migrator.runMigrations()).rejects.toMatchInlineSnapshot(
+          `[Error: Unable to complete saved object migrations for the [.my-index] index: The .my-index alias is pointing to a newer version of Kibana: v8.2.4]`
+        );
+      });
+      it('rejects when an unexpected exception occurs in an action', async () => {
+        const options = mockV2MigrationOptions();
+        options.client.tasks.get.mockReturnValue(
+          elasticsearchClientMock.createSuccessTransportRequestPromise({
+            completed: true,
+            error: { type: 'elatsicsearch_exception', reason: 'task failed with an error' },
+            failures: [],
+            task: { description: 'task description' },
+          })
+        );
+
+        const migrator = new KibanaMigrator(options);
+
+        await expect(migrator.runMigrations()).rejects.toMatchInlineSnapshot(`
+                [Error: Unable to complete saved object migrations for the [.my-index] index. Please check the health of your Elasticsearch cluster and try again. Error: Reindex failed with the following error:
+                {"_tag":"Some","value":{"type":"elatsicsearch_exception","reason":"task failed with an error"}}]
+              `);
+        expect(loggingSystemMock.collect(options.logger).error[0][0]).toMatchInlineSnapshot(`
+          [Error: Reindex failed with the following error:
+          {"_tag":"Some","value":{"type":"elatsicsearch_exception","reason":"task failed with an error"}}]
+        `);
       });
     });
   });
@@ -130,7 +281,40 @@ type MockedOptions = KibanaMigratorOptions & {
   client: ReturnType<typeof elasticsearchClientMock.createElasticsearchClient>;
 };
 
-const mockOptions = () => {
+const mockV2MigrationOptions = () => {
+  const options = mockOptions({ enableV2: true });
+
+  options.client.indices.get.mockReturnValue(
+    elasticsearchClientMock.createSuccessTransportRequestPromise(
+      {
+        '.my-index': {
+          aliases: { '.kibana': {} },
+          mappings: { properties: {} },
+          settings: {},
+        },
+      },
+      { statusCode: 200 }
+    )
+  );
+  options.client.indices.addBlock.mockReturnValue(
+    elasticsearchClientMock.createSuccessTransportRequestPromise({ acknowledged: true })
+  );
+  options.client.reindex.mockReturnValue(
+    elasticsearchClientMock.createSuccessTransportRequestPromise({ taskId: 'reindex_task_id' })
+  );
+  options.client.tasks.get.mockReturnValue(
+    elasticsearchClientMock.createSuccessTransportRequestPromise({
+      completed: true,
+      error: undefined,
+      failures: [],
+      task: { description: 'task description' },
+    })
+  );
+
+  return options;
+};
+
+const mockOptions = ({ enableV2 }: { enableV2: boolean } = { enableV2: false }) => {
   const options: MockedOptions = {
     logger: loggingSystemMock.create().get(),
     kibanaVersion: '8.2.3',
@@ -144,7 +328,7 @@ const mockOptions = () => {
             name: { type: 'keyword' },
           },
         },
-        migrations: {},
+        migrations: { '8.2.3': jest.fn().mockImplementation((doc) => doc) },
       },
       {
         name: 'testtype2',
@@ -168,6 +352,7 @@ const mockOptions = () => {
       pollInterval: 20000,
       scrollDuration: '10m',
       skip: false,
+      enableV2,
     },
     client: elasticsearchClientMock.createElasticsearchClient(),
   };