Make failureReason required

Author: cy-moi

packages/rum-core/src/boot/preStartRum.ts

@@ -26,7 +26,12 @@ import {
   serializeRumConfiguration,
 } from '../domain/configuration'
 import type { ViewOptions } from '../domain/view/trackViews'
-import type { DurationVital, CustomVitalsState, FullFeatureOperationOptions } from '../domain/vital/vitalCollection'
+import type {
+  DurationVital,
+  CustomVitalsState,
+  FailFeatureOperationOptions,
+  FeatureOperationOptions,
+} from '../domain/vital/vitalCollection'
 import { startDurationVital, stopDurationVital } from '../domain/vital/vitalCollection'
 import { callPluginsMethod } from '../domain/plugins'
 import type { StartRumResult } from './startRum'
@@ -152,10 +157,14 @@ export function createPreStartStrategy(
   const addOperationStepVital = (
     name: string,
     stepType: 'start' | 'end',
-    options?: Partial<FullFeatureOperationOptions>
+    options?: FeatureOperationOptions | FailFeatureOperationOptions
   ) => {
     bufferApiCalls.add((startRumResult) =>
-      startRumResult.addOperationStepVital(name, stepType, sanitize(options) as FullFeatureOperationOptions)
+      startRumResult.addOperationStepVital(
+        name,
+        stepType,
+        sanitize(options) as FeatureOperationOptions | FailFeatureOperationOptions
+      )
     )
   }
 

packages/rum-core/src/boot/rumPublicApi.spec.ts

@@ -826,7 +826,7 @@ describe('rum public api', () => {
         noopProfilerApi
       )
       rumPublicApi.init(DEFAULT_INIT_CONFIGURATION)
-      rumPublicApi.failFeatureOperation('foo', { failureReason: 'page not found' })
+      rumPublicApi.failFeatureOperation('foo', 'page not found')
       expect(addOperationStepVitalSpy).toHaveBeenCalledWith('foo', 'end', { failureReason: 'page not found' })
     })
   })

packages/rum-core/src/boot/rumPublicApi.ts

@@ -45,7 +45,7 @@ import type {
   DurationVitalReference,
   DurationVitalOptions,
   FeatureOperationOptions,
-  FullFeatureOperationOptions,
+  FailFeatureOperationOptions,
 } from '../domain/vital/vitalCollection'
 import { createCustomVitalsState } from '../domain/vital/vitalCollection'
 import { callPluginsMethod } from '../domain/plugins'
@@ -455,7 +455,7 @@ export interface RumPublicApi extends PublicApi {
    * @param name - Name of the operation step
    * @param options - Options for the operation step (operationKey, failureReason, context, description)
    */
-  failFeatureOperation: (name: string, options?: FullFeatureOperationOptions) => void
+  failFeatureOperation: (name: string, failureReaon: string, options?: FailFeatureOperationOptions) => void
 }
 
 export interface RecorderApi {
@@ -812,9 +812,9 @@ export function makeRumPublicApi(
       strategy.addOperationStepVital(name, 'end', options)
     }),
 
-    failFeatureOperation: monitor((name, options) => {
+    failFeatureOperation: monitor((name, failureReason, options) => {
       addTelemetryUsage({ feature: 'add-operation-step-vital', action_type: 'fail' })
-      strategy.addOperationStepVital(name, 'end', options)
+      strategy.addOperationStepVital(name, 'end', { ...options, failureReason })
     }),
   })
 

packages/rum-core/src/domain/vital/vitalCollection.ts

@@ -24,8 +24,8 @@ export type DurationVitalOptions = VitalOptions
 export interface FeatureOperationOptions extends VitalOptions {
   operationKey?: string
 }
-export interface FullFeatureOperationOptions extends FeatureOperationOptions {
-  failureReason?: string
+export interface FailFeatureOperationOptions extends FeatureOperationOptions {
+  failureReason: string
 }
 export interface AddDurationVitalOptions extends DurationVitalOptions {
   startTime: number
@@ -86,19 +86,19 @@ export function startVitalCollection(
   function addOperationStepVital(
     name: string,
     stepType: 'start' | 'end',
-    options?: Partial<FullFeatureOperationOptions>
+    options?: FeatureOperationOptions | FailFeatureOperationOptions
   ) {
     if (!isExperimentalFeatureEnabled(ExperimentalFeature.FEATURE_OPERATION_VITAL)) {
       return
     }
 
-    const { operationKey, failureReason, context, description } = options || {}
+    const { operationKey, context, description } = options || {}
 
     const vital: OperationStepVital = {
       name: sanitize(name)!,
       type: VitalType.OPERATION_STEP,
       operationKey,
-      failureReason,
+      failureReason: (options as FailFeatureOperationOptions)?.failureReason,
       stepType,
       startClocks: clocksNow(),
       context: sanitize(context),