feat: add environment variables (#137)

* feat: add environment variables

Author: PierreDemailly

README.md

@@ -132,6 +132,25 @@ if (isDeleteOperation(event.operation)) {
 }
 ```
 
+### Environment Variables
+
+> [!IMPORTANT]
+> Some options takes the lead over environment variables. For instance with: `new Incomer({ dispatcherInactivityOptions: { maxPingInterval: 900_000 }})` the max ping interval will be `900_000` even if `MYUNISOFT_INCOMER_MAX_PING_INTERVAL` variable is set.
+
+| variable | description | default |
+| --- | --- | --- |
+| `MYUNISOFT_INCOMER_INIT_TIMEOUT` | Incomer initialisation timeout | `3_500` |
+| `MYUNISOFT_EVENTS_INIT_EXTERNAL` | Weither Incomer should initialise an external Dispatcher | `false` |
+| `MYUNISOFT_EVENTS_SILENT_LOGGER` | Disable logs | `false` |
+| `MYUNISOFT_INCOMER_MAX_PING_INTERVAL` | Maximum ping interval | `60_000` |
+| `MYUNISOFT_INCOMER_PUBLISH_INTERVAL` | Publish interval | `60_000` |
+| `MYUNISOFT_INCOMER_IS_DISPATCHER` | Weither Incomer is a Dispatcher | `false` |
+| `MYUNISOFT_DISPATCHER_IDLE_TIME` | Interval threshold when Dispatcher become idle | `600_000` |
+| `MYUNISOFT_DISPATCHER_CHECK_LAST_ACTIVITY_INTERVAL` | Dispatcher checking last activity interval | `120_000` |
+| `MYUNISOFT_DISPATCHER_BACKUP_TRANSACTION_STORE_NAME` | Default name for backup transaction store | `backup` |
+| `MYUNISOFT_DISPATCHER_INIT_TIMEOUT` | Dispatcher initialisation timeout | `3_500` |
+| `MYUNISOFT_DISPATCHER_PING_INTERVAL` | Dispatcher ping interval | `3_500` |
+
 ### API
 
 #### Dispatcher & Incomer class

src/class/eventManagement/dispatcher.class.ts

@@ -42,12 +42,13 @@ import { TransactionHandler } from "./dispatcher/transaction-handler.class";
 
 // CONSTANTS
 const ajv = new Ajv();
-const kIdleTime = 60_000 * 10;
-const kCheckLastActivityInterval = 60_000 * 2;
-const kCheckRelatedTransactionInterval = 60_000 * 3;
-const kBackupTransactionStoreName = "backup";
-const kSilentLogger = process.env.MYUNISOFT_EVENTS_SILENT_LOGGER || false;
-export const PING_INTERVAL = 60_000 * 5;
+const kIdleTime = Number(process.env.MYUNISOFT_DISPATCHER_IDLE_TIME ?? 60_000 * 10);
+const kCheckLastActivityInterval = Number(process.env.MYUNISOFT_DISPATCHER_CHECK_LAST_ACTIVITY_INTERVAL ?? 60_000 * 2);
+const kCheckRelatedTransactionInterval = Number(process.env.MYUNISOFT_DISPATCHER_RESOLVE_TRANSACTION_INTERVAL ?? 60_000 * 3);
+const kBackupTransactionStoreName = String(process.env.MYUNISOFT_DISPATCHER_BACKUP_TRANSACTION_STORE_NAME ?? "backup");
+const kSilentLogger = Boolean(process.env.MYUNISOFT_EVENTS_SILENT_LOGGER || false);
+const kMaxInitTimeout = Number(process.env.MYUNISOFT_DISPATCHER_INIT_TIMEOUT ?? 3_500);
+export const PING_INTERVAL = Number(process.env.MYUNISOFT_DISPATCHER_PING_INTERVAL ?? 60_000 * 5);
 
 export type DispatcherOptions<T extends GenericEvent = GenericEvent> = {
   /* Prefix for the channel name, commonly used to distinguish envs */
@@ -139,7 +140,7 @@ export class Dispatcher<T extends GenericEvent = GenericEvent> extends EventEmit
   private minTimeout = 0;
   // Arbitrary value according to fastify default pluginTimeout
   // Max timeout is 8_000, but u may init both an Dispatcher & an Incomer
-  private maxTimeout = 3_500;
+  private maxTimeout = kMaxInitTimeout;
 
   private eventsValidationFn: Map<string, ValidateFunction<Record<string, any>> | CustomEventsValidationFunctions>;
   private validationCbFn: (event: T) => void = null;

src/class/eventManagement/incomer.class.ts

@@ -10,6 +10,7 @@ import {
 } from "@myunisoft/redis";
 import { Logger, pino } from "pino";
 import { P, match } from "ts-pattern";
+import { ValidateFunction } from "ajv";
 
 // Import Internal Dependencies
 import {
@@ -39,14 +40,16 @@ import {
   defaultStandardLog
 } from "../../utils/index";
 import { Externals } from "./externals.class";
-import { ValidateFunction } from "ajv";
 
 // CONSTANTS
 // Arbitrary value according to fastify default pluginTimeout
 // Max timeout is 8_000, but u may init both an Dispatcher & an Incomer
-const kDefaultStartTime = 3_500;
-const kExternalInit = process.env.MYUNISOFT_EVENTS_INIT_EXTERNAL || false;
-const kSilentLogger = process.env.MYUNISOFT_EVENTS_SILENT_LOGGER || false;
+const kDefaultStartTime = Number(process.env.MYUNISOFT_INCOMER_INIT_TIMEOUT ?? 3_500);
+const kExternalInit = Boolean(process.env.MYUNISOFT_EVENTS_INIT_EXTERNAL ?? false);
+const kSilentLogger = Boolean(process.env.MYUNISOFT_EVENTS_SILENT_LOGGER ?? false);
+const kMaxPingInterval = Number(process.env.MYUNISOFT_INCOMER_MAX_PING_INTERVAL ?? 60_000);
+const kPublishInterval = Number(process.env.MYUNISOFT_INCOMER_PUBLISH_INTERVAL ?? 60_000);
+const kIsDispatcherInstance = Boolean(process.env.MYUNISOFT_INCOMER_IS_DISPATCHER ?? false);
 
 type DispatcherChannelEvents = { name: "approvement" };
 type IncomerChannelEvents<
@@ -101,7 +104,7 @@ export class Incomer <
   public baseUUID = randomUUID();
 
   private prefixedName: string;
-  private isDispatcherInstance?: boolean;
+  private isDispatcherInstance: boolean;
   private registerTransactionId: string | null;
   private eventsCast: EventCast[];
   private eventsSubscribe: EventSubscribe[];
@@ -132,8 +135,11 @@ export class Incomer <
     this.prefixedName = `${this.prefix ? `${this.prefix}-` : ""}`;
     this.dispatcherChannelName = this.prefixedName + channels.dispatcher;
     this.standardLogFn = options.standardLog ?? defaultStandardLog;
-    this.publishInterval = options.dispatcherInactivityOptions?.publishInterval ?? 60_000;
-    this.maxPingInterval = options.dispatcherInactivityOptions?.maxPingInterval ?? 60_000;
+    this.publishInterval = options.dispatcherInactivityOptions?.publishInterval ?? kPublishInterval;
+    this.maxPingInterval = options.dispatcherInactivityOptions?.maxPingInterval ?? kMaxPingInterval;
+    if (this.isDispatcherInstance === undefined) {
+      this.isDispatcherInstance = kIsDispatcherInstance;
+    }
 
     if (options.eventsValidation) {
       this.eventsValidationFn = options.eventsValidation.eventsValidationFn;
@@ -169,7 +175,6 @@ export class Incomer <
   private async checkDispatcherState() {
     if (this.lastPingDate + this.maxPingInterval < Date.now()) {
       this.dispatcherIsAlive = false;
-      this.isDispatcherInstance = false;
 
       return;
     }