✅ prepare tests for delayed View first update

Author: BenoitZugmeyer

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

@@ -108,11 +108,13 @@ function startRumStub(
 
 describe('rum session', () => {
   let serverRumEvents: RumEvent[]
+  let clock: Clock
   let lifeCycle: LifeCycle
   let sessionManager: RumSessionManagerMock
 
   beforeEach(() => {
     lifeCycle = new LifeCycle()
+    clock = mockClock()
     sessionManager = createRumSessionManagerMock().setId('42')
     const domMutationObservable = new Observable<RumMutationRecord[]>()
     const windowOpenObservable = new Observable<void>()
@@ -135,6 +137,7 @@ describe('rum session', () => {
   })
 
   it('when the session is renewed, a new view event should be sent', () => {
+    clock.tick(0)
     expect(serverRumEvents.length).toEqual(1)
     expect(serverRumEvents[0].type).toEqual('view')
     expect(serverRumEvents[0].session.id).toEqual('42')
@@ -144,6 +147,7 @@ describe('rum session', () => {
 
     sessionManager.setId('43')
     lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)
+    clock.tick(0)
 
     expect(serverRumEvents.length).toEqual(3)
 
@@ -223,7 +227,6 @@ describe('rum events url', () => {
 
   let changeLocation: (to: string) => void
   let lifeCycle: LifeCycle
-  let clock: Clock
   let serverRumEvents: RumEvent[]
   let stop: () => void
 
@@ -259,18 +262,20 @@ describe('rum events url', () => {
   })
 
   it('should keep the same URL when updating a view ended by a URL change', () => {
+    const clock = mockClock()
     setupViewUrlTest()
     serverRumEvents.length = 0
 
     changeLocation('/bar')
+    clock.tick(0)
 
     expect(serverRumEvents.length).toEqual(2)
     expect(serverRumEvents[0].view.url).toEqual('http://foo.com/')
     expect(serverRumEvents[1].view.url).toEqual('http://foo.com/bar')
   })
 
   it('should attach the url corresponding to the start of the event', () => {
-    clock = mockClock()
+    const clock = mockClock()
     const { notifyPerformanceEntries } = mockPerformanceObserver()
 
     setupViewUrlTest()
@@ -297,13 +302,14 @@ describe('rum events url', () => {
   })
 
   it('should keep the same URL when updating an ended view', () => {
-    clock = mockClock()
+    const clock = mockClock()
     const { triggerOnLoad } = mockDocumentReadyState()
     setupViewUrlTest()
 
     clock.tick(VIEW_DURATION)
 
     changeLocation('/bar')
+    clock.tick(0)
 
     serverRumEvents.length = 0
 

packages/rum-core/src/domain/view/trackViews.spec.ts

@@ -121,6 +121,8 @@ describe('view lifecycle', () => {
     it('should send a final view update', () => {
       const { lifeCycle, getViewUpdateCount, getViewUpdate } = viewTest
 
+      clock.tick(0) // wait for the first view update to be sent
+
       expect(getViewUpdateCount()).toBe(1)
 
       lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
@@ -148,12 +150,12 @@ describe('view lifecycle', () => {
       lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
 
       expect(getViewEndCount()).toBe(1)
-      expect(getViewUpdateCount()).toBe(2)
+      expect(getViewUpdateCount()).toBe(1)
 
       lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
 
       expect(getViewEndCount()).toBe(1)
-      expect(getViewUpdateCount()).toBe(2)
+      expect(getViewUpdateCount()).toBe(1)
     })
   })
 
@@ -291,11 +293,11 @@ describe('view lifecycle', () => {
     it('should trigger a view update on unloading', () => {
       const { lifeCycle, getViewUpdateCount } = viewTest
 
-      expect(getViewUpdateCount()).toEqual(1)
+      expect(getViewUpdateCount()).toEqual(0)
 
       lifeCycle.notify(LifeCycleEventType.PAGE_MAY_EXIT, { reason: PageExitReason.UNLOADING })
 
-      expect(getViewUpdateCount()).toEqual(2)
+      expect(getViewUpdateCount()).toEqual(1)
     })
 
     it('should not create a new view when ending the view on unloading', () => {
@@ -340,18 +342,22 @@ describe('view lifecycle', () => {
 
 describe('view loading type', () => {
   it('should collect initial view type as "initial_load"', () => {
+    const clock = mockClock()
     const { getViewUpdate } = setupViewTest()
+    clock.tick(0)
 
     expect(getViewUpdate(0).loadingType).toEqual(ViewLoadingType.INITIAL_LOAD)
   })
 
   it('should collect view type as "route_change" after a view change', () => {
+    const clock = mockClock()
     const { getViewUpdate, startView } = setupViewTest()
 
     startView()
+    clock.tick(0)
 
-    expect(getViewUpdate(1).loadingType).toEqual(ViewLoadingType.INITIAL_LOAD)
-    expect(getViewUpdate(2).loadingType).toEqual(ViewLoadingType.ROUTE_CHANGE)
+    expect(getViewUpdate(0).loadingType).toEqual(ViewLoadingType.INITIAL_LOAD)
+    expect(getViewUpdate(1).loadingType).toEqual(ViewLoadingType.ROUTE_CHANGE)
   })
 })
 
@@ -370,6 +376,7 @@ describe('view metrics', () => {
         pending('CLS web vital not supported')
       }
       const { getViewUpdateCount, getViewUpdate } = setupViewTest()
+      clock.tick(0)
 
       expect(getViewUpdateCount()).toEqual(1)
       expect(getViewUpdate(0).initialViewMetrics).toEqual({})
@@ -413,8 +420,7 @@ describe('view metrics', () => {
   describe('initial view metrics', () => {
     it('updates should be throttled', () => {
       const { getViewUpdateCount, getViewUpdate } = setupViewTest()
-      expect(getViewUpdateCount()).toEqual(1)
-      expect(getViewUpdate(0).initialViewMetrics).toEqual({})
+      expect(getViewUpdateCount()).toEqual(0)
 
       clock.tick(THROTTLE_VIEW_UPDATE_PERIOD - 1)
 
@@ -471,6 +477,7 @@ describe('view metrics', () => {
 
       beforeEach(() => {
         const { getViewUpdateCount, getViewUpdate, startView } = setupViewTest()
+        clock.tick(0)
 
         expect(getViewUpdateCount()).toEqual(1)
 
@@ -481,6 +488,7 @@ describe('view metrics', () => {
         viewDuration = relativeNow()
 
         startView()
+        clock.tick(0)
 
         expect(getViewUpdateCount()).toEqual(3)
 
@@ -533,18 +541,22 @@ describe('view metrics', () => {
 
 describe('view is active', () => {
   it('should set initial view as active', () => {
+    const clock = mockClock()
     const { getViewUpdate } = setupViewTest()
+    clock.tick(0)
 
     expect(getViewUpdate(0).isActive).toBe(true)
   })
 
   it('should set old view as inactive and new one as active after a route change', () => {
+    const clock = mockClock()
     const { getViewUpdate, startView } = setupViewTest()
 
     startView()
+    clock.tick(0)
 
-    expect(getViewUpdate(1).isActive).toBe(false)
-    expect(getViewUpdate(2).isActive).toBe(true)
+    expect(getViewUpdate(0).isActive).toBe(false)
+    expect(getViewUpdate(1).isActive).toBe(true)
   })
 })
 
@@ -562,6 +574,7 @@ describe('view custom timings', () => {
     const { getViewUpdate, startView, addTiming } = viewTest
 
     startView()
+    clock.tick(0) // wait for the first view update to be sent
 
     const currentViewId = getViewUpdate(2).id
     clock.tick(20)
@@ -688,12 +701,14 @@ describe('start view', () => {
 
   it('should start a new view', () => {
     const { getViewUpdateCount, getViewUpdate, startView } = setupViewTest()
+    clock.tick(0)
 
     expect(getViewUpdateCount()).toBe(1)
     const initialViewId = getViewUpdate(0).id
 
     clock.tick(10)
     startView()
+    clock.tick(0)
 
     expect(getViewUpdateCount()).toBe(3)
 
@@ -713,10 +728,11 @@ describe('start view', () => {
     startView()
     startView({ name: 'foo' })
     startView({ name: 'bar' })
+    clock.tick(0)
 
-    expect(getViewUpdate(2).name).toBeUndefined()
-    expect(getViewUpdate(4).name).toBe('foo')
-    expect(getViewUpdate(6).name).toBe('bar')
+    expect(getViewUpdate(1).name).toBeUndefined()
+    expect(getViewUpdate(2).name).toBe('foo')
+    expect(getViewUpdate(3).name).toBe('bar')
   })
 
   it('should have service and version', () => {
@@ -725,20 +741,21 @@ describe('start view', () => {
     startView()
     startView({ service: 'service 1', version: 'version 1' })
     startView({ service: 'service 2', version: 'version 2' })
+    clock.tick(0)
 
-    expect(getViewUpdate(2)).toEqual(
+    expect(getViewUpdate(1)).toEqual(
       jasmine.objectContaining({
         service: undefined,
         version: undefined,
       })
     )
-    expect(getViewUpdate(4)).toEqual(
+    expect(getViewUpdate(2)).toEqual(
       jasmine.objectContaining({
         service: 'service 1',
         version: 'version 1',
       })
     )
-    expect(getViewUpdate(6)).toEqual(
+    expect(getViewUpdate(3)).toEqual(
       jasmine.objectContaining({
         service: 'service 2',
         version: 'version 2',
@@ -750,7 +767,9 @@ describe('start view', () => {
     const { getViewUpdate, startView } = setupViewTest()
 
     startView({ service: null, version: null })
-    expect(getViewUpdate(2)).toEqual(
+    clock.tick(0)
+
+    expect(getViewUpdate(1)).toEqual(
       jasmine.objectContaining({
         service: undefined,
         version: undefined,
@@ -763,6 +782,7 @@ describe('start view', () => {
 
     clock.tick(100)
     startView({ name: 'foo' }, relativeToClocks(50 as RelativeTime))
+    clock.tick(0)
 
     expect(getViewUpdate(1).duration).toBe(50 as Duration)
     expect(getViewUpdate(2).startClocks.relative).toBe(50 as RelativeTime)
@@ -797,7 +817,7 @@ describe('view event count', () => {
 
     changeLocation('/bar')
 
-    expect(getViewUpdate(getViewUpdateCount() - 2).eventCounts.actionCount).toBe(1)
+    expect(getViewUpdate(getViewUpdateCount() - 1).eventCounts.actionCount).toBe(1)
   })
 
   it('should be updated for 5 min after view end', () => {
@@ -852,17 +872,20 @@ describe('view event count', () => {
       const { getViewUpdate, startView } = setupViewTest()
 
       startView({ context: { foo: 'bar' } })
-      expect(getViewUpdate(2).context).toEqual({ foo: 'bar' })
+      clock.tick(0)
+      expect(getViewUpdate(1).context).toEqual({ foo: 'bar' })
     })
 
     it('should replace current context set on view event', () => {
       const { getViewUpdate, startView } = setupViewTest()
 
       startView({ context: { foo: 'bar' } })
-      expect(getViewUpdate(2).context).toEqual({ foo: 'bar' })
+      clock.tick(0)
+      expect(getViewUpdate(1).context).toEqual({ foo: 'bar' })
 
       startView({ context: { bar: 'baz' } })
-      expect(getViewUpdate(4).context).toEqual({ bar: 'baz' })
+      clock.tick(0)
+      expect(getViewUpdate(3).context).toEqual({ bar: 'baz' })
     })
 
     it('should set view context with setViewContext', () => {
@@ -897,35 +920,43 @@ describe('view event count', () => {
 
       startView()
       setViewName('foo')
-      expect(getViewUpdate(3).name).toEqual('foo')
+      clock.tick(0)
+
+      expect(getViewUpdate(1).name).toEqual('foo')
     })
 
     it('should set a defined view name', () => {
       const { getViewUpdate, startView, setViewName } = setupViewTest()
 
       startView({ name: 'initial view name' })
       setViewName('foo')
-      expect(getViewUpdate(3).name).toEqual('foo')
+      clock.tick(0)
+
+      expect(getViewUpdate(1).name).toEqual('foo')
     })
   })
 })
 
 describe('service and version', () => {
   it('should come from the init configuration by default', () => {
+    const clock = mockClock()
     const { getViewUpdate } = setupViewTest({ partialConfig: { service: 'service', version: 'version' } })
+    clock.tick(0)
 
     expect(getViewUpdate(0).service).toEqual('service')
     expect(getViewUpdate(0).version).toEqual('version')
   })
 
   it('should come from the view option if defined', () => {
+    const clock = mockClock()
     const { getViewUpdate } = setupViewTest({
       partialConfig: { service: 'service', version: 'version' },
       initialViewOptions: {
         service: 'view service',
         version: 'view version',
       },
     })
+    clock.tick(0)
 
     expect(getViewUpdate(0).service).toEqual('view service')
     expect(getViewUpdate(0).version).toEqual('view version')
@@ -934,6 +965,7 @@ describe('service and version', () => {
 
 describe('BFCache views', () => {
   it('should create a new "bf_cache" view when restoring from the BFCache', () => {
+    const clock = mockClock()
     const { getViewCreateCount, getViewEndCount, getViewUpdate, getViewUpdateCount } = setupViewTest({
       partialConfig: { trackBfcacheViews: true },
     })
@@ -944,6 +976,7 @@ describe('BFCache views', () => {
     const event = createNewEvent('pageshow', { persisted: true })
 
     window.dispatchEvent(event)
+    clock.tick(0)
 
     expect(getViewEndCount()).toBe(1)
     expect(getViewCreateCount()).toBe(2)