@reality.eth/reality-eth-lib 3.2.3 → 3.2.5

package/formatters/question.js

@@ -5,6 +5,7 @@ const BigNumber = require('bignumber.js');
 const ethereumjs_abi = require('ethereumjs-abi')
 const vsprintf = require("sprintf-js").vsprintf
 const QUESTION_MAX_OUTCOMES = 128;
+const TEMPLATE_MAX_PLACEHOLDERS = 128;
 const marked = require('marked');
 const DOMPurify = require('isomorphic-dompurify');
 const { convert} = require('html-to-text');
@@ -277,21 +278,126 @@ exports.populatedJSONForTemplate = function(template, question, errors_to_title)
     return module.exports.parseQuestionJSON(interpolated, errors_to_title);
 }
 
+// Encode text, assuming the template has placeholders in the order specified in the params.
+// Additional information about the template can be passed in as template_definitions.
+// If not specified, we'll assume it works like our standard built-in templates.
+exports.encodeCustomText = function(params) {
+
+    var items = [];
+    for (const p in params) {
+        var val = params[p];
+        if (typeof val === 'string') {
+            // Stringify puts quotation marks around the string, so strip them
+            val = JSON.stringify(val).replace(/^"|"$/g, '');
+        } else if (typeof val === 'object') { 
+            // An array of values should be stringified as a JSON array.
+            // However template should do "outcomes: [%s]" instead of "outcomes: %s".
+            // In that case strip the closing brackets.
+            val = JSON.stringify(val).replace(/^\[/, '').replace(/\]$/, '');
+        } else {
+            val = null;
+        } 
+        items.push(val);
+    }
+    const ret = items.join(module.exports.delimiter());
+    return ret;
+
+}
+
+exports.guessTemplateConfig = function(template) {
+    // Use the hash of the template as a temporary placeholder
+    // Since you can't hash yourself we can be confident this won't collide.
+    const placeholder = '0x' + ethereumjs_abi.soliditySHA3(['string'], [template]).toString('hex');
+    const arr_placeholder = '0x' + ethereumjs_abi.soliditySHA3(['string'], [template + "_arr"]).toString('hex');
+    var pl_arr = new Array(TEMPLATE_MAX_PLACEHOLDERS);
+    pl_arr.fill(placeholder);
+    var interpolated = vsprintf(template, pl_arr);
+
+    // Quote the placeholders in any arrays that didn't originally have quotes
+    interpolated = interpolated.replaceAll('['+placeholder+']', '"'+arr_placeholder+'"');
+
+    const fake_json = module.exports.parseQuestionJSON(interpolated, false);
+
+    /*
+    Meta example:
+    {
+        'labels': {'dog': 'Dogs', 'cat': 'Cats'},
+        'tags': {'2': 'dog'}
+        'defaults': {'lang': 'en_US'}
+    }
+    */
+
+
+    // If there's a section called __META, use that for titling columns etc
+    var meta = '__META' in fake_json ? fake_json['__META'] : {};
+    var labels = 'labels' in meta ? meta['labels'] : {};
+
+    var fields = {};
+    for (const k in fake_json) {
+        if (k == 'title_text' || k == 'title_html' || k == '__META') {
+            // Fields we add automatically
+            continue;
+        }
+
+        // We assume that every placeholder is either the value for a field, or contained in it.
+        // ie we handle
+        //    "myfield": "%s"
+        //    "myfield": "A %s and another %s."
+        //    "myfield": [%s]
+
+        var fdef = {};
+        fdef['label'] = (k in labels) ? labels[k] : k;
+        const regexp = new RegExp('('+placeholder+'|'+arr_placeholder+')');
+        //const regexp = new RegExp('('+placeholder+')');
+        const bits = fake_json[k].split(regexp);
+        // console.log(bits);
+        var parts = [];
+        var part_i = 0;
+        for(const b in bits) {
+            if (bits[b] == '') {
+                continue;
+            }
+            if (bits[b] == placeholder || bits[b] == arr_placeholder) {
+                let part_label = k + '_' + part_i;
+                if (part_label in labels) {
+                    part_label = labels[part_label];
+                }
+                if (bits[b] == placeholder) {
+                    parts.push({'part': 'parameter', 'part_index': part_i, 'label': part_label})
+                } else {
+                    parts.push({'part': 'array_parameter', 'part_index': part_i, 'label': part_label})
+                }
+                part_i++;
+            } else {
+                parts.push({'part': 'text', 'value': bits[b]});
+            }
+        }
+        fdef['parts'] = parts;
+        fields[k] = fdef;
+    }
+
+    var tags = {};
+    if ('tags' in meta) {
+        tags = meta['tags']
+    }
+
+    return {
+        'fields': fields,
+        'tags': tags
+    };
+
+}
+
 exports.encodeText = function(qtype, txt, outcomes, category, lang) {
-    var qtext = JSON.stringify(txt).replace(/^"|"$/g, '');
-    var delim = module.exports.delimiter();
-    //console.log('using template_id', template_id);
+    var def = {};
+    def['title'] = txt;
     if (qtype == 'single-select' || qtype == 'multiple-select') {
-        var outcome_str = JSON.stringify(outcomes).replace(/^\[/, '').replace(/\]$/, '');
-        //console.log('made outcome_str', outcome_str);
-        qtext = qtext + delim + outcome_str;
-        //console.log('made qtext', qtext);
-    }
-    if (typeof lang == 'undefined' || lang == '') {
-        lang = 'en_US';
+        def['outcomes'] = outcomes;
     }
-    qtext = qtext + delim + category + delim + lang;
-    return qtext;
+    def['category'] = category;
+    def['lang'] = lang;
+
+    return module.exports.encodeCustomText(def);
 }
 
 // A value used to denote that the question is invalid or can't be answered

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reality.eth/reality-eth-lib",
-  "version": "3.2.3",
+  "version": "3.2.5",
   "description": "Tools for handling questions in the reality.eth fact verification platform",
   "scripts": {
     "test": "env TZ='Asia/Kabul' mocha ./test"
@@ -16,7 +16,7 @@
   "author": "Edmund Edgar (https://reality.eth.link)",
   "license": "GPL-3.0",
   "dependencies": {
-    "@reality.eth/contracts": "^3.0.19",
+    "@reality.eth/contracts": "^3.0.21",
     "bignumber.js": "^7.2.1",
     "bn.js": "^5.2.1",
     "ethereumjs-abi": "^0.6.5",
@@ -39,5 +39,5 @@
     "url": "https://github.com/RealityETH/monorepo/issues"
   },
   "homepage": "https://reality.eth.link",
-  "gitHead": "f1fa5a1a1ea69e30311ecb14809fe2c1854b404b"
+  "gitHead": "a1a1c9160d34921ac395d23614820eaa8a13b305"
 }

