Merge branch 'main' into ops-3103

Author: ravikiranvm

packages/engine/src/engine-executor.ts

@@ -15,7 +15,7 @@ export async function executeEngine(
 ): Promise<string> {
   const startTime = performance.now();
 
-  await encryptionKeyInitializer();
+  encryptionKeyInitializer();
 
   // TODO: Remove this from the server side
   engineInput.publicUrl = await networkUtls.getPublicUrl();

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/cloud-cli-common.ts

@@ -10,10 +10,12 @@ export function handleCliError({
   command: string;
   error: unknown;
 }): never {
-  logger.error(`${provider} CLI execution failed.`, {
-    command,
-    error,
-  });
+  logger.error(
+    `${provider} CLI execution failed.`,
+    error instanceof Error
+      ? { command, error }
+      : { command, errorMessage: error },
+  );
 
   const message = `An error occurred while running ${provider} CLI command: ${error}`;
 

packages/openops/src/lib/command-wrapper.ts

@@ -42,10 +42,10 @@ export async function executeFile(
 
 async function getResult(childProcess: ChildProcess, fullCommand: string) {
   let stdout = '';
-  let error = '';
+  let errorMessage = '';
 
   childProcess.stderr?.on('data', function (data) {
-    error += data;
+    errorMessage += data;
   });
 
   childProcess.stdout?.on('data', (data) => {
@@ -62,13 +62,13 @@ async function getResult(childProcess: ChildProcess, fullCommand: string) {
     command: fullCommand,
     exitCode,
     stdout,
-    error,
+    errorMessage,
   });
 
   return {
     exitCode: exitCode,
     stdOut: trimNewLines(stdout),
-    stdError: trimNewLines(error),
+    stdError: trimNewLines(errorMessage),
   };
 }
 

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/context-helpers.ts

@@ -0,0 +1,29 @@
+import { ServerContext } from '@openops/blocks-framework';
+import { AppSystemProp, encryptUtils, system } from '@openops/server-shared';
+import { authenticateDefaultUserInOpenOpsTables } from './auth-user';
+
+export function shouldUseDatabaseToken(): boolean {
+  return system.getBoolean(AppSystemProp.ENABLE_TABLES_DATABASE_TOKEN) ?? false;
+}
+
+export type TokenOrResolver = string | { getToken: () => string };
+export type TablesServerContext = Pick<
+  ServerContext,
+  'tablesDatabaseId' | 'tablesDatabaseToken'
+>;
+
+export async function resolveTokenProvider(
+  serverContext: TablesServerContext,
+): Promise<TokenOrResolver> {
+  if (shouldUseDatabaseToken()) {
+    return {
+      getToken: () => {
+        const { tablesDatabaseToken } = serverContext;
+        return encryptUtils.decryptString(tablesDatabaseToken);
+      },
+    };
+  }
+
+  const { token } = await authenticateDefaultUserInOpenOpsTables();
+  return token;
+}

packages/openops/src/lib/openops-tables/create-axios-headers.ts

@@ -0,0 +1,35 @@
+import { AxiosHeaders } from 'axios';
+import { shouldUseDatabaseToken, TokenOrResolver } from './context-helpers';
+
+export enum AuthType {
+  JWT = 'JWT',
+  Token = 'Token',
+}
+
+function getToken(tokenOrResolver: TokenOrResolver): string {
+  return typeof tokenOrResolver === 'string'
+    ? tokenOrResolver
+    : tokenOrResolver.getToken();
+}
+
+function getAuthPrefix(
+  useJwtOverride: boolean,
+  shouldUseDatabaseTokenConfig: boolean,
+): AuthType {
+  const useJwt = useJwtOverride || !shouldUseDatabaseTokenConfig;
+  return useJwt ? AuthType.JWT : AuthType.Token;
+}
+
+export const createAxiosHeaders = (
+  tokenOrResolver: TokenOrResolver,
+): AxiosHeaders => {
+  const useJwtOverride = typeof tokenOrResolver === 'string';
+  const token = getToken(tokenOrResolver);
+
+  const prefix = getAuthPrefix(useJwtOverride, shouldUseDatabaseToken());
+
+  return new AxiosHeaders({
+    'Content-Type': 'application/json',
+    Authorization: `${prefix} ${token}`,
+  });
+};

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) {