Remove the ENVIRONMENT variable and replace it with specific ones

Author: maor-rozenfeld

.env.template

@@ -15,6 +15,13 @@ OPS_BLOCKS_SOURCE='FILE'
 OPS_BLOCKS_SYNC_MODE=NONE
 OPS_ENABLE_HOST_SESSION=false
 OPS_EXEC_FILE_MAX_BUFFER_SIZE_MB=
+OPS_BLOCK_CACHE_ENABLED=false
+OPS_BLOCKS_HOT_RELOAD_ENABLED=true
+OPS_FAST_SHUTDOWN_ENABLED=true
+OPS_BLOCKS_BUILDER_ENABLED=true
+OPS_ENGINE_METADATA_CACHE_ENABLED=false
+OPS_SHOW_DEV_MODE_WARNING=true
+OPS_SEED_DEV_DATA=true
 
 # QUEUE CONFIGURATION
 OPS_QUEUE_MODE=REDIS

packages/server/api/.env.tests

@@ -2,6 +2,10 @@ OPS_API_KEY=api-key
 OPS_QUEUE_MODE=MEMORY
 OPS_DB_TYPE=SQLITE3
 OPS_ENVIRONMENT=test
+OPS_ENGINE_QUEUE_UPDATES_ENABLED=false
+OPS_RUN_DB_MIGRATIONS=false
+OPS_DB_SYNCHRONIZE_SCHEMA=true
+OPS_REQUIRE_ENGINE_VALIDATE_AUTH=false
 OPS_ENCRYPTION_KEY=7e19fad4c13eaea8f657afb12e8f9c40
 OPS_FRONTEND_URL=http://localhost:4200
 OPS_WEBHOOK_TIMEOUT_SECONDS=30

packages/server/api/src/app/app-connection/app-connection-service/validate-auth.ts

@@ -3,7 +3,6 @@ import {
   AppConnectionValue,
   ApplicationError,
   EngineResponseStatus,
-  EnvironmentType,
   ErrorCode,
   ProjectId,
 } from '@openops/shared';
