Update the Protocol Handler (#18)

- Added the new eval subtypes into the constants file
- Added the eval subtype to the eval send command
- Modified the protocol handler tests

IoT.js-Debug-DCO-1.0-Signed-off-by: Imre Kiss [email protected]

Author: knightburton

src/JerryProtocolConstants.ts

@@ -17,7 +17,7 @@
 'use strict';
 
 // Expected JerryScript debugger protocol version.
-export const JERRY_DEBUGGER_VERSION = 2;
+export const JERRY_DEBUGGER_VERSION = 3;
 
 // Packages sent from the server to the client.
 export enum SERVER {
@@ -49,8 +49,15 @@ export enum SERVER {
   JERRY_DEBUGGER_OUTPUT_RESULT_END = 26
 }
 
-// Subtypes of the eval message result.
+// Subtypes of eval.
 export enum EVAL_SUBTYPE {
+  JERRY_DEBUGGER_EVAL_EVAL = '\0',
+  JERRY_DEBUGGER_EVAL_THROW = '\1',
+  JERRY_DEBUGGER_EVAL_ABORT = '\2'
+}
+
+// Subtypes of the eval message result.
+export enum EVAL_RESULT_SUBTYPE {
   JERRY_DEBUGGER_EVAL_OK = 1,
   JERRY_DEBUGGER_EVAL_ERROR = 2
 }

src/JerryProtocolHandler.ts

@@ -553,7 +553,7 @@ export class JerryDebugProtocolHandler {
     this.evalsPending++;
 
     // send an _EVAL message prefixed with the byte length, followed by _EVAL_PARTs if necessary
-    const array = stringToCesu8(expression, 1 + 4, this.byteConfig);
+    const array = stringToCesu8(SP.EVAL_SUBTYPE.JERRY_DEBUGGER_EVAL_EVAL + expression, 1 + 4, this.byteConfig);
     const arrayLength = array.byteLength;
     const byteLength = arrayLength - 1 - 4;
     array[0] = SP.CLIENT.JERRY_DEBUGGER_EVAL;

src/test/JerryProtocolHandler.test.ts

@@ -41,28 +41,28 @@ suite('JerryProtocolHandler', () => {
 
         test('allows otherwise valid message to be too long', () => {
             delegate.onError.resetHistory();
-            const array = Uint8Array.from([0, 200, 4, 1, 2, 0]);
+            const array = Uint8Array.from([0, 200, 4, 1, SP.JERRY_DEBUGGER_VERSION, 0]);
             handler.onConfiguration(array);
             assert(delegate.onError.notCalled);
         });
 
         test('aborts when compressed pointer wrong size', () => {
             delegate.onError.resetHistory();
-            const array = Uint8Array.from([0, 200, 6, 1, 2]);
+            const array = Uint8Array.from([0, 200, 6, 1, SP.JERRY_DEBUGGER_VERSION]);
             handler.onConfiguration(array);
             assert(delegate.onError.calledOnce);
         });
 
         test('aborts when version unexpected', () => {
             delegate.onError.resetHistory();
-            const array = Uint8Array.from([0, 200, 4, 1, 3]);
+            const array = Uint8Array.from([0, 200, 4, 1, 0]);
             handler.onConfiguration(array);
             assert(delegate.onError.calledOnce);
         });
 
         test('succeeds when everything is normal', () => {
             delegate.onError.resetHistory();
-            const array = Uint8Array.from([0, 200, 4, 1, 2]);
+            const array = Uint8Array.from([0, 200, 4, 1, SP.JERRY_DEBUGGER_VERSION]);
             handler.onConfiguration(array);
             assert(delegate.onError.notCalled);
         });
@@ -281,9 +281,9 @@ suite('JerryProtocolHandler', () => {
           (handler as any).evalResultData = undefined;
           (handler as any).evalsPending = 1;
           handler.onEvalResult(Uint8Array.from([SP.SERVER.JERRY_DEBUGGER_EVAL_RESULT_END,
-            'a'.charCodeAt(0), 'b'.charCodeAt(0), SP.EVAL_SUBTYPE.JERRY_DEBUGGER_EVAL_OK]));
+            'a'.charCodeAt(0), 'b'.charCodeAt(0), SP.EVAL_RESULT_SUBTYPE.JERRY_DEBUGGER_EVAL_OK]));
           assert(delegate.onEvalResult.calledOnce);
-          assert.strictEqual(delegate.onEvalResult.args[0][0], SP.EVAL_SUBTYPE.JERRY_DEBUGGER_EVAL_OK);
+          assert.strictEqual(delegate.onEvalResult.args[0][0], SP.EVAL_RESULT_SUBTYPE.JERRY_DEBUGGER_EVAL_OK);
           assert.strictEqual(delegate.onEvalResult.args[0][1], 'ab');
           assert.strictEqual((handler as any).evalResultData, undefined);
           assert.strictEqual((handler as any).evalsPending, 0);
@@ -299,9 +299,9 @@ suite('JerryProtocolHandler', () => {
           handler.onEvalResult(Uint8Array.from([SP.SERVER.JERRY_DEBUGGER_EVAL_RESULT,
             'a'.charCodeAt(0), 'b'.charCodeAt(0)]));
           handler.onEvalResult(Uint8Array.from([SP.SERVER.JERRY_DEBUGGER_EVAL_RESULT_END,
-            'a'.charCodeAt(0), 'b'.charCodeAt(0), SP.EVAL_SUBTYPE.JERRY_DEBUGGER_EVAL_OK]));
+            'a'.charCodeAt(0), 'b'.charCodeAt(0), SP.EVAL_RESULT_SUBTYPE.JERRY_DEBUGGER_EVAL_OK]));
           assert(delegate.onEvalResult.calledOnce);
-          assert.strictEqual(delegate.onEvalResult.args[0][0], SP.EVAL_SUBTYPE.JERRY_DEBUGGER_EVAL_OK);
+          assert.strictEqual(delegate.onEvalResult.args[0][0], SP.EVAL_RESULT_SUBTYPE.JERRY_DEBUGGER_EVAL_OK);
           assert.strictEqual(delegate.onEvalResult.args[0][1], 'abab');
           assert.strictEqual((handler as any).evalResultData, undefined);
           assert.strictEqual((handler as any).evalsPending, 0);
@@ -329,7 +329,7 @@ suite('JerryProtocolHandler', () => {
 
         test('aborts when unhandled message sent', () => {
             delegate.onError.resetHistory();
-            const array = Uint8Array.from([SP.SERVER.JERRY_DEBUGGER_CONFIGURATION, 200, 4, 1, 2]);
+            const array = Uint8Array.from([SP.SERVER.JERRY_DEBUGGER_CONFIGURATION, 200, 4, 1, 3]);
             handler.onMessage(array);
             assert(delegate.onError.notCalled);
             array[0] = 255;
@@ -381,7 +381,7 @@ suite('JerryProtocolHandler', () => {
           handler.evaluate('foo');
           assert(debugClient.send.calledOnce);
           assert.deepStrictEqual(debugClient.send.args[0][0], Uint8Array.from([
-            SP.CLIENT.JERRY_DEBUGGER_EVAL, 3, 0, 0, 0,
+            SP.CLIENT.JERRY_DEBUGGER_EVAL, 4, 0, 0, 0, 0,
             'f'.charCodeAt(0), 'o'.charCodeAt(0), 'o'.charCodeAt(0),
           ]));
         });
@@ -398,13 +398,16 @@ suite('JerryProtocolHandler', () => {
           (handler as any).maxMessageSize = 6;
           (handler as any).debuggerClient = debugClient;
           handler.evaluate('foobar');
-          assert(debugClient.send.calledTwice);
+          assert(debugClient.send.calledThrice);
           assert.deepStrictEqual(debugClient.send.args[0][0], Uint8Array.from([
-            SP.CLIENT.JERRY_DEBUGGER_EVAL, 6, 0, 0, 0, 'f'.charCodeAt(0),
+            SP.CLIENT.JERRY_DEBUGGER_EVAL, 7, 0, 0, 0, 0,
           ]));
           assert.deepStrictEqual(debugClient.send.args[1][0], Uint8Array.from([
-            SP.CLIENT.JERRY_DEBUGGER_EVAL_PART, 'o'.charCodeAt(0), 'o'.charCodeAt(0),
-            'b'.charCodeAt(0), 'a'.charCodeAt(0), 'r'.charCodeAt(0),
+            SP.CLIENT.JERRY_DEBUGGER_EVAL_PART, 'f'.charCodeAt(0), 'o'.charCodeAt(0), 'o'.charCodeAt(0),
+            'b'.charCodeAt(0), 'a'.charCodeAt(0),
+          ]));
+          assert.deepStrictEqual(debugClient.send.args[2][0], Uint8Array.from([
+            SP.CLIENT.JERRY_DEBUGGER_EVAL_PART, 'r'.charCodeAt(0),
           ]));
         });
     });
@@ -563,4 +566,4 @@ suite('JerryProtocolHandler', () => {
           assert(debugClient.send.withArgs(Uint8Array.from([SP.CLIENT.JERRY_DEBUGGER_NEXT])));
         });
     });
-});
+});