@finos/legend-application-studio 28.21.45 → 28.21.46

package/src/stores/editor/sidebar-state/WorkspaceReviewState.ts

@@ -25,6 +25,11 @@ import {
 import type { EditorStore } from '../EditorStore.js';
 import type { EditorSDLCState } from '../EditorSDLCState.js';
 import { LEGEND_STUDIO_APP_EVENT } from '../../../__lib__/LegendStudioEvent.js';
+import {
+  LegendStudioTelemetryHelper,
+  SDLC_REVIEW_ACTION,
+  SDLC_REVIEW_ROLE,
+} from '../../../__lib__/LegendStudioTelemetryHelper.js';
 import { LegendStudioUserDataHelper } from '../../../__lib__/LegendStudioUserDataHelper.js';
 import {
   type GeneratorFn,
@@ -287,6 +292,22 @@ export class WorkspaceReviewState {
       return;
     }
     this.isClosingWorkspaceReview = true;
+    const startTime = Date.now();
+    const reviewId = this.workspaceReview.id;
+    const sourceInfo = this.editorStore.editorMode.getSourceInfo();
+    const identity = {
+      action: SDLC_REVIEW_ACTION.CLOSE,
+      role: SDLC_REVIEW_ROLE.AUTHOR,
+      projectId: this.sdlcState.activeProject.projectId,
+      patchReleaseVersionId:
+        this.sdlcState.activePatch?.patchReleaseVersionId.id,
+      reviewId,
+    };
+    LegendStudioTelemetryHelper.logEvent_SdlcReviewActionLaunched(
+      this.editorStore.applicationStore.telemetryService,
+      sourceInfo,
+      identity,
+    );
     try {
       yield this.editorStore.sdlcServerClient.rejectReview(
         this.sdlcState.activeProject.projectId,
@@ -294,12 +315,22 @@ export class WorkspaceReviewState {
         this.workspaceReview.id,
       );
       this.workspaceReview = undefined;
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionSucceeded(
+        this.editorStore.applicationStore.telemetryService,
+        sourceInfo,
+        { ...identity, durationMs: Date.now() - startTime },
+      );
     } catch (error) {
       assertErrorThrown(error);
       this.editorStore.applicationStore.logService.error(
         LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE),
         error,
       );
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionFailure(
+        this.editorStore.applicationStore.telemetryService,
+        sourceInfo,
+        { ...identity, errorMessage: error.message },
+      );
       this.editorStore.applicationStore.notificationService.notifyError(error);
     } finally {
       this.isClosingWorkspaceReview = false;
@@ -332,6 +363,20 @@ export class WorkspaceReviewState {
       return;
     }
     this.isCreatingWorkspaceReview = true;
+    const startTime = Date.now();
+    const sourceInfo = this.editorStore.editorMode.getSourceInfo();
+    const identity = {
+      action: SDLC_REVIEW_ACTION.CREATE,
+      role: SDLC_REVIEW_ROLE.AUTHOR,
+      projectId: this.sdlcState.activeProject.projectId,
+      patchReleaseVersionId:
+        this.sdlcState.activePatch?.patchReleaseVersionId.id,
+    };
+    LegendStudioTelemetryHelper.logEvent_SdlcReviewActionLaunched(
+      this.editorStore.applicationStore.telemetryService,
+      sourceInfo,
+      identity,
+    );
     try {
       const description =
         reviewDescription ??
@@ -348,12 +393,26 @@ export class WorkspaceReviewState {
           },
         )) as PlainObject<Review>,
       );
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionSucceeded(
+        this.editorStore.applicationStore.telemetryService,
+        sourceInfo,
+        {
+          ...identity,
+          reviewId: this.workspaceReview.id,
+          durationMs: Date.now() - startTime,
+        },
+      );
     } catch (error) {
       assertErrorThrown(error);
       this.editorStore.applicationStore.logService.error(
         LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE),
         error,
       );
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionFailure(
+        this.editorStore.applicationStore.telemetryService,
+        sourceInfo,
+        { ...identity, errorMessage: error.message },
+      );
       this.editorStore.applicationStore.notificationService.notifyError(error);
     } finally {
       this.isCreatingWorkspaceReview = false;
@@ -396,6 +455,21 @@ export class WorkspaceReviewState {
       return;
     }
 
+    const startTime = Date.now();
+    const sourceInfo = this.editorStore.editorMode.getSourceInfo();
+    const identity = {
+      action: SDLC_REVIEW_ACTION.COMMIT,
+      role: SDLC_REVIEW_ROLE.AUTHOR,
+      projectId: this.sdlcState.activeProject.projectId,
+      patchReleaseVersionId:
+        this.sdlcState.activePatch?.patchReleaseVersionId.id,
+      reviewId: review.id,
+    };
+    LegendStudioTelemetryHelper.logEvent_SdlcReviewActionLaunched(
+      this.editorStore.applicationStore.telemetryService,
+      sourceInfo,
+      identity,
+    );
     try {
       yield this.editorStore.sdlcServerClient.commitReview(
         this.sdlcState.activeProject.projectId,
@@ -403,6 +477,11 @@ export class WorkspaceReviewState {
         review.id,
         { message: `${review.title} [review]` },
       );
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionSucceeded(
+        this.editorStore.applicationStore.telemetryService,
+        sourceInfo,
+        { ...identity, durationMs: Date.now() - startTime },
+      );
       // Committing a review deletes the workspace on SDLC. Drop it from
       // the recents cache so the workspace setup screen doesn't keep
       // offering a dead link. Patch workspaces are never cached.
@@ -452,6 +531,11 @@ export class WorkspaceReviewState {
         LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE),
         error,
       );
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionFailure(
+        this.editorStore.applicationStore.telemetryService,
+        sourceInfo,
+        { ...identity, errorMessage: error.message },
+      );
       this.editorStore.applicationStore.notificationService.notifyError(error);
     } finally {
       this.isCommittingWorkspaceReview = false;

package/src/stores/editor/sidebar-state/testable/GlobalTestRunnerState.ts

@@ -54,6 +54,14 @@ import type {
 } from '../../../LegendStudioApplicationPlugin.js';
 import { ServiceEditorState } from '../../editor-state/element-editor-state/service/ServiceEditorState.js';
 import { LegendStudioUserDataHelper } from '../../../../__lib__/LegendStudioUserDataHelper.js';
+import {
+  GLOBAL_TEST_RUN_SCOPE,
+  LegendStudioTelemetryHelper,
+  TESTABLE_RUN_MODE,
+  getTestableKind,
+  getTestablePath,
+  summarizeTestResults,
+} from '../../../../__lib__/LegendStudioTelemetryHelper.js';
 
 // Testable Metadata
 export interface TestableMetadata {
@@ -456,6 +464,10 @@ export class TestableState {
     this.isRunningTests.inProgress();
     let input: RunTestsTestableInput;
     let currentNode = node;
+    const testable = this.testableMetadata.testable;
+    let mode: TESTABLE_RUN_MODE = TESTABLE_RUN_MODE.RUN_TESTABLE;
+    let suiteId: string | undefined;
+    let testCount = 0;
     try {
       if (node instanceof AssertionTestTreeNodeData) {
         const atomicTest = guaranteeNonNullable(node.assertion.parentTest);
@@ -463,8 +475,11 @@ export class TestableState {
           atomicTest.__parent instanceof TestSuite
             ? atomicTest.__parent
             : undefined;
-        input = new RunTestsTestableInput(this.testableMetadata.testable);
+        input = new RunTestsTestableInput(testable);
         input.unitTestIds = [new UniqueTestId(suite, atomicTest)];
+        mode = TESTABLE_RUN_MODE.RUN_TEST;
+        suiteId = suite?.id;
+        testCount = 1;
         const parentNode = Array.from(this.treeData.nodes.values())
           .filter(filterByType(AtomicTestTreeNodeData))
           .find((n) => n.atomicTest === atomicTest);
@@ -478,30 +493,74 @@ export class TestableState {
           atomicTest.__parent instanceof TestSuite
             ? atomicTest.__parent
             : undefined;
-        input = new RunTestsTestableInput(this.testableMetadata.testable);
+        input = new RunTestsTestableInput(testable);
         input.unitTestIds = [new UniqueTestId(suite, atomicTest)];
+        mode = TESTABLE_RUN_MODE.RUN_TEST;
+        suiteId = suite?.id;
+        testCount = 1;
         node.isRunning = true;
       } else if (node instanceof TestSuiteTreeNodeData) {
-        input = new RunTestsTestableInput(this.testableMetadata.testable);
+        input = new RunTestsTestableInput(testable);
         input.unitTestIds = node.testSuite.tests.map(
           (s) => new UniqueTestId(node.testSuite, s),
         );
+        mode = TESTABLE_RUN_MODE.RUN_SUITE;
+        suiteId = node.testSuite.id;
+        testCount = node.testSuite.tests.length;
         node.isRunning = true;
       } else if (node instanceof TestableTreeNodeData) {
-        input = new RunTestsTestableInput(this.testableMetadata.testable);
+        input = new RunTestsTestableInput(testable);
+        mode = TESTABLE_RUN_MODE.RUN_TESTABLE;
+        suiteId = undefined;
+        testCount = testable.tests.reduce(
+          (acc, t) => acc + (t instanceof TestSuite ? t.tests.length : 1),
+          0,
+        );
         node.isRunning = true;
       } else {
         throw new UnsupportedOperationError(
           `Unable to run tests for node ${node}`,
         );
       }
-      const testResults =
-        (yield this.editorStore.graphManagerState.graphManager.runTests(
-          [input],
-          this.editorStore.graphManagerState.graph,
-        )) as TestResult[];
-      this.globalTestRunnerState.handleResults(testResults);
-      this.isRunningTests.complete();
+      const telemetryBase = {
+        testableKind: getTestableKind(testable),
+        testablePath: getTestablePath(testable),
+        suiteId,
+        mode,
+        testCount,
+      };
+      const startTime = Date.now();
+      LegendStudioTelemetryHelper.logEvent_TestableRunLaunched(
+        this.editorStore.applicationStore.telemetryService,
+        this.editorStore.editorMode.getSourceInfo(),
+        telemetryBase,
+      );
+      try {
+        const testResults =
+          (yield this.editorStore.graphManagerState.graphManager.runTests(
+            [input],
+            this.editorStore.graphManagerState.graph,
+          )) as TestResult[];
+        this.globalTestRunnerState.handleResults(testResults);
+        this.isRunningTests.complete();
+        LegendStudioTelemetryHelper.logEvent_TestableRunSucceeded(
+          this.editorStore.applicationStore.telemetryService,
+          this.editorStore.editorMode.getSourceInfo(),
+          {
+            ...telemetryBase,
+            durationMs: Date.now() - startTime,
+            ...summarizeTestResults(testResults),
+          },
+        );
+      } catch (error) {
+        assertErrorThrown(error);
+        LegendStudioTelemetryHelper.logEvent_TestableRunFailure(
+          this.editorStore.applicationStore.telemetryService,
+          this.editorStore.editorMode.getSourceInfo(),
+          { ...telemetryBase, errorMessage: error.message },
+        );
+        throw error;
+      }
     } catch (error) {
       assertErrorThrown(error);
       this.editorStore.applicationStore.notificationService.notifyError(error);
@@ -659,11 +718,21 @@ export class GlobalTestRunnerState {
   }
 
   *runAllTests(): GeneratorFn<void> {
+    const inputs = this.ownTestableStates.map(
+      (e) => new RunTestsTestableInput(e.testableMetadata.testable),
+    );
+    const telemetryBase = {
+      scope: GLOBAL_TEST_RUN_SCOPE.ALL,
+      testableCount: inputs.length,
+    };
+    const startTime = Date.now();
+    LegendStudioTelemetryHelper.logEvent_GlobalTestRunLaunched(
+      this.editorStore.applicationStore.telemetryService,
+      this.editorStore.editorMode.getSourceInfo(),
+      telemetryBase,
+    );
     try {
       this.isRunningTests.inProgress();
-      const inputs = this.ownTestableStates.map(
-        (e) => new RunTestsTestableInput(e.testableMetadata.testable),
-      );
       const testResults =
         (yield this.editorStore.graphManagerState.graphManager.runTests(
           inputs,
@@ -671,10 +740,24 @@ export class GlobalTestRunnerState {
         )) as TestResult[];
       this.handleResults(testResults);
       this.isRunningTests.complete();
+      LegendStudioTelemetryHelper.logEvent_GlobalTestRunSucceeded(
+        this.editorStore.applicationStore.telemetryService,
+        this.editorStore.editorMode.getSourceInfo(),
+        {
+          ...telemetryBase,
+          durationMs: Date.now() - startTime,
+          ...summarizeTestResults(testResults),
+        },
+      );
     } catch (error) {
       assertErrorThrown(error);
       this.editorStore.applicationStore.notificationService.notifyError(error);
       this.isRunningTests.fail();
+      LegendStudioTelemetryHelper.logEvent_GlobalTestRunFailure(
+        this.editorStore.applicationStore.telemetryService,
+        this.editorStore.editorMode.getSourceInfo(),
+        { ...telemetryBase, errorMessage: error.message },
+      );
     }
   }
 
@@ -711,11 +794,21 @@ export class GlobalTestRunnerState {
   }
 
   *runDependenciesTests(): GeneratorFn<void> {
+    const inputs = this.allDependencyTestablesStates.map(
+      (e) => new RunTestsTestableInput(e.testableMetadata.testable),
+    );
+    const telemetryBase = {
+      scope: GLOBAL_TEST_RUN_SCOPE.DEPENDENCIES,
+      testableCount: inputs.length,
+    };
+    const startTime = Date.now();
+    LegendStudioTelemetryHelper.logEvent_GlobalTestRunLaunched(
+      this.editorStore.applicationStore.telemetryService,
+      this.editorStore.editorMode.getSourceInfo(),
+      telemetryBase,
+    );
     try {
       this.isRunningDependencyTests.inProgress();
-      const inputs = this.allDependencyTestablesStates.map(
-        (e) => new RunTestsTestableInput(e.testableMetadata.testable),
-      );
       const testResults =
         (yield this.editorStore.graphManagerState.graphManager.runTests(
           inputs,
@@ -723,10 +816,24 @@ export class GlobalTestRunnerState {
         )) as TestResult[];
       this.handleResults(testResults);
       this.isRunningDependencyTests.complete();
+      LegendStudioTelemetryHelper.logEvent_GlobalTestRunSucceeded(
+        this.editorStore.applicationStore.telemetryService,
+        this.editorStore.editorMode.getSourceInfo(),
+        {
+          ...telemetryBase,
+          durationMs: Date.now() - startTime,
+          ...summarizeTestResults(testResults),
+        },
+      );
     } catch (error) {
       assertErrorThrown(error);
       this.editorStore.applicationStore.notificationService.notifyError(error);
       this.isRunningDependencyTests.fail();
+      LegendStudioTelemetryHelper.logEvent_GlobalTestRunFailure(
+        this.editorStore.applicationStore.telemetryService,
+        this.editorStore.editorMode.getSourceInfo(),
+        { ...telemetryBase, errorMessage: error.message },
+      );
     }
   }
 }

package/src/stores/project-reviewer/ProjectReviewerStore.ts

@@ -45,6 +45,11 @@ import {
   ReviewApproval,
 } from '@finos/legend-server-sdlc';
 import { LEGEND_STUDIO_APP_EVENT } from '../../__lib__/LegendStudioEvent.js';
+import {
+  LegendStudioTelemetryHelper,
+  SDLC_REVIEW_ACTION,
+  SDLC_REVIEW_ROLE,
+} from '../../__lib__/LegendStudioTelemetryHelper.js';
 import { LegendStudioUserDataHelper } from '../../__lib__/LegendStudioUserDataHelper.js';
 import { DEFAULT_TAB_SIZE } from '@finos/legend-application';
 import type { Entity } from '@finos/legend-storage';
@@ -431,6 +436,19 @@ export class ProjectReviewerStore {
 
   *approveReview(): GeneratorFn<void> {
     this.approveState.inProgress();
+    const startTime = Date.now();
+    const identity = {
+      action: SDLC_REVIEW_ACTION.APPROVE,
+      role: SDLC_REVIEW_ROLE.REVIEWER,
+      projectId: this.projectId,
+      patchReleaseVersionId: this.patchReleaseVersionId,
+      reviewId: this.review.id,
+    };
+    LegendStudioTelemetryHelper.logEvent_SdlcReviewActionLaunched(
+      this.editorStore.applicationStore.telemetryService,
+      undefined,
+      identity,
+    );
     try {
       this.currentReview = Review.serialization.fromJson(
         (yield this.editorStore.sdlcServerClient.approveReview(
@@ -439,12 +457,22 @@ export class ProjectReviewerStore {
           this.review.id,
         )) as PlainObject<Review>,
       );
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionSucceeded(
+        this.editorStore.applicationStore.telemetryService,
+        undefined,
+        { ...identity, durationMs: Date.now() - startTime },
+      );
     } catch (error) {
       assertErrorThrown(error);
       this.editorStore.applicationStore.logService.error(
         LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE),
         error,
       );
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionFailure(
+        this.editorStore.applicationStore.telemetryService,
+        undefined,
+        { ...identity, errorMessage: error.message },
+      );
       this.editorStore.applicationStore.notificationService.notifyError(error);
     } finally {
       this.approveState.complete();
@@ -453,6 +481,19 @@ export class ProjectReviewerStore {
 
   *commitReview(): GeneratorFn<void> {
     this.commitState.inProgress();
+    const startTime = Date.now();
+    const identity = {
+      action: SDLC_REVIEW_ACTION.COMMIT,
+      role: SDLC_REVIEW_ROLE.REVIEWER,
+      projectId: this.projectId,
+      patchReleaseVersionId: this.patchReleaseVersionId,
+      reviewId: this.review.id,
+    };
+    LegendStudioTelemetryHelper.logEvent_SdlcReviewActionLaunched(
+      this.editorStore.applicationStore.telemetryService,
+      undefined,
+      identity,
+    );
     try {
       this.currentReview = Review.serialization.fromJson(
         (yield this.editorStore.sdlcServerClient.commitReview(
@@ -462,6 +503,11 @@ export class ProjectReviewerStore {
           { message: `${this.review.title} [review]` },
         )) as PlainObject<Review>,
       );
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionSucceeded(
+        this.editorStore.applicationStore.telemetryService,
+        undefined,
+        { ...identity, durationMs: Date.now() - startTime },
+      );
       // Committing a review deletes its workspace on SDLC. Drop the
       // matching entry from the local recents cache (no-op if it wasn't
       // there, e.g., the reviewer isn't the workspace author). Patch
@@ -482,6 +528,11 @@ export class ProjectReviewerStore {
         LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE),
         error,
       );
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionFailure(
+        this.editorStore.applicationStore.telemetryService,
+        undefined,
+        { ...identity, errorMessage: error.message },
+      );
       this.editorStore.applicationStore.notificationService.notifyError(error);
     } finally {
       this.commitState.complete();
@@ -490,6 +541,19 @@ export class ProjectReviewerStore {
 
   *reOpenReview(): GeneratorFn<void> {
     this.reOpenState.inProgress();
+    const startTime = Date.now();
+    const identity = {
+      action: SDLC_REVIEW_ACTION.REOPEN,
+      role: SDLC_REVIEW_ROLE.REVIEWER,
+      projectId: this.projectId,
+      patchReleaseVersionId: this.patchReleaseVersionId,
+      reviewId: this.review.id,
+    };
+    LegendStudioTelemetryHelper.logEvent_SdlcReviewActionLaunched(
+      this.editorStore.applicationStore.telemetryService,
+      undefined,
+      identity,
+    );
     try {
       this.currentReview = Review.serialization.fromJson(
         (yield this.editorStore.sdlcServerClient.reopenReview(
@@ -498,12 +562,22 @@ export class ProjectReviewerStore {
           this.review.id,
         )) as PlainObject<Review>,
       );
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionSucceeded(
+        this.editorStore.applicationStore.telemetryService,
+        undefined,
+        { ...identity, durationMs: Date.now() - startTime },
+      );
     } catch (error) {
       assertErrorThrown(error);
       this.editorStore.applicationStore.logService.error(
         LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE),
         error,
       );
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionFailure(
+        this.editorStore.applicationStore.telemetryService,
+        undefined,
+        { ...identity, errorMessage: error.message },
+      );
       this.editorStore.applicationStore.notificationService.notifyError(error);
     } finally {
       this.reOpenState.complete();
@@ -512,6 +586,19 @@ export class ProjectReviewerStore {
 
   *closeReview(): GeneratorFn<void> {
     this.closeState.inProgress();
+    const startTime = Date.now();
+    const identity = {
+      action: SDLC_REVIEW_ACTION.CLOSE,
+      role: SDLC_REVIEW_ROLE.REVIEWER,
+      projectId: this.projectId,
+      patchReleaseVersionId: this.patchReleaseVersionId,
+      reviewId: this.review.id,
+    };
+    LegendStudioTelemetryHelper.logEvent_SdlcReviewActionLaunched(
+      this.editorStore.applicationStore.telemetryService,
+      undefined,
+      identity,
+    );
     try {
       this.currentReview = Review.serialization.fromJson(
         (yield this.editorStore.sdlcServerClient.closeReview(
@@ -520,12 +607,22 @@ export class ProjectReviewerStore {
           this.review.id,
         )) as PlainObject<Review>,
       );
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionSucceeded(
+        this.editorStore.applicationStore.telemetryService,
+        undefined,
+        { ...identity, durationMs: Date.now() - startTime },
+      );
     } catch (error) {
       assertErrorThrown(error);
       this.editorStore.applicationStore.logService.error(
         LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE),
         error,
       );
+      LegendStudioTelemetryHelper.logEvent_SdlcReviewActionFailure(
+        this.editorStore.applicationStore.telemetryService,
+        undefined,
+        { ...identity, errorMessage: error.message },
+      );
       this.editorStore.applicationStore.notificationService.notifyError(error);
     } finally {
       this.closeState.complete();