@newrelic/browser-agent 1.276.0 → 1.278.0

package/dist/esm/common/harvest/harvest.js

@@ -1,286 +0,0 @@
-/*
- * Copyright 2020 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import { obj as encodeObj, param as encodeParam } from '../url/encode';
-import { stringify } from '../util/stringify';
-import * as submitData from '../util/submit-data';
-import { getLocation } from '../url/location';
-import { getInfo } from '../config/info';
-import { getConfigurationValue, getConfiguration } from '../config/init';
-import { getRuntime } from '../config/runtime';
-import { cleanURL } from '../url/clean-url';
-import { eventListenerOpts } from '../event-listener/event-listener-opts';
-import { SharedContext } from '../context/shared-context';
-import { VERSION } from "../constants/env.npm";
-import { isWorkerScope } from '../constants/runtime';
-import { warn } from '../util/console';
-import { now } from '../timing/now';
-const warnings = {};
-
-/**
- * @typedef {import('./types.js').NetworkSendSpec} NetworkSendSpec
- * @typedef {import('./types.js').HarvestEndpointIdentifier} HarvestEndpointIdentifier
- * @typedef {import('./types.js').HarvestPayload} HarvestPayload
- * @typedef {import('./types.js').FeatureHarvestCallback} FeatureHarvestCallback
- * @typedef {import('./types.js').FeatureHarvestCallbackOptions} FeatureHarvestCallbackOptions
- */
-export class Harvest extends SharedContext {
-  constructor(parent) {
-    super(parent); // gets any allowed properties from the parent and stores them in `sharedContext`
-
-    this.tooManyRequestsDelay = getConfigurationValue(this.sharedContext.agentIdentifier, 'harvest.tooManyRequestsDelay') || 60;
-    this.obfuscator = getRuntime(this.sharedContext.agentIdentifier).obfuscator;
-    this._events = {};
-  }
-
-  /**
-   * Initiate a harvest from multiple sources. An event that corresponds to the endpoint
-   * name is emitted, which gives any listeners the opportunity to provide payload data.
-   * Note: Used by page_action
-   * @param {NetworkSendSpec} spec Specification for sending data
-   */
-  sendX(spec = {}) {
-    const submitMethod = submitData.getSubmitMethod({
-      isFinalHarvest: spec.opts?.unload
-    });
-    const options = {
-      retry: !spec.opts?.unload && submitMethod === submitData.xhr,
-      isFinalHarvest: spec.opts?.unload === true
-    };
-    const payload = this.createPayload(spec.endpoint, options);
-    const caller = this._send.bind(this);
-    return caller({
-      ...spec,
-      payload,
-      submitMethod
-    });
-  }
-
-  /**
-   * Initiate a harvest call.
-   * @param {NetworkSendSpec} spec Specification for sending data
-   */
-  send(spec = {}) {
-    const caller = this._send.bind(this);
-    return caller(spec);
-  }
-
-  /**
-   * Initiate a harvest call. Typically used by `sendX` and `send` methods or called directly
-   * for raw network calls.
-   * @param {NetworkSendSpec} param0 Specification for sending data
-   * @returns {boolean} True if the network call succeeded. For final harvest calls, the return
-   * value should not be relied upon because network calls will be made asynchronously.
-   */
-  _send({
-    endpoint,
-    payload = {},
-    opts = {},
-    submitMethod,
-    cbFinished,
-    customUrl,
-    raw,
-    includeBaseParams = true
-  }) {
-    const info = getInfo(this.sharedContext.agentIdentifier);
-    if (!info.errorBeacon) return false;
-    const agentRuntime = getRuntime(this.sharedContext.agentIdentifier);
-    let {
-      body,
-      qs
-    } = this.cleanPayload(payload);
-    if (Object.keys(body).length === 0 && !opts?.sendEmptyBody) {
-      // no payload body? nothing to send, just run onfinish stuff and return
-      if (cbFinished) {
-        cbFinished({
-          sent: false
-        });
-      }
-      return false;
-    }
-    const init = getConfiguration(this.sharedContext.agentIdentifier);
-    const protocol = init.ssl === false ? 'http' : 'https';
-    const perceviedBeacon = init.proxy.beacon || info.errorBeacon;
-    const endpointURLPart = endpoint !== 'rum' ? "/".concat(endpoint) : '';
-    let url = "".concat(protocol, "://").concat(perceviedBeacon).concat(endpointURLPart, "/1/").concat(info.licenseKey);
-    if (customUrl) url = customUrl;
-    if (raw) url = "".concat(protocol, "://").concat(perceviedBeacon, "/").concat(endpoint);
-    const baseParams = !raw && includeBaseParams ? this.baseQueryString(qs, endpoint) : '';
-    let payloadParams = encodeObj(qs, agentRuntime.maxBytes);
-    if (!submitMethod) {
-      submitMethod = submitData.getSubmitMethod({
-        isFinalHarvest: opts.unload
-      });
-    }
-    if (baseParams === '' && payloadParams.startsWith('&')) {
-      payloadParams = payloadParams.substring(1);
-    }
-    const fullUrl = "".concat(url, "?").concat(baseParams).concat(payloadParams);
-    const gzip = !!qs?.attributes?.includes('gzip');
-    if (!gzip) {
-      if (endpoint !== 'events') body = stringify(body); // all features going to /events/ endpoint should already be serialized & stringified
-      /** Warn --once per endpoint-- if the agent tries to send large payloads */
-      if (body.length > 750000 && (warnings[endpoint] = (warnings?.[endpoint] || 0) + 1) === 1) warn(28, endpoint);
-    }
-    if (!body || body.length === 0 || body === '{}' || body === '[]') {
-      // If body is null, undefined, or an empty object or array, send an empty string instead
-      body = '';
-    }
-    const headers = [];
-    headers.push({
-      key: 'content-type',
-      value: 'text/plain'
-    });
-
-    /* Since workers don't support sendBeacon right now, they can only use XHR method.
-        Because they still do permit synch XHR, the idea is that at final harvest time (worker is closing),
-        we just make a BLOCKING request--trivial impact--with the remaining data as a temp fill-in for sendBeacon.
-       Following the removal of img-element method. */
-    let result = submitMethod({
-      url: fullUrl,
-      body,
-      sync: opts.unload && isWorkerScope,
-      headers
-    });
-    if (!opts.unload && cbFinished && submitMethod === submitData.xhr) {
-      const harvestScope = this;
-      result.addEventListener('loadend', function () {
-        // `this` refers to the XHR object in this scope, do not change this to a fat arrow
-        // status 0 refers to a local error, such as CORS or network failure, or a blocked request by the browser (e.g. adblocker)
-        const cbResult = {
-          sent: this.status !== 0,
-          status: this.status,
-          xhr: this,
-          fullUrl
-        };
-        if (this.status === 429) {
-          cbResult.retry = true;
-          cbResult.delay = harvestScope.tooManyRequestsDelay;
-        } else if (this.status === 408 || this.status === 500 || this.status === 503) {
-          cbResult.retry = true;
-        }
-        if (opts.needResponse) {
-          cbResult.responseText = this.responseText;
-        }
-        cbFinished(cbResult);
-      }, eventListenerOpts(false));
-    } else if (!opts.unload && cbFinished && submitMethod === submitData.xhrFetch) {
-      const harvestScope = this;
-      result.then(async function (response) {
-        const status = response.status;
-        const cbResult = {
-          sent: true,
-          status,
-          fullUrl,
-          fetchResponse: response
-        };
-        if (response.status === 429) {
-          cbResult.retry = true;
-          cbResult.delay = harvestScope.tooManyRequestsDelay;
-        } else if (status === 408 || status === 500 || status === 503) {
-          cbResult.retry = true;
-        }
-        if (opts.needResponse) {
-          cbResult.responseText = await response.text();
-        }
-        cbFinished(cbResult);
-      });
-    }
-    return result;
-  }
-
-  // The stuff that gets sent every time.
-  baseQueryString(qs, endpoint) {
-    const runtime = getRuntime(this.sharedContext.agentIdentifier);
-    const info = getInfo(this.sharedContext.agentIdentifier);
-    const ref = this.obfuscator.obfuscateString(cleanURL(getLocation()));
-    const hr = runtime?.session?.state.sessionReplayMode === 1 && endpoint !== 'jserrors';
-    const qps = ['a=' + info.applicationID, encodeParam('sa', info.sa ? '' + info.sa : ''), encodeParam('v', VERSION), transactionNameParam(info), encodeParam('ct', runtime.customTransaction), '&rst=' + now(), '&ck=0',
-    // ck param DEPRECATED - still expected by backend
-    '&s=' + (runtime.session?.state.value || '0'),
-    // the 0 id encaps all untrackable and default traffic
-    encodeParam('ref', ref), encodeParam('ptid', runtime.ptid ? '' + runtime.ptid : '')];
-    if (hr) qps.push(encodeParam('hr', '1', qs));
-    return qps.join('');
-  }
-
-  /**
-   * Calls and accumulates data from registered harvesting functions based on
-   * the endpoint being harvested.
-   * @param {HarvestEndpointIdentifier} endpoint BAM endpoint identifier.
-   * @param {FeatureHarvestCallbackOptions} options Options to be passed to the
-   * feature harvest listener callback.
-   * @returns {HarvestPayload} Payload object to transmit to the bam endpoint.
-   */
-  createPayload(endpoint, options) {
-    const listeners = this._events[endpoint];
-    const payload = {
-      body: {},
-      qs: {}
-    };
-    if (Array.isArray(listeners) && listeners.length > 0) {
-      for (let i = 0; i < listeners.length; i++) {
-        const singlePayload = listeners[i](options);
-        if (singlePayload) {
-          payload.body = {
-            ...payload.body,
-            ...(singlePayload.body || {})
-          };
-          payload.qs = {
-            ...payload.qs,
-            ...(singlePayload.qs || {})
-          };
-        }
-      }
-    }
-    return payload;
-  }
-
-  /**
-   * Cleans and returns a payload object containing a body and qs
-   * object with key/value pairs. KV pairs where the value is null,
-   * undefined, or an empty string are removed to save on transmission
-   * size.
-   * @param {HarvestPayload} payload Payload to be sent to the endpoint.
-   * @returns {HarvestPayload} Cleaned payload payload to be sent to the endpoint.
-   */
-  cleanPayload(payload = {}) {
-    const clean = input => {
-      if (typeof Uint8Array !== 'undefined' && input instanceof Uint8Array || Array.isArray(input)) return input;
-      if (typeof input === 'string') return input.length > 0 ? input : null;
-      return Object.entries(input || {}).reduce((accumulator, [key, value]) => {
-        if (typeof value === 'number' || typeof value === 'string' && value.length > 0 || typeof value === 'object' && Object.keys(value || {}).length > 0) {
-          accumulator[key] = value;
-        }
-        return accumulator;
-      }, {});
-    };
-    return {
-      body: clean(payload.body),
-      qs: clean(payload.qs)
-    };
-  }
-
-  /**
-   * Registers a function to be called when harvesting is triggered for a specific
-   * endpoint.
-   * @param {HarvestEndpointIdentifier} endpoint
-   * @param {FeatureHarvestCallback} listener
-   */
-  on(endpoint, listener) {
-    if (!Array.isArray(this._events[endpoint])) {
-      this._events[endpoint] = [];
-    }
-    this._events[endpoint].push(listener);
-  }
-}
-
-// Constructs the transaction name param for the beacon URL.
-// Prefers the obfuscated transaction name over the plain text.
-// Falls back to making up a name.
-function transactionNameParam(info) {
-  if (info.transactionName) return encodeParam('to', info.transactionName);
-  return encodeParam('t', info.tNamePlain || 'Unnamed Transaction');
-}

