@finos/legend-graph 32.3.22 → 32.3.23

package/src/graph-manager/protocol/pure/v1/transformation/pureGraph/to/helpers/V1_DataProductBuilder.ts

@@ -14,7 +14,11 @@
  * limitations under the License.
  */
 
-import { isNonNullable, UnsupportedOperationError } from '@finos/legend-shared';
+import {
+  guaranteeNonNullable,
+  isNonNullable,
+  UnsupportedOperationError,
+} from '@finos/legend-shared';
 import {
   type AccessPoint,
   type DataProductElement,
@@ -33,6 +37,12 @@ import {
   ModelAccessPointGroup,
   UnknownAccessPoint,
   UnknownDataProductIcon,
+  NativeModelAccess,
+  type SampleQuery,
+  PackageableElementSampleQuery,
+  InLineSampleQuery,
+  DataProductDiagram,
+  NativeModelExecutionContext,
 } from '../../../../../../../../graph/metamodel/pure/dataProduct/DataProduct.js';
 import {
   type V1_AccessPoint,
@@ -45,9 +55,14 @@ import {
   V1_FunctionAccessPoint,
   V1_LakehouseAccessPoint,
   V1_ModelAccessPointGroup,
+  type V1_NativeModelAccess,
+  type V1_SampleQuery,
   V1_UnknownAccessPoint,
   V1_UnknownDataProductIcon,
   type V1_DataProductOperationalMetadata,
+  V1_PackageableElementSampleQuery,
+  V1_InLineSampleQuery,
+  type V1_NativeModelExecutionContext,
 } from '../../../../model/packageableElements/dataProduct/V1_DataProduct.js';
 import type { V1_GraphBuilderContext } from '../V1_GraphBuilderContext.js';
 import { V1_buildRawLambdaWithResolvedPaths } from './V1_ValueSpecificationPathResolver.js';
@@ -59,6 +74,7 @@ import { Package } from '../../../../../../../../graph/metamodel/pure/packageabl
 import { Class } from '../../../../../../../../graph/metamodel/pure/packageableElements/domain/Class.js';
 import { Enumeration } from '../../../../../../../../graph/metamodel/pure/packageableElements/domain/Enumeration.js';
 import { Association } from '../../../../../../../../graph/metamodel/pure/packageableElements/domain/Association.js';
+import { generateFunctionPrettyName } from '../../../../../../../../graph/helpers/PureLanguageHelper.js';
 
 export const V1_buildDataProductLink = (
   link: V1_DataProductLink,
@@ -202,3 +218,147 @@ export const V1_buildAccessPointGroup = (
     return group;
   }
 };
+
+export const V1_buildNativeModelExecutionContext = (
+  nativeModelExecutionContext: V1_NativeModelExecutionContext,
+  context: V1_GraphBuilderContext,
+): NativeModelExecutionContext => {
+  const metamodelNativeModelExecutionContext =
+    new NativeModelExecutionContext();
+  metamodelNativeModelExecutionContext.key = nativeModelExecutionContext.key;
+  metamodelNativeModelExecutionContext.mapping =
+    PackageableElementExplicitReference.create(
+      context.graph.getMapping(nativeModelExecutionContext.mapping.path),
+    );
+  if (nativeModelExecutionContext.runtime) {
+    metamodelNativeModelExecutionContext.runtime =
+      PackageableElementExplicitReference.create(
+        context.graph.getRuntime(nativeModelExecutionContext.runtime.path),
+      );
+  }
+  return metamodelNativeModelExecutionContext;
+};
+
+export const V1_buildSampleQuery = (
+  sampleQuery: V1_SampleQuery,
+  defaultExecutionContext: string,
+  context: V1_GraphBuilderContext,
+): SampleQuery => {
+  if (sampleQuery instanceof V1_PackageableElementSampleQuery) {
+    const metamodelSampleQuery = new PackageableElementSampleQuery();
+    metamodelSampleQuery.id = sampleQuery.id;
+    metamodelSampleQuery.title = sampleQuery.title;
+    metamodelSampleQuery.description = sampleQuery.description;
+    metamodelSampleQuery.executionContextKey =
+      sampleQuery.executionContextKey ?? defaultExecutionContext;
+    try {
+      metamodelSampleQuery.query = context.resolveElement(
+        sampleQuery.query.path,
+        false,
+      );
+    } catch {
+      try {
+        metamodelSampleQuery.query = PackageableElementExplicitReference.create(
+          guaranteeNonNullable(
+            context.graph.functions.find(
+              (fn) =>
+                generateFunctionPrettyName(fn, {
+                  fullPath: true,
+                  spacing: false,
+                  notIncludeParamName: true,
+                }) === sampleQuery.query.path.replaceAll(/\s*/gu, ''),
+            ),
+          ),
+        );
+      } catch {
+        throw new UnsupportedOperationError(
+          `Can't analyze data product executable with element in path: ${sampleQuery.query.path}`,
+          sampleQuery,
+        );
+      }
+    }
+
+    return metamodelSampleQuery;
+  } else if (sampleQuery instanceof V1_InLineSampleQuery) {
+    const metamodelSampleQuery = new InLineSampleQuery();
+    metamodelSampleQuery.id = sampleQuery.id;
+    metamodelSampleQuery.title = sampleQuery.title;
+    metamodelSampleQuery.description = sampleQuery.description;
+    metamodelSampleQuery.executionContextKey =
+      sampleQuery.executionContextKey ?? defaultExecutionContext;
+    metamodelSampleQuery.query = V1_buildRawLambdaWithResolvedPaths(
+      sampleQuery.query.parameters,
+      sampleQuery.query.body,
+      context,
+    );
+    return metamodelSampleQuery;
+  }
+
+  throw new UnsupportedOperationError(
+    `Unsupported data product sample query type`,
+  );
+};
+
+export const V1_buildNativeModelAccess = (
+  nativeModelAccess: V1_NativeModelAccess,
+  context: V1_GraphBuilderContext,
+): NativeModelAccess => {
+  const metamodelNativeModelAccess = new NativeModelAccess();
+  metamodelNativeModelAccess.defaultExecutionContext =
+    nativeModelAccess.defaultExecutionContext;
+  metamodelNativeModelAccess.nativeModelExecutionContexts =
+    nativeModelAccess.nativeModelExecutionContexts.map((executionContext) =>
+      V1_buildNativeModelExecutionContext(executionContext, context),
+    );
+  if (nativeModelAccess.sampleQueries) {
+    metamodelNativeModelAccess.sampleQueries =
+      nativeModelAccess.sampleQueries.map((sampleQuery) =>
+        V1_buildSampleQuery(
+          sampleQuery,
+          nativeModelAccess.defaultExecutionContext,
+          context,
+        ),
+      );
+  }
+  if (!nativeModelAccess.diagrams) {
+    metamodelNativeModelAccess.diagrams = [];
+  } else {
+    metamodelNativeModelAccess.diagrams = nativeModelAccess.diagrams.map(
+      (diagram) => {
+        const metadatamodelDiagram = new DataProductDiagram();
+        metadatamodelDiagram.diagram = context.graph.getElement(
+          diagram.diagram.path,
+        );
+        metadatamodelDiagram.title = diagram.title;
+        metadatamodelDiagram.description = diagram.description;
+        return metadatamodelDiagram;
+      },
+    );
+  }
+  if (nativeModelAccess.featuredElements) {
+    metamodelNativeModelAccess.featuredElements =
+      nativeModelAccess.featuredElements.map((pointer) => {
+        const elementReference = context.resolveElement(
+          pointer.element.path,
+          true,
+        );
+        if (
+          elementReference.value instanceof Package ||
+          elementReference.value instanceof Class ||
+          elementReference.value instanceof Enumeration ||
+          elementReference.value instanceof Association
+        ) {
+          const elementPointer = new DataProductElementScope();
+          elementPointer.element =
+            elementReference as unknown as PackageableElementReference<DataProductElement>;
+          elementPointer.exclude = pointer.exclude;
+          return elementPointer;
+        }
+        throw new UnsupportedOperationError(
+          `Can't find data product element (only allow packages, classes, enumerations, and associations) '${pointer.element.path}'`,
+        );
+      });
+  }
+
+  return metamodelNativeModelAccess;
+};

package/src/graph-manager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_DataProductSerializationHelper.ts

@@ -48,6 +48,11 @@ import {
   V1_Expertise,
   V1_FunctionAccessPoint,
   V1_DataProductOperationalMetadata,
+  V1_NativeModelAccess,
+  type V1_SampleQuery,
+  V1_PackageableElementSampleQuery,
+  V1_InLineSampleQuery,
+  V1_NativeModelExecutionContext,
 } from '../../../model/packageableElements/dataProduct/V1_DataProduct.js';
 import {
   UnsupportedOperationError,
@@ -87,6 +92,11 @@ export enum V1_AccessPointGrouptype {
   MODEL_ACCESS_POINT_GROUP = 'modelAccessPointGroup',
 }
 
+export enum V1_SampleQueryType {
+  IN_LINE_SAMPLE_QUERY = 'inLineSampleQuery',
+  PACKAGEABLE_ELEMENT_SAMPLE_QUERY = 'packageableElementSampleQuery',
+}
+
 export enum V1_DataProductIconType {
   LIBRARY_ICON = 'libraryIcon',
   EMBEDDED_IMAGE_ICON = 'embeddedImageIcon',
@@ -199,6 +209,85 @@ export const V1_ModelAccessPointGroupModelSchema = createModelSchema(
   },
 );
 
+export const V1_PackageableElementSampleQueryModelSchema = createModelSchema(
+  V1_PackageableElementSampleQuery,
+  {
+    _type: usingConstantValueSchema(
+      V1_SampleQueryType.PACKAGEABLE_ELEMENT_SAMPLE_QUERY,
+    ),
+    id: primitive(),
+    title: primitive(),
+    description: optional(primitive()),
+    query: usingModelSchema(V1_packageableElementPointerModelSchema),
+    executionContextKey: optional(primitive()),
+  },
+);
+
+export const V1_InLineSampleQueryModelSchema = createModelSchema(
+  V1_InLineSampleQuery,
+  {
+    _type: usingConstantValueSchema(V1_SampleQueryType.IN_LINE_SAMPLE_QUERY),
+    id: primitive(),
+    title: primitive(),
+    description: optional(primitive()),
+    executionContextKey: optional(primitive()),
+    query: usingModelSchema(V1_rawLambdaModelSchema),
+  },
+);
+
+const V1_serializeSampleQuery = (
+  protocol: V1_SampleQuery,
+): PlainObject<V1_SampleQuery> => {
+  if (protocol instanceof V1_InLineSampleQuery) {
+    return serialize(V1_InLineSampleQueryModelSchema, protocol);
+  } else if (protocol instanceof V1_PackageableElementSampleQuery) {
+    return serialize(V1_PackageableElementSampleQueryModelSchema, protocol);
+  }
+  throw new UnsupportedOperationError(
+    `Can't serialize data product sample query`,
+    protocol,
+  );
+};
+
+export const V1_deserializeSampleQuery = (
+  json: PlainObject<V1_SampleQuery>,
+): V1_SampleQuery => {
+  switch (json._type) {
+    case V1_SampleQueryType.IN_LINE_SAMPLE_QUERY:
+      return deserialize(V1_InLineSampleQueryModelSchema, json);
+    case V1_SampleQueryType.PACKAGEABLE_ELEMENT_SAMPLE_QUERY:
+    default:
+      return deserialize(V1_PackageableElementSampleQueryModelSchema, json);
+  }
+};
+
+export const V1_NativeModelExecutionContextSchema = createModelSchema(
+  V1_NativeModelExecutionContext,
+  {
+    key: primitive(),
+    mapping: usingModelSchema(V1_packageableElementPointerModelSchema),
+    runtime: optionalCustomUsingModelSchema(
+      V1_packageableElementPointerModelSchema,
+    ),
+  },
+);
+
+export const V1_NativeModelAccessModelSchema = createModelSchema(
+  V1_NativeModelAccess,
+  {
+    diagrams: optionalCustomListWithSchema(V1_dataProductDiagramModelSchema),
+    sampleQueries: optionalCustomList(
+      (val: V1_SampleQuery) => V1_serializeSampleQuery(val),
+      (val) => V1_deserializeSampleQuery(val),
+    ),
+    nativeModelExecutionContexts: customListWithSchema(
+      V1_NativeModelExecutionContextSchema,
+    ),
+    featuredElements: optionalCustomListWithSchema(V1_ElementScopeModelSchema),
+    defaultExecutionContext: primitive(),
+  },
+);
+
 export const V1_DefaultAccessPointGroupModelSchema = createModelSchema(
   V1_AccessPointGroup,
   {
@@ -369,6 +458,9 @@ export const V1_dataProductModelSchema = (
       V1_serializeAccessPointGroup,
       V1_deserializeAccessPointGroup,
     ),
+    nativeModelAccess: optionalCustomUsingModelSchema(
+      V1_NativeModelAccessModelSchema,
+    ),
     description: optional(primitive()),
     sampleValues: optionalCustomList(
       (data: V1_EmbeddedData) => V1_serializeEmbeddedDataType(data, plugins),

package/src/graph-manager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_ServiceSerializationHelper.ts

@@ -383,4 +383,5 @@ export const V1_serviceModelSchema = (
     postValidations: customListWithSchema(V1_servicePostValidationModelSchema, {
       INTERNAL__forceReturnEmptyInTest: true,
     }),
+    mcpServer: optional(primitive()),
   });

package/src/index.ts

@@ -399,6 +399,14 @@ export {
   V1_DataProductArtifact,
   V1_AccessPointImplementation,
   V1_AccessPointGroupInfo,
+  V1_SampleQueryInfo,
+  V1_InLineSampleQueryInfo,
+  V1_PackageableElementSampleQueryInfo,
+  V1_NativeModelAccessInfo,
+  V1_DiagramInfo,
+  V1_EnumerationDocumentationEntry,
+  V1_AssociationDocumentationEntry,
+  V1_ClassDocumentationEntry,
 } from './graph-manager/protocol/pure/v1/lakehouse/deploy/V1_DataProductArtifact.js';
 export {
   V1_IngestEnvironmentType,