fix: Harvest first session trace payload immediately (#1483)

Author: metal-messiah

.github/actions/build-ab/templates/released.js

@@ -15,11 +15,12 @@ window.NREUM={
     harvest: {interval: 5},
     session_replay: {
       enabled: true,
-      autoStart: false,
       fix_stylesheets: false,
       {{#if (isEnvironment args.environment 'dev' 'staging')}}
       mask_all_inputs: false,
       mask_text_selector: null,
+      {{else}}
+      autoStart: false,
       {{/if}}
     },
     session_trace: {

docs/warning-codes.md

@@ -116,4 +116,8 @@
 ### 57
 `Failed to execute measure. Arguments must have valid types.`
 ### 58
-`Failed to execute measure. Resulting duration must be non-negative.`
+`Failed to execute measure. Resulting duration must be non-negative.`
+### 59
+`Session replay harvested before a session trace payload could be sent. This could be problematic for replays that rely on a trace`
+### 60
+`Session trace aborted`

src/common/util/console.js

@@ -3,6 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { dispatchGlobalEvent } from '../dispatch/global-event'
+
 /* eslint no-console: ["error", { allow: ["debug"] }] */
 
 /**
@@ -14,4 +16,15 @@
 export function warn (code, secondary) {
   if (typeof console.debug !== 'function') return
   console.debug(`New Relic Warning: https://github.com/newrelic/newrelic-browser-agent/blob/main/docs/warning-codes.md#${code}`, secondary)
+  dispatchGlobalEvent({
+    agentIdentifier: null,
+    drained: null,
+    type: 'data',
+    name: 'warn',
+    feature: 'warn',
+    data: {
+      code,
+      secondary
+    }
+  })
 }

src/features/session_replay/aggregate/index.js

@@ -262,6 +262,10 @@ export class Aggregate extends AggregateBase {
     if (recorderEvents.type === 'preloaded') this.agentRef.runtime.harvester.triggerHarvestFor(this)
     payloadOutput.payload = payload
 
+    if (!this.agentRef.runtime.session.state.traceHarvestStarted) {
+      warn(59, JSON.stringify(this.agentRef.runtime.session.state))
+    }
+
     return [payloadOutput]
   }
 

src/features/session_trace/aggregate/index.js

@@ -11,6 +11,7 @@ import { globalScope } from '../../../common/constants/runtime'
 import { MODE, SESSION_EVENTS } from '../../../common/session/constants'
 import { applyFnToProps } from '../../../common/util/traverse'
 import { cleanURL } from '../../../common/url/clean-url'
+import { warn } from '../../../common/util/console'
 
 const ERROR_MODE_SECONDS_WINDOW = 30 * 1000 // sliding window of nodes to track when simply monitoring (but not harvesting) in error mode
 /** Reserved room for query param attrs */
@@ -97,6 +98,8 @@ export class Aggregate extends AggregateBase {
     }
     this.agentRef.runtime.session.write({ sessionTraceMode: this.mode })
     this.drain()
+    /** try to harvest immediately. This will not send if the trace is not running in FULL mode due to the pre-harvest checks. */
+    this.agentRef.runtime.harvester.triggerHarvestFor(this)
   }
 
   preHarvestChecks () {
@@ -178,7 +181,8 @@ export class Aggregate extends AggregateBase {
   }
 
   /** Stop running for the remainder of the page lifecycle */
-  abort () {
+  abort (code) {
+    warn(60, code)
     this.blocked = true
     this.mode = MODE.OFF
     this.agentRef.runtime.session.write({ sessionTraceMode: this.mode })