@finos/legend-application-studio 28.21.46 → 28.21.48

package/src/components/editor/editor-group/service-editor/ServiceEditor.tsx

@@ -71,6 +71,7 @@ import {
   validate_ServicePattern,
   validate_ServiceMcpServer,
   DeploymentOwnership,
+  Service,
   UserListOwnership,
 } from '@finos/legend-graph';
 import { LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY } from '../../../../__lib__/LegendStudioApplicationNavigationContext.js';
@@ -78,7 +79,11 @@ import { ServiceTestableEditor } from './testable/ServiceTestableEditor.js';
 import { flowResult } from 'mobx';
 import { ServicePostValidationsEditor } from './ServicePostValidationEditor.js';
 import type { DSL_Service_LegendStudioApplicationPlugin_Extension } from '../../../../stores/extensions/DSL_Service_LegendStudioApplicationPlugin_Extension.js';
-import { LegendStudioTelemetryHelper } from '../../../../__lib__/LegendStudioTelemetryHelper.js';
+import {
+  LEGENDAI_SUGGEST_STAGE,
+  LEGENDAI_SUGGEST_SURFACE,
+} from '../../../../__lib__/LegendStudioTelemetryHelper.js';
+import { useLegendAISuggestTelemetry } from '../LegendAISuggestTelemetryHooks.js';
 import { LEGEND_STUDIO_DOCUMENTATION_KEY } from '../../../../__lib__/LegendStudioDocumentation.js';
 import { DocumentationLink } from '@finos/legend-lego/application';
 
