@twin.org/node-core 0.9.1-next.1 → 0.9.1-next.11

package/dist/es/builders/engineEnvBuilder.js

@@ -2,7 +2,7 @@
 // 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, 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, 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 { CONTEXT_ID_HANDLER_FEATURE_DID, CONTEXT_ID_HANDLER_FEATURE_TENANT } from "../defaults.js";
@@ -28,6 +28,7 @@ export async function buildEngineConfiguration(envVars) {
     if (!Is.empty(mutexTimeoutMs)) {
         Mutex.setDefaultTimeoutMs(mutexTimeoutMs);
     }
+    await configureSchemaMigration(coreConfig, envVars);
     await configurePlatform(coreConfig, envVars);
     await configureTenant(coreConfig, envVars);
     await configureContextIdHandlers(coreConfig, envVars);
@@ -343,6 +344,10 @@ async function configureLogging(coreConfig, envVars) {
                     config: {
                         batchSize: Coerce.integer(envVars.loggingBatchSize),
                         batchIntervalMs: (Coerce.integer(envVars.loggingBatchFlushInterval) ?? 5) * 1000,
+                        retainForMs: Coerce.integer(envVars.loggingRetainForMs),
+                        maxEntries: Coerce.integer(envVars.loggingMaxEntries),
+                        retentionIntervalMs: Coerce.integer(envVars.loggingRetentionIntervalMs),
+                        retentionBatchSize: Coerce.integer(envVars.loggingRetentionBatchSize),
                         mutexTimeoutMs: Coerce.integer(envVars.loggingMutexTimeout)
                     }
                 }
@@ -372,6 +377,21 @@ async function configureLogging(coreConfig, envVars) {
             });
             additionalConnectorCount++;
         }
+        else if (loggingConnector === LoggingConnectorType.File) {
+            coreConfig.types.loggingConnector.push({
+                type: LoggingConnectorType.File,
+                options: {
+                    config: {
+                        directory: envVars.loggingFileDirectory ?? envVars.storageFileRoot ?? "",
+                        filename: envVars.loggingFileFilename,
+                        maxFileSizeBytes: Coerce.integer(envVars.loggingFileMaxFileSizeBytes),
+                        maxRetainedFiles: Coerce.integer(envVars.loggingFileMaxRetainedFiles),
+                        mutexTimeoutMs: Coerce.integer(envVars.loggingMutexTimeout)
+                    }
+                }
+            });
+            additionalConnectorCount++;
+        }
     }
     // If more than one logging connector, then we need to add a multi connector
     // and set it as the default one
@@ -510,7 +530,8 @@ async function configureMetricsCollector(coreConfig, envVars) {
         coreConfig.types.metricsCollectorComponent ??= [];
         coreConfig.types.metricsCollectorComponent.push({
             type: MetricsCollectorComponentType.Service,
-            options: { config: { intervalMs: intervalSec * 1000 } }
+            options: { config: { intervalMs: intervalSec * 1000 } },
+            isCloneable: false
         });
         const maxHistory = Coerce.integer(envVars.telemetryMetricsProducerMaxHistory) ?? 1440;
         coreConfig.types.metricsProducerComponent ??= [];
@@ -519,7 +540,8 @@ async function configureMetricsCollector(coreConfig, envVars) {
         for (const producerType of metricsProducers) {
             coreConfig.types.metricsProducerComponent.push({
                 type: producerType,
-                options: { maxHistory }
+                options: { maxHistory },
+                isCloneable: false
             });
         }
     }
@@ -564,7 +586,24 @@ async function configureHealth(coreConfig, envVars) {
                     healthCheckInterval: (Coerce.integer(envVars.healthInterval) ?? 60) * 1000,
                     initialInterval: (Coerce.integer(envVars.healthStartupInterval) ?? 2) * 1000
                 }
-            }
+            },
+            isCloneable: false
+        });
+    }
+}
+/**
+ * Configures the schema migration.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ * @returns A promise that resolves when the schema migration configuration has been applied.
+ */
+async function configureSchemaMigration(coreConfig, envVars) {
+    const isSchemaMigrationEnabled = Coerce.boolean(envVars.schemaMigrationEnabled) ?? true;
+    if (isSchemaMigrationEnabled) {
+        coreConfig.types.schemaVersionMigrationComponent ??= [];
+        coreConfig.types.schemaVersionMigrationComponent.push({
+            type: SchemaVersionMigrationComponentType.Service,
+            isCloneable: false
         });
     }
 }
@@ -858,7 +897,8 @@ async function configureIdentity(coreConfig, envVars) {
                     identityPkgId: Is.stringValue(envVars.iotaIdentityPackageId)
                         ? envVars.iotaIdentityPackageId
                         : undefined,
-                    walletAddressIndex: Coerce.integer(envVars.identityWalletAddressIndex) ?? 0
+                    walletAddressIndex: Coerce.integer(envVars.identityWalletAddressIndex) ?? 0,
+                    didResolutionCacheTtlMs: Coerce.integer(envVars.identityDidResolutionCacheTtlMs)
                 }
             }
         });
@@ -1235,7 +1275,8 @@ async function configureFederatedCatalogue(coreConfig, envVars) {
             coreConfig.types.federatedCatalogueComponent.push({
                 type: FederatedCatalogueComponentType.RestClient,
                 options: {
-                    endpoint: envVars.federatedCatalogueRemoteEndpoint
+                    endpoint: envVars.federatedCatalogueRemoteEndpoint,
+                    pathPrefix: envVars.federatedCatalogueRestClientPathPrefix ?? "federated-catalogue"
                 }
             });
         }
@@ -1286,6 +1327,8 @@ async function configureDataspace(coreConfig, envVars) {
                     // Must match the control-plane REST mount, as it is combined with the public origin
                     // to build the consumer's advertised callback address;
                     callbackPath: envVars.dataspaceCallbackPath ?? "dataspace-control-plane",
+                    // Base mount path of the data plane only; the transfer handlers append the
+                    // sub-paths themselves (`/entities` for PULL, `/inbox` for PUSH).
                     dataPlanePath: envVars.dataspaceDataPlanePath,
                     autoStartTransfers: Coerce.boolean(envVars.dataspaceAutoStartTransfers),
                     stalledNegotiationTimeoutMs: !Is.empty(stalledNegotiationTimeout)
@@ -1343,7 +1386,9 @@ async function configureDlt(coreConfig, envVars) {
                     },
                     network: envVars.iotaNetwork ?? "",
                     coinType: Coerce.integer(envVars.iotaCoinType),
-                    gasStation: gasStationConfig
+                    gasStation: gasStationConfig,
+                    gasBudget: Coerce.integer(envVars.iotaGasBudget),
+                    gasReservationDuration: Coerce.integer(envVars.iotaGasReservationDuration)
                 }
             }
         });