@finos/legend-query-builder 0.6.27 → 0.6.29

package/src/stores/QueryBuilderTelemetry.ts

@@ -0,0 +1,83 @@
+/**
+ * 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 { GraphManagerOperationReport } from '@finos/legend-graph';
+import type { TelemetryService } from '@finos/legend-shared';
+import { QUERY_BUILDER_EVENT } from './QueryBuilderEvent.js';
+
+type LaunchQueryExecution_TelemteryData = {
+  applicationContext?: string | undefined;
+};
+
+type QueryExecution_TelemetryData = GraphManagerOperationReport & {
+  dependenciesCount: number;
+};
+
+export class QueryBuilderTelemetry {
+  static logEvent_QueryRunLaunched(
+    telemetryService: TelemetryService,
+    data: LaunchQueryExecution_TelemteryData,
+  ): void {
+    telemetryService.logEvent(QUERY_BUILDER_EVENT.RUN_QUERY__LAUNCH, data);
+  }
+
+  static logEvent_ExecutionPlanGenerationLaunched(
+    telemetryService: TelemetryService,
+    data: LaunchQueryExecution_TelemteryData,
+  ): void {
+    telemetryService.logEvent(
+      QUERY_BUILDER_EVENT.GENERATE_EXECUTION_PLAN__LAUNCH,
+      data,
+    );
+  }
+
+  static logEvent_ExecutionPlanDebugLaunched(
+    telemetryService: TelemetryService,
+    data: LaunchQueryExecution_TelemteryData,
+  ): void {
+    telemetryService.logEvent(
+      QUERY_BUILDER_EVENT.DEBUG_EXECUTION_PLAN__LAUNCH,
+      data,
+    );
+  }
+
+  static logEvent_QueryRunSucceeded(
+    telemetryService: TelemetryService,
+    data: QueryExecution_TelemetryData,
+  ): void {
+    telemetryService.logEvent(QUERY_BUILDER_EVENT.RUN_QUERY__SUCCESS, data);
+  }
+
+  static logEvent_ExecutionPlanGenerationSucceeded(
+    telemetryService: TelemetryService,
+    data: QueryExecution_TelemetryData,
+  ): void {
+    telemetryService.logEvent(
+      QUERY_BUILDER_EVENT.GENERATE_EXECUTION_PLAN__SUCCESS,
+      data,
+    );
+  }
+
+  static logEvent_ExecutionPlanDebugSucceeded(
+    telemetryService: TelemetryService,
+    data: QueryExecution_TelemetryData,
+  ): void {
+    telemetryService.logEvent(
+      QUERY_BUILDER_EVENT.DEBUG_EXECUTION_PLAN__SUCCESS,
+      data,
+    );
+  }
+}

package/tsconfig.json

@@ -53,6 +53,7 @@
     "./src/stores/QueryBuilderCommand.ts",
     "./src/stores/QueryBuilderConfig.ts",
     "./src/stores/QueryBuilderConstantsState.ts",
+    "./src/stores/QueryBuilderEvent.ts",
     "./src/stores/QueryBuilderGroupOperationHelper.ts",
     "./src/stores/QueryBuilderParametersState.ts",
     "./src/stores/QueryBuilderPreviewDataHelper.ts",
@@ -61,6 +62,7 @@
     "./src/stores/QueryBuilderState.ts",
     "./src/stores/QueryBuilderStateBuilder.ts",
     "./src/stores/QueryBuilderStateTestUtils.ts",
+    "./src/stores/QueryBuilderTelemetry.ts",
     "./src/stores/QueryBuilderTextEditorState.ts",
     "./src/stores/QueryBuilderTypeaheadHelper.ts",
     "./src/stores/QueryBuilderUnsupportedQueryState.ts",