Make type option required for SavedObjects.find

elastic · Aug 6, 2019 · 0313b50 · 0313b50
1 parent 6cd3a67
commit 0313b50
Show file tree

Hide file tree

Showing 15 changed files with 40 additions and 36 deletions.
diff --git a/docs/development/core/public/kibana-plugin-public.savedobjectsclient.find.md b/docs/development/core/public/kibana-plugin-public.savedobjectsclient.find.md
@@ -9,5 +9,5 @@ Search for objects
 <b>Signature:</b>
 
 ```typescript
-find: <T extends SavedObjectAttributes>(options?: Pick<SavedObjectFindOptionsServer, "search" | "type" | "defaultSearchOperator" | "searchFields" | "sortField" | "hasReference" | "page" | "perPage" | "fields">) => Promise<SavedObjectsFindResponsePublic<T>>;
+find: <T extends SavedObjectAttributes>(options: Pick<SavedObjectFindOptionsServer, "search" | "type" | "defaultSearchOperator" | "searchFields" | "sortField" | "hasReference" | "page" | "perPage" | "fields">) => Promise<SavedObjectsFindResponsePublic<T>>;
 ```
diff --git a/docs/development/core/public/kibana-plugin-public.savedobjectsclient.md b/docs/development/core/public/kibana-plugin-public.savedobjectsclient.md
@@ -20,7 +20,7 @@ export declare class SavedObjectsClient
 |  [bulkGet](./kibana-plugin-public.savedobjectsclient.bulkget.md) |  | <code>(objects?: {</code><br/><code>        id: string;</code><br/><code>        type: string;</code><br/><code>    }[]) =&gt; Promise&lt;SavedObjectsBatchResponse&lt;SavedObjectAttributes&gt;&gt;</code> | Returns an array of objects by id |
 |  [create](./kibana-plugin-public.savedobjectsclient.create.md) |  | <code>&lt;T extends SavedObjectAttributes&gt;(type: string, attributes: T, options?: SavedObjectsCreateOptions) =&gt; Promise&lt;SimpleSavedObject&lt;T&gt;&gt;</code> | Persists an object |
 |  [delete](./kibana-plugin-public.savedobjectsclient.delete.md) |  | <code>(type: string, id: string) =&gt; Promise&lt;{}&gt;</code> | Deletes an object |
