Add get table by id function (#2182)

Part of OPS-4007

Author: bigfluffycookie

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

@@ -27,38 +27,42 @@ export async function getTableIdByTableName(
   return table.id;
 }
 
+export async function getTableById(
+  tableId: number,
+  tablesServerContext: TablesServerContext,
+): Promise<OpenOpsTable | undefined> {
+  const tables = await fetchAllTables(tablesServerContext);
+  return tables.find((t) => t.id === tableId);
+}
+
 export async function getTableByName(
   tableName: string,
   tablesServerContext: TablesServerContext,
 ): Promise<OpenOpsTable | undefined> {
   const tables = await getAvailableTablesInOpenopsTables(tablesServerContext);
-
-  const table = tables.find((t) => t.name === tableName);
-
-  return table;
+  return tables.find((t) => t.name === tableName);
 }
 
 export async function getTableNames(
   tablesServerContext: TablesServerContext,
 ): Promise<string[]> {
   const tables = await getAvailableTablesInOpenopsTables(tablesServerContext);
-
   return tables.map((t) => t.name);
 }
 
 async function getAvailableTablesInOpenopsTables(
   serverContext: TablesServerContext,
 ): Promise<OpenOpsTable[]> {
-  const tokenOrResolver = await resolveTokenProvider(serverContext);
+  const tables = await fetchAllTables(serverContext);
+  return getDistinctTableNames(tables);
+}
 
+async function fetchAllTables(
+  serverContext: TablesServerContext,
+): Promise<OpenOpsTable[]> {
+  const tokenOrResolver = await resolveTokenProvider(serverContext);
   const authenticationHeader = createAxiosHeaders(tokenOrResolver);
-
-  const tables = await getTables(
-    serverContext.tablesDatabaseId,
-    authenticationHeader,
-  );
-
-  return getDistinctTableNames(tables);
+  return getTables(serverContext.tablesDatabaseId, authenticationHeader);
 }
 
 // Tables allows you to have tables with the same name in the same database.

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

@@ -12,6 +12,7 @@ jest.mock('../../src/lib/openops-tables/create-axios-headers', () => ({
 import { EncryptedObject } from '@openops/shared';
 import { TablesServerContext } from '../../src/lib/openops-tables/context-helpers';
 import {
+  getTableById,
   getTableByName,
   getTableIdByTableName,
   getTableNames,
@@ -176,6 +177,46 @@ describe('get table id by table name', () => {
   });
 });
 
+describe('get table by id', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  test('should return the matching table', async () => {
+    makeOpenOpsTablesGetMock.mockResolvedValue([
+      { id: 1, name: 'table name 1' },
+      { id: 2, name: 'table name 2' },
+    ]);
+    createAxiosHeadersMock.mockReturnValue('some header');
+
+    const result = await getTableById(2, mockTablesServerContext);
+
+    expect(result).toStrictEqual({ id: 2, name: 'table name 2' });
+    expect(makeOpenOpsTablesGetMock).toBeCalledTimes(1);
+    expect(makeOpenOpsTablesGetMock).toHaveBeenCalledWith(
+      'api/database/tables/database/1/',
+      'some header',
+    );
+    expect(createAxiosHeadersMock).toBeCalledTimes(1);
+    expect(createAxiosHeadersMock).toHaveBeenCalledWith({
+      getToken: expect.any(Function),
+    });
+  });
+
+  test('should return undefined if table id is not found', async () => {
+    makeOpenOpsTablesGetMock.mockResolvedValue([
+      { id: 1, name: 'table name 1' },
+    ]);
+    createAxiosHeadersMock.mockReturnValue('some header');
+
+    const result = await getTableById(99, mockTablesServerContext);
+
+    expect(result).toBeUndefined();
+    expect(makeOpenOpsTablesGetMock).toBeCalledTimes(1);
+    expect(createAxiosHeadersMock).toBeCalledTimes(1);
+  });
+});
+
 describe('get table by table name', () => {
   beforeEach(() => {
     jest.clearAllMocks();