@@ -267,32 +272,42 @@ const ServiceGeneralEditor = observer(() => {
   const [aiDocSuggestion, setAIDocSuggestion] = useState<string | undefined>(
     undefined,
   );
+  const aiSuggestTelemetry = useLegendAISuggestTelemetry(
+    editorStore,
+    { surface: LEGENDAI_SUGGEST_SURFACE.SERVICE, elementPath: service.path },
+    { legendAIUrl, available: Boolean(aiDocSuggester), isReadOnly },
+  );
   const suggestDocumentationWithAI = async (): Promise<void> => {
     if (!aiDocSuggester || !legendAIUrl) {
       return;
     }
-    LegendStudioTelemetryHelper.logEvent_ServiceLegendAISuggestLaunched(
-      applicationStore.telemetryService,
-      service.path,
-      editorStore.editorMode.getSourceInfo(),
-    );
+    const request = aiSuggestTelemetry.launch({
+      existingText: service.documentation,
+    });
     setIsSuggestingWithAI(true);
     setAIDocSuggestion(undefined);
+    let stage = LEGENDAI_SUGGEST_STAGE.SERIALIZE;
     try {
       const serviceGrammar =
         await editorStore.graphManagerState.graphManager.elementsToPureCode([
           service,
         ]);
+      stage = LEGENDAI_SUGGEST_STAGE.REQUEST;
       const suggestion = await aiDocSuggester(serviceGrammar, legendAIUrl);
-      setAIDocSuggestion(suggestion);
+      const shouldShow = aiSuggestTelemetry.succeed(request, {
+        suggestionText: suggestion,
+        definitionsLength: serviceGrammar.length,
+        currentText: service.documentation,
+      });
+      if (!shouldShow) {
+        applicationStore.notificationService.notifyWarning(
+          'LegendAI did not return a documentation suggestion for this service',
+        );
+      }
+      setAIDocSuggestion(shouldShow ? suggestion : undefined);
     } catch (error) {
       assertErrorThrown(error);
-      LegendStudioTelemetryHelper.logEvent_ServiceLegendAISuggestFailure(
-        applicationStore.telemetryService,
-        service.path,
-        error.message,
-        editorStore.editorMode.getSourceInfo(),
-      );
+      aiSuggestTelemetry.fail(request, error, stage);
       if (
         error instanceof NetworkClientError &&
         (error.response.status === HttpStatus.UNAUTHORIZED ||
@@ -314,20 +329,23 @@ const ServiceGeneralEditor = observer(() => {
     if (!aiDocSuggestion) {
       return;
     }
-    LegendStudioTelemetryHelper.logEvent_ServiceLegendAISuggestApplied(
-      applicationStore.telemetryService,
-      service.path,
-      editorStore.editorMode.getSourceInfo(),
-    );
+    const servicePath = service.path;
+    aiSuggestTelemetry.apply({
+      existingText: service.documentation,
+      appliedText: aiDocSuggestion,
+      readCurrentText: (store) => {
+        const element =
+          store.graphManagerState.graph.getNullableElement(servicePath);
+        return element instanceof Service
+          ? { found: true, text: element.documentation }
+          : { found: false };
+      },
+    });
     service_setDocumentation(service, aiDocSuggestion);
     setAIDocSuggestion(undefined);
   };
   const discardAIDocSuggestion = (): void => {
-    LegendStudioTelemetryHelper.logEvent_ServiceLegendAISuggestDiscarded(
-      applicationStore.telemetryService,
-      service.path,
-      editorStore.editorMode.getSourceInfo(),
-    );
+    aiSuggestTelemetry.discard();
     setAIDocSuggestion(undefined);
   };
 

package/src/components/editor/editor-group/service-editor/testable/ServiceTestDataEditor.tsx

@@ -113,10 +113,8 @@ export const RowIdentifierEditor = observer(
             tableRowIdentifierState.connectionTestDataState.editorStore
               .changeDetectionState.observerContext,
           );
-        if (valueSpec) {
-          rowIdentifierState.updateRowIdentifierValue(valueSpec);
-          rowIdentifierState.updateRowIdentifierColumn(val.value);
-        }
+        rowIdentifierState.updateRowIdentifierValue(valueSpec);
+        rowIdentifierState.updateRowIdentifierColumn(val.value);
       }
     };
 
@@ -129,9 +127,7 @@ export const RowIdentifierEditor = observer(
           tableRowIdentifierState.connectionTestDataState.editorStore
             .changeDetectionState.observerContext,
         );
-      if (valueSpec) {
-        rowIdentifierState.updateRowIdentifierValue(valueSpec);
-      }
+      rowIdentifierState.updateRowIdentifierValue(valueSpec);
     };
 
     return (
@@ -166,10 +162,8 @@ export const RowIdentifierEditor = observer(
                 .changeDetectionState.observerContext
             }
             typeCheckOption={{
-              expectedType: guaranteeNonNullable(
-                getPrimitiveTypeFromRelationalType(
-                  guaranteeNonNullable(rowIdentifierState.column.type),
-                ),
+              expectedType: getPrimitiveTypeFromRelationalType(
+                guaranteeNonNullable(rowIdentifierState.column.type),
               ),
             }}
             resetValue={resetNode}

package/src/index.ts

@@ -73,11 +73,24 @@ export { LEGEND_STUDIO_DOCUMENTATION_KEY } from './__lib__/LegendStudioDocumenta
 export {
   LegendStudioTelemetryHelper,
   SERVICE_REGISTRATION_TRIGGER,
+  LEGENDAI_SUGGEST_SURFACE,
+  LEGENDAI_SUGGEST_STAGE,
+  LEGENDAI_SUGGEST_ERROR_KIND,
+  LEGENDAI_SUGGEST_ABANDON_PHASE,
+  LEGENDAI_SUGGEST_RETENTION,
+  LEGENDAI_SUGGEST_MATCH_STRATEGY,
+  type LegendAISuggestTarget,
 } from './__lib__/LegendStudioTelemetryHelper.js';
+export {
+  LegendAISuggestTelemetryTracker,
+  type LegendAISuggestRequest,
+  type LegendAIAppliedTextReader,
+} from './stores/editor/LegendAISuggestTelemetry.js';
 
 // components
 export { queryClass } from './components/editor/editor-group/uml-editor/ClassQueryBuilder.js';
 export * from './components/editor/EditorStoreProvider.js';
+export { useLegendAISuggestTelemetry } from './components/editor/editor-group/LegendAISuggestTelemetryHooks.js';
 export { ActivityBarMenu } from './components/editor/ActivityBar.js';
 export * from './components/workspace-setup/ProjectSelectorUtils.js';
 export * from './components/workspace-setup/WorkspaceSelectorUtils.js';

package/src/stores/editor/EditorStore.ts

@@ -23,6 +23,7 @@ import {
   observable,
 } from 'mobx';
 import { ExplorerTreeState } from './ExplorerTreeState.js';
+import { LegendAIAppliedSuggestionRegistry } from './LegendAISuggestTelemetry.js';
 import {
   ACTIVITY_MODE,
   PANEL_MODE,
@@ -222,6 +223,8 @@ export class EditorStore implements CommandRegistrar {
   readonly showcasePanelDisplayState: PanelDisplayState;
   readonly showcaseDefaultSize = 500;
   readonly tabManagerState = new EditorTabManagerState(this);
+  readonly legendAIAppliedSuggestionRegistry =
+    new LegendAIAppliedSuggestionRegistry();
   supportedElementTypesWithCategory: Map<string, string[]>;
 
   lazyTextEditorStore = new LazyTextEditorStore(this);

package/src/stores/editor/GraphEditFormModeState.ts

@@ -484,6 +484,19 @@ export class GraphEditFormModeState extends GraphEditorMode {
       );
     } catch (error) {
       assertErrorThrown(error);
+      if (!(error instanceof EngineError)) {
+        // Non-engine errors (e.g. network) are re-thrown below by `assertType`;
+        // still close out the `launch` emitted above so it has a terminal event.
+        LegendStudioTelemetryHelper.logEvent_GraphCompilationFailure(
+          this.editorStore.applicationStore.telemetryService,
+          this.editorStore.editorMode.getSourceInfo(),
+          {
+            errorKind: FORM_MODE_COMPILATION_ERROR_KIND.OTHER,
+            errorMessage: error.message,
+            fallbackToTextMode: false,
+          },
+        );
+      }
       // TODO: we probably should make this pattern of error the handling for all other exceptions in the codebase
       // i.e. there should be a catch-all handler (we can use if-else construct to check error types)
       assertType(error, EngineError, `Unhandled exception:\n${error}`);
@@ -526,6 +539,24 @@ export class GraphEditFormModeState extends GraphEditorMode {
         }
       }
 
+      // NOTE: the `assertType(error, EngineError, ...)` above guarantees
+      // `error` is an `EngineError` here, so the classification only needs
+      // to distinguish `CompilationError` from other `EngineError`s.
+      // Emitted before the (potentially slow, potentially throwing) switch to
+      // text mode so the failure is always recorded with an accurate timestamp.
+      LegendStudioTelemetryHelper.logEvent_GraphCompilationFailure(
+        this.editorStore.applicationStore.telemetryService,
+        this.editorStore.editorMode.getSourceInfo(),
+        {
+          errorKind:
+            error instanceof CompilationError
+              ? FORM_MODE_COMPILATION_ERROR_KIND.COMPILATION
+              : FORM_MODE_COMPILATION_ERROR_KIND.ENGINE,
+          errorMessage: error.message,
+          fallbackToTextMode: fallbackToTextModeForDebugging,
+        },
+      );
+
       // decide if we need to fall back to text mode for debugging
       if (fallbackToTextModeForDebugging) {
         // TODO: when we support showing multiple notifications, we can split this into 2
@@ -551,21 +582,6 @@ export class GraphEditFormModeState extends GraphEditorMode {
           GraphCompilationOutcome.FAILED,
         );
       }
-      // NOTE: the `assertType(error, EngineError, ...)` above guarantees
-      // `error` is an `EngineError` here, so the classification only needs
-      // to distinguish `CompilationError` from other `EngineError`s.
-      LegendStudioTelemetryHelper.logEvent_GraphCompilationFailure(
-        this.editorStore.applicationStore.telemetryService,
-        this.editorStore.editorMode.getSourceInfo(),
-        {
-          errorKind:
-            error instanceof CompilationError
-              ? FORM_MODE_COMPILATION_ERROR_KIND.COMPILATION
-              : FORM_MODE_COMPILATION_ERROR_KIND.ENGINE,
-          errorMessage: error.message,
-          fallbackToTextMode: fallbackToTextModeForDebugging,
-        },
-      );
     } finally {
       this.editorStore.graphState.isRunningGlobalCompile = false;
     }