@twin.org/node-core 0.9.5-next.1 → 0.10.0

package/dist/es/builders/engineEnvBuilder.js

@@ -4,11 +4,12 @@ import { cpus } from "node:os";
 import path from "node:path";
 import { Is, Mutex } from "@twin.org/core";
 import { EngineCloneMode } from "@twin.org/engine-models";
-import { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, AutomationActionType, AutomationComponentType, BackgroundTaskComponentType, BlobStorageComponentType, BlobStorageConnectorType, ContextIdHandlerComponentType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DataspaceControlPlaneComponentType, DataspaceDataPlaneComponentType, DltConfigType, DocumentManagementComponentType, EmailProtocolConnectorType, EngineTypeHelper, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, FederatedCatalogueComponentType, FederatedCatalogueFilterComponentType, HealthComponentType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, LoggingComponentType, LoggingConnectorType, MailboxComponentType, MailStorageComponentType, MessagingAdminComponentType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, MetricsCollectorComponentType, MetricsProducerComponentType, NftComponentType, NftConnectorType, NotarizationComponentType, NotarizationConnectorType, PlatformComponentType, RightsManagementPapComponentType, RightsManagementPdpComponentType, RightsManagementPepComponentType, RightsManagementPipComponentType, RightsManagementPmpComponentType, RightsManagementPnapComponentType, RightsManagementPnpComponentType, RightsManagementPolicyArbiterComponentType, RightsManagementPolicyEnforcementProcessorComponentType, RightsManagementPolicyExecutionActionComponentType, RightsManagementPolicyInformationSourceComponentType, RightsManagementPolicyNegotiatorComponentType, RightsManagementPolicyObligationEnforcerComponentType, RightsManagementPolicyRequesterComponentType, RightsManagementPxpComponentType, SchemaVersionMigrationComponentType, TaskSchedulerComponentType, TelemetryComponentType, TelemetryConnectorType, TenantAdminComponentType, TracingComponentType, TracingConnectorType, TrustComponentType, TrustGeneratorComponentType, TrustVerifierComponentType, VaultConnectorType, WalletConnectorType } from "@twin.org/engine-types";
+import { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, AutomationActionType, AutomationComponentType, BackgroundTaskComponentType, BlobStorageComponentType, BlobStorageConnectorType, ContextIdHandlerComponentType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DataspaceControlPlaneComponentType, DataspaceDataPlaneComponentType, DltConfigType, DocumentManagementComponentType, EmailProtocolConnectorType, EngineTypeHelper, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FacadeType, FaucetConnectorType, FederatedCatalogueComponentType, FederatedCatalogueFilterComponentType, HealthComponentType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, LoggingComponentType, LoggingConnectorType, MailboxComponentType, MailStorageComponentType, MessagingAdminComponentType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, MetricsCollectorComponentType, MetricsProducerComponentType, NftComponentType, NftConnectorType, NotarizationComponentType, NotarizationConnectorType, PlatformComponentType, RightsManagementPapComponentType, RightsManagementPdpComponentType, RightsManagementPepComponentType, RightsManagementPipComponentType, RightsManagementPmpComponentType, RightsManagementPnapComponentType, RightsManagementPnpComponentType, RightsManagementPolicyArbiterComponentType, RightsManagementPolicyEnforcementProcessorComponentType, RightsManagementPolicyExecutionActionComponentType, RightsManagementPolicyInformationSourceComponentType, RightsManagementPolicyNegotiatorComponentType, RightsManagementPolicyObligationEnforcerComponentType, RightsManagementPolicyRequesterComponentType, RightsManagementPxpComponentType, SchemaVersionMigrationComponentType, TaskSchedulerComponentType, TelemetryComponentType, TelemetryConnectorType, TenantAdminComponentType, TracingComponentType, TracingConnectorType, TrustComponentType, TrustGeneratorComponentType, 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, DEFAULT_HEALTH_EXCLUDE_CLONE_COMPONENTS } from "../defaults.js";
+import { TracingFacade } from "@twin.org/tracing-facades";
+import { CONTEXT_ID_HANDLER_FEATURE_DID, CONTEXT_ID_HANDLER_FEATURE_TENANT, COMPONENT_FACTORY_TYPE_NAME, DEFAULT_HEALTH_EXCLUDE_CLONE_COMPONENTS, DEFAULT_TRACING_FACADE_COMPONENT_EXCLUDE_TYPES, DEFAULT_TRACING_FACADE_FACTORIES, TRACING_FACADE_NAME } from "../defaults.js";
 import { isAuthEntityStorageRequired } from "./engineServerEnvBuilder.js";
 import { commaSeparatedListToArray, envArray, envBoolean, envChoice, envCount, envDateTime, envInteger, envListToArray, envMinToMs, envMinutes, envMs, envSecToMs, envSeconds } from "./helper/envHelpers.js";
 /**
@@ -51,6 +52,7 @@ export async function buildEngineConfiguration(envVars) {
     await configureTelemetry(coreConfig, envVars);
     await configureMetricsCollector(coreConfig, envVars);
     await configureTracing(coreConfig, envVars);
+    await configureFacades(coreConfig, envVars);
     await configureMessaging(coreConfig, envVars);
     await configureMailbox(coreConfig, envVars);
     await configureAutomation(coreConfig, envVars);
@@ -719,6 +721,80 @@ async function configureTracing(coreConfig, envVars) {
         coreConfig.types.tracingComponent.push({ type: TracingComponentType.Service });
     }
 }
+/**
+ * Configures the facades.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ * @returns A promise that resolves when the facade configuration has been applied.
+ */
+async function configureFacades(coreConfig, envVars) {
+    const facadeTypes = envListToArray(envVars, "facade", Object.values(FacadeType));
+    if (!Is.arrayValue(facadeTypes)) {
+        return;
+    }
+    coreConfig.types.facade ??= [];
+    coreConfig.facades ??= {};
+    for (const facadeType of facadeTypes) {
+        if (facadeType === FacadeType.Tracing) {
+            configureTracingFacade(coreConfig.types.facade, coreConfig.facades, envVars);
+        }
+    }
+}
+/**
+ * Configures the tracing facade.
+ * @param facadeTypeConfigs The facade type configs to add to.
+ * @param facades The facades to activate, keyed by the type name of the factory they apply to.
+ * @param envVars The environment variables.
+ */
+function configureTracingFacade(facadeTypeConfigs, facades, envVars) {
+    // The facade records its spans through the tracing subsystem, without it there is nothing to record to.
+    if (!isTracingEnabled(envVars)) {
+        return;
+    }
+    // The facade is meaningless without factories to activate it on, so fall back to the defaults.
+    const configuredFactoryTypeNames = commaSeparatedListToArray(envVars.tracingFacadeFactories);
+    const factoryTypeNames = [
+        ...new Set(Is.arrayValue(configuredFactoryTypeNames)
+            ? configuredFactoryTypeNames
+            : DEFAULT_TRACING_FACADE_FACTORIES)
+    ];
+    const config = {};
+    // Adding to the default excludes. We want to keep default list as a base and only add to it.
+    const excludeParams = commaSeparatedListToArray(envVars.tracingFacadeExcludeParams);
+    if (Is.arrayValue(excludeParams)) {
+        config.excludeParams = [
+            ...new Set([...TracingFacade.DEFAULT_EXCLUDE_PARAMS, ...excludeParams])
+        ];
+    }
+    const excludeMethods = commaSeparatedListToArray(envVars.tracingFacadeExcludeMethods);
+    if (Is.arrayValue(excludeMethods)) {
+        config.excludeMethods = [
+            ...new Set([...TracingFacade.DEFAULT_EXCLUDE_METHODS, ...excludeMethods])
+        ];
+    }
+    const includeObjects = commaSeparatedListToArray(envVars.tracingFacadeIncludeObjects);
+    if (Is.arrayValue(includeObjects)) {
+        config.includeObjects = includeObjects;
+    }
+    facadeTypeConfigs.push({
+        type: FacadeType.Tracing,
+        options: Is.objectValue(config) ? { config } : undefined,
+        cloneMode: EngineCloneMode.Always
+    });
+    const componentExcludeTypes = [
+        ...new Set([
+            ...DEFAULT_TRACING_FACADE_COMPONENT_EXCLUDE_TYPES,
+            ...commaSeparatedListToArray(envVars.tracingFacadeComponentExcludeTypes)
+        ])
+    ];
+    for (const factoryTypeName of factoryTypeNames) {
+        facades[factoryTypeName] ??= [];
+        facades[factoryTypeName].push({
+            name: TRACING_FACADE_NAME,
+            excludeTypes: factoryTypeName === COMPONENT_FACTORY_TYPE_NAME ? componentExcludeTypes : undefined
+        });
+    }
+}
 /**
  * Configures the automation.
  * @param coreConfig The core config.