feat: Migrate RUM network call from GET to POST

src/common/harvest/harvest.js

@@ -98,7 +98,7 @@ export class Harvest extends SharedContext {
 
     var agentRuntime = getRuntime(this.sharedContext.agentIdentifier)
 
-    if (!payload.body) { // no payload body? nothing to send, just run onfinish stuff and return
+    if (!payload.body && !opts?.sendEmptyBody) { // no payload body? nothing to send, just run onfinish stuff and return
       if (cbFinished) {
         cbFinished({ sent: false })
       }
@@ -108,7 +108,7 @@ export class Harvest extends SharedContext {
     let url = ''
     if (customUrl) url = customUrl
     else if (raw) url = `${this.getScheme()}://${info.errorBeacon}/${endpoint}`
-    else url = `${this.getScheme()}://${info.errorBeacon}/${endpoint}/1/${info.licenseKey}`
+    else url = `${this.getScheme()}://${info.errorBeacon}${endpoint !== 'rum' ? `/${endpoint}` : ''}/1/${info.licenseKey}`
 
     var baseParams = !raw && includeBaseParams ? this.baseQueryString() : ''
     var payloadParams = payload.qs ? encodeObj(payload.qs, agentRuntime.maxBytes) : ''
@@ -208,6 +208,7 @@ export class Harvest extends SharedContext {
       if (singlePayload.body) mapOwn(singlePayload.body, makeBody)
       if (singlePayload.qs) mapOwn(singlePayload.qs, makeQueryString)
     }
+
     return { body: makeBody(), qs: makeQueryString() }
   }
 
@@ -223,17 +224,12 @@ export class Harvest extends SharedContext {
   }
 }
 
-function or (a, b) { return a || b }
-
 export function getSubmitMethod (endpoint, opts) {
   opts = opts || {}
   var method
   var useBody
 
-  if (opts.needResponse) { // currently: only STN needs a response
-    useBody = true
-    method = submitData.xhr
-  } else if (opts.unload && isBrowserScope) { // all the features' final harvest; neither methods work outside window context
+  if (opts.unload && isBrowserScope) { // all the features' final harvest; neither methods work outside window context
     useBody = haveSendBeacon
     method = haveSendBeacon ? submitData.beacon : submitData.img // really only IE doesn't have Beacon API for web browsers
   } else {
@@ -263,7 +259,7 @@ function createAccumulator () {
   var accumulator = {}
   var hasData = false
   return function (key, val) {
-    if (val !== null && val !== undefined && val.length) {
+    if (val !== null && val !== undefined && val.toString()?.length) {
       accumulator[key] = val
       hasData = true
     }

src/common/harvest/harvest.test.js

@@ -0,0 +1,169 @@
+import { submitData } from '../util/submit-data'
+import { Harvest } from './harvest'
+
+jest.mock('../context/shared-context', () => ({
+  __esModule: true,
+  SharedContext: function () {
+    this.sharedContext = {
+      agentIdentifier: 'abcd'
+    }
+  }
+}))
+jest.mock('../config/config', () => ({
+  __esModule: true,
+  getConfigurationValue: jest.fn(),
+  getInfo: jest.fn().mockReturnValue({
+    errorBeacon: 'example.com',
+    licenseKey: 'abcd'
+  }),
+  getRuntime: jest.fn().mockReturnValue({
+    bytesSent: {},
+    queryBytesSent: {}
+  })
+}))
+jest.mock('../util/submit-data', () => ({
+  __esModule: true,
+  submitData: {
+    xhr: jest.fn(() => ({
+      addEventListener: jest.fn()
+    })),
+    beacon: jest.fn(),
+    img: jest.fn()
+  }
+}))
+
+describe('sendX', () => {
+  test.each([null, undefined, false])('should not send request when body is empty and sendEmptyBody is %s', (sendEmptyBody) => {
+    const sendCallback = jest.fn()
+    const harvester = new Harvest()
+    harvester.on('jserrors', () => ({
+      body: {},
+      qs: {}
+    }))
+
+    harvester.sendX({ endpoint: 'jserrors', cbFinished: sendCallback })
+
+    expect(sendCallback).toHaveBeenCalledWith({ sent: false })
+    expect(submitData.xhr).not.toHaveBeenCalled()
+    expect(submitData.img).not.toHaveBeenCalled()
+    expect(submitData.beacon).not.toHaveBeenCalled()
+  })
+
+  test('should send request when body is empty and sendEmptyBody is true', () => {
+    const harvester = new Harvest()
+    harvester.on('jserrors', () => ({
+      body: {},
+      qs: {}
+    }))
+
+    harvester.sendX({ endpoint: 'jserrors', opts: { sendEmptyBody: true }, cbFinished: jest.fn() })
+
+    expect(submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.stringContaining('https://example.com/jserrors/1/abcd?'),
+      body: undefined
+    }))
+    expect(submitData.img).not.toHaveBeenCalled()
+    expect(submitData.beacon).not.toHaveBeenCalled()
+  })
+
+  test.each([null, undefined, []])('should remove %s values from the body and query string when sending', (emptyValue) => {
+    const harvester = new Harvest()
+    harvester.on('jserrors', () => ({
+      body: { bar: 'foo', empty: emptyValue },
+      qs: { foo: 'bar', empty: emptyValue }
+    }))
+
+    harvester.sendX({ endpoint: 'jserrors', cbFinished: jest.fn() })
+
+    expect(submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.stringContaining('&foo=bar'),
+      body: JSON.stringify({ bar: 'foo' })
+    }))
+    expect(submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.not.stringContaining('&empty'),
+      body: expect.not.stringContaining('empty')
+    }))
+    expect(submitData.img).not.toHaveBeenCalled()
+    expect(submitData.beacon).not.toHaveBeenCalled()
+  })
+
+  test.each([1, false, true])('should not remove value %s (when it doesn\'t have a length) from the body and query string when sending', (nonStringValue) => {
+    const harvester = new Harvest()
+    harvester.on('jserrors', () => ({
+      body: { bar: 'foo', nonString: nonStringValue },
+      qs: { foo: 'bar', nonString: nonStringValue }
+    }))
+
+    harvester.sendX({ endpoint: 'jserrors', cbFinished: jest.fn() })
+
+    expect(submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.stringContaining(`&nonString=${nonStringValue}`),
+      body: JSON.stringify({ bar: 'foo', nonString: nonStringValue })
+    }))
+    expect(submitData.img).not.toHaveBeenCalled()
+    expect(submitData.beacon).not.toHaveBeenCalled()
+  })
+})
+
+describe('send', () => {
+  test.each([null, undefined, false])('should not send request when body is empty and sendEmptyBody is %s', (sendEmptyBody) => {
+    const sendCallback = jest.fn()
+    const harvester = new Harvest()
+
+    harvester.send({ endpoint: 'rum', payload: { qs: {}, body: {} }, opts: { sendEmptyBody }, cbFinished: sendCallback })
+
+    expect(sendCallback).toHaveBeenCalledWith({ sent: false })
+    expect(submitData.xhr).not.toHaveBeenCalled()
+    expect(submitData.img).not.toHaveBeenCalled()
+    expect(submitData.beacon).not.toHaveBeenCalled()
+  })
+
+  test('should send request when body is empty and sendEmptyBody is true', () => {
+    const harvester = new Harvest()
+
+    harvester.send({ endpoint: 'rum', payload: { qs: {}, body: {} }, opts: { sendEmptyBody: true } })
+
+    expect(submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.stringContaining('https://example.com/1/abcd?'),
+      body: undefined
+    }))
+    expect(submitData.img).not.toHaveBeenCalled()
+    expect(submitData.beacon).not.toHaveBeenCalled()
+  })
+
+  test.each([null, undefined, []])('should remove %s values from the body and query string when sending', (emptyValue) => {
+    const harvester = new Harvest()
+
+    harvester.send({
+      endpoint: 'rum',
+      payload: { qs: { foo: 'bar', empty: emptyValue }, body: { bar: 'foo', empty: emptyValue } }
+    })
+
+    expect(submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.stringContaining('&foo=bar'),
+      body: JSON.stringify({ bar: 'foo' })
+    }))
+    expect(submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.not.stringContaining('&empty'),
+      body: expect.not.stringContaining('empty')
+    }))
+    expect(submitData.img).not.toHaveBeenCalled()
+    expect(submitData.beacon).not.toHaveBeenCalled()
+  })
+
+  test.each([1, false, true])('should not remove value %s (when it doesn\'t have a length) from the body and query string when sending', (nonStringValue) => {
+    const harvester = new Harvest()
+
+    harvester.send({
+      endpoint: 'rum',
+      payload: { qs: { foo: 'bar', nonString: nonStringValue }, body: { bar: 'foo', nonString: nonStringValue } }
+    })
+
+    expect(submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.stringContaining(`&nonString=${nonStringValue}`),
+      body: JSON.stringify({ bar: 'foo', nonString: nonStringValue })
+    }))
+    expect(submitData.img).not.toHaveBeenCalled()
+    expect(submitData.beacon).not.toHaveBeenCalled()
+  })
+})

