@twin.org/node-core 0.9.2-next.4 → 0.9.2-next.6

package/dist/es/builders/engineEnvBuilder.js

@@ -2,9 +2,10 @@
 // SPDX-License-Identifier: Apache-2.0.
 import path from "node:path";
 import { Coerce, Is, Mutex } from "@twin.org/core";
-import { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, AutomationComponentType, BackgroundTaskComponentType, BlobStorageComponentType, BlobStorageConnectorType, ContextIdHandlerComponentType, DataProcessingComponentType, DataspaceControlPlaneComponentType, DataspaceDataPlaneComponentType, DltConfigType, DocumentManagementComponentType, EngineTypeHelper, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, FederatedCatalogueComponentType, HealthComponentType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, LoggingComponentType, LoggingConnectorType, MessagingAdminComponentType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, MetricsCollectorComponentType, MetricsProducerComponentType, NftComponentType, NftConnectorType, NotarizationComponentType, NotarizationConnectorType, PlatformComponentType, RightsManagementPapComponentType, RightsManagementPdpComponentType, RightsManagementPepComponentType, RightsManagementPipComponentType, RightsManagementPmpComponentType, RightsManagementPnapComponentType, RightsManagementPnpComponentType, RightsManagementPxpComponentType, SchemaVersionMigrationComponentType, TaskSchedulerComponentType, TelemetryComponentType, TelemetryConnectorType, TenantAdminComponentType, TrustComponentType, TrustVerifierComponentType, VaultConnectorType, WalletConnectorType } from "@twin.org/engine-types";
+import { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, AutomationComponentType, BackgroundTaskComponentType, BlobStorageComponentType, BlobStorageConnectorType, ContextIdHandlerComponentType, DataProcessingComponentType, DataspaceControlPlaneComponentType, DataspaceDataPlaneComponentType, DltConfigType, DocumentManagementComponentType, EngineTypeHelper, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, FederatedCatalogueComponentType, HealthComponentType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, LoggingComponentType, LoggingConnectorType, MessagingAdminComponentType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, MetricsCollectorComponentType, MetricsProducerComponentType, NftComponentType, NftConnectorType, NotarizationComponentType, NotarizationConnectorType, PlatformComponentType, RightsManagementPapComponentType, RightsManagementPdpComponentType, RightsManagementPepComponentType, RightsManagementPipComponentType, RightsManagementPmpComponentType, RightsManagementPnapComponentType, RightsManagementPnpComponentType, RightsManagementPxpComponentType, SchemaVersionMigrationComponentType, TaskSchedulerComponentType, TelemetryComponentType, TelemetryConnectorType, TenantAdminComponentType, TracingComponentType, TracingConnectorType, TrustComponentType, TrustVerifierComponentType, VaultConnectorType, WalletConnectorType } from "@twin.org/engine-types";
 import { OpenTelemetryExporterTypes } from "@twin.org/logging-connector-opentelemetry";
 import { OpenTelemetryReaderTypes } from "@twin.org/telemetry-connector-opentelemetry";