package/test/formatters.js

@@ -385,3 +385,98 @@ describe('Question ID tests', function() {
   });
 
 });
+
+describe('Custom template handling', function() {
+  const example_template = '{"title": "%s", "dogs": "%s", "cats": "%s"}';
+  const example_template_arr = '{"title": "%s", "dogs": "%s", "cats": [%s], "ants": [%s]}';
+  const multi_template = '{"title": "%s", "dogs": "The dogs item contains thing 1 %s and thing 2 %s.", "cats": "%s"}';
+  const example_template_meta = '{"title": "%s", "dogs": "%s", "cats": "%s", "__META": {"tags": {"1": "dogthing1"}, "labels": {"dogs": "Doggies", "cats": "Felines"}}}';
+  const multi_template_meta = '{"title": "%s", "dogs": "The dogs item contains thing 1 %s and thing 2 %s.", "cats": "%s", "__META": {"tags": {"1": "dogthing1"}, "labels": {"dogs": "Doggies", "dogs_0": "First Doggy", "dogs_1": "Second Doggy", "cats": "Felines"}}}';
+  it('Returns a template config for an otherwise unknown template', function() {
+    var q = rc_question.guessTemplateConfig(example_template);
+    const t = q['fields']['title']['label'];
+    expect(t).to.equal('title');
+    const dt = q['fields']['dogs']['label'];
+    expect(dt).to.equal('dogs');
+    const parts = q['fields']['dogs']['parts'];
+    expect(parts.length).to.equal(1);
+    expect(parts[0].part).to.equal('parameter');
+    expect(parts[0].part_index).to.equal(0);
+    expect(parts[0].label).to.equal('dogs_0');
+
+    var qm = rc_question.guessTemplateConfig(example_template_meta);
+    const tm = qm['fields']['title']['label'];
+    expect(tm).to.equal('title');
+    const dtm = qm['fields']['dogs']['label'];
+    expect(dtm).to.equal('Doggies');
+    const partsm = qm['fields']['dogs']['parts'];
+    expect(partsm.length).to.equal(1);
+    expect(partsm[0].part).to.equal('parameter');
+    expect(partsm[0].part_index).to.equal(0);
+    const tag1 = qm['tags']['1'];
+    expect(tag1).to.equal('dogthing1');
+
+    var qa = rc_question.guessTemplateConfig(example_template_arr);
+    const ta = qa['fields']['title']['label'];
+    expect(ta).to.equal('title');
+    const dta = qa['fields']['dogs']['label'];
+    expect(dta).to.equal('dogs');
+    const partsa = qa['fields']['dogs']['parts'];
+    expect(partsa.length).to.equal(1);
+    expect(partsa[0].part).to.equal('parameter');
+    expect(partsa[0].part_index).to.equal(0);
+    expect(partsa[0].label).to.equal('dogs_0');
+
+    const bparts2 = qa['fields']['cats']['parts'];
+    expect(bparts2.length).to.equal(1);
+    expect(bparts2[0].part).to.equal('array_parameter');
+    expect(bparts2[0].part_index).to.equal(0);
+    expect(bparts2[0].label).to.equal('cats_0');
+
+    const bparts3 = qa['fields']['ants']['parts'];
+    expect(bparts3.length).to.equal(1);
+    expect(bparts3[0].part).to.equal('array_parameter');
+    expect(bparts3[0].part_index).to.equal(0);
+    expect(bparts3[0].label).to.equal('ants_0');
+
+  });
+
+  it('Returns a config for placeholders inside strings in json fields', function() {
+    var q = rc_question.guessTemplateConfig(multi_template);
+    const t = q['fields']['title']['label'];
+    expect(t).to.equal('title');
+    const parts = q['fields']['dogs']['parts'];
+    expect(parts.length).to.equal(5);
+    expect(parts[0].part).to.equal('text');
+    expect(parts[0].value).to.equal('The dogs item contains thing 1 ');
+    expect(parts[1].part).to.equal('parameter');
+    expect(parts[1].part_index).to.equal(0);
+    expect(parts[1].label).to.equal("dogs_0");
+    expect(parts[2].part).to.equal('text');
+    expect(parts[2].value).to.equal(' and thing 2 ');
+    expect(parts[3].part).to.equal('parameter');
+    expect(parts[3].part_index).to.equal(1);
+    expect(parts[3].label).to.equal("dogs_1");
+    expect(parts[4].part).to.equal('text');
+    expect(parts[4].value).to.equal('.');
+
+    var qm = rc_question.guessTemplateConfig(multi_template_meta);
+    const tm = q['fields']['title']['label'];
+    expect(tm).to.equal('title');
+    const partsm = qm['fields']['dogs']['parts'];
+    expect(partsm.length).to.equal(5);
+    expect(partsm[0].part).to.equal('text');
+    expect(partsm[0].value).to.equal('The dogs item contains thing 1 ');
+    expect(partsm[1].part).to.equal('parameter');
+    expect(partsm[1].part_index).to.equal(0);
+    expect(partsm[1].label).to.equal("First Doggy");
+    expect(partsm[2].part).to.equal('text');
+    expect(partsm[2].value).to.equal(' and thing 2 ');
+    expect(partsm[3].part).to.equal('parameter');
+    expect(partsm[3].part_index).to.equal(1);
+    expect(partsm[3].label).to.equal("Second Doggy");
+    expect(partsm[4].part).to.equal('text');
+    expect(partsm[4].value).to.equal('.');
+  });
+});
+