-|  [find](./kibana-plugin-public.savedobjectsclient.find.md) |  | <code>&lt;T extends SavedObjectAttributes&gt;(options?: Pick&lt;SavedObjectFindOptionsServer, &quot;search&quot; &#124; &quot;type&quot; &#124; &quot;defaultSearchOperator&quot; &#124; &quot;searchFields&quot; &#124; &quot;sortField&quot; &#124; &quot;hasReference&quot; &#124; &quot;page&quot; &#124; &quot;perPage&quot; &#124; &quot;fields&quot;&gt;) =&gt; Promise&lt;SavedObjectsFindResponsePublic&lt;T&gt;&gt;</code> | Search for objects |
+|  [find](./kibana-plugin-public.savedobjectsclient.find.md) |  | <code>&lt;T extends SavedObjectAttributes&gt;(options: Pick&lt;SavedObjectFindOptionsServer, &quot;search&quot; &#124; &quot;type&quot; &#124; &quot;defaultSearchOperator&quot; &#124; &quot;searchFields&quot; &#124; &quot;sortField&quot; &#124; &quot;hasReference&quot; &#124; &quot;page&quot; &#124; &quot;perPage&quot; &#124; &quot;fields&quot;&gt;) =&gt; Promise&lt;SavedObjectsFindResponsePublic&lt;T&gt;&gt;</code> | Search for objects |
 |  [get](./kibana-plugin-public.savedobjectsclient.get.md) |  | <code>&lt;T extends SavedObjectAttributes&gt;(type: string, id: string) =&gt; Promise&lt;SimpleSavedObject&lt;T&gt;&gt;</code> | Fetches a single object |
 
 ## Methods

diff --git a/docs/development/core/public/kibana-plugin-public.savedobjectsfindoptions.type.md b/docs/development/core/public/kibana-plugin-public.savedobjectsfindoptions.type.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-type?: string | string[];
+type: string | string[];
 ```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsfindoptions.type.md b/docs/development/core/server/kibana-plugin-server.savedobjectsfindoptions.type.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-type?: string | string[];
+type: string | string[];
 ```
diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
@@ -676,7 +676,7 @@ export class SavedObjectsClient {
     }[]) => Promise<SavedObjectsBatchResponse<SavedObjectAttributes>>;
     create: <T extends SavedObjectAttributes>(type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise<SimpleSavedObject<T>>;
     delete: (type: string, id: string) => Promise<{}>;
-    find: <T extends SavedObjectAttributes>(options?: Pick<SavedObjectsFindOptions, "search" | "type" | "defaultSearchOperator" | "searchFields" | "sortField" | "hasReference" | "page" | "perPage" | "fields">) => Promise<SavedObjectsFindResponsePublic<T>>;
+    find: <T extends SavedObjectAttributes>(options: Pick<SavedObjectsFindOptions, "search" | "type" | "defaultSearchOperator" | "searchFields" | "sortField" | "hasReference" | "page" | "perPage" | "fields">) => Promise<SavedObjectsFindResponsePublic<T>>;
     get: <T extends SavedObjectAttributes>(type: string, id: string) => Promise<SimpleSavedObject<T>>;
     update<T extends SavedObjectAttributes>(type: string, id: string, attributes: T, { version, migrationVersion, references }?: SavedObjectsUpdateOptions): Promise<SimpleSavedObject<T>>;
 }
@@ -714,7 +714,7 @@ export interface SavedObjectsFindOptions extends SavedObjectsBaseOptions {
     // (undocumented)
     sortOrder?: string;
     // (undocumented)
-    type?: string | string[];
+    type: string | string[];
 }
 
 // @public

diff --git a/src/core/public/saved_objects/saved_objects_client.ts b/src/core/public/saved_objects/saved_objects_client.ts
@@ -284,7 +284,7 @@ export class SavedObjectsClient {
    * @returns A find result with objects matching the specified search.
    */
   public find = <T extends SavedObjectAttributes>(
-    options: SavedObjectsFindOptions = {}
+    options: SavedObjectsFindOptions
   ): Promise<SavedObjectsFindResponsePublic<T>> => {
     const path = this.getPath(['_find']);
     const renameMap = {

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
@@ -52,7 +52,7 @@ async function fetchObjectsToExport({
   savedObjectsClient: SavedObjectsClientContract;
   namespace?: string;
 }) {
-  if (objects) {
+  if (objects && objects.length > 0) {
     if (objects.length > exportSizeLimit) {
       throw Boom.badRequest(`Can't export more than ${exportSizeLimit} objects`);
     }
@@ -66,18 +66,21 @@ async function fetchObjectsToExport({
       throw err;
     }
     return bulkGetResult.saved_objects;
+  } else if (types && types.length > 0) {
+    const findResponse = await savedObjectsClient.find({
+      type: types,
+      sortField: '_id',
+      sortOrder: 'asc',
+      perPage: exportSizeLimit,
+      namespace,
+    });
+    if (findResponse.total > exportSizeLimit) {
+      throw Boom.badRequest(`Can't export more than ${exportSizeLimit} objects`);
+    }
+    return findResponse.saved_objects;
+  } else {
+    throw Boom.badRequest('Either `type` or `objects` are required.');
   }
-  const findResponse = await savedObjectsClient.find({
-    type: types,
-    sortField: '_id',
-    sortOrder: 'asc',
-    perPage: exportSizeLimit,
-    namespace,
-  });
-  if (findResponse.total > exportSizeLimit) {
-    throw Boom.badRequest(`Can't export more than ${exportSizeLimit} objects`);
-  }
-  return findResponse.saved_objects;
 }
 
 export async function getSortedObjectsForExport({

diff --git a/src/core/server/saved_objects/types.ts b/src/core/server/saved_objects/types.ts
@@ -102,7 +102,7 @@ export interface SavedObjectReference {
  * @public
  */
 export interface SavedObjectsFindOptions extends SavedObjectsBaseOptions {
-  type?: string | string[];
+  type: string | string[];
   page?: number;
   perPage?: number;
   sortField?: string;

diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -759,7 +759,7 @@ export interface SavedObjectsFindOptions extends SavedObjectsBaseOptions {
     // (undocumented)
     sortOrder?: string;
     // (undocumented)
-    type?: string | string[];
+    type: string | string[];
 }
 
 // @public

diff --git a/...gacy/plugins/encrypted_saved_objects/server/lib/encrypted_saved_objects_client_wrapper.ts b/...gacy/plugins/encrypted_saved_objects/server/lib/encrypted_saved_objects_client_wrapper.ts
@@ -114,7 +114,7 @@ export class EncryptedSavedObjectsClientWrapper implements SavedObjectsClientCon
     return await this.options.baseClient.delete(type, id, options);
   }
 
-  public async find(options: SavedObjectsFindOptions = {}) {
+  public async find(options: SavedObjectsFindOptions) {
     return this.stripEncryptedAttributesFromBulkResponse(
       await this.options.baseClient.find(options)
     );

diff --git a/x-pack/legacy/plugins/siem/server/lib/note/saved_object.ts b/x-pack/legacy/plugins/siem/server/lib/note/saved_object.ts
@@ -47,6 +47,7 @@ export class Note {
 
   public async deleteNoteByTimelineId(request: FrameworkRequest, timelineId: string) {
     const options: SavedObjectsFindOptions = {
+      type: noteSavedObjectType,
       search: timelineId,
       searchFields: ['timelineId'],
     };
@@ -69,6 +70,7 @@ export class Note {
     eventId: string
   ): Promise<NoteSavedObject[]> {
     const options: SavedObjectsFindOptions = {
+      type: noteSavedObjectType,
       search: eventId,
       searchFields: ['eventId'],
     };
@@ -81,6 +83,7 @@ export class Note {
     timelineId: string
   ): Promise<NoteSavedObject[]> {
     const options: SavedObjectsFindOptions = {
+      type: noteSavedObjectType,
       search: timelineId,
       searchFields: ['timelineId'],
     };
@@ -95,6 +98,7 @@ export class Note {
     sort: SortNote | null
   ): Promise<ResponseNotes> {
     const options: SavedObjectsFindOptions = {
+      type: noteSavedObjectType,
       perPage: pageInfo != null ? pageInfo.pageSize : undefined,
       page: pageInfo != null ? pageInfo.pageIndex : undefined,
       search: search != null ? search : undefined,
@@ -196,10 +200,7 @@ export class Note {
       request[internalFrameworkRequest]
     );
 
-    const savedObjects = await savedObjectsClient.find({
-      type: noteSavedObjectType,
-      ...options,
-    });
+    const savedObjects = await savedObjectsClient.find(options);
 
     return {
       totalCount: savedObjects.total,

diff --git a/x-pack/legacy/plugins/siem/server/lib/pinned_event/saved_object.ts b/x-pack/legacy/plugins/siem/server/lib/pinned_event/saved_object.ts
@@ -43,6 +43,7 @@ export class PinnedEvent {
 
   public async deleteAllPinnedEventsOnTimeline(request: FrameworkRequest, timelineId: string) {
     const options: SavedObjectsFindOptions = {
+      type: pinnedEventSavedObjectType,
       search: timelineId,
       searchFields: ['timelineId'],
     };
@@ -68,6 +69,7 @@ export class PinnedEvent {
     timelineId: string
   ): Promise<PinnedEventSavedObject[]> {
     const options: SavedObjectsFindOptions = {
+      type: pinnedEventSavedObjectType,
       search: timelineId,
       searchFields: ['timelineId'],
     };
@@ -81,6 +83,7 @@ export class PinnedEvent {
     sort: SortNote | null
   ): Promise<PinnedEventSavedObject[]> {
     const options: SavedObjectsFindOptions = {
+      type: pinnedEventSavedObjectType,
       perPage: pageInfo != null ? pageInfo.pageSize : undefined,
       page: pageInfo != null ? pageInfo.pageIndex : undefined,
       search: search != null ? search : undefined,
@@ -181,10 +184,7 @@ export class PinnedEvent {
       request[internalFrameworkRequest]
     );
 
-    const savedObjects = await savedObjectsClient.find({
-      type: pinnedEventSavedObjectType,
-      ...options,
-    });
+    const savedObjects = await savedObjectsClient.find(options);
 
     return savedObjects.saved_objects.map(savedObject =>
       convertSavedObjectToSavedPinnedEvent(savedObject)

diff --git a/x-pack/legacy/plugins/siem/server/lib/timeline/saved_object.ts b/x-pack/legacy/plugins/siem/server/lib/timeline/saved_object.ts
@@ -61,6 +61,7 @@ export class Timeline {
     sort: SortTimeline | null
   ): Promise<ResponseTimelines> {
     const options: SavedObjectsFindOptions = {
+      type: timelineSavedObjectType,
       perPage: pageInfo != null ? pageInfo.pageSize : undefined,
       page: pageInfo != null ? pageInfo.pageIndex : undefined,
       search: search != null ? search : undefined,
@@ -266,10 +267,7 @@ export class Timeline {
       }`;
     }
 
-    const savedObjects = await savedObjectsClient.find({
-      type: timelineSavedObjectType,
-      ...options,
-    });
+    const savedObjects = await savedObjectsClient.find(options);
 
     const timelinesWithNotesAndPinnedEvents = await Promise.all(
       savedObjects.saved_objects.map(async savedObject => {

diff --git a/...legacy/plugins/spaces/server/lib/saved_objects_client/spaces_saved_objects_client.test.ts b/...legacy/plugins/spaces/server/lib/saved_objects_client/spaces_saved_objects_client.test.ts
@@ -139,7 +139,9 @@ const createSpacesService = async (spaceId: string) => {
           types,
         });
 
-        await expect(client.find({ namespace: 'bar' })).rejects.toThrowErrorMatchingSnapshot();
+        await expect(
+          client.find({ type: 'foo', namespace: 'bar' })
+        ).rejects.toThrowErrorMatchingSnapshot();
       });
 
       test(`passes options.type to baseClient if valid singular type specified`, async () => {

diff --git a/x-pack/legacy/plugins/spaces/server/lib/saved_objects_client/spaces_saved_objects_client.ts b/x-pack/legacy/plugins/spaces/server/lib/saved_objects_client/spaces_saved_objects_client.ts
@@ -132,7 +132,7 @@ export class SpacesSavedObjectsClient implements SavedObjectsClientContract {
    * @property {object} [options.hasReference] - { type, id }
    * @returns {promise} - { saved_objects: [{ id, type, version, attributes }], total, per_page, page }
    */
-  public async find(options: SavedObjectsFindOptions = {}) {
+  public async find(options: SavedObjectsFindOptions) {
     throwErrorIfNamespaceSpecified(options);
 
     return await this.client.find({