Sort SavedObjects server-side instead of by _id in ES

Sorting/Aggregating by _id was removed in elastic#52517 Retains sorting as requested by elastic#29747 Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>
tylersmalley · Jan 24, 2020 · 0c735e1 · 0c735e1
1 parent bc69d6e
commit 0c735e1
Show file tree

Hide file tree

Showing 2 changed files with 121 additions and 10 deletions.
diff --git a/src/core/server/saved_objects/export/get_sorted_objects_for_export.test.ts b/src/core/server/saved_objects/export/get_sorted_objects_for_export.test.ts
@@ -108,8 +108,6 @@ describe('getSortedObjectsForExport()', () => {
               "namespace": undefined,
               "perPage": 500,
               "search": undefined,
-              "sortField": "_id",
-              "sortOrder": "asc",
               "type": Array [
                 "index-pattern",
                 "search",
@@ -256,8 +254,6 @@ describe('getSortedObjectsForExport()', () => {
               "namespace": undefined,
               "perPage": 500,
               "search": "foo",
-              "sortField": "_id",
-              "sortOrder": "asc",
               "type": Array [
                 "index-pattern",
                 "search",
@@ -345,8 +341,6 @@ describe('getSortedObjectsForExport()', () => {
               "namespace": "foo",
               "perPage": 500,
               "search": undefined,
-              "sortField": "_id",
-              "sortOrder": "asc",
               "type": Array [
                 "index-pattern",
                 "search",
@@ -399,6 +393,121 @@ describe('getSortedObjectsForExport()', () => {
     ).rejects.toThrowErrorMatchingInlineSnapshot(`"Can't export more than 1 objects"`);
   });
 
+  test('sorts objects within type', async () => {
+    savedObjectsClient.bulkGet.mockResolvedValueOnce({
+      saved_objects: [
+        {
+          id: '3',
+          type: 'index-pattern',
+          attributes: {
+            name: 'baz',
+          },
+          references: [],
+        },
+        {
+          id: '1',
+          type: 'index-pattern',
+          attributes: {
+            name: 'foo',
+          },
+          references: [],
+        },
+        {
+          id: '2',
+          type: 'index-pattern',
+          attributes: {
+            name: 'bar',
+          },
+          references: [],
+        },
+      ],
+    });
+    const exportStream = await getSortedObjectsForExport({
+      exportSizeLimit: 10000,
+      savedObjectsClient,
+      types: ['index-pattern'],
+      objects: [
+        {
+          type: 'index-pattern',
+          id: '3',
+        },
+        {
+          type: 'index-pattern',
+          id: '1',
+        },
+        {
+          type: 'index-pattern',
+          id: '2',
+        },
+      ],
+    });
+    const response = await readStreamToCompletion(exportStream);
+    expect(response).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "attributes": Object {
+            "name": "foo",
+          },
+          "id": "1",
+          "references": Array [],
+          "type": "index-pattern",
+        },
+        Object {
+          "attributes": Object {
+            "name": "bar",
+          },
+          "id": "2",
+          "references": Array [],
+          "type": "index-pattern",
+        },
+        Object {
+          "attributes": Object {
+            "name": "baz",
+          },
+          "id": "3",
+          "references": Array [],
+          "type": "index-pattern",
+        },
+        Object {
+          "exportedCount": 3,
+          "missingRefCount": 0,
+          "missingReferences": Array [],
+        },
+      ]
+    `);
+    expect(savedObjectsClient.bulkGet).toMatchInlineSnapshot(`
+      [MockFunction] {
+        "calls": Array [
+          Array [
+            Array [
+              Object {
+                "id": "3",
+                "type": "index-pattern",
+              },
+              Object {
+                "id": "1",
+                "type": "index-pattern",
+              },
+              Object {
+                "id": "2",
+                "type": "index-pattern",
+              },
+            ],
+            Object {
+              "namespace": undefined,
+            },
+          ],
+        ],
+        "results": Array [
+          Object {
+            "type": "return",
+            "value": Promise {},
+          },
+        ],
+      }
+    `);
+  });
+
   test('exports selected objects and sorts them', async () => {
     savedObjectsClient.bulkGet.mockResolvedValueOnce({
       saved_objects: [

diff --git a/src/core/server/saved_objects/export/get_sorted_objects_for_export.ts b/src/core/server/saved_objects/export/get_sorted_objects_for_export.ts
@@ -19,7 +19,7 @@
 
 import Boom from 'boom';
 import { createListStream } from '../../../../legacy/utils/streams';
-import { SavedObjectsClientContract } from '../types';
+import { SavedObjectsClientContract, SavedObject } from '../types';
 import { fetchNestedDependencies } from './inject_nested_depdendencies';
 import { sortObjects } from './sort_objects';
 
@@ -69,6 +69,10 @@ export interface SavedObjectsExportResultDetails {
   }>;
 }
 
+function compareSavedObjects(a: SavedObject, b: SavedObject) {
+  return a.id > b.id ? 1 : -1;
+}
+
 async function fetchObjectsToExport({
   objects,
   types,
@@ -105,8 +109,6 @@ async function fetchObjectsToExport({
     const findResponse = await savedObjectsClient.find({
       type: types,
       search,
-      sortField: '_id',
-      sortOrder: 'asc',
       perPage: exportSizeLimit,
       namespace,
     });
@@ -137,7 +139,7 @@ export async function getSortedObjectsForExport({
     exportSizeLimit,
     namespace,
   });
-  let exportedObjects = [...rootObjects];
+  let exportedObjects = [...rootObjects.sort(compareSavedObjects)];
   let missingReferences: SavedObjectsExportResultDetails['missingReferences'] = [];
   if (includeReferencesDeep) {
     const fetchResult = await fetchNestedDependencies(rootObjects, savedObjectsClient, namespace);