fix: Disable session tracking when missing browser API

docs/supportability-metrics.md

@@ -23,8 +23,8 @@ A timeslice metric is harvested to the JSE/XHR consumer. An aggregation service
 * Session/Inactive/Seen
 <!--- Duration of Session at time of ending --->
 * Session/Duration/Ms
-<!--- Capture SMs for Session trace if active (ptid is setwhen returned byReplay ingest). Retain these SMs while we are working through the Session_replay Feature --->
-* PageSession/Feature/SessionTrace/Duration/Ms
+<!--- Capture SM when session tracking (trace, replay, and manager) could not be started due to missing PerformanceNavigationTiming API. --->
+* Session/Disabled/MissingPerformanceNavigationTiming/Seen
 
 ### AJAX
 <!--- Ajax Events were Excluded because they matched the Agent beacon --->

src/features/session_trace/aggregate/index.js

@@ -89,11 +89,7 @@ export class Aggregate extends AggregateBase {
     registerHandler('trace-jserror', (...args) => this.traceStorage.storeErrorAgg(...args), this.featureName, this.ee)
     registerHandler('pvtAdded', (...args) => this.traceStorage.processPVT(...args), this.featureName, this.ee)
 
-    if (typeof PerformanceNavigationTiming !== 'undefined') {
-      this.traceStorage.storeTiming(globalScope.performance?.getEntriesByType?.('navigation')[0])
-    } else {
-      this.traceStorage.storeTiming(globalScope.performance?.timing)
-    }
+    this.traceStorage.storeTiming(globalScope.performance?.getEntriesByType?.('navigation')[0])
 
     /** Only start actually harvesting if running in full mode at init time */
     if (this.mode === MODE.FULL) this.startHarvesting()

src/features/utils/feature-gates.js

@@ -7,5 +7,5 @@ import { isBrowserScope } from '../../common/constants/runtime'
  * @returns {boolean}
  */
 export const canEnableSessionTracking = (agentId) => {
-  return isBrowserScope && getConfigurationValue(agentId, 'privacy.cookies_enabled') === true
+  return isBrowserScope && getConfigurationValue(agentId, 'privacy.cookies_enabled') === true && typeof PerformanceNavigationTiming !== 'undefined'
 }

src/features/utils/instrument-base.js

@@ -14,6 +14,8 @@ import { getConfigurationValue } from '../../common/config/config'
 import { hasReplayPrerequisite } from '../session_replay/shared/utils'
 import { canEnableSessionTracking } from './feature-gates'
 import { single } from '../../common/util/invoke'
+import { handle } from '../../common/event-emitter/handle'
+import { SUPPORTABILITY_METRIC_CHANNEL } from '../metrics/constants'
 
 /**
  * Base class for instrumenting a feature.
@@ -77,12 +79,18 @@ export class InstrumentBase extends FeatureBase {
       loadedSuccessfully = resolve
     })
 
+    const performanceNavigationTimingSupportabilityMetric = single(() => {
+      handle(SUPPORTABILITY_METRIC_CHANNEL, ['Session/Disabled/MissingPerformanceNavigationTiming/Seen'], undefined, FEATURE_NAMES.metrics, this.ee)
+    })
+
     const importLater = async () => {
       let session
       try {
         if (canEnableSessionTracking(this.agentIdentifier)) { // would require some setup before certain features start
           const { setupAgentSession } = await import(/* webpackChunkName: "session-manager" */ './agent-session')
           session = setupAgentSession(this.agentIdentifier)
+        } else if (typeof PerformanceNavigationTiming === 'undefined') {
+          performanceNavigationTimingSupportabilityMetric()
         }
       } catch (e) {
         warn(20, e)

tests/components/session_trace/index.test.js

@@ -31,17 +31,23 @@ jest.mock('../../../src/common/window/load', () => ({
   __esModule: true,
   onWindowLoad: jest.fn(cb => cb())
 }))
+jest.mock('../../../src/features/utils/feature-gates', () => ({
+  __esModule: true,
+  canEnableSessionTracking: jest.fn(() => true)
+}))
 
 const aggregator = new Aggregator({ agentIdentifier: 'abcd', ee })
 
 describe('session trace', () => {
   let traceInstrument, traceAggregate
+
   beforeAll(async () => {
     traceInstrument = new SessionTrace('abcd', aggregator)
     await traceInstrument.onAggregateImported
     traceAggregate = traceInstrument.featAggregate
     traceAggregate.ee.emit('rumresp', [{ st: 1, sts: 1 }])
   })
+
   beforeEach(() => {
     traceAggregate.traceStorage.trace = {}
     traceAggregate.sentTrace = null

tests/unit/features/utils/feature-gates.test.js

@@ -7,15 +7,22 @@ jest.enableAutomock()
 jest.unmock('../../../../src/features/utils/feature-gates')
 
 let agentIdentifier
+let originalPerformanceNavigationTiming
 
 beforeEach(() => {
   agentIdentifier = faker.string.uuid()
+  originalPerformanceNavigationTiming = global.PerformanceNavigationTiming
+})
+
+afterEach(() => {
+  global.PerformanceNavigationTiming = originalPerformanceNavigationTiming
 })
 
 describe('enableSessionTracking', () => {
   test('should return false when not browser scope', async () => {
     jest.replaceProperty(runtimeConstantsModule, 'isBrowserScope', false)
     jest.mocked(configModule.getConfigurationValue).mockReturnValue(true)
+    global.PerformanceNavigationTiming = jest.fn()
 
     expect(canEnableSessionTracking(agentIdentifier)).toEqual(false)
     expect(configModule.getConfigurationValue).not.toHaveBeenCalled()
@@ -24,6 +31,16 @@ describe('enableSessionTracking', () => {
   test('should return false when session tracking disabled', async () => {
     jest.replaceProperty(runtimeConstantsModule, 'isBrowserScope', true)
     jest.mocked(configModule.getConfigurationValue).mockReturnValue(false)
+    global.PerformanceNavigationTiming = jest.fn()
+
+    expect(canEnableSessionTracking(agentIdentifier)).toEqual(false)
+    expect(configModule.getConfigurationValue).toHaveBeenCalledWith(agentIdentifier, 'privacy.cookies_enabled')
+  })
+
+  test('should return false when PerformanceNavigationTiming API is undefined', () => {
+    jest.replaceProperty(runtimeConstantsModule, 'isBrowserScope', true)
+    jest.mocked(configModule.getConfigurationValue).mockReturnValue(true)
+    global.PerformanceNavigationTiming = undefined
 
     expect(canEnableSessionTracking(agentIdentifier)).toEqual(false)
     expect(configModule.getConfigurationValue).toHaveBeenCalledWith(agentIdentifier, 'privacy.cookies_enabled')
@@ -32,6 +49,7 @@ describe('enableSessionTracking', () => {
   test('should return true when stars align', () => {
     jest.replaceProperty(runtimeConstantsModule, 'isBrowserScope', true)
     jest.mocked(configModule.getConfigurationValue).mockReturnValue(true)
+    global.PerformanceNavigationTiming = jest.fn()
 
     expect(canEnableSessionTracking(agentIdentifier)).toEqual(true)
     expect(configModule.getConfigurationValue).toHaveBeenCalledWith(agentIdentifier, 'privacy.cookies_enabled')