fix(wasm) Various fixes to engine and tests, factor out error handlimg

Signed-off-by: Jerome Simeon <jeromesimeon@me.com>

packages/ergo-compiler/lib/script.js

@@ -34,7 +34,7 @@ class Script {
      * @param {ModelManager} modelManager - The ModelManager associated with this Script
      * @param {string} identifier - The identifier of the script
      * @param {string} language - The language type of the script
-     * @param {string} contents - The contents of the script
+     * @param {Buffer} contents - The contents of the script
      * @param {string} contractName - The name of the contract if known or null
      */
     constructor(modelManager, identifier, language, contents, contractName) {
@@ -54,8 +54,7 @@ class Script {
             let parser;
 
             try {
-                // XXX this.contents is now a Buffer
-                parser = new JavaScriptParser(this.contents.toString(), false, 8);
+                parser = new JavaScriptParser(this.getContents(), false, 8);
             } catch (cause) {
                 // consider adding a toHex method in the exception to put out the pure hex values of the file.
                 const error = new SyntaxError('Failed to parse ' + this.identifier + ': ' + cause.message+'\n'+data.errorStatement);
@@ -113,10 +112,14 @@ class Script {
 
     /**
      * Returns the contents of the script
-     * @return {string} the content of the script
+     * @return {*} the content of the script
      */
     getContents() {
-        return this.contents;
+        if (this.language === '.js' || this.language === '.java') {
+            return Buffer.from(this.contents, 'utf8').toString();
+        } else {
+            return this.contents;
+        }
     }
 
     /**

packages/ergo-compiler/test/logicmanager.js

@@ -74,9 +74,9 @@ describe('LogicManager', () => {
             const logicManager = new LogicManager('es6');
             logicManager.addLogicFile(ergoSample,'test.ergo');
             logicManager.compileLogicSync(false);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
             logicManager.compileLogicSync(false);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
         });
 
         it('should succeed creating a dispatch call for a JS logic file with a contract class (ES6)', () => {
@@ -160,9 +160,9 @@ describe('LogicManager', () => {
             const logicManager = new LogicManager('es6');
             logicManager.addLogicFile(ergoSample,'test.ergo');
             logicManager.compileLogic(false).then((logicCode) => {
-                logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+                logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
                 logicManager.compileLogicSync(false);
-                logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+                logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
             });
         });
 
@@ -177,16 +177,16 @@ describe('LogicManager', () => {
             logicManager.addErgoBuiltin();
             logicManager.addLogicFile(ergoSample,'test3.ergo');
             logicManager.compileLogicSync(false);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
             logicManager.compileLogicSync(false);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
         });
 
         it('should load a logic file (without extension) to the script manager', () => {
             const logicManager = new LogicManager('es6');
             logicManager.addLogicFile(ergoSample,'test');
             logicManager.compileLogicSync(false);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
         });
 
         it('should set the contract name', () => {
@@ -202,30 +202,30 @@ describe('LogicManager', () => {
             logicManager.addLogicFile(ergoSample,'test.ergo');
             logicManager.getTarget().should.equal('es6');
             logicManager.compileLogicSync(false);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
             logicManager.setTarget('es6', true);
             logicManager.getTarget().should.equal('es6');
             const contractName = 'org.accordproject.helloemit.HelloWorld';
             logicManager.setContractName(contractName);
             logicManager.getContractName().should.equal(ErgoCompiler.contractCallName(contractName));
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
         });
 
         it('should fail to create init and dispatch for ES6 without a contract name', () => {
             const logicManager = new LogicManager('es6');
             logicManager.addLogicFile(ergoSample,'test.ergo');
             logicManager.getTarget().should.equal('es6');
             logicManager.compileLogicSync(false);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
         });
 
         it('should set the compilation target to ES6 but not recompile the logic', () => {
             const logicManager = new LogicManager('es6');
             logicManager.addLogicFile(ergoSample,'test.ergo');
             logicManager.compileLogicSync(false);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
             logicManager.setTarget('es6', false);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
         });
 
         it('should fail to create init code for Java', () => {
@@ -257,7 +257,7 @@ describe('LogicManager', () => {
                 'model.cto'
             ]);
             modelManager.getModels()[0].content.length.should.equal(1330);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(138466);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(138438);
         });
 
         it('should load a directory with grammar', async function () {
@@ -271,7 +271,7 @@ describe('LogicManager', () => {
                 'model.cto'
             ]);
             modelManager.getModels()[0].content.length.should.equal(1330);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(69535);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(69507);
         });
     });
 
@@ -288,7 +288,7 @@ describe('LogicManager', () => {
                 'model.cto'
             ]);
             modelManager.getModels()[0].content.length.should.equal(1330);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(138466);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(138438);
         });
 
         it('should load a Zip with formula', async function () {
@@ -303,7 +303,7 @@ describe('LogicManager', () => {
                 'model.cto'
             ]);
             modelManager.getModels()[0].content.length.should.equal(1330);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(68167);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(68139);
         });
     });
 
@@ -324,7 +324,7 @@ describe('LogicManager', () => {
                 'model.cto'
             ]);
             modelManager.getModels()[0].content.length.should.equal(1330);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(138466);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(138438);
         });
 
         it('should load a Zip with formula', async function () {
@@ -343,7 +343,7 @@ describe('LogicManager', () => {
                 'model.cto'
             ]);
             modelManager.getModels()[0].content.length.should.equal(1330);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(69535);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(69507);
         });
     });
 
@@ -379,15 +379,15 @@ describe('LogicManager', () => {
             const logicManager = new LogicManager('es6');
             logicManager.addLogicFile(ergoSample,'test.ergo');
             logicManager.compileLogicSync(false);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
             logicManager.updateLogic(ergoSample,'test.ergo');
             logicManager.compileLogicSync(false);
             logicManager.updateLogic(ergoSample,'testNEW.ergo');
             logicManager.compileLogicSync(false);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
             logicManager.updateLogic(ergoSample3,'test.ergo');
             logicManager.compileLogicSync(false);
-            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50153);
+            logicManager.getScriptManager().getCompiledScript().getContents().length.should.equal(50125);
         });
 
     });

packages/ergo-compiler/test/scriptmanager.js

@@ -59,8 +59,8 @@ describe('ScriptManager', () => {
             scriptManager.getLogic().map(x => x.name).should.deep.equal(['test.ergo']);
             scriptManager.allFunctionDeclarations().length.should.equal(2);
             scriptManager.allFunctionDeclarations().map(x => x.getName()).should.deep.equal(['paymentClause','__dispatch']);
-            scriptManager.getCompiledScript().getContents().length.should.equal(50153);
-            scriptManager.getCompiledModule().length.should.equal(50153);
+            scriptManager.getCompiledScript().getContents().length.should.equal(50125);
+            scriptManager.getCompiledModule().length.should.equal(50125);
             scriptManager.allFunctionDeclarations().length.should.equal(150);
         });
 
@@ -70,8 +70,8 @@ describe('ScriptManager', () => {
             const script2 = scriptManager.createScript('test.ergo','.ergo',ergoSample);
             scriptManager.addScript(script1);
             scriptManager.addScript(script2);
-            scriptManager.compileLogic().getContents().length.should.equal(50153);
-            scriptManager.getCompiledScript().getContents().length.should.equal(50153);
+            scriptManager.compileLogic().getContents().length.should.equal(50125);
+            scriptManager.getCompiledScript().getContents().length.should.equal(50125);
             scriptManager.getAllScripts().length.should.equal(3);
         });
 
@@ -176,8 +176,8 @@ describe('ScriptManager', () => {
             const script2 = scriptManager.createScript('test.ergo','.ergo',ergoSample);
             scriptManager.addScript(script1);
             scriptManager.addScript(script2);
-            scriptManager.compileLogic().getContents().length.should.equal(50153);
-            scriptManager.getCompiledModule().length.should.equal(50153);
+            scriptManager.compileLogic().getContents().length.should.equal(50125);
+            scriptManager.getCompiledModule().length.should.equal(50125);
             scriptManager.clearScripts();
             return (() => scriptManager.getCompiledModule()).should.throw('Did not find any compiled logic');
         });

packages/ergo-engine/lib/engine.js

@@ -134,7 +134,8 @@ class Engine {
         };
 
         // execute the logic
-        const result = await this.invokeCall(utcOffset,now,validOptions,context,module,contractName,clauseName);
+        const wrappedResult = await this.invokeCall(utcOffset,now,validOptions,context,module,contractName,clauseName);
+        const result = this.unwrapError(wrappedResult);
         const validResponse = logic.validateOutput(result.__response); // ensure the response is valid
         const validNewState = logic.validateOutput(result.__state); // ensure the new state is valid
         const validEmit = logic.validateOutputArray(result.__emit); // ensure all the emits are valid
@@ -279,6 +280,23 @@ class Engine {
         return await this.trigger(logic, contractId, contract, request, state, currentTime, options);
     }
 
+    /**
+     * Handle success/failure
+     * @param {object} result - the result from invokation
+     * @return {object} the value if success or throws an error
+     */
+    unwrapError(result) {
+        if (Object.prototype.hasOwnProperty.call(result,'$left')) {
+            return result.$left;
+        } else {
+            const failure = result.$right;
+            let message = 'Unknown Ergo Logic Error (Please file a GitHub issue)';
+            if (failure && failure.$data && failure.$data.message) {
+                message = failure.$data.message;
+            }
+            throw new Error('[Ergo] ' + message);
+        }
+    }
 }
 
 module.exports = Engine;

packages/ergo-engine/lib/evalengine.js

@@ -86,8 +86,7 @@ class EvalEngine extends Engine {
         let code;
         if (contractName) {
             code = `
-const __result = ${contractName}.${clauseName}(Object.assign({}, {__now:now,__options:options,__contract:context.data,__state:context.state,__emit:{$coll:[],$length:0}},context.params));
-unwrapError(__result);
+${contractName}.${clauseName}(Object.assign({}, {__now:now,__options:options,__contract:context.data,__state:context.state,__emit:{$coll:[],$length:0}},context.params));
 `;
         } else {
             throw new Error('Cannot invoke contract without a contract name');

packages/ergo-engine/lib/vmengine.js

@@ -101,8 +101,7 @@ class VMEngine extends Engine {
         let code;
         if (contractName) {
             code = `
-const __result = ${contractName}.${clauseName}(Object.assign({__now:now,__options:options,__contract:context.data,__state:context.state,__emit:{$coll:[],$length:0}}, context.params));
-unwrapError(__result);
+${contractName}.${clauseName}(Object.assign({__now:now,__options:options,__contract:context.data,__state:context.state,__emit:{$coll:[],$length:0}}, context.params));
 `;
         } else {
             throw new Error('Cannot invoke contract without a contract name');

packages/ergo-engine/lib/wasmengine.js

@@ -62,12 +62,10 @@ function read(mod, ptr) {
  * @return {*} a pointer to the result
  */
 async function invoke(rt, m, fn_name, arg) {
-    // console.log('INVOKE ' + fn_name + '(' + JSON.stringify(arg) + ')');
     let arg_ptr = write(rt, arg);
     let res_ptr = m.exports[fn_name](arg_ptr);
     let res = read(rt, res_ptr);
-    //console.log('RES ' + JSON.stringify(res,null,2));
-    return res.$left;
+    return res;
 }
 
 // XXX Hack! load runtime explicitely here

packages/ergo-engine/test/engine.js

@@ -15,6 +15,7 @@
 'use strict';
 
 const Chai = require('chai');
+const expect = Chai.expect;
 
 Chai.should();
 Chai.use(require('chai-things'));
@@ -25,7 +26,7 @@ const Engine = require('../lib/engine');
 describe('#engine', () => {
     it('should fail running when using a base Engine', async () => {
         const engine = new Engine();
-        (() => engine.instantiate('const a = 1;')).should.throw('[instantiate] Cannot instantiate module: create engine for a specific platform');
+        await expect(engine.instantiate('const a = 1;')).to.be.rejectedWith('[instantiate] Cannot instantiate module: create engine for a specific platform');
         return engine.invokeCall(2,{ a : 1 },'function f() { return context.a + utcOffset; }','f()').should.be.rejectedWith('[invokeCall] Cannot create invoke call for contract: create engine for a specific platform');
     });
 });

packages/ergo-engine/test/evalengine.js

@@ -18,23 +18,25 @@ const runWorkload = require('./commonengine').runWorkload;
 const EvalEngine = require('../lib/evalengine');
 const LogicManager = require('@accordproject/ergo-compiler').LogicManager;
 
-describe.only('#evalengine', () => {
+describe('#evalengine', () => {
     it('should behave as a proper Eval Engine', () => {
         const engine = new EvalEngine();
         engine.kind().should.equal('eval');
         engine.instantiate('const a = 1;').should.not.be.null;
         engine.invokeCall(2,null,null,{ a : 1 },'class C { static f() { return context.a + utcOffset; } }','C','f').should.equal(3);
     });
 
-    it('should cache a script', () => {
+    it('should cache a script', async () => {
         const engine = new EvalEngine();
         const logicManager = new LogicManager('es6', null);
         const script = 'const a = 1';
         logicManager.addLogicFile(script,'test2.js');
         logicManager.compileLogicSync(false);
         const scriptManager = logicManager.getScriptManager();
-        engine.cacheModule(scriptManager,'test2.js').should.equal(script);
-        engine.cacheModule(scriptManager,'test2.js').should.equal(script);
+        let script1 = await engine.cacheModule(scriptManager,'test2.js');
+        script1.should.equal(script);
+        script1 = await engine.cacheModule(scriptManager,'test2.js');
+        script1.should.equal(script);
     });
 });
 

packages/ergo-engine/test/vmengine.js

@@ -14,16 +14,23 @@
 
 'use strict';
 
+const Chai = require('chai');
+const expect = Chai.expect;
+
+Chai.should();
+Chai.use(require('chai-things'));
+Chai.use(require('chai-as-promised'));
+
 const runWorkload = require('./commonengine').runWorkload;
 const VMEngine = require('../lib/vmengine');
 const LogicManager = require('@accordproject/ergo-compiler').LogicManager;
 
 describe('#vmengine', () => {
-    it('should behave as a proper VM engine', () => {
+    it('should behave as a proper VM engine', async () => {
         const engine = new VMEngine();
         engine.kind().should.equal('vm2');
         engine.instantiate('const a = 1;').should.not.be.null;
-        engine.invokeCall(2,null,null,{ a : 1 },'function f() { return context.a + utcOffset; }','f()').should.equal(3);
+        expect (await engine.invokeCall(2,null,null,{ a : 1 },'class C { static f() { return context.a + utcOffset; } }','C','f')).to.equal(3);
     });
 
     it('should cache a script', () => {

tests/helloworldenforce/data.json

@@ -0,0 +1,4 @@
+{
+  "$class": "org.accordproject.helloworld.TemplateModel",
+  "name": "Fred Blogs"
+}