Branch remote runner plugin fixed

package.json

@@ -40,5 +40,8 @@
   "bugs": {
     "url": "https://github.com/source-academy/plugins/issues"
   },
-  "homepage": "https://github.com/source-academy/plugins#readme"
+  "homepage": "https://github.com/source-academy/plugins#readme",
+  "resolutions": {
+    "@sourceacademy/conductor": "^0.5.0"
+  }
 }

src/common/remoteExecution/manifest.json

@@ -0,0 +1,3 @@
+{
+  "type": "installable"
+}

src/common/remoteExecution/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@sourceacademy/common-remote-execution",
+  "version": "0.0.1",
+  "packageManager": "yarn@4.6.0",
+  "description": "Shared types/constants for the transport-only remote-execution runner plugin and its web-side counterpart",
+  "scripts": {
+    "build": "rollup -c",
+    "prepack": "yarn build"
+  },
+  "license": "ISC",
+  "files": [
+    "dist"
+  ],
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-terser": "^1.0.0",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "rollup": "^4.60.2",
+    "tslib": "^2.8.1",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.9"
+  }
+}

src/common/remoteExecution/rollup.config.mjs

@@ -0,0 +1,21 @@
+import nodeResolve from "@rollup/plugin-node-resolve";
+import terser from "@rollup/plugin-terser";
+import typescript from "@rollup/plugin-typescript";
+
+/**
+ * @type {import('rollup').RollupOptions}
+ */
+export default {
+  input: "src/index.ts",
+  output: [
+    {
+      file: "dist/index.cjs",
+      format: "cjs",
+    },
+    {
+      file: "dist/index.mjs",
+      format: "esm",
+    },
+  ],
+  plugins: [nodeResolve(), typescript(), terser()],
+};

src/common/remoteExecution/src/index.ts

@@ -0,0 +1,18 @@
+export const WEB_ID = "__web_remote_execution";
+export const RUNNER_ID = "__runner_remote_execution";
+
+export const CHANNEL_ID = "remote-execution";
+
+export const MESSAGE_TYPE_CONNECTION_STATUS = "connectionStatus";
+
+/**
+ * Mirrors the existing `DeviceConnection['status']` union from the frontend's
+ * (non-conductor) remoteExecution feature, so a web-side consumer can reuse
+ * the same state machine it already has for the legacy connection flow.
+ */
+export type ConnectionStatus = "CONNECTING" | "CONNECTED" | "FAILED";
+
+export type ConnectionStatusMessage = {
+  type: typeof MESSAGE_TYPE_CONNECTION_STATUS;
+  status: ConnectionStatus;
+};

src/common/remoteExecution/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "exclude": ["./dist"],
+  "include": ["./src"],
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": "./src"
+  }
+}

src/common/test/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "extends": "../../tsconfig.json",
   "exclude": ["./dist"],
-  "include": ["./src"],
+  "include": ["./src", "../../runner/test/src/__tests__/runner.test.ts"],
   "compilerOptions": {
     "declaration": true,
     "outDir": "./dist",

src/runner/remoteExecution/index.ts

@@ -1,24 +1,2 @@
-import { CHANNEL_ID, RUNNER_ID, type PySlangMessage } from "@sourceacademy/common-test";
-import type { IPlugin, IChannel, IConduit } from "@sourceacademy/conductor/conduit";
-import { EV3Engine } from "py-slang/src/engines/ev3/EV3Engine";
-
-export class remoteRunnerPlugin implements IPlugin {
-  readonly id: string = RUNNER_ID;
-  static readonly channelAttach = [CHANNEL_ID];
-  private readonly __channel: IChannel<PySlangMessage>;
-  private readonly engine: EV3Engine;
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  constructor(_conduit: IConduit, [channel]: IChannel<any>[]) {
-    this.__channel = channel;
-    this.engine = new EV3Engine();
-
-    this.__channel.subscribe(async message => {
-      if (message.type === "run") {
-        const result = await this.engine.execute(message.code);
-        console.log("Engine response:", result);
-        this.__channel.send({ type: "result", output: JSON.stringify(result) });
-      }
-    });
-  }
-}
+export { RemoteExecutionPlugin } from "./src";
+export type { ConnectionStatus, ConnectionStatusMessage } from "./src";

src/runner/remoteExecution/package.json

@@ -22,20 +22,22 @@
     "build": "rollup -c",
     "prepack": "yarn build"
   },