package/dist/types/common/harvest/harvest-scheduler.d.ts

@@ -1,50 +0,0 @@
-/**
- * Periodically invokes harvest calls and handles retries
- */
-export class HarvestScheduler extends SharedContext {
-    /**
-       * Create a HarvestScheduler
-       * @param {string} endpoint - The base BAM endpoint name -- ex. 'events'
-       * @param {object} opts - The options used to configure the HarvestScheduler
-       * @param {Function} opts.onFinished - The callback to be fired when a harvest has finished
-       * @param {Function} opts.getPayload - A callback which can be triggered to return a payload for harvesting
-       * @param {number} opts.retryDelay - The number of seconds to wait before retrying after a network failure
-       * @param {boolean} opts.raw - Use a prefabricated payload shape as the harvest payload without the need for formatting
-       * @param {string} opts.customUrl - A custom url that falls outside of the shape of the standard BAM harvester url pattern.  Will use directly instead of concatenating various pieces
-       * @param {*} parent - The parent object, whose state can be passed into SharedContext
-       */
-    constructor(endpoint: string, opts: {
-        onFinished: Function;
-        getPayload: Function;
-        retryDelay: number;
-        raw: boolean;
-        customUrl: string;
-    }, parent: any);
-    endpoint: string;
-    opts: {
-        onFinished: Function;
-        getPayload: Function;
-        retryDelay: number;
-        raw: boolean;
-        customUrl: string;
-    };
-    started: boolean;
-    timeoutHandle: any;
-    aborted: boolean;
-    harvesting: boolean;
-    harvest: Harvest;
-    /**
-     * This function is only meant for the last outgoing harvest cycle of a page. It trickles down to using sendBeacon, which should not be used
-     * to send payloads while the page is still active, due to limitations on how much data can be buffered in the API at any one time.
-     */
-    unload(): void;
-    startTimer(interval: any, initialDelay: any): void;
-    interval: any;
-    stopTimer(permanently?: boolean): void;
-    scheduleHarvest(delay: any, opts: any): void;
-    runHarvest(opts: any): false | undefined;
-    onHarvestFinished(opts: any, result: any): void;
-}
-import { SharedContext } from '../context/shared-context';
-import { Harvest } from './harvest';
-//# sourceMappingURL=harvest-scheduler.d.ts.map

