Add duration to error event

Author: AdityaHegde

web-common/src/features/add-data/form/ConnectorForm.svelte

@@ -13,15 +13,12 @@
   } from "@rilldata/web-common/features/add-data/manager/steps/connector.ts";
   import { getLabelsForConnector } from "@rilldata/web-common/features/add-data/form/form-labels.ts";
   import { setSubmitError } from "@rilldata/web-common/features/add-data/form/errors.ts";
-  import type {
-    AddDataConfig,
-    CreateConnectorStep,
-  } from "@rilldata/web-common/features/add-data/manager/steps/types.ts";
+  import type { CreateConnectorStep } from "@rilldata/web-common/features/add-data/manager/steps/types.ts";
   import { addLeadingSlash } from "@rilldata/web-common/features/entity-management/entity-mappers.ts";
   import { getConnectorDriverForSchema } from "@rilldata/web-common/features/add-data/manager/steps/utils.ts";
-  import { errorEventHandler } from "@rilldata/web-common/metrics/initMetrics.ts";
+  import type { AddDataStateManager } from "@rilldata/web-common/features/add-data/manager/AddDataStateManager.svelte.ts";
 
-  export let config: AddDataConfig;
+  export let stateManager: AddDataStateManager;
   export let step: CreateConnectorStep;
   export let onSubmit: (
     connectorName: string,
@@ -58,13 +55,7 @@
 
         onSubmit(connectorName, form.data);
       } catch (e) {
-        void errorEventHandler?.fireAddDataErrorEvent(
-          config.space,
-          config.screen,
-          step.step,
-          step.schema,
-          e.message,
-        );
+        stateManager.fireErrorEvent(e.message);
         setSubmitError(form, e);
       }
     },

web-common/src/features/add-data/form/ConnectorFormWrapper.svelte

@@ -1,16 +1,14 @@
 <script lang="ts">
-  import type {
-    AddDataConfig,
-    CreateConnectorStep,
-  } from "@rilldata/web-common/features/add-data/manager/steps/types.ts";
+  import type { CreateConnectorStep } from "@rilldata/web-common/features/add-data/manager/steps/types.ts";
   import { connectorFormCache } from "@rilldata/web-common/features/add-data/manager/steps/connector.ts";
   import { onMount } from "svelte";
   import ConnectorForm from "@rilldata/web-common/features/add-data/form/ConnectorForm.svelte";
+  import type { AddDataStateManager } from "@rilldata/web-common/features/add-data/manager/AddDataStateManager.svelte.ts";
 
   // Wrapper to initialize the ConnectorForm with cached data.
   // Has async logic to fetch the .env file. So to ensure we load the form on init, we use this wrapper.
 
