@finos/legend-application-studio/src/__lib__/LegendStudioTelemetryHelper.ts

Legend Studio application core

/**
 * 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 {
  GRAPH_MANAGER_EVENT,
  type GraphInitializationReport,
  type GraphManagerOperationReport,
} from '@finos/legend-graph';
import {
  APPLICATION_EVENT,
  type TelemetryService,
  type VirtualAssistantSearchResultAccessed_TelemetryData,
} from '@finos/legend-application';
import { LEGEND_STUDIO_APP_EVENT } from './LegendStudioEvent.js';
import type { LegendSourceInfo } from '@finos/legend-storage';

type Compilation_TelemetryData = GraphManagerOperationReport & {
  dependenciesCount: number;
};

type TestDataGeneration_TelemetryData = GraphManagerOperationReport & {
  dependenciesCount: number;
};

type ShowcaseSearchInitiated_TelemetryData = {
  searchText: string;
};

export type ShowcaseMetadata_TelemetryData = {
  showcasesTotalCount: number;
  showcasesDevelopmentCount: number;
};

export type ShowcaseProject_TelemetryData = {
  showcasePath: string;
};

export type IngestDefinitionDeployment_TelemetryData = {
  sourceInfo: LegendSourceInfo | undefined;
  ingestUrn: string;
  ingestDefinitionPath: string;
};

export class LegendStudioTelemetryHelper {
  static logEvent_GraphCompilationLaunched(service: TelemetryService): void {
    service.logEvent(LEGEND_STUDIO_APP_EVENT.COMPILE_GRAPH__LAUNCH, {});
  }

  static logEvent_TextCompilationLaunched(service: TelemetryService): void {
    service.logEvent(LEGEND_STUDIO_APP_EVENT.COMPILE_TEXT__LAUNCH, {});
  }

  static logEvent_TestDataGenerationLaunched(service: TelemetryService): void {
    service.logEvent(LEGEND_STUDIO_APP_EVENT.TEST_DATA_GENERATION__LAUNCH, {});
  }

  static logEvent_GraphCompilationSucceeded(
    service: TelemetryService,
    data: Compilation_TelemetryData,
  ): void {
    service.logEvent(
      LEGEND_STUDIO_APP_EVENT.FORM_MODE_COMPILATION__SUCCESS,
      data,
    );
  }

  static logEvent_TextCompilationSucceeded(
    service: TelemetryService,
    data: Compilation_TelemetryData,
  ): void {
    service.logEvent(
      LEGEND_STUDIO_APP_EVENT.TEXT_MODE_COMPILATION__SUCCESS,
      data,
    );
  }

  static logEvent_TestDataGenerationSucceeded(
    service: TelemetryService,
    data: TestDataGeneration_TelemetryData,
  ): void {
    service.logEvent(
      LEGEND_STUDIO_APP_EVENT.TEST_DATA_GENERATION__SUCCESS,
      data,
    );
  }

  static logEvent_GraphInitializationSucceeded(
    service: TelemetryService,
    data: GraphInitializationReport,
  ): void {
    service.logEvent(GRAPH_MANAGER_EVENT.INITIALIZE_GRAPH__SUCCESS, data);
  }

  // showcase manager
  static logEvent_ShowcaseManagerLaunch(
    service: TelemetryService,
    data: ShowcaseMetadata_TelemetryData,
  ): void {
    service.logEvent(LEGEND_STUDIO_APP_EVENT.SHOWCASE_MANAGER_LAUNCH, data);
  }
  static logEvent_ShowcaseManagerShowcaseProjectLaunch(
    service: TelemetryService,
    data: ShowcaseProject_TelemetryData,
  ): void {
    service.logEvent(
      LEGEND_STUDIO_APP_EVENT.SHOWCASE_MANAGER_SHOWCASE_PROJECT_LAUNCH,
      data,
    );
  }
  static logEvent_ShowcaseViewerLaunch(
    service: TelemetryService,
    data: ShowcaseProject_TelemetryData,
  ): void {
    service.logEvent(LEGEND_STUDIO_APP_EVENT.SHOWCASE_VIEWER_LAUNCH, data);
  }

  static logEvent_ShowcaseSearchInitiated(
    service: TelemetryService,
    data: ShowcaseSearchInitiated_TelemetryData,
  ): void {
    service.logEvent(
      LEGEND_STUDIO_APP_EVENT.SHOWCASE_MANAGER_SEARCH__INITIATED,
      data,
    );
  }

  // virtual assistant
  static logEvent_VirtualAssistantPanelOpened(service: TelemetryService): void {
    service.logEvent(APPLICATION_EVENT.VIRTUAL_ASSISTANT_PANEL__OPEN, {});
  }

  static logEvent_VirtualAssistantPanelClosed(service: TelemetryService): void {
    service.logEvent(APPLICATION_EVENT.VIRTUAL_ASSISTANT_PANEL__CLOSE, {});
  }

  static logEvent_VirtualAssistantTabAccessed(
    service: TelemetryService,
    tab: string,
  ): void {
    service.logEvent(APPLICATION_EVENT.VIRTUAL_ASSISTANT_TAB__ACCESS, { tab });
  }

  static logEvent_VirtualAssistantDocumentationSearchInitiated(
    service: TelemetryService,
    searchText: string,
  ): void {
    service.logEvent(
      APPLICATION_EVENT.VIRTUAL_ASSISTANT_DOCUMENTATION_SEARCH__INITIATED,
      { searchText },
    );
  }

  static logEvent_VirtualAssistantContextualInfoPresent(
    service: TelemetryService,
    contextKey: string,
  ): void {
    service.logEvent(
      APPLICATION_EVENT.VIRTUAL_ASSISTANT_CONTEXTUAL_INFO__PRESENT,
      { contextKey },
    );
  }

  static logEvent_VirtualAssistantSearchResultAccessed(
    service: TelemetryService,
    data: VirtualAssistantSearchResultAccessed_TelemetryData,
  ): void {
    service.logEvent(
      APPLICATION_EVENT.VIRTUAL_ASSISTANT_SEARCH_RESULT__ACCESS,
      data,
    );
  }

  // Lakehouse
  static logEvent_LakehouseDeployIngest(
    service: TelemetryService,
    sourceInfo: LegendSourceInfo | undefined,
    ingestUrn: string,
    ingestDefinitionPath: string,
  ): void {
    const eventData: IngestDefinitionDeployment_TelemetryData = {
      sourceInfo,
      ingestUrn,
      ingestDefinitionPath,
    };
    service.logEvent(
      LEGEND_STUDIO_APP_EVENT.INGESTION_DEPLOY_SUCCESS_URN,
      eventData,
    );
  }

  static logEvent_LakehouseDeployIngestFailure(
    service: TelemetryService,
    sourceInfo: LegendSourceInfo | undefined,
    ingestDefinitionPath: string,
    errorMessage: string,
  ): void {
    const eventData = {
      sourceInfo,
      ingestDefinitionPath,
      errorMessage,
    };
    service.logEvent(
      LEGEND_STUDIO_APP_EVENT.INGESTION_DEPLOY_FAILURE,
      eventData,
    );
  }

  static logEvent_LakehouseDeployDataProduct(
    service: TelemetryService,
    sourceInfo: LegendSourceInfo | undefined,
    dataProductPath: string,
  ): void {
    const eventData = {
      sourceInfo,
      dataProductPath,
    };
    service.logEvent(
      LEGEND_STUDIO_APP_EVENT.DATA_PRODUCT_DEPLOY_SUCCESS,
      eventData,
    );
  }

  static logEvent_LakehouseDeployDataProductFailure(
    service: TelemetryService,
    sourceInfo: LegendSourceInfo | undefined,
    dataProductPath: string,
    errorMessage: string,
  ): void {
    const eventData = {
      sourceInfo,
      dataProductPath,
      errorMessage,
    };
    service.logEvent(
      LEGEND_STUDIO_APP_EVENT.DATA_PRODUCT_DEPLOY_FAILURE,
      eventData,
    );
  }

  // Push to Dev Metadata
  static logEvent_DevMetadataPushLaunched(
    service: TelemetryService,
    sourceInfo: LegendSourceInfo | undefined,
    groupId: string,
    artifactId: string,
    versionId: string | undefined,
  ): void {
    service.logEvent(
      LEGEND_STUDIO_APP_EVENT.METADATA_PUSH_TO_METADATA__LAUNCH,
      {
        sourceInfo,
        groupId,
        artifactId,
        versionId,
      },
    );
  }

  static logEvent_DevMetadataPushSucceeded(
    service: TelemetryService,
    sourceInfo: LegendSourceInfo | undefined,
    groupId: string,
    artifactId: string,
    versionId: string | undefined,
    status: string,
  ): void {
    service.logEvent(
      LEGEND_STUDIO_APP_EVENT.METADATA_PUSH_TO_METADATA__SUCCESS,
      {
        sourceInfo,
        groupId,
        artifactId,
        versionId,
        status,
      },
    );
  }

  static logEvent_DevMetadataPushFailure(
    service: TelemetryService,
    sourceInfo: LegendSourceInfo | undefined,
    errorMessage: string,
  ): void {
    service.logEvent(
      LEGEND_STUDIO_APP_EVENT.METADATA_PUSH_TO_METADATA__FAILURE,
      {
        sourceInfo,
        errorMessage,
      },
    );
  }
}