package/dist/types/common/harvest/harvest-scheduler.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"harvest-scheduler.d.ts","sourceRoot":"","sources":["../../../../src/common/harvest/harvest-scheduler.js"],"names":[],"mappings":"AAWA;;GAEG;AACH;IACE;;;;;;;;;;SAUK;IACL,sBATa,MAAM,QAEd;QAAuB,UAAU;QACV,UAAU;QACZ,UAAU,EAAvB,MAAM;QACQ,GAAG,EAAjB,OAAO;QACM,SAAS,EAAtB,MAAM;KACd,UAAQ,GAAC,EAoBb;IAhBC,iBAAwB;IACxB;;;oBARW,MAAM;aACN,OAAO;mBACP,MAAM;MAMK;IACtB,iBAAoB;IACpB,mBAAyB;IACzB,iBAAoB;IACpB,oBAAuB;IACvB,iBAA8C;IAYhD;;;OAGG;IACH,eAGC;IAED,mDAIC;IAHC,cAAwB;IAK1B,uCAMC;IAED,6CAUC;IAED,yCAgEC;IAED,gDAiBC;CACF;8BA/J6B,2BAA2B;wBACjC,WAAW"}

package/dist/types/common/harvest/harvest.d.ts

@@ -1,65 +0,0 @@
-/**
- * @typedef {import('./types.js').NetworkSendSpec} NetworkSendSpec
- * @typedef {import('./types.js').HarvestEndpointIdentifier} HarvestEndpointIdentifier
- * @typedef {import('./types.js').HarvestPayload} HarvestPayload
- * @typedef {import('./types.js').FeatureHarvestCallback} FeatureHarvestCallback
- * @typedef {import('./types.js').FeatureHarvestCallbackOptions} FeatureHarvestCallbackOptions
- */
-export class Harvest extends SharedContext {
-    tooManyRequestsDelay: any;
-    obfuscator: any;
-    _events: {};
-    /**
-     * Initiate a harvest from multiple sources. An event that corresponds to the endpoint
-     * name is emitted, which gives any listeners the opportunity to provide payload data.
-     * Note: Used by page_action
-     * @param {NetworkSendSpec} spec Specification for sending data
-     */
-    sendX(spec?: NetworkSendSpec): boolean;
-    /**
-     * Initiate a harvest call.
-     * @param {NetworkSendSpec} spec Specification for sending data
-     */
-    send(spec?: NetworkSendSpec): boolean;
-    /**
-     * Initiate a harvest call. Typically used by `sendX` and `send` methods or called directly
-     * for raw network calls.
-     * @param {NetworkSendSpec} param0 Specification for sending data
-     * @returns {boolean} True if the network call succeeded. For final harvest calls, the return
-     * value should not be relied upon because network calls will be made asynchronously.
-     */
-    _send({ endpoint, payload, opts, submitMethod, cbFinished, customUrl, raw, includeBaseParams }: NetworkSendSpec): boolean;
-    baseQueryString(qs: any, endpoint: any): string;
-    /**
-     * Calls and accumulates data from registered harvesting functions based on
-     * the endpoint being harvested.
-     * @param {HarvestEndpointIdentifier} endpoint BAM endpoint identifier.
-     * @param {FeatureHarvestCallbackOptions} options Options to be passed to the
-     * feature harvest listener callback.
-     * @returns {HarvestPayload} Payload object to transmit to the bam endpoint.
-     */
-    createPayload(endpoint: HarvestEndpointIdentifier, options: FeatureHarvestCallbackOptions): HarvestPayload;
-    /**
-     * Cleans and returns a payload object containing a body and qs
-     * object with key/value pairs. KV pairs where the value is null,
-     * undefined, or an empty string are removed to save on transmission
-     * size.
-     * @param {HarvestPayload} payload Payload to be sent to the endpoint.
-     * @returns {HarvestPayload} Cleaned payload payload to be sent to the endpoint.
-     */
-    cleanPayload(payload?: HarvestPayload): HarvestPayload;
-    /**
-     * Registers a function to be called when harvesting is triggered for a specific
-     * endpoint.
-     * @param {HarvestEndpointIdentifier} endpoint
-     * @param {FeatureHarvestCallback} listener
-     */
-    on(endpoint: HarvestEndpointIdentifier, listener: FeatureHarvestCallback): void;
-}
-export type NetworkSendSpec = import("./types.js").NetworkSendSpec;
-export type HarvestEndpointIdentifier = import("./types.js").HarvestEndpointIdentifier;
-export type HarvestPayload = import("./types.js").HarvestPayload;
-export type FeatureHarvestCallback = import("./types.js").FeatureHarvestCallback;
-export type FeatureHarvestCallbackOptions = import("./types.js").FeatureHarvestCallbackOptions;
-import { SharedContext } from '../context/shared-context';
-//# sourceMappingURL=harvest.d.ts.map