-  export let config: AddDataConfig;
+  export let stateManager: AddDataStateManager;
   export let step: CreateConnectorStep;
   export let onSubmit: (
     connectorName: string,
@@ -33,7 +31,7 @@
 
 {#if connectorName != null && cachedEnvBlob != null && cachedFormValues != null}
   <ConnectorForm
-    {config}
+    {stateManager}
     {step}
     {onSubmit}
     {onBack}

web-common/src/features/add-data/manager/AddDataManager.svelte

@@ -167,7 +167,7 @@
     <SourceSelector {config} onSelect={schemaSelected} {onBack} />
   {:else if stepState.step === AddDataStep.CreateConnector}
     <ConnectorFormWrapper
-      {config}
+      {stateManager}
       step={stepState}
       onSubmit={(connectorName, connectorFormValues) =>
         void connectorSelected(connectorName, connectorFormValues)}
@@ -198,10 +198,16 @@
       stepState.config.importSteps[0] === ImportDataStep.CreateModel}
     {#if isImportOnlyStep}
       <!-- Special case for import only, we show additional options to handle success and failures. -->
-      <ImportDataStatus {config} importAddDataStep={stepState} {onDone} />
+      <ImportDataStatus
+        {config}
+        {stateManager}
+        importAddDataStep={stepState}
+        {onDone}
+      />
     {:else}
       <GenerateDashboardStatus
         {config}
+        {stateManager}
         importAddDataStep={stepState}
         {onBack}
         {onDone}

web-common/src/features/add-data/manager/AddDataStateManager.svelte.ts

@@ -11,7 +11,10 @@ import {
 } from "@rilldata/web-common/features/add-data/manager/steps/utils.ts";
 import type { V1ConnectorDriver } from "@rilldata/web-common/runtime-client";
 import { connectorFormCache } from "@rilldata/web-common/features/add-data/manager/steps/connector.ts";
-import { behaviourEvent } from "@rilldata/web-common/metrics/initMetrics.ts";
+import {
+  behaviourEvent,
+  errorEventHandler,
+} from "@rilldata/web-common/metrics/initMetrics.ts";
 import {
   type AddDataBehaviourEventFields,
   BehaviourEventAction,
@@ -59,7 +62,7 @@ export class AddDataStateManager {
   private onStepChange: ((step: AddDataStep) => void) | undefined = undefined;
   private config: AddDataConfig | undefined = undefined;
 
-  private lastTransitionTime: number = 0;
+  private startTime = Date.now();
 
   public setCallbacks(
     onDone: (() => void) | undefined,
@@ -244,8 +247,42 @@ export class AddDataStateManager {
           break;
       }
     }
+  }
+
+  public fireErrorEvent(
+    message: string,
+    step: AddDataStep | ImportDataStep = this.state.step,
+  ) {
+    if (!this.config) return;
+
+    const addDataFields: AddDataBehaviourEventFields = {
+      step,
+      duration: Date.now() - this.startTime,
+    };
+    if (
+      this.state.step === AddDataStep.CreateConnector ||
+      this.state.step === AddDataStep.CreateModel ||
+      this.state.step === AddDataStep.ExploreConnector ||
+      this.state.step === AddDataStep.Import
+    ) {
+      addDataFields.schema = this.state.schema;
+    }
+    if (
+      this.state.step === AddDataStep.CreateModel ||
+      this.state.step === AddDataStep.ExploreConnector
+    ) {
+      addDataFields.connector = this.state.connector;
+    }
+    if (this.state.step === AddDataStep.Import) {
+      addDataFields.connector = this.state.config.connector;
+    }
 
-    this.lastTransitionTime = Date.now();
+    void errorEventHandler?.fireAddDataErrorEvent(
+      this.config.space,
+      this.config.screen,
+      message,
+      addDataFields,
+    );
   }
 
   private pushState(state: AddDataState) {
@@ -261,8 +298,6 @@ export class AddDataStateManager {
     this.state = this.stateStack.pop() ?? { step: AddDataStep.Init };
     if (this.stateStack.length === 0) this.onClose?.();
     this.onStepChange?.(this.state.step);
-
-    this.lastTransitionTime = Date.now();
   }
 
   // For lateral state change, going back is not supported.
@@ -276,15 +311,15 @@ export class AddDataStateManager {
     fields: AddDataBehaviourEventFields,
   ) {
     if (!this.config) return;
-    const duration = this.lastTransitionTime
-      ? Date.now() - this.lastTransitionTime
-      : 0;
     void behaviourEvent?.fireAddDataStepEvent(
       action,
       this.config.medium,
       this.config.space,
       this.config.screen,
-      { ...fields, duration },
+      {
+        ...fields,
+        duration: Date.now() - this.startTime,
+      },
     );
   }
 }

web-common/src/features/add-data/manager/GenerateDashboardStatus.svelte

@@ -21,9 +21,10 @@
   import { addLeadingSlash } from "@rilldata/web-common/features/entity-management/entity-mappers.ts";
   import { queryClient } from "@rilldata/web-common/lib/svelte-query/globalQueryClient.ts";
   import FeatherCheckCircle from "@rilldata/web-common/components/icons/FeatherCheckCircle.svelte";
-  import { errorEventHandler } from "@rilldata/web-common/metrics/initMetrics.ts";
+  import type { AddDataStateManager } from "@rilldata/web-common/features/add-data/manager/AddDataStateManager.svelte.ts";
 
   export let config: AddDataConfig;
+  export let stateManager: AddDataStateManager;
   export let importAddDataStep: ImportAddDataStep;
   export let onBack: () => void;
   export let onDone: () => void;
@@ -80,13 +81,7 @@
       return goto(currentFileRoute);
     } catch (e) {
       error = e?.response?.data?.message ?? e?.message ?? "Unknown error";
-      void errorEventHandler?.fireAddDataErrorEvent(
-        config.space,
-        config.screen,
-        importStep,
-        importAddDataStep.config.connector,
-        error!,
-      );
+      stateManager.fireErrorEvent(error!, importStep);
     }
   }
 

web-common/src/features/add-data/manager/ImportDataStatus.svelte

@@ -22,9 +22,10 @@
   import { featureFlags } from "@rilldata/web-common/features/feature-flags.ts";
   import { addLeadingSlash } from "@rilldata/web-common/features/entity-management/entity-mappers.ts";
   import { runImportSteps } from "@rilldata/web-common/features/add-data/manager/steps/import.ts";
-  import { errorEventHandler } from "@rilldata/web-common/metrics/initMetrics.ts";
+  import type { AddDataStateManager } from "@rilldata/web-common/features/add-data/manager/AddDataStateManager.svelte.ts";
 
   export let config: AddDataConfig;
+  export let stateManager: AddDataStateManager;
   export let importAddDataStep: ImportAddDataStep;
   export let onDone: () => void;
 
@@ -64,13 +65,7 @@
       );
     } catch (e) {
       error = e?.response?.data?.message ?? e?.message ?? "Unknown error";
-      void errorEventHandler?.fireAddDataErrorEvent(
-        config.space,
-        config.screen,
-        importAddDataStep.config.connector,
-        importStep,
-        error!,
-      );
+      stateManager.fireErrorEvent(error!, importStep);
     }
   }
 

