Make cursor an optional parameter to findLists

This param is an optimization and not required for basic functionality.
elastic · Jul 2, 2020 · 0e4fee7 · 0e4fee7
1 parent 5be0e87
commit 0e4fee7
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git a/x-pack/plugins/lists/public/lists/api.test.ts b/x-pack/plugins/lists/public/lists/api.test.ts
@@ -88,7 +88,6 @@ describe('Value Lists API', () => {
     it('GETs from the lists endpoint', async () => {
       const abortCtrl = new AbortController();
       await findLists({
-        cursor: undefined,
         http: httpMock,
         pageIndex: 1,
         pageSize: 10,
@@ -106,7 +105,7 @@ describe('Value Lists API', () => {
     it('sends pagination as query parameters', async () => {
       const abortCtrl = new AbortController();
       await findLists({
-        cursor: undefined,
+        cursor: 'cursor',
         http: httpMock,
         pageIndex: 1,
         pageSize: 10,
@@ -116,15 +115,18 @@ describe('Value Lists API', () => {
       expect(httpMock.fetch).toHaveBeenCalledWith(
         '/api/lists/_find',
         expect.objectContaining({
-          query: { page: 1, per_page: 10 },
+          query: {
+            cursor: 'cursor',
+            page: 1,
+            per_page: 10,
+          },
         })
       );
     });
 
     it('rejects with an error if request payload is invalid (and does not make API call)', async () => {
       const abortCtrl = new AbortController();
       const payload: ApiPayload<FindListsParams> = {
-        cursor: undefined,
         pageIndex: 10,
         pageSize: 0,
       };
@@ -142,7 +144,6 @@ describe('Value Lists API', () => {
     it('rejects with an error if response payload is invalid', async () => {
       const abortCtrl = new AbortController();
       const payload: ApiPayload<FindListsParams> = {
-        cursor: undefined,
         pageIndex: 1,
         pageSize: 10,
       };

diff --git a/x-pack/plugins/lists/public/lists/hooks/use_find_lists.test.ts b/x-pack/plugins/lists/public/lists/hooks/use_find_lists.test.ts
@@ -25,7 +25,7 @@ describe('useFindLists', () => {
   it('invokes Api.findLists', async () => {
     const { result, waitForNextUpdate } = renderHook(() => useFindLists());
     act(() => {
-      result.current.start({ cursor: undefined, http: httpMock, pageIndex: 1, pageSize: 10 });
+      result.current.start({ http: httpMock, pageIndex: 1, pageSize: 10 });
     });
     await waitForNextUpdate();
 

diff --git a/x-pack/plugins/lists/public/lists/types.ts b/x-pack/plugins/lists/public/lists/types.ts
@@ -14,7 +14,7 @@ export interface ApiParams {
 export type ApiPayload<T extends ApiParams> = Omit<T, 'http' | 'signal'>;
 
 export interface FindListsParams extends ApiParams {
-  cursor: string | undefined;
+  cursor?: string | undefined;
   pageSize: number | undefined;
   pageIndex: number | undefined;
 }