package/dist/types/common/harvest/harvest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"harvest.d.ts","sourceRoot":"","sources":["../../../../src/common/harvest/harvest.js"],"names":[],"mappings":"AAsBA;;;;;;GAMG;AACH;IAII,0BAA2H;IAC3H,gBAA2E;IAE3E,YAAiB;IAGnB;;;;;OAKG;IACH,aAFW,eAAe,WAWzB;IAED;;;OAGG;IACH,YAFW,eAAe,WAMzB;IAED;;;;;;OAMG;IACH,gGAJW,eAAe,GACb,OAAO,CAkGnB;IAGD,gDAqBC;IAED;;;;;;;OAOG;IACH,wBALW,yBAAyB,WACzB,6BAA6B,GAE3B,cAAc,CA2B1B;IAED;;;;;;;OAOG;IACH,uBAHW,cAAc,GACZ,cAAc,CAuB1B;IAED;;;;;OAKG;IACH,aAHW,yBAAyB,YACzB,sBAAsB,QAQhC;CACF;8BA1PY,OAAO,YAAY,EAAE,eAAe;wCACpC,OAAO,YAAY,EAAE,yBAAyB;6BAC9C,OAAO,YAAY,EAAE,cAAc;qCACnC,OAAO,YAAY,EAAE,sBAAsB;4CAC3C,OAAO,YAAY,EAAE,6BAA6B;8BAbjC,2BAA2B"}