-  "dependencies": {
-    "py-slang": "github:proto-aiken-13/py-slang#branch-ev3-engine"
-  },
   "peerDependencies": {
+    "@sourceacademy/common-remote-execution": "workspace:*",
     "@sourceacademy/conductor": "^0.8.0"
   },
   "devDependencies": {
+    "@rollup/plugin-commonjs": "^29.0.3",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-terser": "^1.0.0",
     "@rollup/plugin-typescript": "^12.3.0",
+    "@sourceacademy/common-remote-execution": "workspace:*",
     "@sourceacademy/common-test": "workspace:*",
     "@sourceacademy/conductor": "^0.8.0",
     "@vitest/coverage-istanbul": "^4.1.9",
-    "rollup": "^4.60.2",
+    "esbuild": "^0.28.1",
+    "rollup": "^4.62.2",
+    "rollup-plugin-esbuild": "^6.2.1",
     "tslib": "^2.8.1",
     "typescript": "^6.0.3",
     "vitest": "^4.1.9"

src/runner/remoteExecution/rollup.config.mjs

@@ -2,21 +2,13 @@ import nodeResolve from "@rollup/plugin-node-resolve";
 import terser from "@rollup/plugin-terser";
 import typescript from "@rollup/plugin-typescript";
 
-/**
- * @type {import('rollup').RollupOptions}
- */
-export default {
-  input: "src/index.ts",
-  external: id => id.includes("py-slang"),
-  output: [
-    {
-      file: "dist/index.cjs",
-      format: "cjs",
-    },
-    {
-      file: "dist/index.mjs",
-      format: "esm",
-    },
-  ],
-  plugins: [nodeResolve(), typescript(), terser()],
-};
+export default [
+  {
+    input: "src/index.ts",
+    output: [
+      { file: "dist/index.cjs", format: "cjs" },
+      { file: "dist/index.mjs", format: "esm" },
+    ],
+    plugins: [nodeResolve(), typescript(), terser()],
+  },
+];

src/runner/remoteExecution/src/index.ts

@@ -1 +1,25 @@
-export { remoteRunnerPlugin } from "../index";
+import {
+  CHANNEL_ID,
+  RUNNER_ID,
+  MESSAGE_TYPE_CONNECTION_STATUS,
+  type ConnectionStatusMessage,
+  type ConnectionStatus,
+} from "@sourceacademy/common-remote-execution";
+import type { IPlugin, IChannel, IConduit } from "@sourceacademy/conductor/conduit";
+
+export class RemoteExecutionPlugin implements IPlugin {
+  readonly id: string = RUNNER_ID;
+  static readonly channelAttach = [CHANNEL_ID];
+  private readonly __channel: IChannel<ConnectionStatusMessage>;
+
+  constructor(_conduit: IConduit, [channel]: IChannel<ConnectionStatusMessage>[]) {
+    if (!channel) {
+      throw new Error("Remote execution channel is required but was not provided.");
+    }
+    this.__channel = channel;
+  }
+
+  sendConnectionStatus(status: ConnectionStatus): void {
+    this.__channel.send({ type: MESSAGE_TYPE_CONNECTION_STATUS, status });
+  }
+}

src/runner/test/package.json

@@ -28,6 +28,7 @@
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-terser": "^1.0.0",
     "@rollup/plugin-typescript": "^12.3.0",
+    "@sourceacademy/common-remote-execution": "workspace:*",
     "@sourceacademy/common-test": "workspace:*",
     "@sourceacademy/conductor": "^0.8.0",
     "@sourceacademy/runner-remote-execution": "workspace:*",
@@ -36,8 +37,5 @@
     "tslib": "^2.8.1",
     "typescript": "^6.0.3",
     "vitest": "^4.1.9"
-  },
-  "dependencies": {
-    "py-slang": "github:proto-aiken-13/py-slang#branch-ev3-engine"
   }
 }

src/runner/test/src/__tests__/runner.test.ts

@@ -1,39 +1,32 @@
 import { vi, test, expect } from "vitest";
+import { RemoteExecutionPlugin } from "@sourceacademy/runner-remote-execution";
+import type { ConnectionStatusMessage } from "@sourceacademy/common-remote-execution";
 
-vi.mock("py-slang/src/engines/ev3/EV3Engine", () => ({
-  EV3Engine: class MockEV3Engine {
-    execute(code: string) {
-      return Promise.resolve({ output: `mock: ${code}` });
-    }
-  },
-}));
-
-import { remoteRunnerPlugin } from "@sourceacademy/runner-remote-execution";
-import type { PySlangMessage } from "@sourceacademy/common-test";
-
-test("plugin subscribes to channel and sends result on run message", async () => {
-  const sentMessages: PySlangMessage[] = [];
-  let messageHandler: (msg: PySlangMessage) => void = () => {};
+test("plugin forwards connection status over its channel without touching execution", () => {
+  const sentMessages: ConnectionStatusMessage[] = [];
 
   const mockChannel = {
-    name: "py_slang_channel",
-    send: (msg: PySlangMessage) => {
+    name: "remote-execution",
+    send: (msg: ConnectionStatusMessage) => {
       sentMessages.push(msg);
     },
-    subscribe: (handler: (msg: PySlangMessage) => void) => {
-      messageHandler = handler;
-    },
-    unsubscribe: () => {},
-    close: () => {},
+    subscribe: vi.fn(),
+    unsubscribe: vi.fn(),
+    close: vi.fn(),
   };
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const mockConduit = {} as any;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  new remoteRunnerPlugin(mockConduit, [mockChannel as any]);
+  const plugin = new RemoteExecutionPlugin(mockConduit, [mockChannel]);
+
+  plugin.sendConnectionStatus("CONNECTED");
 
-  await messageHandler({ type: "run", code: "1 + 1" });
+  expect(sentMessages).toStrictEqual([{ type: "connectionStatus", status: "CONNECTED" }]);
+});
+
+test("plugin construction throws if no channel is attached", () => {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const mockConduit = {} as any;
 
-  expect(sentMessages.length).toBeGreaterThan(0);
-  expect(sentMessages[0]).toMatchObject({ type: "result" });
+  expect(() => new RemoteExecutionPlugin(mockConduit, [])).toThrow();
 });