Add reactions for status channel changes and refactor UI handling of __error and __result channel

package.json

@@ -44,7 +44,7 @@
     "@reduxjs/toolkit": "^1.9.7",
     "@sentry/react": "^10.5.0",
     "@sourceacademy/c-slang": "^1.0.21",
-    "@sourceacademy/conductor": "https://github.com/source-academy/conductor.git#0.3.0",
+    "@sourceacademy/conductor": "https://github.com/source-academy/conductor.git#0.4.0",
     "@sourceacademy/language-directory": "https://github.com/source-academy/language-directory.git#0.0.6",
     "@sourceacademy/plugin-directory": "https://github.com/source-academy/plugin-directory.git#0.0.2",
     "@sourceacademy/sharedb-ace": "2.1.1",

public/evaluators/debug/dummy-conductor-evaluator.js

@@ -1,84 +1,130 @@
-/* Dummy evaluator written in class style using this.conductor.send* calls. */
-(function () {
+/* Dummy evaluator using conductor runner API */
+(async function () {
   'use strict';
 
-  const CHANNEL = {
-    CHUNK: '__chunk',
-    SERVICE: '__service',
-    STDIO: '__stdio',
-    RESULT: '__result',
-    ERROR: '__error'
-  };
-
-  const SERVICE = {
-    HELLO: 0,
-    ENTRY: 2
-  };
-
-  const ports = Object.create(null);
-  const chunkQueue = [];
-  const chunkWaiters = [];
-
-  function post(channelName, payload) {
-    const port = ports[channelName];
-    if (port) {
-      port.postMessage(payload);
-    }
+  // The worker can receive channel-attach messages before async imports resolve.
+  // Buffer and replay them once the conductor runner has been initialised.
+  const earlyMessages = [];
+  function captureEarlyMessage(event) {
+    earlyMessages.push(event);
   }
+  self.addEventListener('message', captureEarlyMessage);
+
+  // Fixed version of conductor runner that is known to work with the current conductor API.
+  const CONDUCTOR_RUNNER_URL =
+    'https://cdn.jsdelivr.net/npm/@sourceacademy/conductor@0.3.0/dist/conductor/runner/index.js';
+  const CONDUCTOR_TYPES_URL =
+    'https://cdn.jsdelivr.net/npm/@sourceacademy/conductor@0.3.0/dist/conductor/types/index.js';
 
   function parseResult(text) {
     const value = text.trim();
     if (value.length === 0) {
       return '';
     }
+
     try {
       return JSON.parse(value);
     } catch (e) {
       return value;
     }
   }
 
-  function pushChunk(message) {
-    const waiter = chunkWaiters.shift();
-    if (waiter) {
-      waiter(message);
-      return;
+  function normaliseError(err, fallbackName) {
+    if (err && typeof err === 'object') {
+      return {
+        name: typeof err.name === 'string' ? err.name : fallbackName,
+        message: typeof err.message === 'string' ? err.message : String(err)
+      };
     }
-    chunkQueue.push(message);
+
+    return { name: fallbackName, message: String(err) };
   }
 
-  function popChunk() {
-    if (chunkQueue.length > 0) {
-      return Promise.resolve(chunkQueue.shift());
+  let runnerConductor;
+  let activeEvaluator;
+
+  function failActiveExecution(error) {
+    if (!runnerConductor) {
+      return;
     }
-    return new Promise(resolve => {
-      chunkWaiters.push(resolve);
-    });
+
+    runnerConductor.sendError(normaliseError(error, 'DummyEvaluatorFatalError'));
+    activeEvaluator?.failExecution();
   }
 
-  class BasicEvaluator {
+  class DummyEvaluator {
     constructor(conductor) {
       this.conductor = conductor;
+      runnerConductor = conductor;
+      activeEvaluator = this;
+      this.conductor.updateStatus(RunnerStatus.EVAL_READY, true);
+    }
+
+    beginExecution() {
+      this.conductor.updateStatus(RunnerStatus.EVAL_READY, false);
+      this.conductor.updateStatus(RunnerStatus.WAITING, false);
+      this.conductor.updateStatus(RunnerStatus.RUNNING, true);
+    }
+
+    finishExecution() {
+      this.conductor.updateStatus(RunnerStatus.RUNNING, false);
+      this.conductor.updateStatus(RunnerStatus.WAITING, true);
+    }
+
+    stopExecution() {
+      this.conductor.updateStatus(RunnerStatus.RUNNING, false);
+      this.conductor.updateStatus(RunnerStatus.WAITING, false);
+      this.conductor.updateStatus(RunnerStatus.STOPPED, true);
+    }
+
+    failExecution() {
+      this.conductor.updateStatus(RunnerStatus.RUNNING, false);
+      this.conductor.updateStatus(RunnerStatus.WAITING, false);
+      this.conductor.updateStatus(RunnerStatus.ERROR, true);
+    }
+
+    sendDisplayResult(result) {
+      this.conductor.sendResult(result);
+    }
+
+    sendDisplayError(error) {
+      this.conductor.sendError(error);
     }
 
     async startEvaluator(entryPoint) {
-      await this.evaluateFile(entryPoint, '');
+      const fileContent = await this.conductor.requestFile(entryPoint);
+      if (!fileContent) {
+        throw new Error('Cannot load entrypoint file');
+      }
+
+      this.beginExecution();
+      const shouldContinue = await this.evaluateFile(entryPoint, fileContent);
+      if (shouldContinue === false) {
+        return;
+      }
+      this.finishExecution();
+
       while (true) {
+        this.conductor.updateStatus(RunnerStatus.WAITING, true);
         const chunk = await this.conductor.requestChunk();
-        await this.evaluateChunk(chunk);
+        this.beginExecution();
+        const shouldContinue = await this.evaluateChunk(chunk);
+        if (shouldContinue === false) {
+          return;
+        }
+        this.finishExecution();
       }
     }
 
-    async evaluateFile(fileName, fileContent) {
-      return this.evaluateChunk(fileContent);
-    }
-  }
-
-  class DummyEvaluator extends BasicEvaluator {
     async evaluateFile(fileName, fileContent) {
       this.conductor.sendOutput('[dummy] output message');
-      this.conductor.sendResult('[dummy] result message');
-      this.conductor.sendError({ name: 'DummyEvaluatorError', message: '[dummy] error message' });
+      this.conductor.sendOutput(`[dummy] loaded file 1`);
+      this.conductor.sendOutput(`[dummy] loaded file 2`);
+      this.sendDisplayError({ name: 'DummyEvaluatorError', message: '[dummy] error message' });
+      this.conductor.sendOutput(`[dummy] loaded file 3`);
+      this.sendDisplayResult('[dummy] result message');
+
+      return true;
     }
 
     async evaluateChunk(chunk) {
@@ -90,89 +136,54 @@
       }
 
       if (text.startsWith('result ')) {
-        this.conductor.sendResult(parseResult(text.slice(7)));
-        return;
+        this.sendDisplayResult(parseResult(text.slice(7)));
+        return true;
       }
 
       if (text.startsWith('error ')) {
-        this.conductor.sendError({ name: 'DummyEvaluatorError', message: text.slice(6) });
-        return;
+        this.sendDisplayError({ name: 'DummyEvaluatorError', message: text.slice(6) });
+        return true;
       }
 
-      this.conductor.sendOutput('[dummy] try: output ..., result ..., error ...');
-    }
-  }
-
-  const conductor = {
-    async requestChunk() {
-      const message = await popChunk();
-      return typeof message?.chunk === 'string' ? message.chunk : '';
-    },
-    sendOutput(message) {
-      post(CHANNEL.STDIO, { message: String(message) });
-    },
-    sendResult(value) {
-      post(CHANNEL.RESULT, { result: value });
-    },
-    sendError(error) {
-      post(CHANNEL.ERROR, { error });
-    }
-  };
-
-  const evaluator = new DummyEvaluator(conductor);
-
-  function onService(message) {
-    if (!message || typeof message.type !== 'number') {
-      return;
-    }
+      if (text === 'stop') {
+        this.stopExecution();
+        return false;
+      }
 
-    if (message.type === SERVICE.HELLO) {
-      post(CHANNEL.SERVICE, { type: SERVICE.HELLO, data: { version: 0 } });
-      return;
-    }
+      if (text.startsWith('fatal ')) {
+        this.sendDisplayError({ name: 'DummyEvaluatorError', message: text.slice(6) });
+        this.failExecution();
+        return false;
+      }
 
-    if (message.type === SERVICE.ENTRY) {
-      evaluator.startEvaluator(message.data).catch(function (err) {
-        conductor.sendError({
-          name: 'DummyEvaluatorFatalError',
-          message: err && err.message ? err.message : String(err)
-        });
-      });
+      this.conductor.sendOutput('[dummy] try: output ..., result ..., error ..., stop, fatal ...');
+      return true;
     }
   }
 
-  self.addEventListener('message', function (event) {
-    const data = event.data;
-    if (!Array.isArray(data) || data.length !== 2) {
-      return;
-    }
+  const runner = await import(CONDUCTOR_RUNNER_URL);
+  const { RunnerStatus } = await import(CONDUCTOR_TYPES_URL);
+  const initialise = runner.initialise;
 
-    const channelName = data[0];
-    const port = data[1];
-    if (typeof channelName !== 'string' || !port) {
-      return;
-    }
-
-    ports[channelName] = port;
+  if (typeof initialise !== 'function') {
+    throw new Error('Failed to load conductor runner initialise()');
+  }
 
-    if (channelName === CHANNEL.SERVICE) {
-      port.addEventListener('message', function (e) {
-        onService(e.data);
-      });
-      port.start();
-      return;
-    }
+  self.addEventListener('unhandledrejection', function (event) {
+    event.preventDefault();
+    failActiveExecution(event.reason);
+  });
 
-    if (channelName === CHANNEL.CHUNK) {
-      port.addEventListener('message', function (e) {
-        pushChunk(e.data);
-      });
-      port.start();
-      return;
-    }
+  initialise(DummyEvaluator);
 
-    if (typeof port.start === 'function') {
-      port.start();
-    }
-  });
-})();
+  self.removeEventListener('message', captureEarlyMessage);
+  for (const event of earlyMessages) {
+    self.dispatchEvent(
+      new MessageEvent('message', {
+        data: event.data
+      })
+    );
+  }
+})().catch(function (err) {
+  console.error('Failed to bootstrap dummy conductor evaluator:', err);
+});

src/commons/application/actions/InterpreterActions.ts

@@ -9,6 +9,11 @@ const InterpreterActions = createActions('interpreter', {
     logString,
     workspaceLocation
   }),
+  appendInterpreterResult: (value: Value, workspaceLocation: WorkspaceLocation) => ({
+    type: 'result',
+    value,
+    workspaceLocation
+  }),
   evalInterpreterSuccess: (value: Value, workspaceLocation: WorkspaceLocation) => ({
     type: 'result',
     value,
@@ -31,6 +36,15 @@ const InterpreterActions = createActions('interpreter', {
     errors,
     workspaceLocation
   }),
+  appendInterpreterError: (errors: SourceError[], workspaceLocation: WorkspaceLocation) => ({
+    type: 'errors',
+    errors,
+    workspaceLocation
+  }),
+  setIsRunning: (isRunning: boolean, workspaceLocation: WorkspaceLocation) => ({
+    isRunning,
+    workspaceLocation
+  }),
   beginInterruptExecution: (workspaceLocation: WorkspaceLocation) => ({ workspaceLocation }),
   endInterruptExecution: (workspaceLocation: WorkspaceLocation) => ({ workspaceLocation }),
   beginDebuggerPause: (workspaceLocation: WorkspaceLocation) => ({ workspaceLocation }),

src/commons/application/actions/__tests__/InterpreterActions.test.ts

@@ -30,6 +30,19 @@ test('evalInterpreterSuccess generates correct action object', () => {
   });
 });
 
+test('appendInterpreterResult generates correct action object', () => {
+  const value = 'value';
+  const action = InterpreterActions.appendInterpreterResult(value, gradingWorkspace);
+  expect(action).toEqual({
+    type: InterpreterActions.appendInterpreterResult.type,
+    payload: {
+      type: 'result',
+      value,
+      workspaceLocation: gradingWorkspace
+    }
+  });
+});
+
 test('evalTestcaseSuccess generates correct action object', () => {
   const value = 'another value';
   const index = 3;
@@ -58,6 +71,30 @@ test('evalInterpreterError generates correct action object', () => {
   });
 });
 
+test('appendInterpreterError generates correct action object', () => {
+  const errors: any = [];
+  const action = InterpreterActions.appendInterpreterError(errors, assessmentWorkspace);
+  expect(action).toEqual({
+    type: InterpreterActions.appendInterpreterError.type,
+    payload: {
+      type: 'errors',
+      errors,
+      workspaceLocation: assessmentWorkspace
+    }
+  });
+});
+
+test('setIsRunning generates correct action object', () => {
+  const action = InterpreterActions.setIsRunning(false, playgroundWorkspace);
+  expect(action).toEqual({
+    type: InterpreterActions.setIsRunning.type,
+    payload: {
+      isRunning: false,
+      workspaceLocation: playgroundWorkspace
+    }
+  });
+});
+
 test('beginInterruptExecution generates correct action object', () => {
   const action = InterpreterActions.beginInterruptExecution(gradingWorkspace);
   expect(action).toEqual({