package/src/common/harvest/__mocks__/harvest.js

@@ -1,13 +0,0 @@
-export const Harvest = jest.fn(function () {
-  this.sharedContext = {
-    agentIdentifier: 'abcd'
-  }
-  this.sendX = jest.fn()
-  this.send = jest.fn()
-  this.obfuscateAndSend = jest.fn()
-  this._send = jest.fn()
-  this.baseQueryString = jest.fn()
-  this.createPayload = jest.fn()
-  this.cleanPayload = jest.fn()
-  this.on = jest.fn()
-})

package/src/common/harvest/harvest-scheduler.js

@@ -1,166 +0,0 @@
-/*
- * Copyright 2020 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import * as submitData from '../util/submit-data'
-import { SharedContext } from '../context/shared-context'
-import { Harvest } from './harvest'
-import { subscribeToEOL } from '../unload/eol'
-import { SESSION_EVENTS } from '../session/constants'
-
-/**
- * Periodically invokes harvest calls and handles retries
- */
-export class HarvestScheduler extends SharedContext {
-  /**
-     * Create a HarvestScheduler
-     * @param {string} endpoint - The base BAM endpoint name -- ex. 'events'
-     * @param {object} opts - The options used to configure the HarvestScheduler
-     * @param {Function} opts.onFinished - The callback to be fired when a harvest has finished
-     * @param {Function} opts.getPayload - A callback which can be triggered to return a payload for harvesting
-     * @param {number} opts.retryDelay - The number of seconds to wait before retrying after a network failure
-     * @param {boolean} opts.raw - Use a prefabricated payload shape as the harvest payload without the need for formatting
-     * @param {string} opts.customUrl - A custom url that falls outside of the shape of the standard BAM harvester url pattern.  Will use directly instead of concatenating various pieces
-     * @param {*} parent - The parent object, whose state can be passed into SharedContext
-     */
-  constructor (endpoint, opts, parent) {
-    super(parent) // gets any allowed properties from the parent and stores them in `sharedContext`
-    this.endpoint = endpoint
-    this.opts = opts || {}
-    this.started = false
-    this.timeoutHandle = null
-    this.aborted = false // this controls the per-interval and final harvests for the scheduler (currently per feature specific!)
-    this.harvesting = false
-    this.harvest = new Harvest(this.sharedContext)
-
-    // If a feature specifies stuff to be done on page unload, those are frontrunned (via capture phase) before ANY feature final harvests.
-    if (typeof this.opts.onUnload === 'function') subscribeToEOL(this.opts.onUnload, true)
-    subscribeToEOL(this.unload.bind(this)) // this should consist only of sending final harvest
-
-    /* Flush all buffered data if session resets and give up retries. This should be synchronous to ensure that the correct `session` value is sent.
-      Since session-reset generates a new session ID and the ID is grabbed at send-time, any delays or retries would cause the payload to be sent under
-      the wrong session ID. */
-    this.sharedContext?.ee.on(SESSION_EVENTS.RESET, () => this.runHarvest({ forceNoRetry: true }))
-  }
-
-  /**
-   * This function is only meant for the last outgoing harvest cycle of a page. It trickles down to using sendBeacon, which should not be used
-   * to send payloads while the page is still active, due to limitations on how much data can be buffered in the API at any one time.
-   */
-  unload () {
-    if (this.aborted) return
-    this.runHarvest({ unload: true })
-  }
-
-  startTimer (interval, initialDelay) {
-    this.interval = interval
-    this.started = true
-    this.scheduleHarvest(initialDelay != null ? initialDelay : this.interval)
-  }
-
-  stopTimer (permanently = false) {
-    this.aborted = permanently // stopping permanently is same as aborting, but this function also cleans up the setTimeout loop
-    this.started = false
-    if (this.timeoutHandle) {
-      clearTimeout(this.timeoutHandle)
-    }
-  }
-
-  scheduleHarvest (delay, opts) {
-    if (this.timeoutHandle) return
-
-    if (delay == null) {
-      delay = this.interval
-    }
-    this.timeoutHandle = setTimeout(() => {
-      this.timeoutHandle = null
-      this.runHarvest(opts)
-    }, delay * 1000)
-  }
-
-  runHarvest (opts) {
-    if (this.aborted) return
-    this.harvesting = true
-
-    /**
-     * This is executed immediately after harvest sends the data via XHR, or if there's nothing to send. Note that this excludes on unloading / sendBeacon.
-     * @param {Object} result
-     */
-    const cbRanAfterSend = (result) => {
-      this.harvesting = false
-      if (opts?.forceNoRetry) result.retry = false // discard unsent data rather than re-queuing for next harvest attempt
-      this.onHarvestFinished(opts, result)
-    }
-
-    let harvests = []
-    let submitMethod
-    let payload
-
-    if (this.opts.getPayload) {
-      // Ajax, PVT, Softnav, Logging, SR & ST features provide a single callback function to get data for harvesting
-      submitMethod = submitData.getSubmitMethod({ isFinalHarvest: opts?.unload })
-      if (!submitMethod) return false
-
-      const retry = !opts?.unload && submitMethod === submitData.xhr
-      payload = this.opts.getPayload({ retry, ...opts })
-
-      if (!payload) {
-        if (this.started) {
-          this.scheduleHarvest()
-        }
-        return
-      }
-
-      payload = Object.prototype.toString.call(payload) === '[object Array]' ? payload : [payload]
-      harvests.push(...payload)
-    }
-
-    /** sendX is used for features that do not supply a preformatted payload via "getPayload" */
-    let send = args => this.harvest.sendX(args)
-    if (harvests.length) {
-      /** _send is the underlying method for sending in the harvest, if sending raw we can bypass the other helpers completely which format the payloads */
-      if (this.opts.raw) send = args => this.harvest._send(args)
-      /** send is used to formated the payloads from "getPayload" and obfuscate before sending */
-      else send = args => this.harvest.send(args)
-    } else {
-      // force it to run at least once in sendX mode
-      harvests.push(undefined)
-    }
-
-    harvests.forEach(payload => {
-      send({
-        endpoint: this.endpoint,
-        payload,
-        opts,
-        submitMethod,
-        cbFinished: cbRanAfterSend,
-        customUrl: this.opts.customUrl,
-        raw: this.opts.raw
-      })
-    })
-
-    if (this.started) {
-      this.scheduleHarvest()
-    }
-  }
-
-  onHarvestFinished (opts, result) {
-    if (this.opts.onFinished) {
-      this.opts.onFinished(result)
-    }
-
-    if (result.sent && result.retry) {
-      const delay = result.delay || this.opts.retryDelay
-      // reschedule next harvest if should be delayed longer
-      if (this.started && delay) {
-        clearTimeout(this.timeoutHandle)
-        this.timeoutHandle = null
-        this.scheduleHarvest(delay, opts)
-      } else if (!this.started && delay) {
-        // if not running on a timer, schedule a single retry
-        this.scheduleHarvest(delay, opts)
-      }
-    }
-  }
-}