Proposal to upgrade schema to Json 2020-12 (#833)

* Upgraded validation schema from draft 07 to 2020-12 * Commented out product urls not following RFC3986 Thermocon product paths needs to be updated to follow RFC3986 * Clean up dependencies * Ajv cli security patch * Update URLs to comply with RFC3986 --------- Co-authored-by: Johan Stokking <[email protected]>
TheThingsNetwork · Oct 14, 2024 · 584ec7f · 584ec7f
1 parent 2286a21
commit 584ec7f
Show file tree

Hide file tree

Showing 10 changed files with 662 additions and 189 deletions.
diff --git a/bin/validate.js b/bin/validate.js
@@ -1,6 +1,8 @@
 #!/usr/bin/env node
 
-const Ajv = require('ajv');
+const Ajv = require('ajv/dist/2020');
+const addFormats = require('ajv-formats');
+
 const yargs = require('yargs');
 const fs = require('fs');
 const yaml = require('js-yaml');
@@ -11,6 +13,7 @@ const readChunk = require('read-chunk');
 const imageType = require('image-type');
 
 const ajv = new Ajv({ schemas: [require('../lib/payload.json'), require('../schema.json')] });
+addFormats(ajv);
 
 const options = yargs
   .usage('Usage: --vendor <file> [--vendor-id <id>]')
@@ -26,21 +29,12 @@ const options = yargs
     type: 'string',
   }).argv;
 
-let validateVendorsIndex = ajv.compile({
-  $ref: 'https://schema.thethings.network/devicerepository/1/schema#/definitions/vendorsIndex',
-});
-let validateVendorIndex = ajv.compile({
-  $ref: 'https://schema.thethings.network/devicerepository/1/schema#/definitions/vendorIndex',
-});
-let validateEndDevice = ajv.compile({
-  $ref: 'https://schema.thethings.network/devicerepository/1/schema#/definitions/endDevice',
-});
-let validateEndDeviceProfile = ajv.compile({
-  $ref: 'https://schema.thethings.network/devicerepository/1/schema#/definitions/endDeviceProfile',
-});
-let validateEndDevicePayloadCodec = ajv.compile({
-  $ref: 'https://schema.thethings.network/devicerepository/1/schema#/definitions/endDevicePayloadCodec',
-});
+const schemaId = 'https://schema.thethings.network/devicerepository/1/schema';
+const validateVendorsIndex = ajv.getSchema(`${schemaId}#/$defs/vendorsIndex`);
+const validateVendorIndex = ajv.getSchema(`${schemaId}#/$defs/vendorIndex`);
+const validateEndDevice = ajv.getSchema(`${schemaId}#/$defs/endDevice`);
+const validateEndDeviceProfile = ajv.getSchema(`${schemaId}#/$defs/endDeviceProfile`);
+const validateEndDevicePayloadCodec = ajv.getSchema(`${schemaId}#/$defs/endDevicePayloadCodec`);
 
 function requireFile(path) {
   if (path.toLowerCase() !== path) {
@@ -206,7 +200,7 @@ function requireImageDecode(fileName) {
 }
 
 function formatValidationErrors(errors) {
-  return errors.map((e) => `${e.dataPath} ${e.message}`);
+  return errors.map((e) => `${e.instancePath} ${e.message}`);
 }
 
 const vendors = yaml.load(fs.readFileSync(options.vendor));
@@ -283,17 +277,18 @@ vendors.vendors.forEach((v) => {
     console.log(`${v.id}: valid index`);
 
     const codecs = {};
-
     const deviceNames = {};
 
     vendor.endDevices.forEach(async (d) => {
       const key = `${v.id}: ${d}`;
       const endDevicePath = `${folder}/${d}.yaml`;
       const endDevice = yaml.load(fs.readFileSync(endDevicePath));
+
       if (!validateEndDevice(endDevice)) {
         console.error(`${key}: invalid: ${formatValidationErrors(validateEndDevice.errors)}`);
         process.exit(1);
       }
+
       console.log(`${key}: valid`);
 
       // Create a regex to check if the vendor's name is a standalone word in the device name

diff --git a/lib/payload.json b/lib/payload.json
@@ -1,9 +1,9 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://schema.thethings.network/devicerepository/1/payload/schema",
   "title": "LoRaWAN Device Repository Payload",
   "description": "Payload definitions for the LoRaWAN Device Repository",
-  "definitions": {
+  "$defs": {
     "temperature": {
       "type": "number",
       "description": "Temperature (°C)",
@@ -66,15 +66,15 @@
           "properties": {
             "depth": {
               "description": "Depth of the soil measurement (cm)",
-              "$ref": "#/definitions/depth"
+              "$ref": "#/$defs/depth"
             },
             "moisture": {
               "description": "Soil moisture (%)",
-              "$ref": "#/definitions/percentage"
+              "$ref": "#/$defs/percentage"
             },
             "temperature": {
               "description": "Soil temperature (°C)",
-              "$ref": "#/definitions/temperature"
+              "$ref": "#/$defs/temperature"
             },
             "ec": {
               "description": "Soil electrical conductivity (dS/m)",
@@ -84,19 +84,19 @@
             },
             "pH": {
               "description": "Soil pH level",
-              "$ref": "#/definitions/pH"
+              "$ref": "#/$defs/pH"
             },
             "n": {
               "description": "Concentration of Nitrogen in the soil (ppm)",
-              "$ref": "#/definitions/concentration"
+              "$ref": "#/$defs/concentration"
             },
             "p": {
               "description": "Concentration of Phosphorus in the soil (ppm)",
-              "$ref": "#/definitions/concentration"
+              "$ref": "#/$defs/concentration"
             },
             "k": {
               "description": "Concentration of Potassium in the soil (ppm)",
-              "$ref": "#/definitions/concentration"
+              "$ref": "#/$defs/concentration"
             }
           },
           "additionalProperties": false
@@ -111,11 +111,11 @@
             },
             "temperature": {
               "description": "Air temperature (°C)",
-              "$ref": "#/definitions/temperature"
+              "$ref": "#/$defs/temperature"
             },
             "relativeHumidity": {
               "description": "Relative humidity (%)",
-              "$ref": "#/definitions/percentage"
+              "$ref": "#/$defs/percentage"
             },
             "pressure": {
               "type": "number",
@@ -125,11 +125,11 @@
             },
             "co2": {
               "description": "Concentration of CO2 in the air (ppm)",
-              "$ref": "#/definitions/concentration"
+              "$ref": "#/$defs/concentration"
             },
             "lightIntensity": {
               "description": "Light intensity (lux)",
-              "$ref": "#/definitions/illuminance"
+              "$ref": "#/$defs/illuminance"
             }
           },
           "additionalProperties": false
@@ -139,11 +139,11 @@
           "properties": {
             "speed": {
               "description": "Wind speed (m/s)",
-              "$ref": "#/definitions/speed"
+              "$ref": "#/$defs/speed"
             },
             "direction": {
               "description": "Wind direction (°)",
-              "$ref": "#/definitions/direction"
+              "$ref": "#/$defs/direction"
             }
           },
           "additionalProperties": false
@@ -160,19 +160,19 @@
               "properties": {
                 "min": {
                   "description": "Minimum temperature (°C)",
-                  "$ref": "#/definitions/temperature"
+                  "$ref": "#/$defs/temperature"
                 },
                 "max": {
                   "description": "Maximum temperature (°C)",
-                  "$ref": "#/definitions/temperature"
+                  "$ref": "#/$defs/temperature"
                 },
                 "avg": {
                   "description": "Average temperature (°C)",
-                  "$ref": "#/definitions/temperature"
+                  "$ref": "#/$defs/temperature"
                 },
                 "current": {
                   "description": "Current temperature (°C)",
-                  "$ref": "#/definitions/temperature"
+                  "$ref": "#/$defs/temperature"
                 }
               }
             }
@@ -238,13 +238,13 @@
     "uplinkPayload": {
       "type": "array",
       "items": {
-        "$ref": "#/definitions/measurement"
+        "$ref": "#/$defs/measurement"
       }
     }
   },
   "oneOf": [
     {
-      "$ref": "#/definitions/uplinkPayload"
+      "$ref": "#/$defs/uplinkPayload"
     }
   ]
 }