@elliemae/pui-app-sdk 5.13.5 → 5.14.0

package/dist/cjs/utils/headSampler.js

@@ -0,0 +1,70 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var headSampler_exports = {};
+__export(headSampler_exports, {
+  HeadSampler: () => HeadSampler
+});
+module.exports = __toCommonJS(headSampler_exports);
+const normalize = (percent) => {
+  if (typeof percent !== "number" || Number.isNaN(percent)) return 0;
+  if (percent >= 100) return 100;
+  if (percent <= 0) return 0;
+  return percent;
+};
+const convertToDivisibleBy5 = (percent) => Math.round(normalize(percent) / 5) * 5;
+const percentToFraction = (percent) => {
+  const numerator = percent;
+  const denominator = 100;
+  const gcd = (a, b) => b === 0 ? a : gcd(b, a % b);
+  const divisor = gcd(numerator, denominator);
+  return { numerator: numerator / divisor, denominator: denominator / divisor };
+};
+class HeadSampler {
+  /**
+   * Upper bound of the sampling size
+   */
+  #upperBound = 0;
+  /**
+   * Total size of the sampling
+   */
+  #totalSize = 0;
+  /**
+   * Number of events sampled
+   */
+  #sampled = 0;
+  /**
+   * Creates new instance of HeadSampler
+   * @param samplingPercent sampling percentage
+   */
+  constructor(samplingPercent) {
+    const value = percentToFraction(convertToDivisibleBy5(samplingPercent));
+    this.#upperBound = value.numerator;
+    this.#totalSize = value.denominator;
+  }
+  /**
+   * check if the event should be sampled
+   * @returns true if the event should be sampled
+   */
+  shouldSample = () => {
+    this.#sampled += 1;
+    if (this.#sampled <= this.#upperBound) return true;
+    if (this.#sampled === this.#totalSize) this.#sampled = 0;
+    return false;
+  };
+}

package/dist/cjs/utils/micro-frontend/host.js

@@ -62,7 +62,7 @@ class CMicroAppHost {
     };
     this.activeGuests = {};
     this.#ssfHostRef = params?.ssfHostRef || null;
-    const analyticsObj = params?.analytics ?? new import_analytics.Analytics(this.logger);
+    const analyticsObj = params?.analytics ?? new import_analytics.Analytics({ logger: this.logger });
     this.scriptingObjects = {
       analytics: analyticsObj,
       ...params?.scriptingObjects ?? {}

package/dist/cjs/utils/micro-frontend/scripting-objects/analytics.js

@@ -34,20 +34,41 @@ module.exports = __toCommonJS(analytics_exports);
 var import_em_ssf_host = __toESM(require("@elliemae/em-ssf-host"));
 var import_web_analytics = require("./web-analytics.js");
 var import_helpers = require("../../helpers.js");
+var import_headSampler = require("../../headSampler.js");
 class Analytics extends import_em_ssf_host.default.ScriptingObject {
   /**
    * logger instance
    */
   #logger;
+  /**
+   * sampling size for different events
+   */
+  #samplingSizes = {};
   /**
    * Creates new instance of Analytics scripting object
-   * @param logger instance of PUI Diagnostics logger
+   * @param params Analytics constructor parameters
    */
-  constructor(logger) {
+  constructor(params) {
     super("analytics");
-    this.#logger = logger;
+    this.#logger = params.logger;
+    this.#setupSampling(params.samplingRatios);
     this.#monitorPerformance();
   }
+  /**
+   * setup sampling size for different events
+   * @param samplingSizes sampling sizes for different events
+   */
+  #setupSampling = (samplingSizes = {}) => {
+    Object.keys(samplingSizes).forEach((key) => {
+      this.#samplingSizes[key] = new import_headSampler.HeadSampler(samplingSizes[key]);
+    });
+  };
+  /**
+   * check if the event should be sampled and recorded
+   * @param name name of the event
+   * @returns true if the event should be sampled and recorded
+   */
+  #shouldSampleandRecord = (name) => this.#samplingSizes[name] ? this.#samplingSizes[name].shouldSample() : true;
   /**
    * monitor performance and report to GTM
    */
@@ -57,18 +78,28 @@ class Analytics extends import_em_ssf_host.default.ScriptingObject {
         for (const entry of list.getEntries()) {
           switch (entry.entryType) {
             case "measure": {
+              if (!this.#shouldSampleandRecord(entry.name)) return;
               const detail = entry.detail ?? {};
+              const duration = entry.duration.toString();
+              const startTime = new Date(
+                performance.timeOrigin + entry.startTime
+              ).toISOString();
               this.sendBAEvent({
                 event: "timing",
                 name: entry.name,
-                duration: entry.duration.toString(),
-                startTime: new Date(
-                  performance.timeOrigin + entry.startTime
-                ).toISOString(),
+                duration,
+                startTime,
                 ...(0, import_web_analytics.getBAEventParameters)(),
                 ...detail
               }).catch(() => {
               });
+              this.#logger.info({
+                message: "timing",
+                event: entry.name,
+                duration,
+                startTime,
+                detail
+              });
               break;
             }
             default:

package/dist/esm/utils/headSampler.js

@@ -0,0 +1,50 @@
+const normalize = (percent) => {
+  if (typeof percent !== "number" || Number.isNaN(percent)) return 0;
+  if (percent >= 100) return 100;
+  if (percent <= 0) return 0;
+  return percent;
+};
+const convertToDivisibleBy5 = (percent) => Math.round(normalize(percent) / 5) * 5;
+const percentToFraction = (percent) => {
+  const numerator = percent;
+  const denominator = 100;
+  const gcd = (a, b) => b === 0 ? a : gcd(b, a % b);
+  const divisor = gcd(numerator, denominator);
+  return { numerator: numerator / divisor, denominator: denominator / divisor };
+};
+class HeadSampler {
+  /**
+   * Upper bound of the sampling size
+   */
+  #upperBound = 0;
+  /**
+   * Total size of the sampling
+   */
+  #totalSize = 0;
+  /**
+   * Number of events sampled
+   */
+  #sampled = 0;
+  /**
+   * Creates new instance of HeadSampler
+   * @param samplingPercent sampling percentage
+   */
+  constructor(samplingPercent) {
+    const value = percentToFraction(convertToDivisibleBy5(samplingPercent));
+    this.#upperBound = value.numerator;
+    this.#totalSize = value.denominator;
+  }
+  /**
+   * check if the event should be sampled
+   * @returns true if the event should be sampled
+   */
+  shouldSample = () => {
+    this.#sampled += 1;
+    if (this.#sampled <= this.#upperBound) return true;
+    if (this.#sampled === this.#totalSize) this.#sampled = 0;
+    return false;
+  };
+}
+export {
+  HeadSampler
+};

package/dist/esm/utils/micro-frontend/host.js

@@ -46,7 +46,7 @@ class CMicroAppHost {
     };
     this.activeGuests = {};
     this.#ssfHostRef = params?.ssfHostRef || null;
-    const analyticsObj = params?.analytics ?? new Analytics(this.logger);
+    const analyticsObj = params?.analytics ?? new Analytics({ logger: this.logger });
     this.scriptingObjects = {
       analytics: analyticsObj,
       ...params?.scriptingObjects ?? {}

package/dist/esm/utils/micro-frontend/scripting-objects/analytics.js

@@ -1,20 +1,41 @@
 import ssfHost from "@elliemae/em-ssf-host";
 import { getBAEventParameters } from "./web-analytics.js";
 import { getProductAppDetails } from "../../helpers.js";
+import { HeadSampler } from "../../headSampler.js";
 class Analytics extends ssfHost.ScriptingObject {
   /**
    * logger instance
    */
   #logger;
+  /**
+   * sampling size for different events
+   */
+  #samplingSizes = {};
   /**
    * Creates new instance of Analytics scripting object
-   * @param logger instance of PUI Diagnostics logger
+   * @param params Analytics constructor parameters
    */
-  constructor(logger) {
+  constructor(params) {
     super("analytics");
-    this.#logger = logger;
+    this.#logger = params.logger;
+    this.#setupSampling(params.samplingRatios);
     this.#monitorPerformance();
   }
+  /**
+   * setup sampling size for different events
+   * @param samplingSizes sampling sizes for different events
+   */
+  #setupSampling = (samplingSizes = {}) => {
+    Object.keys(samplingSizes).forEach((key) => {
+      this.#samplingSizes[key] = new HeadSampler(samplingSizes[key]);
+    });
+  };
+  /**
+   * check if the event should be sampled and recorded
+   * @param name name of the event
+   * @returns true if the event should be sampled and recorded
+   */
+  #shouldSampleandRecord = (name) => this.#samplingSizes[name] ? this.#samplingSizes[name].shouldSample() : true;
   /**
    * monitor performance and report to GTM
    */
@@ -24,18 +45,28 @@ class Analytics extends ssfHost.ScriptingObject {
         for (const entry of list.getEntries()) {
           switch (entry.entryType) {
             case "measure": {
+              if (!this.#shouldSampleandRecord(entry.name)) return;
               const detail = entry.detail ?? {};
+              const duration = entry.duration.toString();
+              const startTime = new Date(
+                performance.timeOrigin + entry.startTime
+              ).toISOString();
               this.sendBAEvent({
                 event: "timing",
                 name: entry.name,
-                duration: entry.duration.toString(),
-                startTime: new Date(
-                  performance.timeOrigin + entry.startTime
-                ).toISOString(),
+                duration,
+                startTime,
                 ...getBAEventParameters(),
                 ...detail
               }).catch(() => {
               });
+              this.#logger.info({
+                message: "timing",
+                event: entry.name,
+                duration,
+                startTime,
+                detail
+              });
               break;
             }
             default:

package/dist/types/lib/utils/headSampler.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Samples events based on the sampling size
+ */
+export declare class HeadSampler {
+    #private;
+    /**
+     * Creates new instance of HeadSampler
+     * @param samplingPercent sampling percentage
+     */
+    constructor(samplingPercent: number);
+    /**
+     * check if the event should be sampled
+     * @returns true if the event should be sampled
+     */
+    shouldSample: () => boolean;
+}

package/dist/types/lib/utils/micro-frontend/host.d.ts

@@ -2,8 +2,9 @@ import { History, To } from 'history';
 import { DefaultTheme } from 'styled-components';
 import { IMicroAppHost, ResizeEventHandler, BreakpointChangeEventHandler, SubscriptionListener } from '@elliemae/pui-micro-frontend-base';
 import ssfHost from '@elliemae/em-ssf-host';
-import { BAEvent, IAnalytics } from '@elliemae/pui-scripting-object';
+import { BAEvent } from '@elliemae/pui-scripting-object';
 import { MicroFrontEndLogger } from '../types.js';
+import { Analytics } from './scripting-objects/analytics.js';
 type HostOptions = {
     systemVersion: string;
     history: History;
@@ -19,7 +20,7 @@ type ConstructorParams = {
     onRenewSessionTimer?: () => void;
     onInit?: OnInitCallback;
     ssfHostRef?: typeof ssfHost.Host;
-    analytics?: IAnalytics;
+    analytics?: Analytics;
 };
 export declare class CMicroAppHost implements IMicroAppHost {
     #private;

package/dist/types/lib/utils/micro-frontend/scripting-objects/analytics.d.ts

@@ -1,6 +1,21 @@
 import ssfHost from '@elliemae/em-ssf-host';
 import { IAnalytics, BAEvent, TimingOptions } from '@elliemae/pui-scripting-object';
 import { MicroFrontEndLogger } from '../../types.js';
+/**
+ * Analytics constructor parameters
+ */
+type AnalyticsParams = {
+    /**
+     * logger instance
+     */
+    logger: MicroFrontEndLogger;
+    /**
+     * sampling ratios for different events
+     * ratio is a number between 0 and 1
+     * @example { 'event1': 0.1, 'event2': 0.5 }
+     */
+    samplingRatios?: Record<string, number>;
+};
 /**
  * Analytics scripting object
  */
@@ -8,9 +23,9 @@ export declare class Analytics extends ssfHost.ScriptingObject implements IAnaly
     #private;
     /**
      * Creates new instance of Analytics scripting object
-     * @param logger instance of PUI Diagnostics logger
+     * @param params Analytics constructor parameters
      */
-    constructor(logger: MicroFrontEndLogger);
+    constructor(params: AnalyticsParams);
     /**
      * send business analytics event
      * @param event business analytics event
@@ -43,3 +58,4 @@ export declare class Analytics extends ssfHost.ScriptingObject implements IAnaly
      */
     endTiming: (start: string | PerformanceMeasure, options: TimingOptions) => Promise<void>;
 }
+export {};