@finos/legend-application-studio 28.21.28 → 28.21.30

package/src/stores/editor/editor-state/element-editor-state/ingest/IngestDefinitionEditorState.ts

@@ -18,6 +18,8 @@ import {
   type MatViewDataSet,
   type PackageableElement,
   type V1_RawLineageModel,
+  type ArtifactGenerationExtensionResult,
+  type IngestionDefinitionArtifact,
   GRAPH_MANAGER_EVENT,
   IngestDefinition,
 } from '@finos/legend-graph';
@@ -62,6 +64,8 @@ export enum INGEST_DEFINITION_TAB {
   TESTING = 'Testing',
 }
 
+export const INGEST_DEFINITION_ARTIFACT_EXTENSION = 'ingestDefinition';
+
 const createEditorInitialConfiguration = (): EditorInitialConfiguration => {
   const config = new EditorInitialConfiguration();
   const ingest = new IngestElementEditorInitialConfiguration();
@@ -85,11 +89,20 @@ export const generateUrlToDeployOnOpen = (
 };
 
 const PARSER_SECTION = `###Lakehouse`;
+
+type CachedIngestArtifact = {
+  hashCode: string;
+  artifact: IngestionDefinitionArtifact;
+};
+
 export class IngestDefinitionEditorState extends ElementEditorState {
   selectedTab = INGEST_DEFINITION_TAB.DEFINITION;
   validateAndDeployResponse: ValidateAndDeploymentResponse | undefined;
   deploymentState = ActionState.create();
   lineageGenerationState = ActionState.create();
+  artifactGenerationState = ActionState.create();
+  ingestionArtifact: IngestionDefinitionArtifact | undefined;
+  cachedArtfact: CachedIngestArtifact | undefined;
   deployOnOpen = false;
   lineageState: LineageState;
   ingestTestableState: IngestTestableState;
@@ -106,13 +119,18 @@ export class IngestDefinitionEditorState extends ElementEditorState {
       deploymentState: observable,
       deployOnOpen: observable,
       setDeployOnOpen: observable,
+      cachedArtfact: observable,
       validateAndDeployResponse: observable,
+      ingestionArtifact: observable,
       deploymentResponse: computed,
       setSelectedTab: action,
       setValidateAndDeployResponse: action,
+      setIngestCachedArtifact: action,
+      setIngestionArtifact: action,
       init_with_deploy: flow,
       deploy: flow,
       generateLineage: flow,
+      generateArtifact: flow,
     });
     if (
       config?.elementEditorConfiguration instanceof
@@ -154,6 +172,14 @@ export class IngestDefinitionEditorState extends ElementEditorState {
     this.deployOnOpen = value;
   }
 
+  setIngestionArtifact(val: IngestionDefinitionArtifact | undefined): void {
+    this.ingestionArtifact = val;
+  }
+
+  setIngestCachedArtifact(val: CachedIngestArtifact | undefined): void {
+    this.cachedArtfact = val;
+  }
+
   *init_with_deploy(auth: AuthContextProps): GeneratorFn<void> {
     this.setDeployOnOpen(false);
     if (!auth.isAuthenticated) {
@@ -269,6 +295,62 @@ export class IngestDefinitionEditorState extends ElementEditorState {
     }
   }
 
+  *generateArtifact(): GeneratorFn<void> {
+    if (this.artifactGenerationState.isInProgress) {
+      this.editorStore.applicationStore.notificationService.notifyError(
+        'Artifact generation in progress already',
+      );
+      return;
+    }
+    const currentHashCode = this.ingest.hashCode;
+    if (this.cachedArtfact?.hashCode === currentHashCode) {
+      // reuse cached artifact if the ingest definition has not changed
+      this.setIngestionArtifact(this.cachedArtfact.artifact);
+      return;
+    }
+    try {
+      this.artifactGenerationState.inProgress();
+      const generatedArtifacts =
+        (yield this.editorStore.graphManagerState.graphManager.generateArtifacts(
+          this.editorStore.graphManagerState.graph,
+          this.editorStore.graphEditorMode.getGraphTextInputOption(),
+          [this.ingest.path],
+        )) as ArtifactGenerationExtensionResult;
+      const ingestArtifact = generatedArtifacts.values.find(
+        (artifact) =>
+          artifact.extension === INGEST_DEFINITION_ARTIFACT_EXTENSION,
+      );
+      const artifactContent =
+        ingestArtifact?.artifactsByExtensionElements[0]?.files[0]?.content;
+      if (!artifactContent) {
+        throw new Error(
+          `Could not find generated ingest definition artifact for '${this.ingest.path}'`,
+        );
+      }
+      const artifact =
+        this.editorStore.graphManagerState.graphManager.buildIngestDefinitionArtifact(
+          JSON.parse(artifactContent) as Record<PropertyKey, unknown>,
+          this.editorStore.graphManagerState.graph,
+        );
+      this.setIngestCachedArtifact({
+        hashCode: currentHashCode,
+        artifact,
+      });
+      this.setIngestionArtifact(artifact);
+    } catch (error) {
+      assertErrorThrown(error);
+      this.editorStore.applicationStore.logService.error(
+        LogEvent.create(GRAPH_MANAGER_EVENT.EXECUTION_FAILURE),
+        error,
+      );
+      this.editorStore.applicationStore.notificationService.notifyError(
+        `Failed to generate ingest artifact: ${error.message}`,
+      );
+    } finally {
+      this.artifactGenerationState.complete();
+    }
+  }
+
   reprocess(
     newElement: PackageableElement,
     editorStore: EditorStore,

package/src/stores/editor/editor-state/element-editor-state/mapping/MappingElementDecorator.ts

@@ -671,7 +671,10 @@ export class MappingElementDecorator implements SetImplementationVisitor<void> {
     ): RelationFunctionPropertyMapping[] => {
       const existingPropertyMappings = (propertyMappings ?? []).filter((pm) => {
         if (pm instanceof RelationFunctionPropertyMapping) {
-          return !isStubbed_RelationColumn(pm.column);
+          return (
+            pm.valueFn !== undefined ||
+            (pm.column !== undefined && !isStubbed_RelationColumn(pm.column))
+          );
         }
         return false;
       });
@@ -715,7 +718,9 @@ export class MappingElementDecorator implements SetImplementationVisitor<void> {
         propertyMappingsBeforeDecoration
           .filter(
             (propertyMapping) =>
-              !isStubbed_RelationColumn(propertyMapping.column),
+              propertyMapping.valueFn !== undefined ||
+              (propertyMapping.column !== undefined &&
+                !isStubbed_RelationColumn(propertyMapping.column)),
           )
           .filter(
             (propertyMapping) =>

package/src/stores/editor/editor-state/element-editor-state/mapping/RelationFunctionInstanceSetImplementationState.ts

@@ -85,7 +85,10 @@ export class RelationFunctionPropertyMappingState extends PropertyMappingState {
     pretty?: boolean | undefined;
     preserveCompilationError?: boolean | undefined;
   }): GeneratorFn<void> {
-    if (!isStubbed_RelationColumn(this.propertyMapping.column)) {
+    if (
+      this.propertyMapping.column &&
+      !isStubbed_RelationColumn(this.propertyMapping.column)
+    ) {
       this.setLambdaString(this.propertyMapping.column.name);
     } else {
       this.clearErrors();
@@ -170,7 +173,10 @@ export class RelationFunctionInstanceSetImplementationState extends InstanceSetI
 
   *convertPropertyMappingTransformObjects(): GeneratorFn<void> {
     this.propertyMappingStates.forEach((pm) => {
-      if (!isStubbed_RelationColumn(pm.propertyMapping.column)) {
+      if (
+        pm.propertyMapping.column &&
+        !isStubbed_RelationColumn(pm.propertyMapping.column)
+      ) {
         pm.setLambdaString(pm.propertyMapping.column.name);
       }
     });

package/src/stores/extensions/DSL_DataSpace_LegendStudioApplicationPlugin_Extension.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 { DSL_LegendStudioApplicationPlugin_Extension } from '../LegendStudioApplicationPlugin.js';
+
+// ── Response type ─────────────────────────────────────────────────────────────
+
+export type DataSpaceDocResponse = {
+  description: string;
+  confidence: number;
+};
+
+// ── Request type ──────────────────────────────────────────────────────────────
+
+export type DataSpaceDocRequest = {
+  /**
+   * Raw Pure grammar text containing the data space definitions.
+   */
+  definitions: string;
+  /**
+   * Fully-qualified name of the data space (e.g. dataSpace::MY_SPACE).
+   */
+  data_space_name: string;
+  /**
+   * LLM model override (uses server default if omitted).
+   */
+  model?: string;
+};
+
+// ── Plugin extension interface ────────────────────────────────────────────────
+
+export interface DSL_DataSpace_LegendStudioApplicationPlugin_Extension
+  extends DSL_LegendStudioApplicationPlugin_Extension {
+  /**
+   * Generate AI-suggested description for a data space.
+   */
+  getExtraDataSpaceDocumentationAISuggester?(
+    request: DataSpaceDocRequest,
+    legendAIUrl: string,
+  ): Promise<DataSpaceDocResponse>;
+}

package/tsconfig.json

@@ -200,6 +200,7 @@
     "./src/stores/editor/utils/TestableUtils.ts",
     "./src/stores/editor/utils/TreeUtils.ts",
     "./src/stores/extensions/DSL_DataProduct_LegendStudioApplicationPlugin_Extension.ts",
+    "./src/stores/extensions/DSL_DataSpace_LegendStudioApplicationPlugin_Extension.ts",
     "./src/stores/extensions/DSL_Data_LegendStudioApplicationPlugin_Extension.ts",
     "./src/stores/extensions/DSL_Generation_LegendStudioApplicationPlugin_Extension.ts",
     "./src/stores/extensions/DSL_Mapping_LegendStudioApplicationPlugin_Extension.ts",