@finos/legend-extension-dsl-data-space 10.4.255 → 10.4.256

package/src/components/DataSpaceViewer.tsx

@@ -45,6 +45,7 @@ import { useApplicationStore } from '@finos/legend-application';
 import { DataSpaceLegendAIIntegration } from './DataSpaceLegendAIIntegration.js';
 import { DSL_DATASPACE_EVENT } from '../__lib__/DSL_DataSpace_Event.js';
 import { guaranteeNonNullable } from '@finos/legend-shared';
+import { DataSpaceQualityEmote } from './DataSpaceQualityEmote.js';
 
 const DataSpaceHeader = observer(
   (props: {
@@ -91,128 +92,133 @@ const DataSpaceHeader = observer(
               </div>
             )}
           </div>
-          <div className="data-space__viewer__header__actions">
-            {dataSpaceViewerState.currentExecutionContext && (
+          <div className="data-space__viewer__header__actions-group">
+            <DataSpaceQualityEmote
+              qualityState={dataSpaceViewerState.qualityState}
+            />
+            <div className="data-space__viewer__header__actions">
+              {dataSpaceViewerState.currentExecutionContext && (
+                <ControlledDropdownMenu
+                  className="data-space__viewer__header__execution-context-selector"
+                  menuProps={{
+                    anchorOrigin: { vertical: 'bottom', horizontal: 'center' },
+                    transformOrigin: { vertical: 'top', horizontal: 'center' },
+                    elevation: 7,
+                  }}
+                  title={`Current Execution Context: ${dataSpaceViewerState.currentExecutionContext.name}\nClick to switch`}
+                  content={
+                    <MenuContent>
+                      {Array.from(
+                        dataSpaceViewerState.dataSpaceAnalysisResult.executionContextsIndex.values(),
+                      ).map((context) => (
+                        <MenuContentItem
+                          key={context.name}
+                          className={clsx(
+                            'data-space__viewer__header__execution-context-selector__option',
+                            {
+                              'data-space__viewer__header__execution-context-selector__option--active':
+                                context ===
+                                dataSpaceViewerState.currentExecutionContext,
+                            },
+                          )}
+                          onClick={() =>
+                            dataSpaceViewerState.setCurrentExecutionContext(
+                              context,
+                            )
+                          }
+                        >
+                          {context.name}
+                        </MenuContentItem>
+                      ))}
+                    </MenuContent>
+                  }
+                >
+                  <div className="data-space__viewer__header__execution-context-selector__trigger">
+                    <div className="data-space__viewer__header__execution-context-selector__trigger__icon">
+                      <PlayIcon />
+                    </div>
+                    <div className="data-space__viewer__header__execution-context-selector__trigger__label">
+                      {dataSpaceViewerState.currentExecutionContext.name}
+                    </div>
+                    <div className="data-space__viewer__header__execution-context-selector__trigger__dropdown-icon">
+                      <CaretDownIcon />
+                    </div>
+                  </div>
+                </ControlledDropdownMenu>
+              )}
               <ControlledDropdownMenu
-                className="data-space__viewer__header__execution-context-selector"
+                className="data-space__viewer__header__actions-selector"
                 menuProps={{
-                  anchorOrigin: { vertical: 'bottom', horizontal: 'center' },
-                  transformOrigin: { vertical: 'top', horizontal: 'center' },
+                  anchorOrigin: { vertical: 'bottom', horizontal: 'right' },
+                  transformOrigin: { vertical: 'top', horizontal: 'right' },
                   elevation: 7,
                 }}
-                title={`Current Execution Context: ${dataSpaceViewerState.currentExecutionContext.name}\nClick to switch`}
+                title="More Actions..."
                 content={
                   <MenuContent>
-                    {Array.from(
-                      dataSpaceViewerState.dataSpaceAnalysisResult.executionContextsIndex.values(),
-                    ).map((context) => (
-                      <MenuContentItem
-                        key={context.name}
-                        className={clsx(
-                          'data-space__viewer__header__execution-context-selector__option',
-                          {
-                            'data-space__viewer__header__execution-context-selector__option--active':
-                              context ===
-                              dataSpaceViewerState.currentExecutionContext,
-                          },
-                        )}
-                        onClick={() =>
-                          dataSpaceViewerState.setCurrentExecutionContext(
-                            context,
-                          )
+                    {dataSpaceViewerState.currentExecutionContext && (
+                      <>
+                        <MenuContentItem
+                          onClick={() =>
+                            dataSpaceViewerState.queryDataSpace(
+                              guaranteeNonNullable(
+                                dataSpaceViewerState.currentExecutionContext,
+                              ).name,
+                            )
+                          }
+                        >
+                          Query Data Space
+                        </MenuContentItem>
+                        <MenuContentDivider />
+                      </>
+                    )}
+                    <MenuContentItem
+                      onClick={() =>
+                        dataSpaceViewerState.viewProject(analysisResult.path)
+                      }
+                    >
+                      View Project
+                    </MenuContentItem>
+                    <MenuContentItem
+                      onClick={() => {
+                        dataSpaceViewerState
+                          .viewSDLCProject(analysisResult.path)
+                          .catch(applicationStore.alertUnhandledError);
+                      }}
+                    >
+                      View SDLC Project
+                    </MenuContentItem>
+                    <MenuContentDivider />
+                    <MenuContentItem
+                      onClick={() => {
+                        const documentationUrl =
+                          analysisResult.supportInfo?.documentationUrl;
+                        if (documentationUrl) {
+                          applicationStore.navigationService.navigator.visitAddress(
+                            documentationUrl,
+                          );
                         }
-                      >
-                        {context.name}
-                      </MenuContentItem>
-                    ))}
+                      }}
+                    >
+                      Read Documentation
+                    </MenuContentItem>
+                    <MenuContentItem
+                      onClick={() =>
+                        dataSpaceViewerState.changeZone(
+                          generateAnchorForActivity(
+                            DATA_SPACE_VIEWER_ACTIVITY_MODE.SUPPORT,
+                          ),
+                        )
+                      }
+                    >
+                      Get Help
+                    </MenuContentItem>
                   </MenuContent>
                 }
               >
-                <div className="data-space__viewer__header__execution-context-selector__trigger">
-                  <div className="data-space__viewer__header__execution-context-selector__trigger__icon">
-                    <PlayIcon />
-                  </div>
-                  <div className="data-space__viewer__header__execution-context-selector__trigger__label">
-                    {dataSpaceViewerState.currentExecutionContext.name}
-                  </div>
-                  <div className="data-space__viewer__header__execution-context-selector__trigger__dropdown-icon">
-                    <CaretDownIcon />
-                  </div>
-                </div>
+                <MoreVerticalIcon />
               </ControlledDropdownMenu>
-            )}
-            <ControlledDropdownMenu
-              className="data-space__viewer__header__actions-selector"
-              menuProps={{
-                anchorOrigin: { vertical: 'bottom', horizontal: 'right' },
-                transformOrigin: { vertical: 'top', horizontal: 'right' },
-                elevation: 7,
-              }}
-              title="More Actions..."
-              content={
-                <MenuContent>
-                  {dataSpaceViewerState.currentExecutionContext && (
-                    <>
-                      <MenuContentItem
-                        onClick={() =>
-                          dataSpaceViewerState.queryDataSpace(
-                            guaranteeNonNullable(
-                              dataSpaceViewerState.currentExecutionContext,
-                            ).name,
-                          )
-                        }
-                      >
-                        Query Data Space
-                      </MenuContentItem>
-                      <MenuContentDivider />
-                    </>
-                  )}
-                  <MenuContentItem
-                    onClick={() =>
-                      dataSpaceViewerState.viewProject(analysisResult.path)
-                    }
-                  >
-                    View Project
-                  </MenuContentItem>
-                  <MenuContentItem
-                    onClick={() => {
-                      dataSpaceViewerState
-                        .viewSDLCProject(analysisResult.path)
-                        .catch(applicationStore.alertUnhandledError);
-                    }}
-                  >
-                    View SDLC Project
-                  </MenuContentItem>
-                  <MenuContentDivider />
-                  <MenuContentItem
-                    onClick={() => {
-                      const documentationUrl =
-                        analysisResult.supportInfo?.documentationUrl;
-                      if (documentationUrl) {
-                        applicationStore.navigationService.navigator.visitAddress(
-                          documentationUrl,
-                        );
-                      }
-                    }}
-                  >
-                    Read Documentation
-                  </MenuContentItem>
-                  <MenuContentItem
-                    onClick={() =>
-                      dataSpaceViewerState.changeZone(
-                        generateAnchorForActivity(
-                          DATA_SPACE_VIEWER_ACTIVITY_MODE.SUPPORT,
-                        ),
-                      )
-                    }
-                  >
-                    Get Help
-                  </MenuContentItem>
-                </MenuContent>
-              }
-            >
-              <MoreVerticalIcon />
-            </ControlledDropdownMenu>
+            </div>
           </div>
         </div>
       </div>

package/src/components/__test-utils__/DataSpaceViewerTestUtils.ts

@@ -40,6 +40,7 @@ import {
   DSL_DataSpace_getGraphManagerExtension,
 } from '../../graph-manager/index.js';
 import { DataSpaceViewerState } from '../../stores/DataSpaceViewerState.js';
+import type { DataSpaceQualityResult } from '../../stores/DataSpaceQualityState.js';
 
 class TEST__LegendApplicationPluginManager
   extends LegendApplicationPluginManager<LegendApplicationPlugin>
@@ -113,6 +114,7 @@ export type TEST__DataSpaceViewerActionOverrides = {
         dataProductPath: string,
       ) => void)
     | undefined;
+  fetchDataSpaceQuality?: (() => Promise<DataSpaceQualityResult>) | undefined;
 };
 
 /**
@@ -182,6 +184,7 @@ export const TEST__getDataSpaceViewerState = async (
       queryClass: () => undefined,
       openServiceQuery: () => undefined,
       viewDataProduct: overrides?.viewDataProduct,
+      fetchDataSpaceQuality: overrides?.fetchDataSpaceQuality,
     },
   );
   return { viewerState, applicationStore };

package/src/components/index.ts

@@ -22,6 +22,11 @@ export { DSL_DataSpace_LegendApplicationPlugin } from './DSL_DataSpace_LegendApp
 export { DataSpaceViewer } from './DataSpaceViewer.js';
 export * from '../stores/DSL_DataSpace_LegendApplicationPlugin_Extension.js';
 export { DataSpaceViewerState } from '../stores/DataSpaceViewerState.js';
+export {
+  DATA_SPACE_QUALITY_LEVEL,
+  type DataSpaceQualityBreakdown,
+  type DataSpaceQualityResult,
+} from '../stores/DataSpaceQualityState.js';
 export {
   DataSpaceQueryBuilderState,
   resolveUsableDataSpaceClasses,

package/src/graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.ts

@@ -27,6 +27,7 @@ import {
   type RawLambda,
   type DataElementReference,
   type OperationalMetadata,
+  type RelationElement,
   PackageableElement,
   ConcreteFunctionDefinition,
   generateFunctionPrettyName,
@@ -90,6 +91,7 @@ export abstract class DataSpaceExecutable implements Hashable {
   executionContextKey?: string | undefined;
   title!: string;
   description?: string | undefined;
+  sampleValues?: RelationElement | undefined;
 
   get hashCode(): string {
     return hashArray([
@@ -98,6 +100,7 @@ export abstract class DataSpaceExecutable implements Hashable {
       this.title,
       this.description ?? '',
       this.executionContextKey ?? '',
+      this.sampleValues ?? '',
     ]);
   }
 }
@@ -115,6 +118,7 @@ export class DataSpacePackageableElementExecutable
       this.title,
       this.description ?? '',
       this.executionContextKey ?? '',
+      this.sampleValues ?? '',
       this.executable.value instanceof ConcreteFunctionDefinition
         ? generateFunctionPrettyName(this.executable.value, {
             fullPath: true,
@@ -140,6 +144,7 @@ export class DataSpaceExecutableTemplate
       this.description ?? '',
       this.query,
       this.executionContextKey ?? '',
+      this.sampleValues ?? '',
     ]);
   }
 }

package/src/graph-manager/action/changeDetection/DSL_DataSpace_ObserverHelper.ts

@@ -20,6 +20,7 @@ import {
   type OperationalMetadata,
   observe_PackageableElementReference,
   observe_RawLambda,
+  observe_RelationElement,
   observe_StereotypeReference,
   observe_TaggedValue,
   skipObserved,
@@ -109,7 +110,12 @@ const observe_Abstract_DataSpaceExecutable = (
     executionContextKey: observable,
     title: observable,
     description: observable,
+    sampleValues: observable,
   });
+
+  if (metamodel.sampleValues) {
+    observe_RelationElement(metamodel.sampleValues);
+  }
 };
 
 const observe_DataSpacePackageableElementExecutable = skipObserved(

package/src/graph-manager/protocol/pure/DSL_DataSpace_PureProtocolProcessorPlugin.ts

@@ -123,6 +123,10 @@ import {
   QueryDataSpaceExecutionContextInfo,
   generateFunctionPrettyName,
   ConcreteFunctionDefinition,
+  V1_RelationElement,
+  V1_RelationRowTestData,
+  RelationElement,
+  RelationRowTestData,
 } from '@finos/legend-graph';
 import { V1_resolveDiagram } from '@finos/legend-extension-dsl-diagram/graph';
 import { V1_MappingIncludeDataSpace } from './v1/model/packageableElements/mapping/V1_DSL_DataSpace_MappingIncludeDataSpace.js';
@@ -239,6 +243,34 @@ export const V1_transformDataSpaceSupportFullInfo = (
   return fullInfo;
 };
 
+const V1_buildDataSpaceExecutableSampleValues = (
+  protocol: V1_RelationElement,
+): RelationElement => {
+  const sampleValues = new RelationElement();
+  sampleValues.columns = protocol.columns;
+  sampleValues.paths = protocol.paths;
+  sampleValues.rows = protocol.rows.map((row) => {
+    const rowData = new RelationRowTestData();
+    rowData.values = row.values;
+    return rowData;
+  });
+  return sampleValues;
+};
+
+const V1_transformDataSpaceExecutableSampleValues = (
+  metamodel: RelationElement,
+): V1_RelationElement => {
+  const sampleValues = new V1_RelationElement();
+  sampleValues.columns = metamodel.columns;
+  sampleValues.paths = metamodel.paths;
+  sampleValues.rows = metamodel.rows.map((row) => {
+    const rowData = new V1_RelationRowTestData();
+    rowData.values = row.values;
+    return rowData;
+  });
+  return sampleValues;
+};
+
 export class DSL_DataSpace_PureProtocolProcessorPlugin
   extends PureProtocolProcessorPlugin
   implements DSL_Mapping_PureProtocolProcessorPlugin_Extension
@@ -384,6 +416,12 @@ export class DSL_DataSpace_PureProtocolProcessorPlugin
                     executable.executionContextKey =
                       executableProtocol.executionContextKey;
                   }
+                  if (executableProtocol.sampleValues) {
+                    executable.sampleValues =
+                      V1_buildDataSpaceExecutableSampleValues(
+                        executableProtocol.sampleValues,
+                      );
+                  }
                   return executable;
                 } else if (
                   executableProtocol instanceof
@@ -400,6 +438,12 @@ export class DSL_DataSpace_PureProtocolProcessorPlugin
                     executable.executionContextKey =
                       executableProtocol.executionContextKey;
                   }
+                  if (executableProtocol.sampleValues) {
+                    executable.sampleValues =
+                      V1_buildDataSpaceExecutableSampleValues(
+                        executableProtocol.sampleValues,
+                      );
+                  }
                   try {
                     executable.executable = context.resolveElement(
                       executableProtocol.executable.path,
@@ -641,6 +685,12 @@ export class DSL_DataSpace_PureProtocolProcessorPlugin
                 executable.query.accept_RawValueSpecificationVisitor(
                   new V1_RawValueSpecificationTransformer(context),
                 ) as V1_RawLambda;
+              if (executable.sampleValues) {
+                executableProtocol.sampleValues =
+                  V1_transformDataSpaceExecutableSampleValues(
+                    executable.sampleValues,
+                  );
+              }
               return executableProtocol;
             } else if (
               executable instanceof DataSpacePackageableElementExecutable
@@ -656,6 +706,12 @@ export class DSL_DataSpace_PureProtocolProcessorPlugin
                 executableProtocol.executionContextKey =
                   executable.executionContextKey;
               }
+              if (executable.sampleValues) {
+                executableProtocol.sampleValues =
+                  V1_transformDataSpaceExecutableSampleValues(
+                    executable.sampleValues,
+                  );
+              }
               if (
                 executable.executable.value instanceof
                 ConcreteFunctionDefinition

package/src/graph-manager/protocol/pure/v1/model/packageableElements/dataSpace/V1_DSL_DataSpace_DataSpace.ts

@@ -25,6 +25,7 @@ import {
   type V1_DataProductOperationalMetadata,
   V1_PackageableElement,
   type V1_DataElementReference,
+  type V1_RelationElement,
 } from '@finos/legend-graph';
 
 export class V1_DataSpaceMappingProvider implements Hashable {
@@ -81,6 +82,7 @@ export abstract class V1_DataSpaceExecutable implements Hashable {
   executionContextKey?: string | undefined;
   title!: string;
   description?: string | undefined;
+  sampleValues?: V1_RelationElement | undefined;
 
   get hashCode(): string {
     return hashArray([
@@ -89,6 +91,7 @@ export abstract class V1_DataSpaceExecutable implements Hashable {
       this.title,
       this.description ?? '',
       this.executionContextKey ?? '',
+      this.sampleValues ?? '',
     ]);
   }
 }
@@ -106,6 +109,7 @@ export class V1_DataSpacePackageableElementExecutable
       this.title,
       this.description ?? '',
       this.executionContextKey ?? '',
+      this.sampleValues ?? '',
       this.executable.path,
     ]);
   }
@@ -125,6 +129,7 @@ export class V1_DataSpaceTemplateExecutable
       this.description ?? '',
       this.query,
       this.executionContextKey ?? '',
+      this.sampleValues ?? '',
     ]);
   }
 }

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

@@ -33,6 +33,7 @@ import {
   V1_rawLambdaModelSchema,
   V1_dataElementReferenceModelSchema,
   V1_DataProductOperationalMetadata,
+  V1_relationElementModelSchema,
 } from '@finos/legend-graph';
 import {
   type PlainObject,
@@ -205,10 +206,11 @@ const V1_dataSpacePackageableElementExecutableModelSchema = createModelSchema(
       V1_DATA_SPACE_PACKAGEABLE_ELEMENT_EXECUTABLE,
     ),
     description: optional(primitive()),
+    executable: usingModelSchema(V1_packageableElementPointerModelSchema),
     executionContextKey: optional(primitive()),
     id: optional(primitive()),
+    sampleValues: optional(usingModelSchema(V1_relationElementModelSchema)),
     title: primitive(),
-    executable: usingModelSchema(V1_packageableElementPointerModelSchema),
   },
 );
 
@@ -217,10 +219,11 @@ const V1_dataSpaceTemplateExecutableModelSchema = createModelSchema(
   {
     _type: usingConstantValueSchema(V1_DATA_SPACE_TEMPLATE_EXECUTABLE),
     description: optional(primitive()),
-    title: primitive(),
+    executionContextKey: optional(primitive()),
     id: primitive(),
     query: usingModelSchema(V1_rawLambdaModelSchema),
-    executionContextKey: optional(primitive()),
+    sampleValues: optional(usingModelSchema(V1_relationElementModelSchema)),
+    title: primitive(),
   },
 );
 

package/src/stores/DataSpaceQualityState.ts

@@ -0,0 +1,117 @@
+/**
+ * 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 { action, flow, makeObservable, observable } from 'mobx';
+import {
+  ActionState,
+  assertErrorThrown,
+  LogEvent,
+  type GeneratorFn,
+} from '@finos/legend-shared';
+import type { DataSpaceViewerState } from './DataSpaceViewerState.js';
+import { DSL_DATASPACE_EVENT } from '../__lib__/DSL_DataSpace_Event.js';
+
+export enum DATA_SPACE_QUALITY_LEVEL {
+  DIAMOND = 'DIAMOND',
+  PLATINUM = 'PLATINUM',
+  GOLD = 'GOLD',
+  SILVER = 'SILVER',
+  BRONZE = 'BRONZE',
+}
+
+// A step-by-step breakdown of every criterion behind the quality rating, so the UI can show
+// users a roadmap of what's already done and what's needed for the next tier.
+export type DataSpaceQualityBreakdown = {
+  isDescriptionDocumented: boolean;
+  isExecutablesPresent: boolean;
+  isModelsDocumentationPresent: boolean;
+  isEveryServiceDocumented: boolean;
+  attributeCoverage?: number;
+  documentedAttributeCount: number;
+  totalAttributeCount: number;
+};
+
+export type DataSpaceQualityResult = {
+  qualityLevel: DATA_SPACE_QUALITY_LEVEL;
+  qualityBreakdown: DataSpaceQualityBreakdown;
+};
+
+// The actual scoring (description/executables/Models Documentation checks, attribute
+// coverage thresholds) lives server-side — see vendor-data-marketplace's
+// `doc-quality/dataspace` endpoint — since SingleStore already has the dataspace's
+// description and per-attribute documentation ingested for search. This state calls the
+// host app's injected `fetchDataSpaceQuality` action (see DataSpaceViewerState) and stores
+// the result. If the host app didn't wire that action up (e.g. a non-Marketplace consumer
+// of DataSpaceViewerState), or the call fails, qualityLevel/qualityBreakdown stay undefined
+// and the badge simply doesn't render.
+export class DataSpaceQualityState {
+  readonly dataSpaceViewerState: DataSpaceViewerState;
+  qualityLevel: DATA_SPACE_QUALITY_LEVEL | undefined;
+  qualityBreakdown: DataSpaceQualityBreakdown | undefined;
+  readonly computingQualityState = ActionState.create();
+
+  constructor(dataSpaceViewerState: DataSpaceViewerState) {
+    makeObservable(this, {
+      qualityLevel: observable,
+      qualityBreakdown: observable,
+      setQualityLevel: action,
+      setQualityBreakdown: action,
+      computeQuality: flow,
+    });
+
+    this.dataSpaceViewerState = dataSpaceViewerState;
+  }
+
+  setQualityLevel(val: DATA_SPACE_QUALITY_LEVEL | undefined): void {
+    this.qualityLevel = val;
+  }
+
+  setQualityBreakdown(val: DataSpaceQualityBreakdown | undefined): void {
+    this.qualityBreakdown = val;
+  }
+
+  get isSupported(): boolean {
+    return this.dataSpaceViewerState.fetchDataSpaceQuality !== undefined;
+  }
+
+  *computeQuality(): GeneratorFn<void> {
+    if (!this.computingQualityState.isInInitialState) {
+      return;
+    }
+    const fetchDataSpaceQuality =
+      this.dataSpaceViewerState.fetchDataSpaceQuality;
+    if (!fetchDataSpaceQuality) {
+      this.computingQualityState.complete(false);
+      return;
+    }
+    this.computingQualityState.inProgress();
+    try {
+      const result = (yield fetchDataSpaceQuality()) as DataSpaceQualityResult;
+      this.setQualityLevel(result.qualityLevel);
+      this.setQualityBreakdown(result.qualityBreakdown);
+      this.computingQualityState.complete();
+    } catch (error) {
+      assertErrorThrown(error);
+      // A cosmetic badge failing to load isn't worth a user-facing toast — just log it and
+      // leave qualityLevel/qualityBreakdown undefined so the badge doesn't render.
+      this.dataSpaceViewerState.applicationStore.logService.warn(
+        LogEvent.create(DSL_DATASPACE_EVENT.ERROR_FETCH_DATA_SPACE_QUALITY),
+        error,
+      );
+      this.computingQualityState.complete(false);
+    }
+  }
+}