Branch remote runner plugin by proto-aiken-13 · Pull Request #23 · source-academy/plugins

proto-aiken-13 · 2026-06-15T05:01:40Z

Set up a remote runner plugin under the runner/dist directory to receive code from the ev3 engine in py-slang

Set up the remote runner plugin, and associated directory and index files to be linked to the ev3 engine in py-slang

changeset-bot · 2026-06-15T05:01:44Z

⚠️ No Changeset found

Latest commit: f9fa921

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

gemini-code-assist

Code Review

This pull request establishes a monorepo structure for plugins using Yarn workspaces, adding configuration files for ESLint, Prettier, Jest, and VSCode, alongside a custom build script to manage plugin manifests. It also bootstraps initial test packages for common, runner, and web environments. The code review highlights several critical issues that must be addressed before merging, including a missing type export (PySlangMessage), hardcoded absolute local file paths in imports and tsconfig.json mappings, incorrect import paths in tests, a hardcoded failing test assertion, and a class naming convention violation.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

gemini-code-assist · 2026-06-15T05:03:13Z

+
+export const CHANNEL_ID = "test";
+
+export type TestMessage = "ping" | "pong";


The type PySlangMessage is imported by both src/runner/test/src/remoteExecution/index.ts and src/runner/test/src/__tests__/runner.test.ts from @sourceacademy/common-test, but it is not defined or exported here. This will cause compilation errors. Please define and export PySlangMessage in this file.

Suggested change

export type TestMessage = "ping" | "pong";

export type TestMessage = "ping" | "pong";

export type PySlangMessage = {

type: "run";

code: string;

};

++, but put it in a separate common/remoteExecution package

gemini-code-assist · 2026-06-15T05:03:13Z

@@ -0,0 +1,26 @@
+import { CHANNEL_ID, RUNNER_ID, type PySlangMessage } from "@sourceacademy/common-test";
+import { IPlugin, IChannel, IConduit } from "@sourceacademy/conductor/conduit";
+import { EV3Engine } from "C:/Users/Migue/OneDrive/Desktop/Projects/py-slang-2/src/engines/ev3/EV3Engine";


Avoid using absolute local file paths (e.g., C:/Users/...) for imports, as this will fail to compile on any other machine or in CI/CD environments. Since py-slang is listed as a dependency in package.json, you should import EV3Engine directly from the py-slang package.

Suggested change

import { EV3Engine } from "C:/Users/Migue/OneDrive/Desktop/Projects/py-slang-2/src/engines/ev3/EV3Engine";

import { EV3Engine } from "py-slang";

gemini-code-assist · 2026-06-15T05:03:13Z

+    "rootDir": ".",
+    "paths": {
+      "@py-slang/*": ["C:/Users/Migue/OneDrive/Desktop/Projects/py-slang-2/src/*"]
+    }


Avoid hardcoding absolute local paths in tsconfig.json path mappings, as this breaks compilation on other environments. Since py-slang is installed as a package dependency, this path mapping is unnecessary and should be removed.

"rootDir": "."

gemini-code-assist · 2026-06-15T05:03:13Z

@@ -0,0 +1,25 @@
+import { remoteRunnerPlugin } from "..";


The import of remoteRunnerPlugin from ".." (which points to src/runner/test/src/index.ts) will fail because remoteRunnerPlugin is not exported from the package entry point. Import it directly from the relative path ../remoteExecution to fix the test compilation, and consider exporting it from src/runner/test/src/index.ts if it is intended to be part of the public API.

Suggested change

import { remoteRunnerPlugin } from "..";

import { remoteRunnerPlugin } from "../remoteExecution";

gemini-code-assist · 2026-06-15T05:03:13Z

+
+  expect(sentMessages.length).toBeGreaterThan(0);
+  console.log(sentMessages[0]);
+  expect(sentMessages[0]).toEqual("FORCE_FAIL_TO_SEE_OUTPUT");


The assertion expect(sentMessages[0]).toEqual("FORCE_FAIL_TO_SEE_OUTPUT"); is hardcoded to fail. This was likely added for debugging purposes to inspect the output. Please replace it with a proper assertion matching the expected output of the engine execution so that the test suite can pass in CI.

Suggested change

expect(sentMessages[0]).toEqual("FORCE_FAIL_TO_SEE_OUTPUT");

expect(sentMessages[0]).toBeDefined();

gemini-code-assist · 2026-06-15T05:03:13Z

