add validation for config json

WIPACrepo · Oct 15, 2024 · c31a111 · c31a111
1 parent ae8c084
commit c31a111
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 6 deletions.
diff --git a/iceprod/core/data/dataset.schema.json b/iceprod/core/data/dataset.schema.json
@@ -1,6 +1,6 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://iceprod2.icecube.wisc.edu/static/dataset.schema.json",
+  "$id": "https://iceprod.icecube.aq/schemas/v3/dataset.schema.json",
   "title": "IceProd Dataset Config",
   "description": "The schema for an IceProd Dataset Config",
   "type": "object",

diff --git a/iceprod/server/data/config.schema.json b/iceprod/server/data/config.schema.json
@@ -1,6 +1,6 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://iceprod2.icecube.wisc.edu/static/config.schema.json",
+  "$id": "https://iceprod.icecube.aq/schemas/v3/config.schema.json",
   "title": "IceProd Server Config",
   "description": "The schema for an IceProd Server Config",
   "type": "object",

diff --git a/iceprod/website/data/www_templates/submit.html b/iceprod/website/data/www_templates/submit.html
@@ -71,16 +71,34 @@ <h4>$(task)</h4>
 {% block body_scripts %}
 <script src="/static/fetch.js"></script>
 <script type="text/javascript" src="/static/rest.js"></script>
-<!--<script type="text/javascript" src="/static/dataclasses.js"></script>
-<script type="text/javascript" src="/static/jsviews.min.js"></script>
-<script type="text/javascript" src="/static/documentation.js"></script>
-<script type="text/javascript" src="/static/jsonlint.js"></script>-->
+<script src="https://cdnjs.cloudflare.com/ajax/libs/ajv/8.17.1/ajv2020.bundle.min.js" integrity="sha512-mXlpzWzZB+t4DFFezQkpSiCbT8aW12t688aLsd6KGNbRWDOdCur5C6Fl0rDl75VruBy42GvWsd6F35VQcs3lwQ==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
 <script type="text/javascript">
 var rest_api = '{{ rest_api }}';
 var passkey = '{{ passkey }}';
 var orig_config = {{ json_encode(config) }};
 var edit = {{ json_encode(edit) }};
 var dataset_id = '{{ dataset_id }}';
+
+async function validator(config) {
+    try {
+        const ret = await fetch(rest_api + '/schemas/dataset.schema.json');
+        if (!response.ok) {
+            throw new Error('Response status: '+response.status);
+        }
+        const schema = await ret.json();
+    } catch (error) {
+        $('#error').text('Error obtaining json schema: '+error.message);
+        return false;
+    }
+    try {
+        const ajv = new Ajv2020({useDefaults: true});
+        const validate = ajv.compile(schema);
+        return validate(config)
+    } catch (error) {
+        $('#error').text('Error validating config: '+validate.errors);
+        return false;
+    }
+}
 function parse_json(config){
     try {
         return JSON.parse(config);
@@ -119,6 +137,12 @@ <h4>$(task)</h4>
     if (ntasks < 0)
         return;
 
+    // validate config
+    const ret = await validator(submit_data);
+    if (!ret) {
+        return;
+    }
+
     // create dataset
     var response = await fetch_json('POST', '/datasets',
         {'description': description,
@@ -141,6 +165,10 @@ <h4>$(task)</h4>
     );
     if ('error' in response) {
         $('#error').text('error uploading config: '+response['error']);
+        await fetch_json('PUT', '/datasets/' + dataset_id + '/status',
+            {'status': 'errors'},
+            passkey
+        );
         return;
     }
     window.location = '/dataset/' + dataset_id;
@@ -150,6 +178,13 @@ <h4>$(task)</h4>
     var submit_data = parse_json($("#submit_box").val());
     if (submit_data == null)
         return;
+
+    // validate config
+    const ret = await validator(submit_data);
+    if (!ret) {
+        return;
+    }
+
     var response = await fetch_json('PUT', '/config/' + dataset_id,
         submit_data, passkey
     );

diff --git a/iceprod/website/server.py b/iceprod/website/server.py
@@ -31,6 +31,8 @@
 
 import iceprod
 from iceprod.roles_groups import GROUPS
+from iceprod.core.config import CONFIG_SCHEMA as DATASET_SCHEMA
+from iceprod.server.config import CONFIG_SCHEMA as SERVER_SCHEMA
 import iceprod.core.functions
 from iceprod.server import documentation
 from iceprod.server.module import FakeStatsClient, StatsClientIgnoreErrors
@@ -260,6 +262,17 @@ async def get(self):
         self.render('main.html')
 
 
+class Schemas(PublicHandler):
+    """Handle /schemas/v3/(.*) urls"""
+    @catch_error
+    async def get(self, schema):
+        if schema == 'dataset.schema.json':
+            self.write(DATASET_SCHEMA)
+        elif schema == 'config.schema.json':
+            self.write(SERVER_SCHEMA)
+        else:
+            raise tornado.web.HTTPError(404, reason='unknown schema')
+
 class Submit(PublicHandler):
     """Handle /submit urls"""
     @authenticated
@@ -790,6 +803,7 @@ def __init__(self):
         server.add_route(r"/", Default, handler_args)
         server.add_route(r"/submit", Submit, handler_args)
         server.add_route(r"/config", Config, handler_args)
+        server.add_route(r"/schemas/v3/([\w\.]+)", Schemas, handler_args)
         server.add_route(r"/dataset", DatasetBrowse, handler_args)
         server.add_route(r"/dataset/(\w+)", Dataset, handler_args)
         server.add_route(r"/dataset/(\w+)/task", TaskBrowse, handler_args)