+import { OpenTelemetryProcessorTypes } from "@twin.org/tracing-connector-opentelemetry";
 import { CONTEXT_ID_HANDLER_FEATURE_DID, CONTEXT_ID_HANDLER_FEATURE_TENANT } from "../defaults.js";
 import { isAuthEntityStorageRequired } from "./engineServerEnvBuilder.js";
 /**
@@ -42,6 +43,7 @@ export async function buildEngineConfiguration(envVars) {
     await configureEventBus(coreConfig, envVars);
     await configureTelemetry(coreConfig, envVars);
     await configureMetricsCollector(coreConfig, envVars);
+    await configureTracing(coreConfig, envVars);
     await configureMessaging(coreConfig, envVars);
     await configureAutomation(coreConfig, envVars);
     await configureHealth(coreConfig, envVars);
@@ -354,7 +356,7 @@ async function configureLogging(coreConfig, envVars) {
             });
             additionalConnectorCount++;
         }
-        else if (loggingConnector === LoggingConnectorType.Otel) {
+        else if (loggingConnector === LoggingConnectorType.OpenTelemetry) {
             const otelLoggingConfig = {
                 loggerName: envVars.openTelemetryLoggingLoggerName,
                 loggerVersion: envVars.openTelemetryLoggingLoggerVersion
@@ -370,7 +372,7 @@ async function configureLogging(coreConfig, envVars) {
                 };
             }
             coreConfig.types.loggingConnector.push({
-                type: LoggingConnectorType.Otel,
+                type: LoggingConnectorType.OpenTelemetry,
                 options: {
                     config: otelLoggingConfig
                 }
@@ -499,7 +501,7 @@ async function configureTelemetry(coreConfig, envVars) {
     }
     else if (envVars.telemetryConnector === TelemetryConnectorType.OpenTelemetry) {
         let readers;
-        if (envVars.openTelemetryReader === "prometheus") {
+        if (envVars.openTelemetryReader === OpenTelemetryReaderTypes.Prometheus) {
             readers = {
                 prometheus: {
                     type: OpenTelemetryReaderTypes.Prometheus,
@@ -552,6 +554,50 @@ async function configureMetricsCollector(coreConfig, envVars) {
         }
     }
 }
+/**
+ * Configures the tracing.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ * @returns A promise that resolves when the tracing configuration has been applied.
+ */
+async function configureTracing(coreConfig, envVars) {
+    coreConfig.types.tracingConnector ??= [];
+    if (envVars.tracingConnector === TracingConnectorType.EntityStorage) {
+        coreConfig.types.tracingConnector.push({
+            type: TracingConnectorType.EntityStorage,
+            options: {
+                config: {
+                    mutexTimeoutMs: Coerce.integer(envVars.tracingMutexTimeout)
+                }
+            }
+        });
+    }
+    else if (envVars.tracingConnector === TracingConnectorType.OpenTelemetry) {
+        const otelTracingConfig = {
+            tracerName: envVars.openTelemetryTracingTracerName,
+            tracerVersion: envVars.openTelemetryTracingTracerVersion
+        };
+        if (Is.stringValue(envVars.openTelemetryTracingEndpoint)) {
+            otelTracingConfig.exporters = {
+                otlp: {
+                    endpoint: envVars.openTelemetryTracingEndpoint,
+                    processor: envVars.openTelemetryTracingProcessor ??
+                        OpenTelemetryProcessorTypes.Batch
+                }
+            };
+        }
+        coreConfig.types.tracingConnector.push({
+            type: TracingConnectorType.OpenTelemetry,
+            options: {
+                config: otelTracingConfig
+            }
+        });
+    }
+    if (coreConfig.types.tracingConnector.length > 0) {
+        coreConfig.types.tracingComponent ??= [];
+        coreConfig.types.tracingComponent.push({ type: TracingComponentType.Service });
+    }
+}
 /**
  * Configures the automation.
  * @param coreConfig The core config.
@@ -590,6 +636,7 @@ async function configureHealth(coreConfig, envVars) {
             options: {
                 config: {
                     healthCheckInterval: (Coerce.integer(envVars.healthInterval) ?? 60) * 1000,
+                    healthCheckApplicationInterval: (Coerce.integer(envVars.healthApplicationInterval) ?? 300) * 1000,
                     initialInterval: (Coerce.integer(envVars.healthStartupInterval) ?? 2) * 1000
                 }
             },
@@ -766,13 +813,14 @@ async function configureFaucet(coreConfig, envVars) {
             type: FaucetConnectorType.EntityStorage
         });
     }
-    else if (envVars.faucetConnector === FaucetConnectorType.Iota) {
+    else if (envVars.faucetConnector === FaucetConnectorType.Iota &&
+        Is.stringValue(envVars.iotaFaucetEndpoint)) {
         const dltConfig = EngineTypeHelper.getConfigOfType(coreConfig, "dltConfig", DltConfigType.Iota);
         coreConfig.types.faucetConnector.push({
             type: FaucetConnectorType.Iota,
             options: {
                 config: {
-                    endpoint: envVars.iotaFaucetEndpoint ?? "",
+                    endpoint: envVars.iotaFaucetEndpoint,
                     clientOptions: dltConfig?.options?.config?.clientOptions ?? { url: "" },
                     network: dltConfig?.options?.config?.network ?? ""
                 }
@@ -1479,7 +1527,8 @@ export function isTaskSchedulerRequired(envVars) {
     return ((Coerce.boolean(envVars.taskSchedulerEnabled) ?? false) ||
         (Coerce.boolean(envVars.dataspaceEnabled) ?? false) ||
         isRightsManagementRequired(envVars) ||
-        isAuthEntityStorageRequired(envVars));
+        isAuthEntityStorageRequired(envVars) ||
+        isImmutableProofRequired(envVars));
 }
 /**
  * Checks if the automation subsystem is required.