+import { IPlugin, IChannel, IConduit } from "@sourceacademy/conductor/conduit";
+import { EV3Engine } from "C:/Users/Migue/OneDrive/Desktop/Projects/py-slang-2/src/engines/ev3/EV3Engine";
+
+export class remoteRunnerPlugin implements IPlugin {


Following standard TypeScript naming conventions, class names should use PascalCase. Please rename remoteRunnerPlugin to RemoteRunnerPlugin and update all references accordingly.

Suggested change

export class remoteRunnerPlugin implements IPlugin {

export class RemoteRunnerPlugin implements IPlugin {

AaravMalani · 2026-06-15T19:35:41Z

Could you please rebase the branch off main instead of the init-infra branch (ensure the main branch is not out of date, check out your local branch, run git rebase --onto main 7e9293f, then git push --force-with-lease), so the merge conflicts go away? Thanks!

AaravMalani

I may have missed a couple of changes, but for now, I have a couple of recommendations

Rebase the branch onto main as mentioned in the previous comments (it'll help me look through your code easily as well)
Move the remote execution code into a separate folder. Each directory under the runner, common and web represents a distinct package. They'll each have their own package.json, manifest, etc. and get published as a separate package (if they're installable) or deployed onto GitHub Pages under a separate plugin definition in the plugin directory (if they're external)

AaravMalani · 2026-06-15T19:37:50Z

The remoteExecution directory would be a sibling of the runner/test directory, not a child of it.

runner ├─── test └─── remoteExecution

It would have its own manifest, package.json, rollup.config.mjs, etc.
Just make a copy of the runner/test directory and rename it to runner/remoteExecution.

AaravMalani · 2026-06-15T19:39:11Z

+import { IPlugin, IChannel, IConduit } from "@sourceacademy/conductor/conduit";
+import { EV3Engine } from "C:/Users/Migue/OneDrive/Desktop/Projects/py-slang-2/src/engines/ev3/EV3Engine";
+
+export class remoteRunnerPlugin implements IPlugin {


AaravMalani · 2026-06-15T19:39:23Z

@@ -0,0 +1,26 @@
+import { CHANNEL_ID, RUNNER_ID, type PySlangMessage } from "@sourceacademy/common-test";
+import { IPlugin, IChannel, IConduit } from "@sourceacademy/conductor/conduit";
+import { EV3Engine } from "C:/Users/Migue/OneDrive/Desktop/Projects/py-slang-2/src/engines/ev3/EV3Engine";


AaravMalani · 2026-06-15T19:40:43Z

+
+  constructor(
+    _conduit: IConduit,
+    [channel]: IChannel<any>[],


You might have to ESLint ignore this line for now, otherwise it throws a warning

AaravMalani · 2026-06-15T19:41:19Z

@@ -0,0 +1,26 @@
+import { CHANNEL_ID, RUNNER_ID, type PySlangMessage } from "@sourceacademy/common-test";


It shouldn't share the same CHANNEL_ID and RUNNER_ID as the test package
They are separate plugins

AaravMalani · 2026-06-15T19:41:58Z

+
+export const CHANNEL_ID = "test";
+
+export type TestMessage = "ping" | "pong";


++, but put it in a separate common/remoteExecution package

AaravMalani and others added 17 commits May 26, 2026 23:23

feat: add initial packages + tsconfig

305f5cc

feat: add ESLint and Prettier + tsconfigs

5ca4abb

feat: add build script

10e4aae

feat: add CI/CD infra

260ef38

feat: add test plugins

6bbe350

fix: Gemini issues

30341f9

chore: format files

1c8759d

fix: add yarn.lock

19f724b

fix: update build script to topologically sort devDependencies

f26ab4b

chore: format files

28dd7eb

Merge branch 'main' into feat/add-init-infra

3828ae7

chore: format files

d444035

feat: add changesets to automate versioning bumps

aa882df

fix: properly copy dist files

34b7a93

chore: format files

1da7e82

chore: prettierignore the config file for changeset

7e9293f

Setup of the remoteRunner plugin

f9fa921

Set up the remote runner plugin, and associated directory and index files to be linked to the ev3 engine in py-slang

gemini-code-assist Bot reviewed Jun 15, 2026

View reviewed changes

AaravMalani reviewed Jun 15, 2026

View reviewed changes


		export const CHANNEL_ID = "test";

		export type TestMessage = "ping" \| "pong";

-export type TestMessage = "ping" | "pong";
+export type TestMessage = "ping" | "pong";
+export type PySlangMessage = {
+  type: "run";
+  code: string;
+};

	import { EV3Engine } from "C:/Users/Migue/OneDrive/Desktop/Projects/py-slang-2/src/engines/ev3/EV3Engine";
	import { EV3Engine } from "py-slang";

	import { remoteRunnerPlugin } from "..";
	import { remoteRunnerPlugin } from "../remoteExecution";

	expect(sentMessages[0]).toEqual("FORCE_FAIL_TO_SEE_OUTPUT");
	expect(sentMessages[0]).toBeDefined();

	export class remoteRunnerPlugin implements IPlugin {
	export class RemoteRunnerPlugin implements IPlugin {

		@@ -0,0 +1,26 @@
		import { CHANNEL_ID, RUNNER_ID, type PySlangMessage } from "@sourceacademy/common-test";

Conversation

proto-aiken-13 commented Jun 15, 2026

Uh oh!

changeset-bot Bot commented Jun 15, 2026

⚠️ No Changeset found

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AaravMalani commented Jun 15, 2026

Uh oh!

AaravMalani left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants