@exodus/analytics-validation 1.0.1-alpha.7 → 1.1.0-alpha.0

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.1.0-alpha.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/analytics-validation@1.0.1-alpha.8...@exodus/analytics-validation@1.1.0-alpha.0) (2023-05-10)
+
+### Features
+
+- support `unknown_unknown` locale ([#1606](https://github.com/ExodusMovement/exodus-hydra/issues/1606)) ([ccb95fd](https://github.com/ExodusMovement/exodus-hydra/commit/ccb95fdbf28484f1f920e4f630b328266b722de2))
+
+### Bug Fixes
+
+- **analytics:** client migration ([#1551](https://github.com/ExodusMovement/exodus-hydra/issues/1551)) ([a02b101](https://github.com/ExodusMovement/exodus-hydra/commit/a02b101f8d7177eb8e43634282bfedcb516cb539))
+
+## [1.0.1-alpha.8](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/analytics-validation@1.0.1-alpha.7...@exodus/analytics-validation@1.0.1-alpha.8) (2023-04-27)
+
+### Features
+
+- add schemas for new backup events ([#1421](https://github.com/ExodusMovement/exodus-hydra/issues/1421)) ([cc84ca8](https://github.com/ExodusMovement/exodus-hydra/commit/cc84ca84a51e4cbe6d2a431b4a26b4ca202c5cf1))
+
+### Bug Fixes
+
+- **analytics-validation:** test coverage ([#1376](https://github.com/ExodusMovement/exodus-hydra/issues/1376)) ([26c2140](https://github.com/ExodusMovement/exodus-hydra/commit/26c21407389308fd1633e00fa5412a92f9dfeae7))
+
 ## [1.0.1-alpha.7](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/analytics-validation@1.0.1-alpha.6...@exodus/analytics-validation@1.0.1-alpha.7) (2023-04-21)
 
 ### Bug Fixes

package/README.md

@@ -1,3 +1,18 @@
 # @exodus/analytics-validation
 
-## Usage
+## Development
+
+Before adding a new schema, double check if a subdirectory (essentially an event domain, e.g. `dapps`) already exists in `./src`.
+If not, you will have to come up with a subdirectory name during the next steps.
+
+To add a new schema run
+
+> yarn generate:analytics-validation
+
+in the project root. The CLI tool will ask you for all details needed.
+Once the schema is created, make sure to
+
+1. Add a reference to the just generated schema in [main.schemasafe.json](./src/main.schemasafe.json);
+2. Fill the schema with the expected properties and their types. The property names should be in the snake case (e.g. `expected_property`);
+3. Fix the generated unit test as it will be intentionally failing;
+4. Add your own test cases to ensure the schema works properly before merging the PR and publishing a new version.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/analytics-validation",
-  "version": "1.0.1-alpha.7",
+  "version": "1.1.0-alpha.0",
   "description": "The analytics-validation library",
   "author": "Exodus Movement Inc",
   "repository": {
@@ -32,5 +32,5 @@
     "eslint": "^8.33.0",
     "jest": "^29.1.2"
   },
-  "gitHead": "00b238c7c460a0bd58a3fb284a167399ac5d8bd1"
+  "gitHead": "9698337f5775e439007aff5718c12ef87d0691b2"
 }

package/schemasafe.config.js

@@ -1,25 +1,30 @@
 const fs = require('fs')
 const path = require('path')
 
-const schemasDirPath = path.join(__dirname, './src')
-const schemaNames = fs.readdirSync(schemasDirPath)
-
 const schemas = {}
-for (const schemaName of schemaNames) {
-  if (schemaName === 'main.schemasafe.json') continue
-  const schemaPath = path.join(schemasDirPath, schemaName)
 
-  if (fs.statSync(schemaPath).isDirectory()) {
-    if (schemaName === '__tests__') continue
-    throw new Error('unexpected directory in schemas folder')
-  }
+const getSchemas = ({ schemaDir, schemaNames }) => {
+  for (const schemaName of schemaNames) {
+    if (schemaName === 'main.schemasafe.json') continue
+    const schemaPath = path.join(schemaDir, schemaName)
 
-  // primitive-type.schemafe.json -> primitive-type
-  const name = schemaName.slice(0, schemaName.indexOf('.'))
-  const schemaString = fs.readFileSync(schemaPath, 'utf8')
-  schemas[name] = JSON.parse(schemaString)
+    if (fs.statSync(schemaPath).isDirectory()) {
+      if (schemaName === '__tests__') continue
+      getSchemas({ schemaDir: schemaPath, schemaNames: fs.readdirSync(schemaPath) })
+    } else {
+      // primitive-type.schemafe.json -> primitive-type
+      const name = schemaName.slice(0, schemaName.indexOf('.'))
+      const schemaString = fs.readFileSync(schemaPath, 'utf8')
+      schemas[name] = JSON.parse(schemaString)
+    }
+  }
 }
 
+const schemaDir = path.join(__dirname, './src')
+const schemaNames = fs.readdirSync(schemaDir)
+
+getSchemas({ schemaDir, schemaNames })
+
 // Source: https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
 const semVerRegEx =
   /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[A-Za-z-][\dA-Za-z-]*)(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][\dA-Za-z-]*))*))?(?:\+([\dA-Za-z-]+(?:\.[\dA-Za-z-]+)*))?$/

package/src/backup/check-backup-quiz-completed.schemasafe.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "CheckBackupQuizCompleted"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "invalid_option_click_count": {
+          "type": "number"
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/src/backup/write-phrase-screen-exit.schemasafe.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "WritePhraseScreenExit"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "phrase_revealed_duration_ms": {
+          "type": "number"
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/src/common-properties.schemasafe.json

@@ -123,6 +123,9 @@
           "format": "locale",
           "maxLength": 10,
           "$comment": "Max length is arbitrary"
+        },
+        {
+          "enum": ["unknown_unknown", "unknown-unknown"]
         }
       ]
     },

package/src/main.schemasafe.json

@@ -22,6 +22,12 @@
     {
       "$ref": "backup-prompt-view#"
     },
+    {
+      "$ref": "check-backup-quiz-completed#"
+    },
+    {
+      "$ref": "write-phrase-screen-exit#"
+    },
     {
       "$ref": "balance-fetch-network-error-notice#"
     },

package/src/onboarding/client-migration-run.schemasafe.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "ClientMigrationRun"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "migration_id": {
+          "type": "string",
+          "format": "any-string"
+        },
+        "success": {
+          "type": "boolean"
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/src/client-migration-run.schemasafe.json

@@ -1,37 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "event": {
-      "const": "ClientMigrationRun"
-    },
-    "properties": {
-      "allOf": [
-        {
-          "$ref": "common-properties#"
-        }
-      ],
-      "type": "object",
-      "required": [],
-      "properties": {
-        "migration_id": {
-          "type": "string",
-          "enum": [
-            "encrypt-fusion-storage",
-            "encrypt-orders-storage",
-            "encrypt-synced-balances-storage",
-            "encrypt-wallet-accounts-storage",
-            "nfts-hidden-config",
-            "revoke-connections"
-          ]
-        },
-        "success": {
-          "type": "boolean"
-        }
-      },
-      "unevaluatedProperties": false
-    }
-  },
-  "unevaluatedProperties": false,
-  "required": ["event", "properties"]
-}