src/common/url/encode.js

@@ -48,11 +48,11 @@ export function obj (payload, maxBytes) {
     var next
     var i
 
-    if (typeof dataArray === 'string') {
+    if (typeof dataArray === 'string' || (!Array.isArray(dataArray) && dataArray !== null && dataArray !== undefined && dataArray.toString().length)) {
       next = '&' + feature + '=' + qs(dataArray)
       total += next.length
       result += next
-    } else if (dataArray.length) {
+    } else if (Array.isArray(dataArray) && dataArray.length) {
       total += 9
       for (i = 0; i < dataArray.length; i++) {
         next = qs(stringify(dataArray[i]))

src/features/metrics/aggregate/endpoint-map.js

@@ -0,0 +1,7 @@
+export const endpointMap = {
+  rum: '1',
+  events: 'Events',
+  ins: 'Ins',
+  jserrors: 'Jserrors',
+  resources: 'Resources'
+}

src/features/metrics/aggregate/index.js

@@ -13,6 +13,7 @@ import { windowAddEventListener } from '../../../common/event-listener/event-lis
 import { isBrowserScope } from '../../../common/util/global-scope'
 import { AggregateBase } from '../../utils/aggregate-base'
 import { stringify } from '../../../common/util/stringify'
+import { endpointMap } from './endpoint-map'
 
 export class Aggregate extends AggregateBase {
   static featureName = FEATURE_NAME
@@ -125,15 +126,15 @@ export class Aggregate extends AggregateBase {
       // Capture per-agent bytes sent for each endpoint (see harvest) and RUM call (see page_view_event aggregator).
       Object.keys(agentRuntime.bytesSent).forEach(endpoint => {
         this.storeSupportabilityMetrics(
-          `PageSession/Endpoint/${endpoint.charAt(0).toUpperCase() + endpoint.slice(1)}/BytesSent`,
+          `PageSession/Endpoint/${endpointMap[endpoint]}/BytesSent`,
           agentRuntime.bytesSent[endpoint]
         )
       })
 
       // Capture per-agent query bytes sent for each endpoint (see harvest) and RUM call (see page_view_event aggregator).
       Object.keys(agentRuntime.bytesSent).forEach(endpoint => {
         this.storeSupportabilityMetrics(
-          `PageSession/Endpoint/${endpoint.charAt(0).toUpperCase() + endpoint.slice(1)}/QueryBytesSent`,
+          `PageSession/Endpoint/${endpointMap[endpoint]}/QueryBytesSent`,
           agentRuntime.queryBytesSent[endpoint]
         )
       })