PR feedback

Author: cnasikas

x-pack/plugins/cases/public/api/decoders.ts

@@ -15,10 +15,14 @@ import type {
   CasesFindResponse,
   CasesStatusResponse,
   CasesMetricsResponse,
+  CasesBulkGetResponseCertainFields,
+  CaseResponse,
 } from '../../common/api';
 import {
   CasesFindResponseRt,
   CasesStatusResponseRt,
+  CasesResponseRt,
+  getTypeForCertainFieldsFromArray,
   CasesMetricsResponseRt,
 } from '../../common/api';
 
@@ -36,3 +40,13 @@ export const decodeCasesMetricsResponse = (metrics?: CasesMetricsResponse) =>
     CasesMetricsResponseRt.decode(metrics),
     fold(throwErrors(createToasterPlainError), identity)
   );
+
+export const decodeCasesBulkGetResponse = <Field extends keyof CaseResponse = keyof CaseResponse>(
+  res: CasesBulkGetResponseCertainFields<Field>,
+  fields?: string[]
+) => {
+  const typeToDecode = getTypeForCertainFieldsFromArray(CasesResponseRt, fields);
+  pipe(typeToDecode.decode(res.cases), fold(throwErrors(createToasterPlainError), identity));
+
+  return res;
+};

x-pack/plugins/cases/public/api/index.test.ts

@@ -7,7 +7,7 @@
 
 import { httpServiceMock } from '@kbn/core/public/mocks';
 import { bulkGetCases, getCases, getCasesMetrics } from '.';
-import { allCases, allCasesSnake } from '../containers/mock';
+import { allCases, allCasesSnake, casesSnake } from '../containers/mock';
 
 describe('api', () => {
   beforeEach(() => {
@@ -50,11 +50,19 @@ describe('api', () => {
 
   describe('bulkGetCases', () => {
     const http = httpServiceMock.createStartContract({ basePath: '' });
-    http.post.mockResolvedValue({ cases: allCasesSnake, errors: [] });
+    http.post.mockResolvedValue({ cases: [{ title: 'test' }], errors: [] });
 
-    it('should return the correct response', async () => {
+    it('should return the correct cases with a subset of fields', async () => {
       expect(await bulkGetCases({ http, params: { ids: ['test'], fields: ['title'] } })).toEqual({
-        cases: allCasesSnake,
+        cases: [{ title: 'test' }],
+        errors: [],
+      });
+    });
+
+    it('should return the correct cases with all fields', async () => {
+      http.post.mockResolvedValueOnce({ cases: casesSnake, errors: [] });
+      expect(await bulkGetCases({ http, params: { ids: ['test'] } })).toEqual({
+        cases: casesSnake,
         errors: [],
       });
     });

x-pack/plugins/cases/public/api/index.ts

@@ -26,6 +26,7 @@ import type {
 } from '../../common/api';
 import { convertAllCasesToCamel, convertToCamelCase } from './utils';
 import {
+  decodeCasesBulkGetResponse,
   decodeCasesFindResponse,
   decodeCasesMetricsResponse,
   decodeCasesStatusResponse,
@@ -82,5 +83,5 @@ export const bulkGetCases = async <Field extends keyof CaseResponse = keyof Case
     }
   );
 
-  return res;
+  return decodeCasesBulkGetResponse(res, params.fields);
 };

x-pack/plugins/cases/public/client/api/index.test.ts

@@ -7,7 +7,7 @@
 
 import { httpServiceMock } from '@kbn/core/public/mocks';
 import { createClientAPI } from '.';
-import { allCases, allCasesSnake } from '../../containers/mock';
+import { allCases, allCasesSnake, casesSnake } from '../../containers/mock';
 
 describe('createClientAPI', () => {
   beforeEach(() => {
@@ -84,11 +84,19 @@ describe('createClientAPI', () => {
     describe('bulkGet', () => {
       const http = httpServiceMock.createStartContract({ basePath: '' });
       const api = createClientAPI({ http });
-      http.post.mockResolvedValue({ cases: [], errors: [] });
+      http.post.mockResolvedValue({ cases: [{ title: 'test' }], errors: [] });
 
-      it('should return the correct response', async () => {
+      it('should return the correct cases with a subset of fields', async () => {
+        expect(await api.cases.bulkGet({ ids: ['test'], fields: ['title'] })).toEqual({
+          cases: [{ title: 'test' }],
+          errors: [],
+        });
+      });
+
+      it('should return the correct cases with all fields', async () => {
+        http.post.mockResolvedValueOnce({ cases: casesSnake, errors: [] });
         expect(await api.cases.bulkGet({ ids: ['test'], fields: ['title'] })).toEqual({
-          cases: [],
+          cases: casesSnake,
           errors: [],
         });
       });

x-pack/plugins/cases/server/client/cases/client.ts

@@ -66,8 +66,8 @@ export interface CasesSubClient {
    * Retrieves multiple cases with the specified IDs.
    */
   bulkGet<Field extends keyof CaseResponse = keyof CaseResponse>(
-    params: CasesBulkGetRequestCertainFields<Field | 'id' | 'version' | 'owner'>
-  ): Promise<CasesBulkGetResponseCertainFields<Field | 'id' | 'version' | 'owner'>>;
+    params: CasesBulkGetRequestCertainFields<Field>
+  ): Promise<CasesBulkGetResponseCertainFields<Field>>;
   /**
    * Pushes a specific case to an external system.
    */