Add snippet version to the beacons

Author: josephwynn-sc

rollup.config.mjs

@@ -24,7 +24,7 @@ const scriptOutput = (file, minified) => ({
   sourcemap: true,
 });
 
-const snippetOutput = (file, target) => {
+const snippetOutput = (file, target = "es5") => {
   const versionString = `${pkg.config.snippetVersion}${target === "es5" ? "" : `-${target}`}`;
   const preamble = `/* SpeedCurve RUM Snippet v${versionString} */`;
 

src/beacon.ts

@@ -204,6 +204,7 @@ export class Beacon {
         collectionDuration: now() - collectionStart,
         pageId: this.pageId,
         scriptVersion: VERSION,
+        snippetVersion: this.config.snippetVersion,
         sessionId: this.sessionId,
         startTime: this.startTime,
       },
@@ -239,6 +240,9 @@ export type BeaconMetaData = {
   /** The lux.js version that sent the beacon */
   scriptVersion: string;
 
+  /** The lux.js snippet version that sent the beacon */
+  snippetVersion?: string;
+
   /** How long in milliseconds did this beacon capture page data for */
   measureDuration: number;
 

src/config.ts

@@ -1,3 +1,4 @@
+import { LuxGlobal } from "./global";
 import { ServerTimingConfig } from "./server-timing";
 import { UrlPatternMapping } from "./url-matcher";
 
@@ -26,6 +27,7 @@ export interface ConfigObject {
   samplerate: number;
   sendBeaconOnPageHidden: boolean;
   serverTiming?: ServerTimingConfig;
+  snippetVersion?: LuxGlobal["snippetVersion"];
   trackErrors: boolean;
   trackHiddenPages: boolean;
 }

src/global.ts

@@ -27,5 +27,6 @@ export interface LuxGlobal extends UserConfig {
   /** Timestamp representing when the LUX snippet was evaluated */
   ns?: number;
   send: () => void;
+  snippetVersion?: string;
   version?: string;
 }

src/lux.ts

@@ -1435,6 +1435,10 @@ LUX = (function () {
       queryParams.push("fl=" + gFlags);
     }
 
+    if (LUX.snippetVersion) {
+      queryParams.push("sv=" + LUX.snippetVersion);
+    }
+
     const customDataValues = CustomData.valuesToString(customData);
 
     if (customDataValues) {
@@ -2065,6 +2069,7 @@ LUX = (function () {
 
   // Public properties
   globalLux.version = VERSION;
+  globalLux.snippetVersion = LUX.snippetVersion;
 
   /**
    * Run a command from the command queue

src/snippet.ts

@@ -22,6 +22,7 @@ LUX.markLoadTime = () => LUX.cmd(["markLoadTime", msSinceNavigationStart()]);
 LUX.measure = _measure;
 LUX.on = (event, callback) => LUX.cmd(["on", event, callback]);
 LUX.send = () => LUX.cmd(["send"]);
+LUX.snippetVersion = __SNIPPET_VERSION;
 LUX.ns = scriptStartTime;
 
 export default LUX;

src/version.ts

@@ -1,6 +1,8 @@
+import { version as pkgVersion, config as pkgConfig } from "../package.json";
 import { padStart } from "./string";
 
-export const VERSION = "4.2.1";
+export const VERSION = pkgVersion;
+export const SNIPPET_VERSION = pkgConfig.snippetVersion;
 
 /**
  * Returns the version of the script as a float to be stored in legacy systems that do not support

src/window.d.ts

@@ -2,6 +2,7 @@ import { LuxGlobal } from "./global";
 
 declare global {
   declare const __ENABLE_POLYFILLS: boolean;
+  declare const __SNIPPET_VERSION: string;
 
   // LUX globals
   interface Window {