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

package/src/graphManager/protocol/pure/DSLPersistence_PureProtocolProcessorPlugin_Extension.ts

@@ -15,7 +15,9 @@
  */
 
 import type { V1_PersistencePlatform } from './v1/model/packageableElements/persistence/V1_DSLPersistence_PersistencePlatform.js';
+import type { V1_Trigger } from './v1/model/packageableElements/persistence/V1_DSLPersistence_Trigger.js';
 import type { PersistencePlatform } from '../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_PersistencePlatform.js';
+import type { Trigger } from '../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Trigger.js';
 import type {
   PureProtocolProcessorPlugin,
   V1_GraphBuilderContext,
@@ -43,6 +45,26 @@ export type V1_PersistencePlatformProtocolDeserializer = (
   json: PlainObject<V1_PersistencePlatform>,
 ) => V1_PersistencePlatform | undefined;
 
+// types: trigger
+
+export type V1_TriggerBuilder = (
+  protocol: V1_Trigger,
+  context: V1_GraphBuilderContext,
+) => Trigger | undefined;
+
+export type V1_TriggerTransformer = (
+  metamodel: Trigger,
+  context: V1_GraphTransformerContext,
+) => V1_Trigger | undefined;
+
+export type V1_TriggerProtocolSerializer = (
+  protocol: V1_Trigger,
+) => PlainObject<V1_Trigger> | undefined;
+
+export type V1_TriggerProtocolDeserializer = (
+  json: PlainObject<V1_Trigger>,
+) => V1_Trigger | undefined;
+
 export interface DSLPersistence_PureProtocolProcessorPlugin_Extension
   extends PureProtocolProcessorPlugin {
   // extension hooks: persistence platform
@@ -54,4 +76,14 @@ export interface DSLPersistence_PureProtocolProcessorPlugin_Extension
   V1_getExtraPersistencePlatformProtocolSerializers?(): V1_PersistencePlatformProtocolSerializer[];
 
   V1_getExtraPersistencePlatformProtocolDeserializers?(): V1_PersistencePlatformProtocolDeserializer[];
+
+  // extension hooks: trigger
+
+  V1_getExtraTriggerBuilders?(): V1_TriggerBuilder[];
+
+  V1_getExtraTriggerTransformers?(): V1_TriggerTransformer[];
+
+  V1_getExtraTriggerProtocolSerializers?(): V1_TriggerProtocolSerializer[];
+
+  V1_getExtraTriggerProtocolDeserializers?(): V1_TriggerProtocolDeserializer[];
 }

package/src/graphManager/protocol/pure/v1/model/packageableElements/persistence/V1_DSLPersistence_Sink.ts

@@ -15,7 +15,6 @@
  */
 
 import { PERSISTENCE_HASH_STRUCTURE } from '../../../../../../../graph/DSLPersistence_HashUtils.js';
-import type { V1_Connection } from '@finos/legend-graph';
 import { type Hashable, hashArray } from '@finos/legend-shared';
 
 export abstract class V1_Sink implements Hashable {
@@ -23,30 +22,23 @@ export abstract class V1_Sink implements Hashable {
 }
 
 export class V1_RelationalSink extends V1_Sink implements Hashable {
-  //TODO: ledav -- make required once persistence changes are rolled out in engine
-  database?: string;
-  //TODO: ledav -- remove once persistence changes are rolled out in engine
-  connection?: V1_Connection;
+  database!: string;
 
   override get hashCode(): string {
     return hashArray([
       PERSISTENCE_HASH_STRUCTURE.RELATIONAL_SINK,
-      this.database ?? '',
-      this.connection ?? '',
+      this.database,
     ]);
   }
 }
 
 export class V1_ObjectStorageSink extends V1_Sink implements Hashable {
   binding!: string;
-  //TODO: ledav -- remove once persistence changes are rolled out in engine
-  connection?: V1_Connection;
 
   override get hashCode(): string {
     return hashArray([
       PERSISTENCE_HASH_STRUCTURE.OBJECT_STORAGE_SINK,
       this.binding,
-      this.connection ?? '',
     ]);
   }
 }

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

@@ -79,11 +79,7 @@ import {
   type TargetShape,
   TransactionScope,
 } from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_TargetShape.js';
-import {
-  CronTrigger,
-  ManualTrigger,
-  type Trigger,
-} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Trigger.js';
+import type { Trigger } from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Trigger.js';
 import {
   type V1_Auditing,
   V1_DateTimeAuditing,
@@ -149,15 +145,11 @@ import {
   type V1_TargetShape,
   V1_TransactionScope,
 } from '../../../model/packageableElements/persistence/V1_DSLPersistence_TargetShape.js';
-import {
-  V1_CronTrigger,
-  V1_ManualTrigger,
-  type V1_Trigger,
-} from '../../../model/packageableElements/persistence/V1_DSLPersistence_Trigger.js';
+import type { V1_Trigger } from '../../../model/packageableElements/persistence/V1_DSLPersistence_Trigger.js';
+import type { DSLPersistence_PureProtocolProcessorPlugin_Extension } from '../../../../DSLPersistence_PureProtocolProcessorPlugin_Extension.js';
 import {
   type V1_GraphTransformerContext,
   V1_initPackageableElement,
-  V1_transformConnection,
 } from '@finos/legend-graph';
 import { UnsupportedOperationError } from '@finos/legend-shared';
 
@@ -169,18 +161,22 @@ export const V1_transformTrigger = (
   element: Trigger,
   context: V1_GraphTransformerContext,
 ): V1_Trigger => {
-  if (element instanceof CronTrigger) {
-    const protocol = new V1_CronTrigger();
-    protocol.minutes = element.minutes;
-    protocol.hours = element.hours;
-    protocol.dayOfMonth = element.dayOfMonth;
-    protocol.month = element.month;
-    protocol.dayOfWeek = element.dayOfWeek;
-    return protocol;
-  } else if (element instanceof ManualTrigger) {
-    return new V1_ManualTrigger();
+  const extraTriggerTransformers = context.plugins.flatMap(
+    (plugin) =>
+      (
+        plugin as DSLPersistence_PureProtocolProcessorPlugin_Extension
+      ).V1_getExtraTriggerTransformers?.() ?? [],
+  );
+  for (const transformer of extraTriggerTransformers) {
+    const protocol = transformer(element, context);
+    if (protocol) {
+      return protocol;
+    }
   }
-  throw new UnsupportedOperationError(`Can't transform trigger '${element}'`);
+  throw new UnsupportedOperationError(
+    `Can't transform trigger: no compatible transformer available from plugins`,
+    element,
+  );
 };
 
 /**********
@@ -192,16 +188,7 @@ 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,
-      true,
-      context,
-    );
-  }
+  protocol.database = element.database.value.path;
   return protocol;
 };
 
@@ -211,13 +198,6 @@ export const V1_transformObjectStorageSink = (
 ): V1_ObjectStorageSink => {
   const protocol = new V1_ObjectStorageSink();
   protocol.binding = element.binding.value.path;
-  if (element.connection) {
-    protocol.connection = V1_transformConnection(
-      element.connection,
-      true,
-      context,
-    );
-  }
   return protocol;
 };
 

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

@@ -79,11 +79,7 @@ import {
   type V1_TargetShape,
   V1_TransactionScope,
 } from '../../../model/packageableElements/persistence/V1_DSLPersistence_TargetShape.js';
-import {
-  V1_CronTrigger,
-  V1_ManualTrigger,
-  type V1_Trigger,
-} from '../../../model/packageableElements/persistence/V1_DSLPersistence_Trigger.js';
+import type { V1_Trigger } from '../../../model/packageableElements/persistence/V1_DSLPersistence_Trigger.js';
 import {
   type Auditing,
   DateTimeAuditing,
@@ -148,19 +144,15 @@ import {
   type TargetShape,
   TransactionScope,
 } from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_TargetShape.js';
-import {
-  CronTrigger,
-  ManualTrigger,
-  type Trigger,
-} from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Trigger.js';
-import { getOwnPersistence } from '../../../../../../../graphManager/DSLPersistence_GraphManagerHelper.js';
+import type { Trigger } from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Trigger.js';
+import { getOwnPersistence } from '../../../../../../DSLPersistence_GraphManagerHelper.js';
+import type { DSLPersistence_PureProtocolProcessorPlugin_Extension } from '../../../../DSLPersistence_PureProtocolProcessorPlugin_Extension.js';
 import {
   type Binding,
   type Database,
   type PackageableElementImplicitReference,
   type V1_GraphBuilderContext,
   V1_buildFullPath,
-  V1_buildConnection,
 } from '@finos/legend-graph';
 import {
   guaranteeNonEmptyString,
@@ -175,18 +167,22 @@ export const V1_buildTrigger = (
   protocol: V1_Trigger,
   context: V1_GraphBuilderContext,
 ): Trigger => {
-  if (protocol instanceof V1_CronTrigger) {
-    const trigger = new CronTrigger();
-    trigger.minutes = protocol.minutes;
-    trigger.hours = protocol.hours;
-    trigger.dayOfMonth = protocol.dayOfMonth;
-    trigger.month = protocol.month;
-    trigger.dayOfWeek = protocol.dayOfWeek;
-    return new CronTrigger();
-  } else if (protocol instanceof V1_ManualTrigger) {
-    return new ManualTrigger();
+  const extraTriggerBuilders = context.extensions.plugins.flatMap(
+    (plugin) =>
+      (
+        plugin as DSLPersistence_PureProtocolProcessorPlugin_Extension
+      ).V1_getExtraTriggerBuilders?.() ?? [],
+  );
+  for (const builder of extraTriggerBuilders) {
+    const metamodel = builder(protocol, context);
+    if (metamodel) {
+      return metamodel;
+    }
   }
-  throw new UnsupportedOperationError(`Can't build trigger`, protocol);
+  throw new UnsupportedOperationError(
+    `Can't build trigger: no compatible builder available from plugins`,
+    protocol,
+  );
 };
 
 /**********
@@ -198,15 +194,10 @@ 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 = V1_buildConnection(protocol.connection, context);
-  }
+  sink.database = context.resolveElement(
+    protocol.database,
+    false,
+  ) as PackageableElementImplicitReference<Database>;
   return sink;
 };
 
@@ -219,9 +210,6 @@ export const V1_buildObjectStorageSink = (
     protocol.binding,
     false,
   ) as PackageableElementImplicitReference<Binding>;
-  if (protocol.connection) {
-    sink.connection = V1_buildConnection(protocol.connection, context);
-  }
   return sink;
 };
 

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

@@ -36,7 +36,7 @@ import {
   ServiceParameter,
   type ServiceParameterValue,
 } from '../../../../../../../graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_ServiceParameter.js';
-import { getOwnPersistenceContext } from '../../../../../../../graphManager/DSLPersistence_GraphManagerHelper.js';
+import { getOwnPersistenceContext } from '../../../../../../DSLPersistence_GraphManagerHelper.js';
 import type { DSLPersistence_PureProtocolProcessorPlugin_Extension } from '../../../../DSLPersistence_PureProtocolProcessorPlugin_Extension.js';
 import {
   type PackageableElementImplicitReference,

package/src/graphManager/protocol/pure/v1/transformation/pureProtocol/V1_DSLPersistence_ProtocolHelper.ts

@@ -83,6 +83,7 @@ import {
   type V1_Persister,
   V1_StreamingPersister,
 } from '../../model/packageableElements/persistence/V1_DSLPersistence_Persister.js';
+import type { DSLPersistence_PureProtocolProcessorPlugin_Extension } from '../../../DSLPersistence_PureProtocolProcessorPlugin_Extension.js';
 import type { PureProtocolProcessorPlugin } from '@finos/legend-graph';
 import {
   deserializeArray,
@@ -691,7 +692,7 @@ const V1_relationalSinkModelSchema = (
 ): ModelSchema<V1_RelationalSink> =>
   createModelSchema(V1_RelationalSink, {
     _type: usingConstantValueSchema(V1_SinkType.RELATIONAL_SINK),
-    database: optional(primitive()),
+    database: primitive(),
   });
 
 const V1_objectStorageSinkModelSchema = (
@@ -699,7 +700,7 @@ const V1_objectStorageSinkModelSchema = (
 ): ModelSchema<V1_ObjectStorageSink> =>
   createModelSchema(V1_ObjectStorageSink, {
     _type: usingConstantValueSchema(V1_SinkType.OBJECT_STORAGE_SINK),
-    binding: optional(primitive()),
+    binding: primitive(),
   });
 
 export const V1_serializeSink = (
@@ -970,16 +971,16 @@ export const V1_deserializePersister = (
  * trigger
  **********/
 
-enum V1_TriggerType {
+export enum V1_TriggerType {
   MANUAL_TRIGGER = 'manualTrigger',
   CRON_TRIGGER = 'cronTrigger',
 }
 
-const V1_manualTriggerModelSchema = createModelSchema(V1_ManualTrigger, {
+export const V1_manualTriggerModelSchema = createModelSchema(V1_ManualTrigger, {
   _type: usingConstantValueSchema(V1_TriggerType.MANUAL_TRIGGER),
 });
 
-const V1_cronTriggerModelSchema = createModelSchema(V1_CronTrigger, {
+export const V1_cronTriggerModelSchema = createModelSchema(V1_CronTrigger, {
   _type: usingConstantValueSchema(V1_TriggerType.CRON_TRIGGER),
   minutes: primitive(),
   hours: primitive(),
@@ -990,28 +991,45 @@ const V1_cronTriggerModelSchema = createModelSchema(V1_CronTrigger, {
 
 export const V1_serializeTrigger = (
   protocol: V1_Trigger,
+  plugins: PureProtocolProcessorPlugin[],
 ): PlainObject<V1_Trigger> => {
-  if (protocol instanceof V1_ManualTrigger) {
-    return serialize(V1_manualTriggerModelSchema, protocol);
-  } else if (protocol instanceof V1_CronTrigger) {
-    return serialize(V1_cronTriggerModelSchema, protocol);
+  const extraTriggerProtocolSerializers = plugins.flatMap(
+    (plugin) =>
+      (
+        plugin as DSLPersistence_PureProtocolProcessorPlugin_Extension
+      ).V1_getExtraTriggerProtocolSerializers?.() ?? [],
+  );
+  for (const serializer of extraTriggerProtocolSerializers) {
+    const triggerProtocolJson = serializer(protocol);
+    if (triggerProtocolJson) {
+      return triggerProtocolJson;
+    }
   }
-  throw new UnsupportedOperationError(`Can't serialize trigger`, protocol);
+  throw new UnsupportedOperationError(
+    `Can't serialize trigger: no compatible serializer available from plugins`,
+    protocol,
+  );
 };
 
 export const V1_deserializeTrigger = (
   json: PlainObject<V1_Trigger>,
+  plugins: PureProtocolProcessorPlugin[],
 ): V1_Trigger => {
-  switch (json._type) {
-    case V1_TriggerType.MANUAL_TRIGGER:
-      return deserialize(V1_manualTriggerModelSchema, json);
-    case V1_TriggerType.CRON_TRIGGER:
-      return deserialize(V1_cronTriggerModelSchema, json);
-    default:
-      throw new UnsupportedOperationError(
-        `Can't deserialize trigger '${json._type}'`,
-      );
+  const extraTriggerProtocolDeserializers = plugins.flatMap(
+    (plugin) =>
+      (
+        plugin as DSLPersistence_PureProtocolProcessorPlugin_Extension
+      ).V1_getExtraTriggerProtocolDeserializers?.() ?? [],
+  );
+  for (const deserializer of extraTriggerProtocolDeserializers) {
+    const triggerProtocol = deserializer(json);
+    if (triggerProtocol) {
+      return triggerProtocol;
+    }
   }
+  throw new UnsupportedOperationError(
+    `Can't deserialize trigger of type '${json._type}': no compatible deserializer available from plugins`,
+  );
 };
 
 /**********
@@ -1038,7 +1056,7 @@ export const V1_persistenceModelSchema = (
     ),
     service: primitive(),
     trigger: custom(
-      (val) => V1_serializeTrigger(val),
-      (val) => V1_deserializeTrigger(val),
+      (val) => V1_serializeTrigger(val, plugins),
+      (val) => V1_deserializeTrigger(val, plugins),
     ),
   });

package/src/index.ts

@@ -23,11 +23,13 @@ export { DSLPersistence_LegendStudioApplicationPlugin } from './components/studi
 export { Persistence } from './graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Persistence.js';
 export { PersistenceContext } from './graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_PersistenceContext.js';
 export { PersistencePlatform } from './graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_PersistencePlatform.js';
+export { Trigger } from './graph/metamodel/pure/model/packageableElements/persistence/DSLPersistence_Trigger.js';
 
 // v1 protocols
 export { V1_Persistence } from './graphManager/protocol/pure/v1/model/packageableElements/persistence/V1_DSLPersistence_Persistence.js';
 export { V1_PersistenceContext } from './graphManager/protocol/pure/v1/model/packageableElements/persistence/V1_DSLPersistence_PersistenceContext.js';
 export { V1_PersistencePlatform } from './graphManager/protocol/pure/v1/model/packageableElements/persistence/V1_DSLPersistence_PersistencePlatform.js';
+export { V1_Trigger } from './graphManager/protocol/pure/v1/model/packageableElements/persistence/V1_DSLPersistence_Trigger.js';
 
 // ---------- TRANSFORMATION ----------