Add batch delete rows

Author: bigfluffycookie

packages/openops/src/lib/openops-tables/rows.ts

@@ -25,6 +25,10 @@ export interface RowParams {
   tokenOrResolver: TokenOrResolver;
 }
 
+export interface BatchDeleteRowsParams extends RowParams {
+  rowIds: number[];
+}
+
 export interface GetRowsParams extends RowParams {
   filters?: { fieldName: string; value: any; type: ViewFilterTypesEnum }[];
   filterType?: FilterType;
@@ -252,3 +256,29 @@ function getEqualityFilterType(
 
   return ViewFilterTypesEnum.equal;
 }
+
+export async function batchDeleteRows(params: BatchDeleteRowsParams) {
+  if (params.rowIds.length === 0) {
+    return;
+  }
+
+  const url = `api/database/rows/table/${params.tableId}/batch-delete/`;
+
+  return executeWithConcurrencyLimit(
+    async () => {
+      const authenticationHeader = createAxiosHeaders(params.tokenOrResolver);
+      return await makeOpenOpsTablesPost(
+        url,
+        { items: params.rowIds },
+        authenticationHeader,
+      );
+    },
+    (error) => {
+      logger.error('Error while batch deleting rows:', {
+        error,
+        url,
+        rowIds: params.rowIds,
+      });
+    },
+  );
+}

packages/openops/test/openops-tables/rows.test.ts

@@ -54,6 +54,7 @@ import {
 import { axiosTablesRetryConfig } from '../../src/lib/openops-tables/requests-helpers';
 import {
   addRow,
+  batchDeleteRows,
   deleteRow,
   getRowByPrimaryKeyValue,
   getRows,
@@ -321,6 +322,41 @@ describe('delete row', () => {
   });
 });
 
+describe('batchDeleteRows', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  test('does nothing when rowIds is empty', async () => {
+    await batchDeleteRows({ tableId: 1, tokenOrResolver: 'token', rowIds: [] });
+
+    expect(makeOpenOpsTablesPostMock).not.toHaveBeenCalled();
+    expect(acquireMock).not.toHaveBeenCalled();
+  });
+
+  test('posts to batch-delete endpoint with correct url and body', async () => {
+    makeOpenOpsTablesPostMock.mockResolvedValue('mock result');
+    createAxiosHeadersMock.mockReturnValue('some header');
+
+    const result = await batchDeleteRows({
+      tableId: 5,
+      tokenOrResolver: 'token',
+      rowIds: [1, 2, 3],
+    });
+
+    expect(result).toBe('mock result');
+    expect(acquireMock).toBeCalledTimes(1);
+    expect(releaseMock).toBeCalledTimes(1);
+    expect(makeOpenOpsTablesPostMock).toBeCalledTimes(1);
+    expect(makeOpenOpsTablesPostMock).toHaveBeenCalledWith(
+      'api/database/rows/table/5/batch-delete/',
+      { items: [1, 2, 3] },
+      'some header',
+    );
+    expect(createAxiosHeadersMock).toHaveBeenCalledWith('token');
+  });
+});
+
 describe('getRowByPrimaryKeyValue', () => {
   beforeEach(() => {
     jest.clearAllMocks();