@imtbl/sdk 1.5.2 → 1.5.3-alpha

package/dist/config.js

@@ -1,4 +1,6 @@
 import axios from 'axios';
+import { memorise } from 'lru-memorise';
+import { getGlobalisedValue as getGlobalisedValue$1 } from 'global-const';
 
 const isNode = () => typeof window === 'undefined';
 const isBrowser = () => !isNode();
@@ -13,12 +15,6 @@ var Detail;
     Detail["DOMAIN"] = "domain";
     Detail["SDK_VERSION"] = "sdkVersion";
 })(Detail || (Detail = {}));
-var Store;
-(function (Store) {
-    Store["EVENTS"] = "events";
-    Store["RUNTIME"] = "runtime";
-})(Store || (Store = {}));
-const POLLING_FREQUENCY = 5000;
 
 const IMTBL_API = 'https://api.x.immutable.com';
 async function post(path, data) {
@@ -78,6 +74,11 @@ const setItem = (key, payload) => {
     return false;
 };
 
+var Store;
+(function (Store) {
+    Store["EVENTS"] = "events";
+    Store["RUNTIME"] = "runtime";
+})(Store || (Store = {}));
 // In memory storage for events and other data
 let EVENT_STORE;
 let RUNTIME_DETAILS;
@@ -127,9 +128,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.2';
-let initialised = false;
-const isInitialised = () => initialised;
+const SDK_VERSION = '1.5.3-alpha';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -166,21 +165,28 @@ const getRuntimeDetails = () => {
         screen: `${window.screen.width}x${window.screen.height}`,
     };
 };
+let initialised = false;
+const isInitialised = () => initialised;
 const initialise = async () => {
-    const runtimeDetails = flattenProperties(getRuntimeDetails());
-    const existingRuntimeId = getDetail(Detail.RUNTIME_ID);
-    const body = {
-        version: 1,
-        data: {
-            runtimeDetails,
-            runtimeId: existingRuntimeId,
-        },
-    };
-    const response = await post('/v1/sdk/initialise', body);
-    // Get runtimeId and store it
-    const { runtimeId } = response;
-    storeDetail(Detail.RUNTIME_ID, runtimeId);
     initialised = true;
+    try {
+        const runtimeDetails = flattenProperties(getRuntimeDetails());
+        const existingRuntimeId = getDetail(Detail.RUNTIME_ID);
+        const body = {
+            version: 1,
+            data: {
+                runtimeDetails,
+                runtimeId: existingRuntimeId,
+            },
+        };
+        const response = await post('/v1/sdk/initialise', body);
+        // Get runtimeId and store it
+        const { runtimeId } = response;
+        storeDetail(Detail.RUNTIME_ID, runtimeId);
+    }
+    catch (error) {
+        initialised = false;
+    }
 };
 
 function errorBoundary(fn) {
@@ -212,6 +218,21 @@ function isTestEnvironment() {
     return process.env.JEST_WORKER_ID !== undefined;
 }
 
+const GLOBALISE_KEY = 'imtbl__metrics';
+const MEMORISE_TIMEFRAME = 1000;
+const MEMORISE_MAX = 1000;
+const getGlobalisedValue = (key, value) => getGlobalisedValue$1(GLOBALISE_KEY, key, value);
+const getGlobalisedCachedFunction = (key, fn) => {
+    // Some applications (esp backend, or frontends using the split bundles) can sometimes
+    // initialise the same request multiple times. This will prevent multiple of the
+    // same event,value from being reported in a 1 second period.
+    const memorisedFn = memorise(fn, {
+        lruOptions: { ttl: MEMORISE_TIMEFRAME, max: MEMORISE_MAX },
+    });
+    return getGlobalisedValue$1(GLOBALISE_KEY, key, memorisedFn);
+};
+
+const POLLING_FREQUENCY = 5000;
 // Store the event in the event store
 const trackFn = (moduleName, eventName, properties) => {
     const event = {
@@ -221,7 +242,7 @@ const trackFn = (moduleName, eventName, properties) => {
     };
     addEvent(event);
 };
-const track = errorBoundary(trackFn);
+const track = errorBoundary(getGlobalisedCachedFunction('track', trackFn));
 // Sending events to the server
 const flushFn = async () => {
     // Don't flush if not initialised
@@ -257,19 +278,31 @@ const flushPoll = async () => {
     await flush();
     setTimeout(flushPoll, POLLING_FREQUENCY);
 };
+let flushingStarted = false;
+const startFlushing = () => {
+    if (flushingStarted) {
+        return;
+    }
+    flushingStarted = true;
+    flushPoll();
+};
 // This will get initialised when module is imported.
 if (!isTestEnvironment()) {
-    errorBoundary(flushPoll)();
+    errorBoundary(getGlobalisedValue('startFlushing', startFlushing))();
 }
 
 const setEnvironmentFn = (env) => {
     storeDetail(Detail.ENVIRONMENT, env);
 };
-const setEnvironment = errorBoundary(setEnvironmentFn);
+const setEnvironment = errorBoundary(getGlobalisedValue('setEnvironment', setEnvironmentFn));
+const setPassportClientIdFn = (passportClientId) => {
+    storeDetail(Detail.PASSPORT_CLIENT_ID, passportClientId);
+};
+errorBoundary(getGlobalisedValue('setPassportClientId', setPassportClientIdFn));
 const setPublishableApiKeyFn = (publishableApiKey) => {
     storeDetail(Detail.PUBLISHABLE_API_KEY, publishableApiKey);
 };
-const setPublishableApiKey = errorBoundary(setPublishableApiKeyFn);
+const setPublishableApiKey = errorBoundary(getGlobalisedValue('setPublishableApiKey', setPublishableApiKeyFn));
 
 var Environment;
 (function (Environment) {