@@ -14,8 +13,9 @@ import { findBlockByAuthProviderKey } from '../connection-providers-resolver';
 export const engineValidateAuth = async (
   params: EngineValidateAuthParams,
 ): Promise<void> => {
-  const environment = system.getOrThrow(SharedSystemProp.ENVIRONMENT);
-  if (environment === EnvironmentType.TESTING) {
+  const shouldValidateAuth =
+    system.getBoolean(SharedSystemProp.REQUIRE_ENGINE_VALIDATE_AUTH) ?? true;
+  if (!shouldValidateAuth) {
     return;
   }
   const { authProviderKey, auth, projectId } = params;

packages/server/api/src/app/app.ts

@@ -18,7 +18,6 @@ import {
 } from '@openops/server-shared';
 import {
   AppConnectionWithoutSensitiveData,
-  EnvironmentType,
   Flow,
   FlowImportTemplate,
   FlowRun,
@@ -311,10 +310,11 @@ The application started on ${system.get(
   logger.info(`Node version: ${process.version}`);
   logger.info(`Blocks will be loaded from source type ${blocksSource}`);
 
-  const environment = system.get(SharedSystemProp.ENVIRONMENT);
-  if (environment === EnvironmentType.DEVELOPMENT) {
+  const environmentName =
+    system.get(SharedSystemProp.ENVIRONMENT_NAME) ?? 'unknown';
+  if (system.getBoolean(SharedSystemProp.SHOW_DEV_MODE_WARNING)) {
     logger.warn(
-      `[WARNING]: The application is running in ${environment} mode.`,
+      `[WARNING]: The application is running in ${environmentName} mode.`,
     );
   }
 }

packages/server/api/src/app/database/database-connection.ts

@@ -1,10 +1,5 @@
-import {
-  AppSystemProp,
-  DatabaseType,
-  SharedSystemProp,
-  system,
-} from '@openops/server-shared';
-import { EnvironmentType, isNil } from '@openops/shared';
+import { AppSystemProp, DatabaseType, system } from '@openops/server-shared';
+import { isNil } from '@openops/shared';
 import {
   ArrayContains,
   DataSource,
@@ -67,13 +62,7 @@ function getEntities(): EntitySchema<unknown>[] {
 }
 
 const getSynchronize = (): boolean => {
-  const env = system.getOrThrow<EnvironmentType>(SharedSystemProp.ENVIRONMENT);
-
-  const value: Partial<Record<EnvironmentType, boolean>> = {
-    [EnvironmentType.TESTING]: true,
-  };
-
-  return value[env] ?? false;
+  return system.getBoolean(AppSystemProp.DB_SYNCHRONIZE_SCHEMA) ?? false;
 };
 
 export const commonProperties = {

packages/server/api/src/app/database/postgres-connection.ts

@@ -1,9 +1,5 @@
-import {
-  AppSystemProp,
-  SharedSystemProp,
-  system,
-} from '@openops/server-shared';
-import { EnvironmentType, isNil } from '@openops/shared';
+import { AppSystemProp, system } from '@openops/server-shared';
+import { isNil } from '@openops/shared';
 import { TlsOptions } from 'node:tls';
 import { DataSource, MigrationInterface } from 'typeorm';
 import { commonProperties } from './database-connection';
@@ -90,9 +86,10 @@ const getMigrations = (): (new () => MigrationInterface)[] => {
 };
 
 const getMigrationConfig = (): MigrationConfig => {
-  const env = system.getOrThrow<EnvironmentType>(SharedSystemProp.ENVIRONMENT);
+  const runDbMigrations =
+    system.getBoolean(AppSystemProp.RUN_DB_MIGRATIONS) ?? true;
 
-  if (env === EnvironmentType.TESTING) {
+  if (!runDbMigrations) {
     return {};
   }
 

packages/server/api/src/app/database/seeds/dev-seeds.ts

@@ -1,14 +1,13 @@
-import { logger, SharedSystemProp, system } from '@openops/server-shared';
-import { EnvironmentType, Provider } from '@openops/shared';
+import { AppSystemProp, logger, system } from '@openops/server-shared';
+import { Provider } from '@openops/shared';
 import { getAuthenticationService } from '../../authentication/authentication-service-factory';
 import { FlagEntity } from '../../flags/flag.entity';
 import { databaseConnection } from '../database-connection';
 
 const DEV_DATA_SEEDED_FLAG = 'DEV_DATA_SEEDED';
 
-const currentEnvIsNotDev = (): boolean => {
-  const env = system.get(SharedSystemProp.ENVIRONMENT);
-  return env !== EnvironmentType.DEVELOPMENT;
+const devSeedingEnabled = (): boolean => {
+  return system.getBoolean(AppSystemProp.SEED_DEV_DATA) ?? false;
 };
 
 const devDataAlreadySeeded = async (): Promise<boolean> => {
@@ -49,11 +48,8 @@ const seedDevUser = async (): Promise<void> => {
 };
 
 export const seedDevData = async (): Promise<void> => {
-  if (currentEnvIsNotDev()) {
-    logger.info(
-      { name: 'seedDevData' },
-      'skip: not in development environment',
-    );
+  if (!devSeedingEnabled()) {
+    logger.info({ name: 'seedDevData' }, 'skip: dev data seeding disabled');
     return;
   }
 

packages/server/api/src/app/flags/flag.service.ts

@@ -43,7 +43,7 @@ export const flagService = {
     flags.push(
       {
         id: FlagId.ENVIRONMENT,
-        value: system.get(SharedSystemProp.ENVIRONMENT),
+        value: system.get(SharedSystemProp.ENVIRONMENT_NAME),
         created,
         updated,
       },

packages/server/api/src/app/workers/engine-controller.ts

@@ -15,7 +15,6 @@ import {
   assertNotNullOrUndefined,
   EngineHttpResponse,
   EnginePrincipal,
-  EnvironmentType,
   ErrorCode,
   ExecutionState,
   FlowRunId,
@@ -83,8 +82,10 @@ export const flowEngineWorker: FastifyPluginAsyncTypebox = async (app) => {
       },
     },
     async (request) => {
-      const environment = system.getOrThrow(SharedSystemProp.ENVIRONMENT);
-      if (environment === EnvironmentType.TESTING) {
+      const queueUpdatesEnabled =
+        system.getBoolean(SharedSystemProp.ENGINE_QUEUE_UPDATES_ENABLED) ??
+        true;
+      if (!queueUpdatesEnabled) {
         return {};
       }
       const enginePrincipal = request.principal as unknown as EnginePrincipal;

packages/server/shared/src/lib/blocks-builder.ts

@@ -21,7 +21,8 @@ import { SharedSystemProp, system } from './system';
 
 const isFileBlocks =
   system.getOrThrow(SharedSystemProp.BLOCKS_SOURCE) === 'FILE';
-const isDevEnv = system.getOrThrow(SharedSystemProp.ENVIRONMENT) === 'dev';
+const blocksBuilderEnabled =
+  system.getBoolean(SharedSystemProp.BLOCKS_BUILDER_ENABLED) ?? false;
 
 const depBuildCache = loadBuildCache();
 
@@ -105,14 +106,12 @@ async function analyzeDependencies(): Promise<BuildResult> {
 }
 
 export async function blocksBuilder(): Promise<void> {
-  // Only run this script if the blocks source is file and the environment is dev
-  if (!isFileBlocks || !isDevEnv) {
+  // Only run this script if the blocks source is file and incremental building is enabled
+  if (!isFileBlocks || !blocksBuilderEnabled) {
     return;
   }
 
-  logger.info(
-    'Development environment detected - using smart incremental building',
-  );
+  logger.info('Blocks builder enabled - using smart incremental building');
 
   let lock: Lock | undefined;
   try {