@finos/legend-extension-dsl-persistence 2.0.9 → 3.0.0

package/src/graphManager/protocol/pure/v1/transformation/pureGraph/from/V1_PersistenceContextTransformer.ts

@@ -0,0 +1,141 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { PersistenceContext } from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_PersistenceContext.js';
+import {
+  type PersistencePlatform,
+  DefaultPersistencePlatform,
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_PersistencePlatform.js';
+import {
+  ConnectionValue,
+  PrimitiveTypeValue,
+  type ServiceParameter,
+  type ServiceParameterValue,
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_ServiceParameter.js';
+import { V1_PersistenceContext } from '../../../model/packageableElements/persistence/V1_DSLPersistence_PersistenceContext.js';
+import {
+  V1_DefaultPersistencePlatform,
+  type V1_PersistencePlatform,
+} from '../../../model/packageableElements/persistence/V1_DSLPersistence_PersistencePlatform.js';
+import {
+  V1_ConnectionValue,
+  V1_PrimitiveTypeValue,
+  V1_ServiceParameter,
+  type V1_ServiceParameterValue,
+} from '../../../model/packageableElements/persistence/V1_DSLPersistence_ServiceParameter.js';
+import type { DSLPersistence_PureProtocolProcessorPlugin_Extension } from '../../../../DSLPersistence_PureProtocolProcessorPlugin_Extension.js';
+import {
+  type V1_GraphTransformerContext,
+  V1_initPackageableElement,
+  V1_transformConnection,
+  V1_transformRootValueSpecification,
+} from '@finos/legend-graph';
+import { UnsupportedOperationError } from '@finos/legend-shared';
+
+/**********
+ * persistence platform
+ **********/
+
+export const V1_transformPersistencePlatform = (
+  element: PersistencePlatform,
+  context: V1_GraphTransformerContext,
+): V1_PersistencePlatform => {
+  if (element instanceof DefaultPersistencePlatform) {
+    return new V1_DefaultPersistencePlatform();
+  }
+  const extraPersistencePlatformTransformers = context.plugins.flatMap(
+    (plugin) =>
+      (
+        plugin as DSLPersistence_PureProtocolProcessorPlugin_Extension
+      ).V1_getExtraPersistencePlatformTransformers?.() ?? [],
+  );
+  for (const transformer of extraPersistencePlatformTransformers) {
+    const protocol = transformer(element, context);
+    if (protocol) {
+      return protocol;
+    }
+  }
+  throw new UnsupportedOperationError(
+    `Can't transform persistence platform: no compatible transformer available from plugins`,
+    element,
+  );
+};
+
+/**********
+ * service parameter
+ **********/
+
+export const V1_transformServiceParameterValue = (
+  element: ServiceParameterValue,
+  context: V1_GraphTransformerContext,
+): V1_ServiceParameterValue => {
+  if (element instanceof PrimitiveTypeValue) {
+    const protocol = new V1_PrimitiveTypeValue();
+    protocol.primitiveType = V1_transformRootValueSpecification(
+      element.primitiveType,
+    );
+    return protocol;
+  } else if (element instanceof ConnectionValue) {
+    const protocol = new V1_ConnectionValue();
+    protocol.connection = V1_transformConnection(
+      element.connection,
+      true,
+      context,
+    );
+    return protocol;
+  }
+  throw new UnsupportedOperationError(
+    `Can't transform service parameter value '${element}'`,
+  );
+};
+
+export const V1_transformServiceParameter = (
+  element: ServiceParameter,
+  context: V1_GraphTransformerContext,
+): V1_ServiceParameter => {
+  const protocol = new V1_ServiceParameter();
+  protocol.name = element.name;
+  protocol.value = V1_transformServiceParameterValue(element.value, context);
+  return protocol;
+};
+
+/**********
+ * persistence context
+ **********/
+
+export const V1_transformPersistenceContext = (
+  element: PersistenceContext,
+  context: V1_GraphTransformerContext,
+): V1_PersistenceContext => {
+  const protocol = new V1_PersistenceContext();
+  V1_initPackageableElement(protocol, element);
+  protocol.persistence = element.persistence.valueForSerialization ?? '';
+  protocol.platform = V1_transformPersistencePlatform(
+    element.platform,
+    context,
+  );
+  protocol.serviceParameters = element.serviceParameters.map((sp) =>
+    V1_transformServiceParameter(sp, context),
+  );
+  if (element.sinkConnection) {
+    protocol.sinkConnection = V1_transformConnection(
+      element.sinkConnection,
+      true,
+      context,
+    );
+  }
+  return protocol;
+};

package/src/{models/protocols → graphManager/protocol}/pure/v1/transformation/pureGraph/from/V1_PersistenceTransformer.ts

@@ -18,14 +18,14 @@ import {
   type Auditing,
   DateTimeAuditing,
   NoAuditing,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_Auditing.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Auditing.js';
 import {
   AnyVersionDeduplicationStrategy,
   type DeduplicationStrategy,
   DuplicateCountDeduplicationStrategy,
   MaxVersionDeduplicationStrategy,
   NoDeduplicationStrategy,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_DeduplicationStrategy.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_DeduplicationStrategy.js';
 import {
   AppendOnly,
   BitemporalDelta,
@@ -35,12 +35,12 @@ import {
   NontemporalSnapshot,
   UnitemporalDelta,
   UnitemporalSnapshot,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_IngestMode.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_IngestMode.js';
 import {
   DeleteIndicatorMergeStrategy,
   type MergeStrategy,
   NoDeletesMergeStrategy,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_MergeStrategy.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_MergeStrategy.js';
 import {
   BatchIdAndDateTimeTransactionMilestoning,
   BatchIdTransactionMilestoning,
@@ -54,36 +54,36 @@ import {
   type TransactionMilestoning,
   type ValidityDerivation,
   type ValidityMilestoning,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_Milestoning.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Milestoning.js';
 import {
   EmailNotifyee,
   type Notifier,
   type Notifyee,
   PagerDutyNotifyee,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_Notifier.js';
-import type { Persistence } from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_Persistence.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Notifier.js';
+import type { Persistence } from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Persistence.js';
 import {
   BatchPersister,
   type Persister,
   StreamingPersister,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_Persister.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Persister.js';
 import {
   ObjectStorageSink,
   RelationalSink,
   type Sink,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_Sink.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Sink.js';
 import {
   FlatTarget,
   MultiFlatTarget,
   type MultiFlatTargetPart,
   type TargetShape,
   TransactionScope,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_TargetShape.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_TargetShape.js';
 import {
   CronTrigger,
   ManualTrigger,
   type Trigger,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_Trigger.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Trigger.js';
 import {
   type V1_Auditing,
   V1_DateTimeAuditing,
@@ -192,6 +192,9 @@ export const V1_transformRelationalSink = (
   context: V1_GraphTransformerContext,
 ): V1_RelationalSink => {
   const protocol = new V1_RelationalSink();
+  if (element.database) {
+    protocol.database = element.database.value.path;
+  }
   if (element.connection) {
     protocol.connection = V1_transformConnection(
       element.connection,
@@ -207,12 +210,14 @@ export const V1_transformObjectStorageSink = (
   context: V1_GraphTransformerContext,
 ): V1_ObjectStorageSink => {
   const protocol = new V1_ObjectStorageSink();
-  protocol.connection = V1_transformConnection(
-    element.connection,
-    true,
-    context,
-  );
   protocol.binding = element.binding.value.path;
+  if (element.connection) {
+    protocol.connection = V1_transformConnection(
+      element.connection,
+      true,
+      context,
+    );
+  }
   return protocol;
 };
 
@@ -489,7 +494,7 @@ export const V1_transformFlatTarget = (
   context: V1_GraphTransformerContext,
 ): V1_FlatTarget => {
   const protocol = new V1_FlatTarget();
-  protocol.modelClass = element.modelClass.valueForSerialization;
+  protocol.modelClass = element.modelClass?.valueForSerialization;
   protocol.targetName = element.targetName;
   protocol.partitionFields = element.partitionFields;
   protocol.deduplicationStrategy = V1_transformDeduplicationStrategy(

package/src/{models/protocols → graphManager/protocol}/pure/v1/transformation/pureGraph/to/V1_PersistenceBuilder.ts

@@ -88,14 +88,14 @@ import {
   type Auditing,
   DateTimeAuditing,
   NoAuditing,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_Auditing.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Auditing.js';
 import {
   AnyVersionDeduplicationStrategy,
   type DeduplicationStrategy,
   DuplicateCountDeduplicationStrategy,
   MaxVersionDeduplicationStrategy,
   NoDeduplicationStrategy,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_DeduplicationStrategy.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_DeduplicationStrategy.js';
 import {
   AppendOnly,
   BitemporalDelta,
@@ -105,12 +105,12 @@ import {
   NontemporalSnapshot,
   UnitemporalDelta,
   UnitemporalSnapshot,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_IngestMode.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_IngestMode.js';
 import {
   DeleteIndicatorMergeStrategy,
   type MergeStrategy,
   NoDeletesMergeStrategy,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_MergeStrategy.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_MergeStrategy.js';
 import {
   BatchIdAndDateTimeTransactionMilestoning,
   BatchIdTransactionMilestoning,
@@ -124,43 +124,43 @@ import {
   type TransactionMilestoning,
   type ValidityDerivation,
   type ValidityMilestoning,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_Milestoning.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Milestoning.js';
 import {
   EmailNotifyee,
   Notifier,
   type Notifyee,
   PagerDutyNotifyee,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_Notifier.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Notifier.js';
 import {
   BatchPersister,
   type Persister,
   StreamingPersister,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_Persister.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Persister.js';
 import {
   ObjectStorageSink,
   RelationalSink,
   type Sink,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_Sink.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Sink.js';
 import {
   FlatTarget,
   MultiFlatTarget,
   MultiFlatTargetPart,
   type TargetShape,
   TransactionScope,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_TargetShape.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_TargetShape.js';
 import {
   CronTrigger,
   ManualTrigger,
   type Trigger,
-} from '../../../../../../metamodels/pure/model/packageableElements/persistence/DSLPersistence_Trigger.js';
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Trigger.js';
 import { getOwnPersistence } from '../../../../../../../graphManager/DSLPersistence_GraphManagerHelper.js';
 import {
   type Binding,
+  type Database,
   type PackageableElementImplicitReference,
   type V1_GraphBuilderContext,
-  V1_ProtocolToMetaModelConnectionBuilder,
   V1_buildFullPath,
-  optionalizePackageableElementReference,
+  V1_buildConnection,
 } from '@finos/legend-graph';
 import {
   guaranteeNonEmptyString,
@@ -198,10 +198,14 @@ export const V1_buildRelationalSink = (
   context: V1_GraphBuilderContext,
 ): RelationalSink => {
   const sink = new RelationalSink();
+  if (protocol.database) {
+    sink.database = context.resolveElement(
+      protocol.database,
+      false,
+    ) as PackageableElementImplicitReference<Database>;
+  }
   if (protocol.connection) {
-    sink.connection = protocol.connection.accept_ConnectionVisitor(
-      new V1_ProtocolToMetaModelConnectionBuilder(context),
-    );
+    sink.connection = V1_buildConnection(protocol.connection, context);
   }
   return sink;
 };
@@ -211,13 +215,13 @@ export const V1_buildObjectStorageSink = (
   context: V1_GraphBuilderContext,
 ): ObjectStorageSink => {
   const sink = new ObjectStorageSink();
-  sink.connection = protocol.connection.accept_ConnectionVisitor(
-    new V1_ProtocolToMetaModelConnectionBuilder(context),
-  );
   sink.binding = context.resolveElement(
     protocol.binding,
     false,
   ) as PackageableElementImplicitReference<Binding>;
+  if (protocol.connection) {
+    sink.connection = V1_buildConnection(protocol.connection, context);
+  }
   return sink;
 };
 
@@ -496,10 +500,9 @@ export const V1_buildFlatTarget = (
   context: V1_GraphBuilderContext,
 ): FlatTarget => {
   const targetShape = new FlatTarget();
-  targetShape.modelClass = optionalizePackageableElementReference(
-    modelClass ? context.resolveClass(modelClass) : undefined,
-  );
-
+  targetShape.modelClass = modelClass
+    ? context.resolveClass(modelClass)
+    : undefined;
   targetShape.targetName = guaranteeNonEmptyString(protocol.targetName);
   targetShape.partitionFields = protocol.partitionFields;
   targetShape.deduplicationStrategy = V1_buildDeduplicationStrategy(

package/src/graphManager/protocol/pure/v1/transformation/pureGraph/to/V1_PersistenceContextBuilder.ts

@@ -0,0 +1,151 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { V1_PersistenceContext } from '../../../model/packageableElements/persistence/V1_DSLPersistence_PersistenceContext.js';
+import {
+  type V1_PersistencePlatform,
+  V1_DefaultPersistencePlatform,
+} from '../../../model/packageableElements/persistence/V1_DSLPersistence_PersistencePlatform.js';
+import {
+  V1_ConnectionValue,
+  V1_PrimitiveTypeValue,
+  type V1_ServiceParameter,
+  type V1_ServiceParameterValue,
+} from '../../../model/packageableElements/persistence/V1_DSLPersistence_ServiceParameter.js';
+import type { Persistence } from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Persistence.js';
+import {
+  DefaultPersistencePlatform,
+  type PersistencePlatform,
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_PersistencePlatform.js';
+import {
+  ConnectionValue,
+  PrimitiveTypeValue,
+  ServiceParameter,
+  type ServiceParameterValue,
+} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_ServiceParameter.js';
+import { getOwnPersistenceContext } from '../../../../../../../graphManager/DSLPersistence_GraphManagerHelper.js';
+import type { DSLPersistence_PureProtocolProcessorPlugin_Extension } from '../../../../DSLPersistence_PureProtocolProcessorPlugin_Extension.js';
+import {
+  type PackageableElementImplicitReference,
+  V1_buildFullPath,
+  V1_buildValueSpecification,
+  type V1_GraphBuilderContext,
+  V1_buildConnection,
+} from '@finos/legend-graph';
+import { UnsupportedOperationError } from '@finos/legend-shared';
+
+/**********
+ * persistence platform
+ **********/
+
+export const V1_buildPersistencePlatform = (
+  protocol: V1_PersistencePlatform,
+  context: V1_GraphBuilderContext,
+): PersistencePlatform => {
+  if (protocol instanceof V1_DefaultPersistencePlatform) {
+    return new DefaultPersistencePlatform();
+  }
+  const extraPersistencePlatformBuilders = context.extensions.plugins.flatMap(
+    (plugin) =>
+      (
+        plugin as DSLPersistence_PureProtocolProcessorPlugin_Extension
+      ).V1_getExtraPersistencePlatformBuilders?.() ?? [],
+  );
+  for (const builder of extraPersistencePlatformBuilders) {
+    const metamodel = builder(protocol, context);
+    if (metamodel) {
+      return metamodel;
+    }
+  }
+  throw new UnsupportedOperationError(
+    `Can't build persistence platform: no compatible builder available from plugins`,
+    protocol,
+  );
+};
+
+/**********
+ * service parameter
+ **********/
+
+export const V1_buildServiceParameterValue = (
+  protocol: V1_ServiceParameterValue,
+  context: V1_GraphBuilderContext,
+): ServiceParameterValue => {
+  if (protocol instanceof V1_PrimitiveTypeValue) {
+    const serviceParameterValue = new PrimitiveTypeValue();
+    serviceParameterValue.primitiveType = V1_buildValueSpecification(
+      protocol.primitiveType,
+      context,
+    );
+    return serviceParameterValue;
+  } else if (protocol instanceof V1_ConnectionValue) {
+    const serviceParameterValue = new ConnectionValue();
+    serviceParameterValue.connection = V1_buildConnection(
+      protocol.connection,
+      context,
+    );
+    return serviceParameterValue;
+  }
+  throw new UnsupportedOperationError(
+    `Can't build service parameter value`,
+    protocol,
+  );
+};
+
+export const V1_buildServiceParameter = (
+  protocol: V1_ServiceParameter,
+  context: V1_GraphBuilderContext,
+): ServiceParameter => {
+  const serviceParameter = new ServiceParameter();
+  serviceParameter.name = protocol.name;
+  serviceParameter.value = V1_buildServiceParameterValue(
+    protocol.value,
+    context,
+  );
+  return serviceParameter;
+};
+
+/**********
+ * persistence context
+ **********/
+
+export const V1_buildPersistenceContext = (
+  protocol: V1_PersistenceContext,
+  context: V1_GraphBuilderContext,
+): void => {
+  const path = V1_buildFullPath(protocol.package, protocol.name);
+  const persistenceContext = getOwnPersistenceContext(
+    path,
+    context.currentSubGraph,
+  );
+  persistenceContext.persistence = context.resolveElement(
+    protocol.persistence,
+    false,
+  ) as PackageableElementImplicitReference<Persistence>;
+  persistenceContext.platform = V1_buildPersistencePlatform(
+    protocol.platform,
+    context,
+  );
+  persistenceContext.serviceParameters = protocol.serviceParameters.map((sp) =>
+    V1_buildServiceParameter(sp, context),
+  );
+  if (protocol.sinkConnection) {
+    persistenceContext.sinkConnection = V1_buildConnection(
+      protocol.sinkConnection,
+      context,
+    );
+  }
+};