Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RUMF-636] initial document trace id #492

Merged
merged 10 commits into from
Aug 24, 2020
Merged
17 changes: 7 additions & 10 deletions packages/rum/src/performanceCollection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import { DOM_EVENT, getRelativeTime, isNumber, monitor } from '@datadog/browser-

import { LifeCycle, LifeCycleEventType } from './lifeCycle'
import { FAKE_INITIAL_DOCUMENT } from './resourceUtils'
import { RumSession } from './rumSession'

interface BrowserWindow extends Window {
PerformanceObserver?: PerformanceObserver
Expand All @@ -20,16 +19,16 @@ function supportPerformanceNavigationTimingEvent() {
)
}

export function startPerformanceCollection(lifeCycle: LifeCycle, session: RumSession) {
export function startPerformanceCollection(lifeCycle: LifeCycle) {
retrieveInitialDocumentResourceTiming((timing) => {
handlePerformanceEntries(session, lifeCycle, [timing])
handlePerformanceEntries(lifeCycle, [timing])
})
if (supportPerformanceObject()) {
handlePerformanceEntries(session, lifeCycle, performance.getEntries())
handlePerformanceEntries(lifeCycle, performance.getEntries())
}
if ((window as BrowserWindow).PerformanceObserver) {
const observer = new PerformanceObserver(
monitor((entries) => handlePerformanceEntries(session, lifeCycle, entries.getEntries()))
monitor((entries) => handlePerformanceEntries(lifeCycle, entries.getEntries()))
)
const entryTypes = ['resource', 'navigation', 'longtask']

Expand All @@ -48,7 +47,7 @@ export function startPerformanceCollection(lifeCycle: LifeCycle, session: RumSes
}
if (!supportPerformanceNavigationTimingEvent()) {
retrieveNavigationTimingWhenLoaded((timing) => {
handlePerformanceEntries(session, lifeCycle, [timing])
handlePerformanceEntries(lifeCycle, [timing])
})
}
}
Expand Down Expand Up @@ -130,14 +129,12 @@ function computeRelativePerformanceTiming() {
return result as PerformanceTiming
}

function handlePerformanceEntries(session: RumSession, lifeCycle: LifeCycle, entries: PerformanceEntry[]) {
function handlePerformanceEntries(lifeCycle: LifeCycle, entries: PerformanceEntry[]) {
function notify(entry: PerformanceEntry) {
lifeCycle.notify(LifeCycleEventType.PERFORMANCE_ENTRY_COLLECTED, entry)
}

if (session.isTrackedWithResource()) {
entries.filter((entry) => entry.entryType === 'resource').forEach(notify)
}
entries.filter((entry) => entry.entryType === 'resource').forEach(notify)

entries
.filter((entry) => entry.entryType === 'navigation')
Expand Down
2 changes: 1 addition & 1 deletion packages/rum/src/rum.entry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ export function makeRumGlobal(stub: RumGlobal) {

const [requestStartObservable, requestCompleteObservable] = startRequestCollection(configuration)
startTraceCollection(configuration, requestCompleteObservable, globalApi.getInternalContext)
startPerformanceCollection(lifeCycle, session)
startPerformanceCollection(lifeCycle)
startDOMMutationCollection(lifeCycle)
if (configuration.trackInteractions) {
startUserActionCollection(lifeCycle)
Expand Down
19 changes: 12 additions & 7 deletions packages/rum/src/rum.ts
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ function trackRumEvents(
)
trackErrors(lifeCycle, handler(assembleWithAction, batch.add))
trackRequests(configuration, lifeCycle, session, handler(assembleWithAction, batch.add))
trackPerformanceTiming(configuration, lifeCycle, handler(assembleWithAction, batch.add))
trackPerformanceTiming(configuration, lifeCycle, session, handler(assembleWithAction, batch.add))
trackCustomUserAction(lifeCycle, handler(assembleWithoutAction, batch.add))
trackAutoUserAction(lifeCycle, handler(assembleWithoutAction, batch.add))
}
Expand Down Expand Up @@ -485,15 +485,16 @@ function trackRequests(
function trackPerformanceTiming(
configuration: Configuration,
lifeCycle: LifeCycle,
session: RumSession,
handler: (startTime: number, event: RumResourceEvent | RumLongTaskEvent) => void
) {
lifeCycle.subscribe(LifeCycleEventType.PERFORMANCE_ENTRY_COLLECTED, (entry) => {
switch (entry.entryType) {
case 'resource':
handleResourceEntry(configuration, entry as PerformanceResourceTiming, handler, lifeCycle)
handleResourceEntry(configuration, lifeCycle, session, handler, entry as PerformanceResourceTiming)
break
case 'longtask':
handleLongTaskEntry(entry as PerformanceLongTaskTiming, handler)
handleLongTaskEntry(handler, entry as PerformanceLongTaskTiming)
break
default:
break
Expand All @@ -503,10 +504,14 @@ function trackPerformanceTiming(

export function handleResourceEntry(
configuration: Configuration,
entry: PerformanceResourceTiming,
lifeCycle: LifeCycle,
session: RumSession,
handler: (startTime: number, event: RumResourceEvent) => void,
lifeCycle: LifeCycle
entry: PerformanceResourceTiming
) {
if (!session.isTrackedWithResource()) {
return
}
if (!isValidResource(entry.name, configuration)) {
return
}
BenoitZugmeyer marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -535,8 +540,8 @@ export function handleResourceEntry(
}

function handleLongTaskEntry(
entry: PerformanceLongTaskTiming,
handler: (startTime: number, event: RumLongTaskEvent) => void
handler: (startTime: number, event: RumLongTaskEvent) => void,
entry: PerformanceLongTaskTiming
) {
handler(entry.startTime, {
date: getTimestamp(entry.startTime),
Expand Down
42 changes: 35 additions & 7 deletions packages/rum/test/rum.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import sinon from 'sinon'
import { LifeCycle, LifeCycleEventType } from '../src/lifeCycle'
import { RequestCompleteEvent } from '../src/requestCollection'
import { handleResourceEntry, RawRumEvent, RumEvent, RumResourceEvent, RumViewEvent, trackView } from '../src/rum'
import { RumSession } from '../src/rumSession'
import { AutoUserAction, CustomUserAction, UserActionType } from '../src/userActionCollection'
import { SESSION_KEEP_ALIVE_INTERVAL, THROTTLE_VIEW_UPDATE_PERIOD, View } from '../src/viewCollection'
import { setup, TestSetupBuilder } from './specHelper'
Expand All @@ -26,6 +27,13 @@ function getRumMessage(server: sinon.SinonFakeServer, index: number) {
return JSON.parse(server.requests[index].requestBody) as RumEvent
}

function createMockSession(): RumSession {
return {
getId: () => 'foo',
isTracked: () => true,
isTrackedWithResource: () => true,
}
}
interface ExpectedRequestBody {
application_id: string
date: number
Expand Down Expand Up @@ -87,9 +95,10 @@ describe('rum handle performance entry', () => {
it(description, () => {
handleResourceEntry(
configuration as Configuration,
entry as PerformanceResourceTiming,
new LifeCycle(),
createMockSession(),
handler,
new LifeCycle()
entry as PerformanceResourceTiming
)
const entryAdded = (handler as jasmine.Spy).calls.all().length !== 0
expect(entryAdded).toEqual(expectEntryToBeAdded)
Expand Down Expand Up @@ -135,9 +144,10 @@ describe('rum handle performance entry', () => {

handleResourceEntry(
configuration as Configuration,
entry as PerformanceResourceTiming,
new LifeCycle(),
createMockSession(),
handler,
new LifeCycle()
entry as PerformanceResourceTiming
)
const resourceEvent = getEntry(handler, 0) as RumResourceEvent
expect(resourceEvent.resource.kind).toEqual(expected)
Expand All @@ -161,7 +171,13 @@ describe('rum handle performance entry', () => {
secureConnectionStart: 0,
}

handleResourceEntry(configuration as Configuration, entry as PerformanceResourceTiming, handler, new LifeCycle())
handleResourceEntry(
configuration as Configuration,
new LifeCycle(),
createMockSession(),
handler,
entry as PerformanceResourceTiming
)
const resourceEvent = getEntry(handler, 0) as RumResourceEvent
expect(resourceEvent.http.performance!.connect!.duration).toEqual(7 * 1e6)
expect(resourceEvent.http.performance!.download!.duration).toEqual(75 * 1e6)
Expand All @@ -185,7 +201,13 @@ describe('rum handle performance entry', () => {
secureConnectionStart: 0,
}

handleResourceEntry(configuration as Configuration, entry as PerformanceResourceTiming, handler, new LifeCycle())
handleResourceEntry(
configuration as Configuration,
new LifeCycle(),
createMockSession(),
handler,
entry as PerformanceResourceTiming
)
const resourceEvent = getEntry(handler, 0) as RumResourceEvent
expect(resourceEvent.http.performance).toBe(undefined)
})
Expand All @@ -198,7 +220,13 @@ describe('rum handle performance entry', () => {
responseStart: 100,
}

handleResourceEntry(configuration as Configuration, entry as PerformanceResourceTiming, handler, new LifeCycle())
handleResourceEntry(
configuration as Configuration,
new LifeCycle(),
createMockSession(),
handler,
entry as PerformanceResourceTiming
)
const resourceEvent = getEntry(handler, 0) as RumResourceEvent
expect(resourceEvent.http.performance).toBe(undefined)
})
Expand Down
2 changes: 1 addition & 1 deletion packages/rum/test/specHelper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ export function setup(): TestSetupBuilder {
return setupBuilder
},
withPerformanceCollection() {
buildTasks.push(() => startPerformanceCollection(lifeCycle, session))
buildTasks.push(() => startPerformanceCollection(lifeCycle))
return setupBuilder
},
withTraceCollection(requestCompleteObservable: Observable<RequestCompleteEvent>) {
Expand Down