@mrporter/frontend-monitoring - npm Package Compare versions

Comparing version 3.0.2 to 4.0.0

dist/index.js

@@ -6,2 +6,5 @@ 'use strict';
 });
+
+var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
+
 exports.setupMonitoring = setupMonitoring;
@@ -20,11 +23,33 @@ exports.trackEvent = trackEvent;
 
+function _objectWithoutProperties(obj, keys) { var target = {}; for (var i in obj) { if (keys.indexOf(i) >= 0) continue; if (!Object.prototype.hasOwnProperty.call(obj, i)) continue; target[i] = obj[i]; } return target; }
+
 var client = void 0;
 
-function setupMonitoring(config) {
-    var properties = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : defaultProperties;
+function setupMonitoring() {
+    var config = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
 
-    if (config && config.projectId) {
-        client = new _keenTracking2.default(config);
-        client.extendEvents(properties);
+    var _config$globalPropert = config.globalProperties,
+        globalProperties = _config$globalPropert === undefined ? {} : _config$globalPropert,
+        keenConfig = _objectWithoutProperties(config, ['globalProperties']);
+
+    var app_name = globalProperties.app_name,
+        business = globalProperties.business;
+
+
+    if (process && process.env && process.env.NODE_ENV !== 'production') {
+        if (!app_name) {
+            console.warn('Warning: No app_name property set');
+        }
+
+        if (!business) {
+            console.warn('Warning: No business property set');
+        }
     }
+
+    if (keenConfig.projectId) {
+        client = new _keenTracking2.default(keenConfig);
+        client.extendEvents(function () {
+            return mergeWithDefaultProperties(globalProperties);
+        });
+    }
     return client;
@@ -62,4 +87,4 @@ }
 
-function defaultProperties() {
-    return {
+function mergeWithDefaultProperties(properties) {
+    return _extends({}, properties, {
         ip_address: '${keen.ip}',
@@ -96,3 +121,3 @@ user_agent: '${keen.user_agent}',
         }
-    };
+    });
 }

package.json

 {
   "name": "@mrporter/frontend-monitoring",
-  "version": "3.0.2",
+  "version": "4.0.0",
   "description": "Utils and Events for MRP front end monitoring",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -14,5 +14,12 @@ # MRP Front End Monitoring
     projectId: 'abc123',
-    writeKey: 'def456'
+    writeKey: 'def456',
+    properties: {
+        app_name: 'myaccount',
+        business: 'mrporter'
+    }
 });
 ```
+
+The properties object can contain any default properties you want to pass with every event. You can specify an app_name property and business here to easily differentiate when querying keen. If these aren't set, a warning will be logged to the console in dev mode. 
+
 If no projectId is passed in, `trackEvent` will log events to the console ('dev mode') rather than attempt to fire off events to keen.
@@ -19,0 +26,0 @@ ### API

New alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 2 instances in 1 package

Improved metrics

Total package byte prevSize

9614

increased by18.96%

Lines of code

154

increased by12.41%

Number of lines in readme file

73

increased by10.61%

Worsened metrics

Number of low supply chain risk alerts

3

increased by200%

No dependency changes