Removed unused method searchForOutdatedDocuments (#157470)

gsoldevila · kibanamachine · web-flow · commit 4951e29973b4 · 2023-05-15T14:14:32.000+02:00
This method is no longer used (replaced by `readWithPit`).

---------

Co-authored-by: kibanamachine &lt;42973632+kibanamachine@users.noreply.github.com&gt;
diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/index.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/index.ts
@@ -32,7 +32,6 @@ export {
   updateAliases,
   transformDocs,
   setWriteBlock,
-  searchForOutdatedDocuments,
   removeWriteBlock,
   reindex,
   readWithPit,
@@ -45,7 +44,6 @@ export {
 export type {
   OpenPitResponse,
   ReadWithPit,
-  SearchResponse,
   ReindexResponse,
   UpdateByQueryResponse,
   UpdateAndPickupMappingsResponse,
diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/README.md b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/README.md
@@ -426,7 +426,7 @@ We can’t use the temporary index as our target index because one instance can
 
 ## OUTDATED_DOCUMENTS_SEARCH
 ### Next action
-`searchForOutdatedDocuments`
+`readWithPit(outdatedDocumentsQuery)`
 
 Search for outdated saved object documents. Will return one batch of
 documents.
diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/index.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/index.ts
@@ -118,12 +118,6 @@ export { checkForUnknownDocs } from './check_for_unknown_docs';
 
 export { waitForPickupUpdatedMappingsTask } from './wait_for_pickup_updated_mappings_task';
 
-export type {
-  SearchResponse,
-  SearchForOutdatedDocumentsOptions,
-} from './search_for_outdated_documents';
-export { searchForOutdatedDocuments } from './search_for_outdated_documents';
-
 export type { BulkOverwriteTransformedDocumentsParams } from './bulk_overwrite_transformed_documents';
 export { bulkOverwriteTransformedDocuments } from './bulk_overwrite_transformed_documents';
 
diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/search_for_outdated_documents.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/search_for_outdated_documents.test.ts
diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/search_for_outdated_documents.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/search_for_outdated_documents.ts
diff --git a/src/core/server/integration_tests/saved_objects/migrations/group3/actions/actions.test.ts b/src/core/server/integration_tests/saved_objects/migrations/group3/actions/actions.test.ts
@@ -23,8 +23,6 @@ import {
   reindex,
   readWithPit,
   type ReadWithPit,
-  searchForOutdatedDocuments,
-  type SearchResponse,
   setWriteBlock,
   updateAliases,
   waitForReindexTask,
@@ -724,14 +722,9 @@ describe('migration actions', () => {
         }
       `);
 
-      const results = (
-        (await searchForOutdatedDocuments(client, {
-          batchSize: 1000,
-          targetIndex: 'reindex_target',
-          outdatedDocumentsQuery: undefined,
-        })()) as Either.Right<SearchResponse>
-      ).right.outdatedDocuments;
-      expect(results.map((doc) => doc._source.title).sort()).toMatchInlineSnapshot(`
+      const results = await client.search({ index: 'reindex_target', size: 1000 });
+      expect((results.hits?.hits as SavedObjectsRawDoc[]).map((doc) => doc._source.title).sort())
+        .toMatchInlineSnapshot(`
         Array [
           "doc 1",
           "doc 2",
@@ -764,14 +757,9 @@ describe('migration actions', () => {
         }
       `);
 
-      const results = (
-        (await searchForOutdatedDocuments(client, {
-          batchSize: 1000,
-          targetIndex: 'reindex_target_excluded_docs',
-          outdatedDocumentsQuery: undefined,
-        })()) as Either.Right<SearchResponse>
-      ).right.outdatedDocuments;
-      expect(results.map((doc) => doc._source.title).sort()).toMatchInlineSnapshot(`
+      const results = await client.search({ index: 'reindex_target_excluded_docs', size: 1000 });
+      expect((results.hits?.hits as SavedObjectsRawDoc[]).map((doc) => doc._source.title).sort())
+        .toMatchInlineSnapshot(`
         Array [
           "doc 1",
           "doc 2",
@@ -796,14 +784,10 @@ describe('migration actions', () => {
           "right": "reindex_succeeded",
         }
       `);
-      const results = (
-        (await searchForOutdatedDocuments(client, {
-          batchSize: 1000,
-          targetIndex: 'reindex_target_2',
-          outdatedDocumentsQuery: undefined,
-        })()) as Either.Right<SearchResponse>
-      ).right.outdatedDocuments;
-      expect(results.map((doc) => doc._source.title).sort()).toMatchInlineSnapshot(`
+
+      const results = await client.search({ index: 'reindex_target_2', size: 1000 });
+      expect((results.hits?.hits as SavedObjectsRawDoc[]).map((doc) => doc._source.title).sort())
+        .toMatchInlineSnapshot(`
         Array [
           "doc 1_updated",
           "doc 2_updated",
@@ -850,14 +834,9 @@ describe('migration actions', () => {
       `);
 
       // Assert that documents weren't overridden by the second, unscripted reindex
-      const results = (
-        (await searchForOutdatedDocuments(client, {
-          batchSize: 1000,
-          targetIndex: 'reindex_target_3',
-          outdatedDocumentsQuery: undefined,
-        })()) as Either.Right<SearchResponse>
-      ).right.outdatedDocuments;
-      expect(results.map((doc) => doc._source.title).sort()).toMatchInlineSnapshot(`
+      const results = await client.search({ index: 'reindex_target_3', size: 1000 });
+      expect((results.hits?.hits as SavedObjectsRawDoc[]).map((doc) => doc._source.title).sort())
+        .toMatchInlineSnapshot(`
         Array [
           "doc 1_updated",
           "doc 2_updated",
@@ -872,13 +851,8 @@ describe('migration actions', () => {
       // Simulate a reindex that only adds some of the documents from the
       // source index into the target index
       await createIndex({ client, indexName: 'reindex_target_4', mappings: { properties: {} } })();
-      const sourceDocs = (
-        (await searchForOutdatedDocuments(client, {
-          batchSize: 1000,
-          targetIndex: 'existing_index_with_docs',
-          outdatedDocumentsQuery: undefined,
-        })()) as Either.Right<SearchResponse>
-      ).right.outdatedDocuments
+      const response = await client.search({ index: 'existing_index_with_docs', size: 1000 });
+      const sourceDocs = (response.hits?.hits as SavedObjectsRawDoc[])
         .slice(0, 2)
         .map(({ _id, _source }) => ({
           _id,
@@ -909,14 +883,9 @@ describe('migration actions', () => {
       `);
       // Assert that existing documents weren't overridden, but that missing
       // documents were added by the reindex
-      const results = (
-        (await searchForOutdatedDocuments(client, {
-          batchSize: 1000,
-          targetIndex: 'reindex_target_4',
-          outdatedDocumentsQuery: undefined,
-        })()) as Either.Right<SearchResponse>
-      ).right.outdatedDocuments;
-      expect(results.map((doc) => doc._source.title).sort()).toMatchInlineSnapshot(`
+      const results = await client.search({ index: 'reindex_target_4', size: 1000 });
+      expect((results.hits?.hits as SavedObjectsRawDoc[]).map((doc) => doc._source.title).sort())
+        .toMatchInlineSnapshot(`
         Array [
           "doc 1",
           "doc 2",
@@ -1446,16 +1415,15 @@ describe('migration actions', () => {
       })();
 
       // Assert that we can't search over the unmapped fields of the document
-      const originalSearchResults = (
-        (await searchForOutdatedDocuments(client, {
-          batchSize: 1000,
-          targetIndex: 'existing_index_without_mappings',
-          outdatedDocumentsQuery: {
-            match: { title: { query: 'doc' } },
-          },
-        })()) as Either.Right<SearchResponse>
-      ).right.outdatedDocuments;
-      expect(originalSearchResults.length).toBe(0);
+
+      const originalSearchResults = await client.search({
+        index: 'existing_index_without_mappings',
+        size: 1000,
+        query: {
+          match: { title: { query: 'doc' } },
+        },
+      });
+      expect(originalSearchResults.hits?.hits.length).toBe(0);
 
       // Update and pickup mappings so that the title field is searchable
       const res = await updateAndPickupMappings({
@@ -1472,16 +1440,14 @@ describe('migration actions', () => {
       await waitForPickupUpdatedMappingsTask({ client, taskId, timeout: '60s' })();
 
       // Repeat the search expecting to be able to find the existing documents
-      const pickedUpSearchResults = (
-        (await searchForOutdatedDocuments(client, {
-          batchSize: 1000,
-          targetIndex: 'existing_index_without_mappings',
-          outdatedDocumentsQuery: {
-            match: { title: { query: 'doc' } },
-          },
-        })()) as Either.Right<SearchResponse>
-      ).right.outdatedDocuments;
-      expect(pickedUpSearchResults.length).toBe(4);
+      const pickedUpSearchResults = await client.search({
+        index: 'existing_index_without_mappings',
+        size: 1000,
+        query: {
+          match: { title: { query: 'doc' } },
+        },
+      });
+      expect(pickedUpSearchResults.hits?.hits.length).toBe(4);
     });
   });
 
@@ -1903,13 +1869,8 @@ describe('migration actions', () => {
       `);
     });
     it('resolves right even if there were some version_conflict_engine_exception', async () => {
-      const existingDocs = (
-        (await searchForOutdatedDocuments(client, {
-          batchSize: 1000,
-          targetIndex: 'existing_index_with_docs',
-          outdatedDocumentsQuery: undefined,
-        })()) as Either.Right<SearchResponse>
-      ).right.outdatedDocuments;
+      const response = await client.search({ index: 'existing_index_with_docs', size: 1000 });
+      const existingDocs = response.hits?.hits as SavedObjectsRawDoc[];
 
       const task = bulkOverwriteTransformedDocuments({
         client,
