Merge pull request #115 from dselman/contract-as-composer-object

(fix) contract data should be a Composer object

Author: dselman

package-lock.json

@@ -49,7 +49,7 @@
     "@accordproject/cicero-core": "0.3.14",
     "@accordproject/cicero-engine": "0.3.14",
     "@accordproject/ergo-compiler": "0.0.48",
-    "composer-common": "0.19.5",
+    "composer-common": "0.19.6",
     "yargs": "9.0.1"
   },
   "license-check-config": {

packages/cicero-cli/package.json

@@ -42,7 +42,7 @@
     "nyc": "11.7.2"
   },
   "dependencies": {
-    "composer-common": "0.19.5"
+    "composer-common": "0.19.6"
   },
   "license-check-config": {
     "src": [

packages/cicero-common/package.json

@@ -40,12 +40,14 @@ class TemplateInstance {
         }
         this.template = template;
         this.data = null;
+        this.composerData = null;
     }
 
     /**
      * Set the data for the clause
      * @param {object} data  - the data for the clause, must be an instance of the
-     * template model for the clause's template
+     * template model for the clause's template. This should be a plain JS object
+     * and will be deserialized and validated into the Composer object before assignment.
      */
     setData(data) {
         // verify that data is an instance of the template model
@@ -57,21 +59,34 @@ class TemplateInstance {
 
         // downloadExternalDependencies the data using the template model
         logger.debug('Setting clause data: ' + JSON.stringify(data));
-        const resource = this.template.getSerializer().fromJSON(data);
+        const resource = this.getTemplate().getSerializer().fromJSON(data);
         resource.validate();
 
-        // passed validation!
+        // save the data
         this.data = data;
+
+        // save the composer data
+        this.composerData = resource;
     }
 
     /**
-     * Get the data for the clause
+     * Get the data for the clause. This is a plain JS object. To retrieve the Composer
+     * object call getComposerData().
      * @return {object} - the data for the clause, or null if it has not been set
      */
     getData() {
         return this.data;
     }
 
+    /**
+     * Get the data for the clause. This is a Composer object. To retrieve the
+     * plain JS object suitable for serialization call toJSON() and retrieve the `data` property.
+     * @return {object} - the data for the clause, or null if it has not been set
+     */
+    getDataAsComposerObject() {
+        return this.composerData;
+    }
+
     /**
      * Set the data for the clause by parsing natural language text.
      * @param {string} text  - the data for the clause
@@ -107,7 +122,7 @@ class TemplateInstance {
         let hash = '';
 
         if (this.data) {
-            const textToHash = JSON.stringify(this.data);
+            const textToHash = JSON.stringify(this.getData());
             const hasher = crypto.createHash('sha256');
             hasher.update(textToHash);
             hash = '-' + hasher.digest('hex');

packages/cicero-core/lib/templateinstance.js

@@ -50,7 +50,7 @@
   "dependencies": {
     "@accordproject/cicero-common": "0.3.14",
     "@accordproject/ergo-compiler": "0.0.48",
-    "composer-common": "0.19.5",
+    "composer-common": "0.19.6",
     "debug": "2.6.2",
     "glob": "7.1.2",
     "ietf-language-tag-regex": "0.0.5",

packages/cicero-core/package.json

@@ -71,6 +71,9 @@ describe('Clause', () => {
             };
             clause.setData(data);
             clause.getData().should.eql(data);
+
+            // check that the composer data is really a Composer object
+            clause.getDataAsComposerObject().getFullyQualifiedType().should.be.equal('io.clause.latedeliveryandpenalty.TemplateModel');
         });
         it('should throw error for bad $class', async function() {
             const template = await Template.fromDirectory('./test/data/latedeliveryandpenalty');

packages/cicero-core/test/clause.js

@@ -153,7 +153,7 @@ class Engine {
         this.compileJsClause(clause);
         script = this.scripts[clause.getIdentifier()];
 
-        const validContract = clause.getData();
+        const validContract = clause.getDataAsComposerObject();
         const factory = template.getFactory();
         const vm = new VM({
             timeout: 1000,

packages/cicero-engine/lib/engine.js

@@ -47,7 +47,8 @@ class Logger {
             keys.forEach(function(key) {
                 let element = obj[key];
                 if(element.getType) {
-                    printable[key] = this.serializer.toJSON(element, {validate: false, permitResourcesForRelationships: true});
+                    // TODO (DCS) call toJSON once that works for concepts
+                    printable[key] = element.getFullyQualifiedType();
                 }
                 else {
                     printable[key] = element;

packages/cicero-engine/lib/logger.js

@@ -44,7 +44,7 @@
   },
   "dependencies": {
     "@accordproject/cicero-core": "0.3.14",
-    "composer-common": "0.19.5",
+    "composer-common": "0.19.6",
     "moment": "2.20.1",
     "vm2": "3.5.0"
   },