@finos/legend-query-builder 4.11.2 → 4.11.4

package/src/stores/QueryBuilderState.ts

@@ -102,6 +102,14 @@ import {
 import type { QueryBuilderConfig } from '../graph-manager/QueryBuilderConfig.js';
 import { QUERY_BUILDER_EVENT } from '../__lib__/QueryBuilderEvent.js';
 
+export interface QuerySDLC {}
+
+export type QueryStateInfo = QuerySDLC & {
+  class: string;
+  mapping: string;
+  runtime: string;
+};
+
 export abstract class QueryBuilderState implements CommandRegistrar {
   readonly applicationStore: GenericLegendApplicationStore;
   readonly graphManagerState: GraphManagerState;
@@ -137,6 +145,11 @@ export abstract class QueryBuilderState implements CommandRegistrar {
   executionContextState: QueryBuilderExecutionContextState;
   internalizeState?: QueryBuilderInternalizeState | undefined;
 
+  // NOTE: This property contains information about workflow used
+  // to create this state. This should only be used to add additional
+  // information to query builder analytics.
+  sourceInfo?: QuerySDLC | undefined;
+
   // NOTE: this makes it so that we need to import components in stores code,
   // we probably want to refactor to an extension mechanism
   TEMPORARY__setupPanelContentRenderer?: (() => React.ReactNode) | undefined;
@@ -145,6 +158,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
     applicationStore: GenericLegendApplicationStore,
     graphManagerState: GraphManagerState,
     config: QueryBuilderConfig | undefined,
+    sourceInfo?: QuerySDLC | undefined,
   ) {
     makeObservable(this, {
       explorerState: observable,
@@ -215,6 +229,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
     );
     this.changeDetectionState = new QueryBuilderChangeDetectionState(this);
     this.config = config;
+    this.sourceInfo = sourceInfo;
   }
 
   get isMappingReadOnly(): boolean {
@@ -259,6 +274,31 @@ export abstract class QueryBuilderState implements CommandRegistrar {
     return this.allVariables.map((e) => e.name);
   }
 
+  /**
+   * Gets information about the current queryBuilderState.
+   * This information can be used as a part of analytics
+   */
+  getStateInfo(): QueryStateInfo | undefined {
+    if (this.sourceInfo) {
+      const classPath = this.class?.path;
+      const mappingPath = this.executionContextState.mapping?.path;
+      const runtimePath =
+        this.executionContextState.runtimeValue instanceof RuntimePointer
+          ? this.executionContextState.runtimeValue.packageableRuntime.value
+              .path
+          : undefined;
+      if (classPath && mappingPath && runtimePath) {
+        const contextInfo = {
+          class: classPath,
+          mapping: mappingPath,
+          runtime: runtimePath,
+        };
+        return Object.assign({}, this.sourceInfo, contextInfo);
+      }
+    }
+    return undefined;
+  }
+
   setIsQueryChatOpened(val: boolean): void {
     this.isQueryChatOpened = val;
   }

package/src/stores/explorer/QueryBuilderExplorerState.ts

@@ -748,9 +748,14 @@ export class QueryBuilderExplorerState {
             stopWatch,
             report.timings,
           );
+        const reportWithState = Object.assign(
+          {},
+          report,
+          this.queryBuilderState.getStateInfo(),
+        );
         QueryBuilderTelemetryHelper.logEvent_QueryMappingModelCoverageAnalysisSucceeded(
           this.queryBuilderState.applicationStore.telemetryService,
-          report,
+          reportWithState,
         );
       } catch (error) {
         assertErrorThrown(error);

package/src/stores/workflows/MappingQueryBuilderState.ts

@@ -42,8 +42,9 @@ export class MappingQueryBuilderState extends QueryBuilderState {
     onMappingChange?: ((val: Mapping) => void) | undefined,
     onRuntimeChange?: ((val: Runtime) => void) | undefined,
     config?: QueryBuilderConfig | undefined,
+    sourceInfo?: object | undefined,
   ) {
-    super(applicationStore, graphManagerState, config);
+    super(applicationStore, graphManagerState, config, sourceInfo);
 
     this.onMappingChange = onMappingChange;
     this.onRuntimeChange = onRuntimeChange;

package/src/stores/workflows/ServiceQueryBuilderState.ts

@@ -66,8 +66,9 @@ export class ServiceQueryBuilderState extends QueryBuilderState {
       | ((val: ServiceExecutionContext) => void)
       | undefined,
     config?: QueryBuilderConfig | undefined,
+    sourceInfo?: object | undefined,
   ) {
-    super(applicationStore, graphManagerState, config);
+    super(applicationStore, graphManagerState, config, sourceInfo);
 
     makeObservable(this, {
       selectedExecutionContext: observable,