Feature/harmonize processor concurrency environment variables (#3913)

* Harmonize processor concurrency environment variables

* Update changelog

CHANGELOG.md

@@ -15,12 +15,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Improved the labels of the chart of the holdings tab on the home page (experimental)
 - Exposed the timeout of the portfolio snapshot computation as an environment variable (`PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_TIMEOUT`)
+- Harmonized the processor concurrency environment variables
 - Improved the portfolio unit tests to work with exported activity files
 
 ### Fixed
 
 - Considered the language of the user settings on login with _Security Token_
 
+### Todo
+
+- Rename the environment variable from `PROCESSOR_CONCURRENCY_GATHER_ASSET_PROFILE` to `PROCESSOR_GATHER_ASSET_PROFILE_CONCURRENCY`
+- Rename the environment variable from `PROCESSOR_CONCURRENCY_GATHER_HISTORICAL_MARKET_DATA` to `PROCESSOR_GATHER_HISTORICAL_MARKET_DATA_CONCURRENCY`
+- Rename the environment variable from `PROCESSOR_CONCURRENCY_PORTFOLIO_SNAPSHOT` to `PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_CONCURRENCY`
+
 ## 2.114.0 - 2024-10-10
 
 ### Added

apps/api/src/services/configuration/configuration.service.ts

@@ -1,9 +1,9 @@
 import { Environment } from '@ghostfolio/api/services/interfaces/environment.interface';
 import {
   CACHE_TTL_NO_CACHE,
-  DEFAULT_PROCESSOR_CONCURRENCY_GATHER_ASSET_PROFILE,
+  DEFAULT_PROCESSOR_GATHER_ASSET_PROFILE_CONCURRENCY,
-  DEFAULT_PROCESSOR_CONCURRENCY_GATHER_HISTORICAL_MARKET_DATA,
+  DEFAULT_PROCESSOR_GATHER_HISTORICAL_MARKET_DATA_CONCURRENCY,
-  DEFAULT_PROCESSOR_CONCURRENCY_PORTFOLIO_SNAPSHOT,
+  DEFAULT_PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_CONCURRENCY,
   DEFAULT_PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_TIMEOUT,
   DEFAULT_ROOT_URL
 } from '@ghostfolio/common/config';
@@ -51,14 +51,14 @@ export class ConfigurationService {
       MAX_ACTIVITIES_TO_IMPORT: num({ default: Number.MAX_SAFE_INTEGER }),
       MAX_CHART_ITEMS: num({ default: 365 }),
       PORT: port({ default: 3333 }),
-      PROCESSOR_CONCURRENCY_GATHER_ASSET_PROFILE: num({
+      PROCESSOR_GATHER_ASSET_PROFILE_CONCURRENCY: num({
-        default: DEFAULT_PROCESSOR_CONCURRENCY_GATHER_ASSET_PROFILE
+        default: DEFAULT_PROCESSOR_GATHER_ASSET_PROFILE_CONCURRENCY
       }),
-      PROCESSOR_CONCURRENCY_GATHER_HISTORICAL_MARKET_DATA: num({
+      PROCESSOR_GATHER_HISTORICAL_MARKET_DATA_CONCURRENCY: num({
-        default: DEFAULT_PROCESSOR_CONCURRENCY_GATHER_HISTORICAL_MARKET_DATA
+        default: DEFAULT_PROCESSOR_GATHER_HISTORICAL_MARKET_DATA_CONCURRENCY
       }),
-      PROCESSOR_CONCURRENCY_PORTFOLIO_SNAPSHOT: num({
+      PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_CONCURRENCY: num({
-        default: DEFAULT_PROCESSOR_CONCURRENCY_PORTFOLIO_SNAPSHOT
+        default: DEFAULT_PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_CONCURRENCY
       }),
       PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_TIMEOUT: num({
         default: DEFAULT_PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_TIMEOUT

apps/api/src/services/interfaces/environment.interface.ts

@@ -30,6 +30,10 @@ export interface Environment extends CleanedEnvAccessors {
   MAX_ACTIVITIES_TO_IMPORT: number;
   MAX_CHART_ITEMS: number;
   PORT: number;
+  PROCESSOR_GATHER_ASSET_PROFILE_CONCURRENCY: number;
+  PROCESSOR_GATHER_HISTORICAL_MARKET_DATA_CONCURRENCY: number;
+  PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_CONCURRENCY: number;
+  PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_TIMEOUT: number;
   REDIS_DB: number;
   REDIS_HOST: string;
   REDIS_PASSWORD: string;

apps/api/src/services/queues/data-gathering/data-gathering.processor.ts

@@ -3,8 +3,8 @@ import { IDataGatheringItem } from '@ghostfolio/api/services/interfaces/interfac
 import { MarketDataService } from '@ghostfolio/api/services/market-data/market-data.service';
 import {
   DATA_GATHERING_QUEUE,
-  DEFAULT_PROCESSOR_CONCURRENCY_GATHER_ASSET_PROFILE,
+  DEFAULT_PROCESSOR_GATHER_ASSET_PROFILE_CONCURRENCY,
-  DEFAULT_PROCESSOR_CONCURRENCY_GATHER_HISTORICAL_MARKET_DATA,
+  DEFAULT_PROCESSOR_GATHER_HISTORICAL_MARKET_DATA_CONCURRENCY,
   GATHER_ASSET_PROFILE_PROCESS,
   GATHER_HISTORICAL_MARKET_DATA_PROCESS_JOB_NAME
 } from '@ghostfolio/common/config';
@@ -38,8 +38,8 @@ export class DataGatheringProcessor {
 
   @Process({
     concurrency: parseInt(
-      process.env.PROCESSOR_CONCURRENCY_GATHER_ASSET_PROFILE ??
+      process.env.PROCESSOR_GATHER_ASSET_PROFILE_CONCURRENCY ??
-        DEFAULT_PROCESSOR_CONCURRENCY_GATHER_ASSET_PROFILE.toString(),
+        DEFAULT_PROCESSOR_GATHER_ASSET_PROFILE_CONCURRENCY.toString(),
       10
     ),
     name: GATHER_ASSET_PROFILE_PROCESS
@@ -69,8 +69,8 @@ export class DataGatheringProcessor {
 
   @Process({
     concurrency: parseInt(
-      process.env.PROCESSOR_CONCURRENCY_GATHER_HISTORICAL_MARKET_DATA ??
+      process.env.PROCESSOR_GATHER_HISTORICAL_MARKET_DATA_CONCURRENCY ??
-        DEFAULT_PROCESSOR_CONCURRENCY_GATHER_HISTORICAL_MARKET_DATA.toString(),
+        DEFAULT_PROCESSOR_GATHER_HISTORICAL_MARKET_DATA_CONCURRENCY.toString(),
       10
     ),
     name: GATHER_HISTORICAL_MARKET_DATA_PROCESS_JOB_NAME

apps/api/src/services/queues/portfolio-snapshot/portfolio-snapshot.processor.ts

@@ -9,7 +9,7 @@ import { RedisCacheService } from '@ghostfolio/api/app/redis-cache/redis-cache.s
 import { ConfigurationService } from '@ghostfolio/api/services/configuration/configuration.service';
 import {
   CACHE_TTL_INFINITE,
-  DEFAULT_PROCESSOR_CONCURRENCY_PORTFOLIO_SNAPSHOT,
+  DEFAULT_PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_CONCURRENCY,
   PORTFOLIO_SNAPSHOT_PROCESS_JOB_NAME,
   PORTFOLIO_SNAPSHOT_QUEUE
 } from '@ghostfolio/common/config';
@@ -35,7 +35,7 @@ export class PortfolioSnapshotProcessor {
   @Process({
     concurrency: parseInt(
       process.env.PROCESSOR_CONCURRENCY_PORTFOLIO_SNAPSHOT ??
-        DEFAULT_PROCESSOR_CONCURRENCY_PORTFOLIO_SNAPSHOT.toString(),
+        DEFAULT_PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_CONCURRENCY.toString(),
       10
     ),
     name: PORTFOLIO_SNAPSHOT_PROCESS_JOB_NAME

libs/common/src/lib/config.ts

@@ -48,9 +48,9 @@ export const DEFAULT_CURRENCY = 'USD';
 export const DEFAULT_DATE_FORMAT_MONTH_YEAR = 'MMM yyyy';
 export const DEFAULT_LANGUAGE_CODE = 'en';
 export const DEFAULT_PAGE_SIZE = 50;
-export const DEFAULT_PROCESSOR_CONCURRENCY_GATHER_ASSET_PROFILE = 1;
+export const DEFAULT_PROCESSOR_GATHER_ASSET_PROFILE_CONCURRENCY = 1;
-export const DEFAULT_PROCESSOR_CONCURRENCY_GATHER_HISTORICAL_MARKET_DATA = 1;
+export const DEFAULT_PROCESSOR_GATHER_HISTORICAL_MARKET_DATA_CONCURRENCY = 1;
-export const DEFAULT_PROCESSOR_CONCURRENCY_PORTFOLIO_SNAPSHOT = 1;
+export const DEFAULT_PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_CONCURRENCY = 1;
 export const DEFAULT_PROCESSOR_PORTFOLIO_SNAPSHOT_COMPUTATION_TIMEOUT = 30000;
 export const DEFAULT_ROOT_URL = 'https://localhost:4200';