Make fields and rows Openops tables helpers use database token authentication helpers (#1663)

Part of OPS-3021.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Refactor**
* Updated token/context handling and public parameter types across
table-related APIs.
  * Reorganized request header utilities to centralize header creation.

* **Tests**
  * Enhanced test mocks with numeric/boolean/throw-or-return helpers.
* Adjusted mock initialization to improve module loading and alignment
with header mocking.

* **Deprecation**
* Added deprecation notice for the default database ID helper; slated
for future removal.

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Marcelo Gonçalves <[email protected]>

Author: cezudas

packages/openops/src/index.ts

@@ -38,6 +38,7 @@ export * from './lib/aws/pricing';
 export * from './lib/openops-analytics';
 export * from './lib/openops-tables/applications-service';
 export * from './lib/openops-tables/auth-user';
+export * from './lib/openops-tables/create-axios-headers';
 export * from './lib/openops-tables/fields';
 export * from './lib/openops-tables/filters';
 export * from './lib/openops-tables/openops-tables-common-properties';

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

@@ -1,8 +1,13 @@
-import { createAxiosHeaders, makeOpenOpsTablesGet } from './requests-helpers';
+import { createAxiosHeaders } from './create-axios-headers';
+import { makeOpenOpsTablesGet } from './requests-helpers';
 import { Application } from './types';
 
 export const OPENOPS_DEFAULT_DATABASE_NAME = 'OpenOps Dataset';
 
+/*
+@deprecated The tablesDatabaseId is now stored in the project.
+This function will be removed once flag ENABLE_TABLES_DATABASE_TOKEN is removed.
+*/
 export async function getDefaultDatabaseId(
   token: string,
   databaseName = OPENOPS_DEFAULT_DATABASE_NAME, // TODO: remove this when all environments are migrated

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

@@ -1,23 +1,21 @@
 import { IAxiosRetryConfig } from 'axios-retry';
-import {
-  createAxiosHeaders,
-  makeOpenOpsTablesGet,
-} from '../openops-tables/requests-helpers';
+import { makeOpenOpsTablesGet } from '../openops-tables/requests-helpers';
+import { TokenOrResolver } from './context-helpers';
+import { createAxiosHeaders } from './create-axios-headers';
 
 export async function getFields(
   tableId: number,
-  token: string,
+  tokenOrResolver: TokenOrResolver,
   userFieldNames = true,
   axiosRetryConfig?: IAxiosRetryConfig,
 ): Promise<OpenOpsField[]> {
-  const authenticationHeader = createAxiosHeaders(token);
+  const authenticationHeader = createAxiosHeaders(tokenOrResolver);
   const fields = await makeOpenOpsTablesGet<any[]>(
     `api/database/fields/table/${tableId}/?user_field_names=${userFieldNames}`,
     authenticationHeader,
     axiosRetryConfig,
   );
-
-  return fields.flatMap((item) => item);
+  return fields.flat();
 }
 
 export interface OpenOpsField {

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

@@ -5,13 +5,6 @@ import { IAxiosRetryConfig } from 'axios-retry';
 import { StatusCodes } from 'http-status-codes';
 import { makeHttpRequest } from '../axios-wrapper';
 
-export function createAxiosHeaders(token: string): AxiosHeaders {
-  return new AxiosHeaders({
-    'Content-Type': 'application/json',
-    Authorization: `JWT ${token}`,
-  });
-}
-
 const RETRY_DELAY_MS = 1000;
 
 const getStatusText = (statusCode: number): string => {

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

@@ -6,13 +6,14 @@ import {
   ViewFilterTypesEnum,
 } from '../openops-tables/filters';
 import {
-  createAxiosHeaders,
   makeOpenOpsTablesDelete,
   makeOpenOpsTablesGet,
   makeOpenOpsTablesPatch,
   makeOpenOpsTablesPost,
   makeOpenOpsTablesPut,
 } from '../openops-tables/requests-helpers';
+import { TokenOrResolver } from './context-helpers';
+import { createAxiosHeaders } from './create-axios-headers';
 
 export interface OpenOpsRow {
   id: number;
@@ -21,7 +22,7 @@ export interface OpenOpsRow {
 
 export interface RowParams {
   tableId: number;
-  token: string;
+  token: TokenOrResolver;
 }
 
 export interface GetRowsParams extends RowParams {
@@ -207,22 +208,22 @@ export async function deleteRow(deleteRowParams: DeleteRowParams) {
 }
 
 export async function getRowByPrimaryKeyValue(
-  token: string,
+  tokenOrResolver: TokenOrResolver,
   tableId: number,
   primaryKeyFieldValue: string,
   primaryKeyFieldName: any,
   primaryKeyFieldType: string,
 ) {
   const rows = await getRows({
     tableId: tableId,
-    token: token,
     filters: [
       {
         fieldName: primaryKeyFieldName,
         value: primaryKeyFieldValue,
         type: getEqualityFilterType(primaryKeyFieldType),
       },
     ],
+    token: tokenOrResolver,
   });
 
   if (rows.length > 1) {

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

@@ -1,9 +1,7 @@
-import {
-  createAxiosHeaders,
-  makeOpenOpsTablesGet,
-} from '../openops-tables/requests-helpers';
+import { makeOpenOpsTablesGet } from '../openops-tables/requests-helpers';
 import { getDefaultDatabaseId } from './applications-service';
 import { authenticateDefaultUserInOpenOpsTables } from './auth-user';
+import { createAxiosHeaders } from './create-axios-headers';
 
 async function getTables(
   token: string,

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

@@ -2,6 +2,9 @@ const makeOpenOpsTablesGetMock = jest.fn();
 const createAxiosHeadersMock = jest.fn();
 jest.mock('../../src/lib/openops-tables/requests-helpers', () => ({
   makeOpenOpsTablesGet: makeOpenOpsTablesGetMock,
+}));
+
+jest.mock('../../src/lib/openops-tables/create-axios-headers', () => ({
   createAxiosHeaders: createAxiosHeadersMock,
 }));
 

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

@@ -2,6 +2,9 @@ const makeOpenOpsTablesGetMock = jest.fn();
 const createAxiosHeadersMock = jest.fn();
 jest.mock('../../src/lib/openops-tables/requests-helpers', () => ({
   makeOpenOpsTablesGet: makeOpenOpsTablesGetMock,
+}));
+
+jest.mock('../../src/lib/openops-tables/create-axios-headers', () => ({
   createAxiosHeaders: createAxiosHeadersMock,
 }));
 

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

@@ -5,6 +5,9 @@ jest.mock('../../src/lib/axios-wrapper', () => ({
 
 const systemMock = {
   get: jest.fn(),
+  getNumber: jest.fn(),
+  getBoolean: jest.fn(),
+  getOrThrow: jest.fn(),
 };
 
 jest.mock('@openops/server-shared', () => ({
@@ -30,6 +33,9 @@ describe('axios request', () => {
   beforeEach(() => {
     jest.clearAllMocks();
     systemMock.get.mockReturnValue('https://mockapi.com');
+    systemMock.getNumber.mockReturnValue(60);
+    systemMock.getBoolean.mockReturnValue(false);
+    systemMock.getOrThrow.mockReturnValue('mock-value');
   });
 
   const header = new AxiosHeaders({ some: 'header' });

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

@@ -4,16 +4,20 @@ const makeOpenOpsTablesPostMock = jest.fn();
 const makeOpenOpsTablesDeleteMock = jest.fn();
 const createAxiosHeadersMock = jest.fn();
 
-const actualRequestsHelpers = jest.requireActual(
-  '../../src/lib/openops-tables/requests-helpers',
-);
-
-jest.mock('../../src/lib/openops-tables/requests-helpers', () => ({
-  ...actualRequestsHelpers,
-  makeOpenOpsTablesGet: makeOpenOpsTablesGetMock,
-  makeOpenOpsTablesPatch: makeOpenOpsTablesPatchMock,
-  makeOpenOpsTablesPost: makeOpenOpsTablesPostMock,
-  makeOpenOpsTablesDelete: makeOpenOpsTablesDeleteMock,
+jest.mock('../../src/lib/openops-tables/requests-helpers', () => {
+  const actualRequestsHelpers = jest.requireActual(
+    '../../src/lib/openops-tables/requests-helpers',
+  );
+  return {
+    ...actualRequestsHelpers,
+    makeOpenOpsTablesGet: makeOpenOpsTablesGetMock,
+    makeOpenOpsTablesPatch: makeOpenOpsTablesPatchMock,
+    makeOpenOpsTablesPost: makeOpenOpsTablesPostMock,
+    makeOpenOpsTablesDelete: makeOpenOpsTablesDeleteMock,
+  };
+});
+
+jest.mock('../../src/lib/openops-tables/create-axios-headers', () => ({
   createAxiosHeaders: createAxiosHeadersMock,
 }));