web-common/src/metrics/ErrorEventHandler.ts

@@ -17,6 +17,7 @@ import type {
   SourceFileType,
 } from "./service/SourceEventTypes";
 import { categorizeSourceError } from "@rilldata/web-common/features/sources/errors/errors.ts";
+import type { AddDataBehaviourEventFields } from "@rilldata/web-common/metrics/service/BehaviourEventTypes.ts";
 
 export class ErrorEventHandler {
   public constructor(
@@ -117,18 +118,16 @@ export class ErrorEventHandler {
   public fireAddDataErrorEvent(
     space: MetricsEventSpace,
     screen_name: MetricsEventScreenName,
-    step: string,
-    schema: string,
     message: string,
+    addDataFields: AddDataBehaviourEventFields,
   ) {
     const code = categorizeSourceError(message);
     return this.metricsService.dispatch("addDataErrorEvent", [
       this.commonUserMetrics,
       space,
       screen_name,
-      step,
-      schema,
       code,
+      addDataFields,
     ]);
   }
 

web-common/src/metrics/service/ErrorEventFactory.ts

@@ -11,6 +11,7 @@ import type {
   SourceErrorCodes,
   SourceFileType,
 } from "./SourceEventTypes";
+import type { AddDataBehaviourEventFields } from "@rilldata/web-common/metrics/service/BehaviourEventTypes.ts";
 
 export enum ErrorEventAction {
   SourceError = "source-error",
@@ -45,13 +46,13 @@ export interface JavascriptErrorEvent extends MetricsEvent {
   page_url: string;
 }
 
-export interface AddDataErrorEvent extends MetricsEvent {
+export interface AddDataErrorEvent
+  extends MetricsEvent,
+    AddDataBehaviourEventFields {
   action: ErrorEventAction;
   error_code: SourceErrorCodes;
   space: MetricsEventSpace;
   screen_name: MetricsEventScreenName;
-  step: string;
-  schema: string;
 }
 
 export class ErrorEventFactory extends MetricsEventFactory {
@@ -86,9 +87,8 @@ export class ErrorEventFactory extends MetricsEventFactory {
     commonUserFields: CommonUserFields,
     space: MetricsEventSpace,
     screen_name: MetricsEventScreenName,
-    step: string,
-    schema: string,
     error_code: SourceErrorCodes,
+    addDataFields: AddDataBehaviourEventFields,
   ) {
     const event = this.getBaseMetricsEvent(
       "error",
@@ -99,9 +99,12 @@ export class ErrorEventFactory extends MetricsEventFactory {
     event.action = ErrorEventAction.SourceError;
     event.space = space;
     event.screen_name = screen_name;
-    event.step = step;
-    event.schema = schema;
     event.error_code = error_code;
+    if (addDataFields) {
+      for (const key in addDataFields) {
+        event[key] = addDataFields[key];
+      }
+    }
     return event;
   }