Merge pull request #403 from UMD-ARLIS/jsonschema

Jsonschema

Author: Jyyjy

build/UserALEWebExtension/content.js

@@ -1083,7 +1083,6 @@ function setup(config) {
         started = config.on = true;
         packageCustomLog({
           type: 'load',
-          logType: 'raw',
           details: {
             pageLoadTime: endLoadTimestamp - startLoadTimestamp
           }

build/userale-2.4.0.js

@@ -1218,7 +1218,6 @@
           exports.started = config.on = true;
           packageCustomLog({
             type: 'load',
-            logType: 'raw',
             details: {
               pageLoadTime: endLoadTimestamp - startLoadTimestamp
             }

build/userale-2.4.0.min.js

@@ -0,0 +1,125 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://flagon.incubator.apache.org/log.schema.json",
+    "title": "Log",
+    "description": "A raw or custom log produced by userale",
+    "type": "object",
+    "properties": {
+        "target": {
+            "type": "string"
+        },
+        "path": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "minItems": 1
+        },
+        "pageUrl": {
+            "type": "string"
+        },
+        "pageTitle": {
+            "type": "string"
+        },
+        "browser": {
+            "type": "object",
+            "properties": {
+                "browser": {
+                    "type": "string"
+                },
+                "version": {
+                    "type": "string"
+                }
+            },
+            "required" : ["browser", "version"]
+        },
+        "clientTime": {
+            "type": "integer"
+        },
+        "microTime": {
+            "type": "number",
+            "minimum": 0,
+            "maxmaximumi": 1
+        },
+        "location": {
+          "type": "object",
+          "properties": {
+              "x": {
+                  "type": ["integer", "null"]
+              },
+              "y": {
+                  "type": ["integer", "null"]
+              }
+          },
+          "required" : ["x", "y"]
+        },
+        "scrnRes": {
+          "type": "object",
+          "properties": {
+              "height": {
+                  "type": "integer"
+              },
+              "width": {
+                  "type": "integer"
+              }
+          },
+          "required" : ["height", "width"]
+        },
+        "type": {
+          "type": "string"
+        },
+        "logType": {
+          "type": "string",
+          "enum": ["raw", "custom"]
+        },
+        "userAction": {
+          "type": "boolean"
+        },
+        "details": {
+          "type": "object"
+        },
+        "userId": {
+          "type": "string"
+        },
+        "toolVersion": {
+          "type": "string"
+        },
+        "toolName": {
+          "type": "string"
+        },
+        "useraleVersion": {
+          "type": "string"
+        },
+        "sessionID": {
+          "type": "string"
+        }
+    },
+    "required": [
+        "pageUrl",
+        "pageTitle",
+        "pageReferrer",
+        "browser",
+        "clientTime",
+        "scrnRes",
+        "logType",
+        "userAction",
+        "details",
+        "userId",
+        "toolVersion",
+        "toolName",
+        "useraleVersion",
+        "sessionID"
+    ],
+    "if": {
+        "properties": { "logType": { "const": "raw" } }
+    },
+    "then": {
+        "required": [
+            "target",
+            "path",
+            "microTime",
+            "location",
+            "type"
+        ]
+    }
+}

example/log.schema.json

@@ -14,6 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { validate } from 'jsonschema';
+
 describe('Userale logging', () => {
     beforeEach(() => {
         cy.intercept('POST', 'http://localhost:8000/').as('backend')
@@ -26,7 +28,7 @@ describe('Userale logging', () => {
             const pageLoadLog = body[0]
             expect(pageLoadLog['details']['pageLoadTime']).to.be.greaterThan(0)
             expect(pageLoadLog).to.contain({
-                logType: 'raw',
+                logType: 'custom',
                 type: 'load'
             })
         })
@@ -62,4 +64,24 @@ describe('Userale logging', () => {
             expect(actualValue).to.equal(expectedValue)
         })
     });
+
+    it('produces valid logs', () => {
+        cy.visit('http://localhost:8000');
+        cy.wait('@backend').then(xhr => {
+            var schema = require('../example/log.schema.json');
+            for(const log of xhr.request.body) {
+                const result = validate(log, schema);
+                expect(result.valid, result.errors).to.equal(true);
+            }
+        })
+        cy.contains(/click me/i).click();
+        cy.wait('@backend').then(xhr => {
+            var schema = require('../example/log.schema.json');
+            for(const log of xhr.request.body) {
+                const result = validate(log, schema);
+                expect(result.valid, result.errors).to.equal(true);
+            }
+        })
+    });
+
 });

journey/userale.journey.cy.js

@@ -69,6 +69,7 @@
     "express": "^4.18.2",
     "global-jsdom": "^9.1.0",
     "jsdom": "^22.1.0",
+    "jsonschema": "^1.4.1",
     "mocha": "^10.2.0",
     "nodemon": "^3.0.2",
     "rollup": "^4.6.1",

package-lock.json

@@ -70,7 +70,6 @@ function setup(config) {
                 started = config.on = true;
                 packageCustomLog({
                     type: 'load',
-                    logType: 'raw',
                     details: {pageLoadTime: endLoadTimestamp - startLoadTimestamp}
                     }, () => {},false)
             } else {