@reality.eth/reality-eth-lib 3.0.1 → 3.1.1

package/formatters/question.js

@@ -171,7 +171,7 @@ exports.secondsTodHms = function(sec) {
     return dDisplay + hDisplay + mDisplay + sDisplay;
 }
 
-exports.parseQuestionJSON = function(data) {
+exports.parseQuestionJSON = function(data, errors_to_title) {
 
     var question_json;
     try {
@@ -179,23 +179,43 @@ exports.parseQuestionJSON = function(data) {
     } catch(e) {
         question_json = {
             'title': '[Badly formatted question]: ' + data,
-            'type': 'broken-question'
+            'type': 'broken-question',
+            'errors': {"json_parse_failed": true}
         };
     }
     if (question_json['outcomes'] && question_json['outcomes'].length > QUESTION_MAX_OUTCOMES) {
-        throw Error("Too many outcomes");
+        question_json['errors'] = {'too_many_outcomes': true}
+    }
+    if ('type' in question_json && question_json['type'] == 'datetime' && 'precision' in question_json) {
+        if (!(['Y', 'm', 'd', 'H', 'i', 's'].includes(question_json['precision']))) {
+            question_json['errors'] = {'invalid_precision': true};
+        }
+    }
+    // If errors_to_title is specified, we add any error message to the title to make sure we don't lose it
+    if (errors_to_title) {
+        if ('errors' in question_json) {
+            const prependers = {
+                'invalid_precision': 'Invalid date format',
+                'too_many_outcomes': 'Too many outcomes'
+            }
+            for (var e in question_json['errors']) {
+                if (e in prependers) {
+                    question_json['title'] = '['+prependers[e]+'] ' + question_json['title'];
+                }
+            }
+        }
     }
     return question_json;
 
 }
 
-exports.populatedJSONForTemplate = function(template, question) {
+exports.populatedJSONForTemplate = function(template, question, errors_to_title) {
     var qbits = question.split(module.exports.delimiter());
     //console.log('pp', template);
     //console.log('qbits', qbits);
     var interpolated = vsprintf(template, qbits);
     //console.log('resulting template', interpolated);
-    return module.exports.parseQuestionJSON(interpolated);
+    return module.exports.parseQuestionJSON(interpolated, errors_to_title);
 }
 
 exports.encodeText = function(qtype, txt, outcomes, category, lang) {
@@ -292,18 +312,72 @@ exports.getAnswerString = function(question_json, answer) {
             }
             break;
         case 'datetime':
+            let precision = 'd';
+            if ('precision' in question_json && ['Y', 'm', 'd', 'H', 'i', 's'].includes(question_json['precision'])) {
+                precision = question_json['precision'];
+            }
             let ts = parseInt(module.exports.bytes32ToString(answer, question_json));
             let dateObj = new Date(ts * 1000);
-            let year = dateObj.getUTCFullYear();
-            let month = dateObj.getUTCMonth() + 1;
-            let date = dateObj.getUTCDate();
-            label = year + '/' + month + '/' + date;
+
+            const year = dateObj.getUTCFullYear();
+            const month = dateObj.getUTCMonth() + 1;
+            const date = dateObj.getUTCDate();
+            const hour = dateObj.getUTCHours();
+            const min = dateObj.getUTCMinutes();
+            const sec = dateObj.getUTCSeconds();
+
+            // We need whatever the precision states, plus anything above
+            const needy = true;
+            const needm = (precision != 'Y');
+            const needd = needm && (precision != 'm');
+            const needH = needd && (precision != 'd');
+            const needi = needH && (precision != 'H');
+            const needs = needi && (precision != 'i');
+
+            // If anything is set then we've got it.
+            // We also consider that anything required by the precision is there, but set to 0
+            const hass = needs || sec > 0;
+            const hasi = needi || hass || min > 0;
+            const hasH = needH || hasi || hour > 0;
+            const hasd = needd || hasH || date > 1;
+            const hasm = needm || hasd || month > 1;
+            const hasy = true;
+
+            // We'll show an invalid warning if we've got a more precise date than the precision demands
+            let invalid = false;
+            if (!needm && hasm) invalid = true;
+            if (!needd && hasd) invalid = true;
+            if (!needH && hasH) invalid = true;
+            if (!needi && hasi) invalid = true;
+            if (!needs && hass) invalid = true;
+
+            if (invalid) {
+                label = '[Invalid datetime]: ';
+            }
 
             function pad2(n) { return ("0" + n).slice(-2); }
-            time_label = pad2(dateObj.getUTCHours()) + ':' + pad2(dateObj.getUTCMinutes()) + ':' + pad2(dateObj.getUTCSeconds());
-            if (time_label != '00:00:00') {
-                label = label + ' ' + time_label;
+    
+            if (hasy) {
+                label += year;
+            }
+            if (hasm) {
+                label += '-'+pad2(month);
+            }
+            if (hasd) {
+                label += '-'+pad2(date);
+            }
+            if (hasH) {
+                label += ' '+pad2(hour);
+            } 
+            if (hasi) {
+                label += ':'+pad2(min);
+            } else if (hasH) {
+                // "2021-12-23 11" without the minutes at the end is hard to understand so add "hr"
+                label += 'hr';
             }
+            if (hass) {
+                label += ':'+pad2(sec);
+            } 
             break;
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reality.eth/reality-eth-lib",
-  "version": "3.0.1",
+  "version": "3.1.1",
   "description": "Tools for handling questions in the reality.eth fact verification platform",
   "scripts": {
     "test": "env TZ='Asia/Kabul' mocha ./test"
@@ -16,14 +16,14 @@
   "author": "Edmund Edgar (https://reality.eth.link)",
   "license": "GPL-3.0",
   "dependencies": {
-    "@reality.eth/contracts": "^3.0.1",
+    "@reality.eth/contracts": "^3.0.3",
     "bignumber.js": "^7.2.1",
-    "bn.js": "^4.11.8",
+    "bn.js": "^5.2.1",
     "ethereumjs-abi": "^0.6.5",
     "sprintf-js": "^1.1.1"
   },
   "devDependencies": {
-    "chai": "^4.1.2",
+    "chai": "^4.3.6",
     "chai-bignumber": "^2.0.2",
     "mocha": "^5.2.0",
     "truffle": "^4.0.1"
@@ -36,5 +36,5 @@
     "url": "https://github.com/RealityETH/monorepo/issues"
   },
   "homepage": "https://reality.eth.link",
-  "gitHead": "ec3439b604fe5fc18f20ad26cb30f2e511629a71"
+  "gitHead": "b9fcb24ff3274a58c4f98c0c97b58c4d5c5b0fcd"
 }

package/test/formatters.js

@@ -116,13 +116,66 @@ describe('Answer strings', function() {
     expect(rc_question.getAnswerString(q, '0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff')).to.equal('-1e-18');
   });
   */
-  it('Handles datetimes as expected', function() {
+  it('Handles datetimes of default precision as expected', function() {
     var q = rc_question.populatedJSONForTemplate(rc_template.defaultTemplateForType('datetime'), '');
-    expect(rc_question.getAnswerString(q, '0x0000000000000000000000000000000000000000000000000000000000000000')).to.equal('1970/1/1');
-    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0DE980')).to.equal('2018/5/30');
-    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0DE981')).to.equal('2018/5/30 00:00:01');
-    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0E02F7')).to.equal('2018/5/30 01:48:39'); // TODO: Change this to include time if it's not 00:00
+    expect(rc_question.getAnswerString(q, '0x0000000000000000000000000000000000000000000000000000000000000000')).to.equal('1970-01-01');
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0DE980')).to.equal('2018-05-30');
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0DE981')).to.equal('[Invalid datetime]: 2018-05-30 00:00:01');
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0E02F7')).to.equal('[Invalid datetime]: 2018-05-30 01:48:39');
   });
+  it('Handles datetimes of specified precision as expected', function() {
+    var q = rc_question.populatedJSONForTemplate(rc_template.defaultTemplateForType('datetime'), '');
+    q['precision'] = 'd';
+    expect(rc_question.getAnswerString(q, '0x0000000000000000000000000000000000000000000000000000000000000000')).to.equal('1970-01-01');
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0DE980')).to.equal('2018-05-30');
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0DE981')).to.equal('[Invalid datetime]: 2018-05-30 00:00:01');
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0E02F7')).to.equal('[Invalid datetime]: 2018-05-30 01:48:39'); 
+
+    q['precision'] = 'H';
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0E02F7')).to.equal('[Invalid datetime]: 2018-05-30 01:48:39'); 
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0DE980')).to.equal('2018-05-30 00hr');
+
+    q['precision'] = 'i';
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0E02F7')).to.equal('[Invalid datetime]: 2018-05-30 01:48:39'); 
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0DE980')).to.equal('2018-05-30 00:00');
+
+    q['precision'] = 's';
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0E02F7')).to.equal('2018-05-30 01:48:39'); 
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005B0DE980')).to.equal('2018-05-30 00:00:00');
+
+    q['precision'] = 'i';
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000006163683C')).to.equal('2021-10-10 22:25'); 
+
+    q['precision'] = 'H';
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000006163683C')).to.equal('[Invalid datetime]: 2021-10-10 22:25'); 
+    expect(rc_question.getAnswerString(q, '0x0000000000000000000000000000000000000000000000000000000061636260')).to.equal('2021-10-10 22hr'); 
+    // q['precision'] = 'H';
+
+    q['precision'] = 'd';
+    expect(rc_question.getAnswerString(q, '0x0000000000000000000000000000000000000000000000000000000061636260')).to.equal('[Invalid datetime]: 2021-10-10 22hr'); 
+
+    q['precision'] = 's';
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005FEE6600')).to.equal('2021-01-01 00:00:00'); 
+    q['precision'] = 'i';
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005FEE6600')).to.equal('2021-01-01 00:00'); 
+    q['precision'] = 'H';
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005FEE6600')).to.equal('2021-01-01 00hr'); 
+    q['precision'] = 'd';
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005FEE6600')).to.equal('2021-01-01'); 
+    q['precision'] = 'm';
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005FEE6600')).to.equal('2021-01'); 
+    q['precision'] = 'Y';
+    expect(rc_question.getAnswerString(q, '0x000000000000000000000000000000000000000000000000000000005FEE6600')).to.equal('2021'); 
+
+    // 1609426800 2021 5FEE6600
+
+    //1633904700 6163683C 
+    //1633903200 61636260
+    //1609426800 5FEDE770
+
+
+  });
+
   it('Handles single selects as expected', function() {
     var outcomes = ['thing1', 'thing2', 'thing3'];
     var qtext = rc_question.encodeText('single-select', 'oink', outcomes, 'my-category');
@@ -139,7 +192,21 @@ describe('Answer strings', function() {
     expect(rc_question.getAnswerString(q, '0x0000000000000000000000000000000000000000000000000000000000000002')).to.equal('thing2');
     expect(rc_question.getAnswerString(q, '0x0000000000000000000000000000000000000000000000000000000000000003')).to.equal('thing1 / thing2');
   });
-
+  it('Sets an error if there are too many outcomes', function() {
+    var outcomes = [];
+    for(var i=0; i<129; i++) {
+        outcomes.push('thing'+i);
+    }
+    var qtext = rc_question.encodeText('multiple-select', 'oink', outcomes, 'my-category');
+    var q1 = rc_question.populatedJSONForTemplate(rc_template.defaultTemplateForType('multiple-select'), qtext);
+    expect(q1.errors.too_many_outcomes).to.equal(true);
+    console.log(q1.title);
+    expect(q1.title).to.equal('oink');
+    var q2 = rc_question.populatedJSONForTemplate(rc_template.defaultTemplateForType('multiple-select'), qtext, true);
+    expect(q2.errors.too_many_outcomes).to.equal(true);
+    expect(q2.title).to.equal('[Too many outcomes] oink');
+    //expect(rc_question.getAnswerString(q, '0x0000000000000000000000000000000000000000000000000000000000000003')).to.equal('thing1 / thing2');
+  });
 });
 /*
 describe('Min Number Formatter', function() {
@@ -161,6 +228,16 @@ describe('Broken questions', function() {
     var broken = '{ "title": "You need to quote your "quotation marks" before parsing", "type": "bool" }';
     var q = rc_question.populatedJSONForTemplate(rc_template.defaultTemplateForType('bool'), broken);
     expect(q.type).to.equal('broken-question');
+    expect(q.errors.json_parse_failed).to.equal(true);
+  });
+  it('Sets the invalid_precision error if the precision is set but to something other than Y m d H i s', function() {
+    var broken = '{ "title": "This datetime will not work", "type": "datetime", "precision": "X" }';
+    var q1 = rc_question.populatedJSONForTemplate(broken, '');
+    expect(q1.errors.invalid_precision).to.equal(true);
+    expect(q1.title).to.equal('This datetime will not work');
+    var q2 = rc_question.populatedJSONForTemplate(broken, '', true);
+    expect(q2.errors.invalid_precision).to.equal(true);
+    expect(q2.title).to.equal('[Invalid date format] This datetime will not work');
   });
 });