♻️ wire configuration and trackViews changes

DataDog · May 27, 2021 · c9aec32 · c9aec32
1 parent cc76616
commit c9aec32
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 9 deletions.
diff --git a/packages/core/src/domain/configuration.ts b/packages/core/src/domain/configuration.ts
@@ -12,6 +12,7 @@ export const DEFAULT_CONFIGURATION = {
   sampleRate: 100,
   silentMultipleInit: false,
   trackInteractions: false,
+  trackViewsManually: false,
 
   /**
    * arbitrary value, byte precision not needed
@@ -50,6 +51,7 @@ export interface UserConfiguration {
   enableExperimentalFeatures?: string[]
   silentMultipleInit?: boolean
   trackInteractions?: boolean
+  trackViewsManually?: boolean
   proxyHost?: string
   beforeSend?: (event: any) => void
 
@@ -131,6 +133,10 @@ export function buildConfiguration(userConfiguration: UserConfiguration, buildEn
     configuration.trackInteractions = !!userConfiguration.trackInteractions
   }
 
+  if ('trackViewsManually' in userConfiguration) {
+    configuration.trackViewsManually = !!userConfiguration.trackViewsManually
+  }
+
   return configuration
 }
 

diff --git a/packages/rum-core/src/boot/rum.spec.ts b/packages/rum-core/src/boot/rum.spec.ts
@@ -35,7 +35,7 @@ function startRum(
       user: {},
     })
   )
-  const { stop: viewCollectionStop } = startViewCollection(lifeCycle, location)
+  const { stop: viewCollectionStop } = startViewCollection(lifeCycle, configuration, location)
   return {
     stop: () => {
       rumEventCollectionStop()

diff --git a/packages/rum-core/src/boot/rum.ts b/packages/rum-core/src/boot/rum.ts
@@ -44,7 +44,7 @@ export function startRum(userConfiguration: RumUserConfiguration, getCommonConte
 
   startLongTaskCollection(lifeCycle)
   startResourceCollection(lifeCycle, session)
-  const { addTiming, startView } = startViewCollection(lifeCycle, location)
+  const { addTiming, startView } = startViewCollection(lifeCycle, configuration, location)
   const { addError } = startErrorCollection(lifeCycle, configuration)
   const { addAction } = startActionCollection(lifeCycle, configuration)
 

diff --git a/packages/rum-core/src/domain/rumEventsCollection/view/trackLocationChanges.spec.ts b/packages/rum-core/src/domain/rumEventsCollection/view/trackLocationChanges.spec.ts
@@ -20,7 +20,7 @@ describe('rum track location change', () => {
           initialViewId = id
           subscription.unsubscribe()
         })
-        return trackViews(location, lifeCycle)
+        return trackViews(location, lifeCycle, true)
       })
     createSpy = jasmine.createSpy('create')
   })

diff --git a/packages/rum-core/src/domain/rumEventsCollection/view/trackViewMetrics.spec.ts b/packages/rum-core/src/domain/rumEventsCollection/view/trackViewMetrics.spec.ts
@@ -67,7 +67,7 @@ describe('rum track view metrics', () => {
       .withFakeLocation('/foo')
       .beforeBuild(({ location, lifeCycle }) => {
         lifeCycle.subscribe(LifeCycleEventType.VIEW_UPDATED, handler)
-        return trackViews(location, lifeCycle)
+        return trackViews(location, lifeCycle, true)
       })
   })
 

diff --git a/packages/rum-core/src/domain/rumEventsCollection/view/viewCollection.spec.ts b/packages/rum-core/src/domain/rumEventsCollection/view/viewCollection.spec.ts
@@ -13,8 +13,8 @@ describe('viewCollection', () => {
       .withConfiguration({
         isEnabled: () => true,
       })
-      .beforeBuild(({ lifeCycle }) => {
-        startViewCollection(lifeCycle, location)
+      .beforeBuild(({ lifeCycle, configuration }) => {
+        startViewCollection(lifeCycle, configuration, location)
       })
   })
 

diff --git a/packages/rum-core/src/domain/rumEventsCollection/view/viewCollection.ts b/packages/rum-core/src/domain/rumEventsCollection/view/viewCollection.ts
@@ -1,14 +1,22 @@
-import { Duration, isEmptyObject, mapValues, ServerDuration, toServerDuration } from '@datadog/browser-core'
+import {
+  Duration,
+  isEmptyObject,
+  mapValues,
+  ServerDuration,
+  toServerDuration,
+  Configuration,
+} from '@datadog/browser-core'
 import { RawRumViewEvent, RumEventType } from '../../../rawRumEvent.types'
 import { LifeCycle, LifeCycleEventType } from '../../lifeCycle'
 import { trackViews, ViewEvent } from './trackViews'
 
-export function startViewCollection(lifeCycle: LifeCycle, location: Location) {
+export function startViewCollection(lifeCycle: LifeCycle, configuration: Configuration, location: Location) {
   lifeCycle.subscribe(LifeCycleEventType.VIEW_UPDATED, (view) =>
     lifeCycle.notify(LifeCycleEventType.RAW_RUM_EVENT_COLLECTED, processViewUpdate(view))
   )
 
-  return trackViews(location, lifeCycle)
+  const shouldTrackViewsAutomatically = !configuration.isEnabled('view-renaming') || !configuration.trackViewsManually
+  return trackViews(location, lifeCycle, shouldTrackViewsAutomatically)
 }
 
 function processViewUpdate(view: ViewEvent) {