@exodus/analytics - npm Package Compare versions

Comparing version 2.1.0 to 3.0.0

module/index.js

 import ExodusModule from '@exodus/module'
 import { fetchival } from '@exodus/fetch'
+import validateEvent from './schemas/main.schemasafe.json'
 
@@ -18,2 +19,3 @@ // { experimentName: variant } -> ['experimentName:variant']
   #installEventReportingUrl = null
+  #trackUnvalidated = false
 
@@ -42,2 +44,3 @@ #checkRequiredOptions = (options) => {
       config: { installEventReportingUrl } = {},
+      trackUnvalidated,
     } = options
@@ -49,2 +52,3 @@
     this.#installEventReportingUrl = installEventReportingUrl // optional
+    this.#trackUnvalidated = trackUnvalidated
   }
@@ -111,2 +115,9 @@
     try {
+      validateEvent(args)
+    } catch (err) {
+      this._logger.warn(err.message, `for event '${args.name}'`)
+      if (this.#trackUnvalidated !== true) return
+    }
+
+    try {
       if (this.#connected && (await this.#canTrack(force))) {
@@ -113,0 +124,0 @@ await this.#tracker.track(args)

package.json

 {
   "name": "@exodus/analytics",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "This library abstracts analytics reporting.",
@@ -8,2 +8,3 @@ "files": [
     "atoms",
+    "schemasafe.config.js",
     "!**/__tests__"
@@ -32,2 +33,4 @@ ],
   "devDependencies": {
+    "@exodus/schemasafe": "^1.0.0",
+    "@exodus/schemasafe-babel-plugin": "^0.0.1",
     "eslint": "^8.33.0"
@@ -38,3 +41,3 @@ },
   },
-  "gitHead": "ba219ca9ea31decf1de775be9a59a56bb8bb2128"
+  "gitHead": "17e471e85bde8c5e4abdc0dabdd49a8be850de76"
 }

README.md

@@ -36,2 +36,3 @@ # Exodus analytics
 | shareActivityAtom               | yes      | An [atom](https://github.com/ExodusMovement/exodus-hydra/tree/master/modules/atoms/src) returning a boolean value indicating if a consumer application is ready to send events. |
+| trackUnvalidated                | no       | A boolean flag indicating if not validated events should be still submitted to Segment API. `false` by default                                                                  |
 | config                          | no       | Static configuration options                                                                                                                                                    |
@@ -38,0 +39,0 @@ | config.installEventReportingUrl | no       | Url to which to post app install events                                                                                                                                         |

New alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10300

increased by36.9%

Number of package files

8

increased by60%

Lines of code

197

increased by66.95%

Number of lines in readme file

48

increased by2.13%

Worsened metrics

Dev dependency count

3

increased by200%

Number of low supply chain risk alerts

1

increased byInfinity%

No dependency changes