Deploy conductor-ready modules to modules-conductor

.github/actions/src/info/__tests__/sorter.test.ts

@@ -89,4 +89,27 @@ describe(topoSortPackages, () => {
 
     expect(func).toThrowError('Dependency graph has a cycle!');
   });
+
+  test('A dependency sharing the @sourceacademy scope but not a local workspace package (e.g. the real published @sourceacademy/conductor npm package) is ignored, not treated as a graph node', () => {
+    const result = topoSortPackages({
+      '@sourceacademy/0': {
+        type: null,
+        hasChanges: false,
+        directory: '/',
+        package: {
+          name: '@sourceacademy/0',
+          devDependencies: {},
+          dependencies: {
+            // Not a key of this packages record at all - a real npm dependency, not a workspace
+            // package - so it must not end up in the topological order (there's no
+            // RawPackageRecord for it, and processRawPackages would crash reading .hasChanges off
+            // undefined otherwise).
+            '@sourceacademy/conductor': 'npm:^0.7.1'
+          }
+        }
+      }
+    });
+
+    expect(result).toEqual(['@sourceacademy/0']);
+  });
 });

.github/actions/src/info/sorter.ts

@@ -28,7 +28,11 @@ export function topoSortPackages(packages: Record<string, RawPackageRecord>) {
     }
 
     for (const name of keys) {
-      if (name.startsWith('@sourceacademy')) {
+      // A dependency starting with @sourceacademy isn't necessarily a local workspace package -
+      // e.g. @sourceacademy/conductor is a real published npm package that just happens to share
+      // the org scope. Only graph it if it's an actual node in this monorepo; otherwise it has no
+      // RawPackageRecord and processRawPackages crashes reading .hasChanges off undefined.
+      if (name.startsWith('@sourceacademy') && name in packages) {
         if (!(name in indegrees)) {
           indegrees[name] = 1;
         } else {

.github/workflows/conductor-deploy.yml

@@ -0,0 +1,49 @@
+name: Deploy to modules-conductor
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches:
+      - conductor-migration
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v6
+        with:
+          submodules: recursive
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Use Node.js 💻
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: .node-version
+          cache: yarn
+
+      - name: Install Dependencies 📦
+        run: yarn install --immutable
+
+      - name: Build Modules 🔧
+        run: yarn workspaces foreach -ptW --from "./src/{bundles,tabs}/*" run build
+
+      - name: Build Manifest
+        run: yarn buildtools manifest
+
+      - name: Build All Docs
+        run: yarn build:docs
+
+      - name: include java json
+        run: cp -r src/java build
+
+      - name: Deploy 🚀
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          deploy_key: ${{ secrets.CONDUCTOR_DEPLOY_KEY }}
+          external_repository: source-academy/modules-conductor
+          publish_dir: ./build

.yarnrc.yml

@@ -10,11 +10,13 @@ npmMinimalAgeGate: 4320 # 3 days
 # exempt our own first-party packages
 npmPreapprovedPackages:
   - js-slang
+  - '@sourceacademy/conductor'
 
 # Supported from Yarn 4.10.0 onwards
 # https://yarnpkg.com/features/catalogs
 # Define here to avoid duplications
 catalog:
+  '@sourceacademy/conductor': ^0.8.2
   js-slang: ^1.0.94
   react: ^19.0.0
   react-dom: ^19.0.0

docs/src/modules/2-bundle/4-conventions/3-errors.md

@@ -105,14 +105,13 @@ Specific to error handling, thrown errors should contain a reference to the call
 ```ts twoslash
 import { GeneralRuntimeError } from '@sourceacademy/modules-lib/errors';
 import type { Wave, Sound } from '@sourceacademy/bundle-sound/types';
-import { pair } from 'js-slang/dist/stdlib/list';
 // ---cut---
 export function make_sound(wave: Wave, duration: number): Sound {
   if (duration < 0) {
     throw new GeneralRuntimeError(`${make_sound.name}: Sound duration must be greater than or equal to 0`);
   }
 
-  return pair((t: number) => (t >= duration ? 0 : wave(t)), duration);
+  return { leftWave: wave, rightWave: wave, duration };
 }
 ```
 

docs/src/modules/2-bundle/4-conventions/4-types.md

@@ -585,9 +585,10 @@ export function run_callback(f: () => void) {
 You can also provide arguments:
 
 ```ts twoslash
-import type { Curve } from '@sourceacademy/bundle-curve/curves_webgl';
 import { callWithoutMetadata } from '@sourceacademy/modules-lib/utilities';
 
+type Curve = (t: number) => number;
+
 export function makeNewCurve(c: Curve, numPoints: number): Curve {
   for (let i = 0; i < numPoints; i++) {
     const point = callWithoutMetadata(c, i / numPoints);
@@ -606,9 +607,10 @@ functions that are provided from the _standard library_ or from other module fun
 `callIfFuncAndRightArgs` is used when you want to provide extra metadata about where the function was defined:
 
 ```ts twoslash
-import type { Curve } from '@sourceacademy/bundle-curve/curves_webgl';
 import { callIfFuncAndRightArgs } from '@sourceacademy/modules-lib/utilities';
 
+type Curve = (t: number) => number;
+
 export function evaluateCurve(c: Curve, numPoints: number) {
   for (let i = 0; i < numPoints; i++) {
     // Line Number, Column Number, File name, NativeStorage (usually undefined), ...args

docs/src/modules/3-tabs/1-overview.md

@@ -90,25 +90,25 @@ export default defineTab({
 
 Here is an example of a tab object:
 
-```tsx twoslash [Sound/src/index.tsx]
+```tsx twoslash [Curve/src/index.tsx]
 // @jsx: react-jsx
-import type { AudioPlayed } from '@sourceacademy/bundle-sound/types';
-declare function SoundTab(props: { elements: AudioPlayed[] }): React.ReactElement;
+import type { CurveModuleState as _CurveModuleState } from '@sourceacademy/bundle-curve/types';
+declare function CurveRenderer(props: { elements: _CurveModuleState['drawnCurves'] }): React.ReactElement;
 // ---cut---
-import type { SoundModuleState } from '@sourceacademy/bundle-sound/types';
+import type { CurveModuleState } from '@sourceacademy/bundle-curve/types';
 import { defineTab, getModuleState } from '@sourceacademy/modules-lib/tabs/utils';
 
 export default defineTab({
   toSpawn(context) {
-    const state = getModuleState<SoundModuleState>(context, 'sound');
-    return !!state && state.audioPlayed.length > 0;
+    const state = getModuleState<CurveModuleState>(context, 'curve');
+    return !!state && state.drawnCurves.length > 0;
   },
   body(context) {
-    const { audioPlayed } = getModuleState<SoundModuleState>(context, 'sound')!;
-    return <SoundTab elements={audioPlayed} />;
+    const { drawnCurves } = getModuleState<CurveModuleState>(context, 'curve')!;
+    return <CurveRenderer elements={drawnCurves} />;
   },
-  label: 'Sound Tab',
-  iconName: 'music'
+  label: 'Curve Tab',
+  iconName: 'graph'
 });
 ```
 
@@ -152,6 +152,6 @@ Note that `IconName`s are defined in `@blueprintjs/core`, but it is not necessar
 
 A tab is only evaluated once per Source evaluation. Only one instance of a given tab can be spawned at the same time. Your tab and bundle should be designed with this in mind.
 
-For example, the `sound` bundle stores in its state an array of `AudioPlayed` objects, which allows the single tab to handle multiple calls to `play_in_tab`, which is the function in the bundle that causes the tab to spawn.
+For example, the `curve` bundle stores in its state an array of drawn curves, which allows the single tab to handle multiple draw calls across a program's evaluation, accumulating them all into one tab instance instead of spawning a new one per call.
 
 Other bundles like `repl` have a single instance. The bundle never spawns a second instance of its programmable REPL, so the single REPL tab that spawns handles everything.

docs/src/modules/3-tabs/3-editing.md

@@ -195,9 +195,9 @@ test('Matches snapshot', () => {
 > property accesses or object destructuring:
 >
 > ```ts
-> const { context: { moduleContexts: { sound: { state: { audioPlayed } } } } } = context;
+> const { context: { moduleContexts: { curve: { state: { drawnCurves } } } } } = context;
 > // or
-> const audioPlayed = context.context.moduleContexts.sound.state.audioPlayed;
+> const drawnCurves = context.context.moduleContexts.curve.state.drawnCurves;
 > ```
 >
 > The risk here is that each one of these property accesses could return `null` or `undefined`, resulting
@@ -208,8 +208,8 @@ test('Matches snapshot', () => {
 > ```ts
 > const toSpawn = (context: DebuggerContext): boolean => {
 >   // Can't use destructuring with null coalescing
->   const audioPlayed = context.context.moduleContexts?.sound?.state?.audioPlayed;
->   return audioPlayed && audioPlayed.length > 0;
+>   const drawnCurves = context.context.moduleContexts?.curve?.state?.drawnCurves;
+>   return drawnCurves && drawnCurves.length > 0;
 > };
 > ```
 >
@@ -218,14 +218,14 @@ test('Matches snapshot', () => {
 >
 > ```ts twoslash
 > import type { DebuggerContext } from '@sourceacademy/modules-lib/types';
-> import type { SoundModuleState } from '@sourceacademy/bundle-sound/types';
+> import type { CurveModuleState } from '@sourceacademy/bundle-curve/types';
 > // ---cut---
 > import { getModuleState } from '@sourceacademy/modules-lib/tabs/utils';
 >
 > const toSpawn = (context: DebuggerContext): boolean => {
 >   // Can't use destructuring with null coalescing
->   const state = getModuleState<SoundModuleState>(context, 'sound');
->   return !!state && state.audioPlayed.length > 0;
+>   const state = getModuleState<CurveModuleState>(context, 'curve');
+>   return !!state && state.drawnCurves.length > 0;
 > };
 > ```
 >
@@ -234,14 +234,15 @@ test('Matches snapshot', () => {
 > ```tsx twoslash
 > // @jsx: react-jsx
 > import type { DebuggerContext } from '@sourceacademy/modules-lib/types';
-> import type { AudioPlayed, SoundModuleState } from '@sourceacademy/bundle-sound/types';
-> declare function SoundTab(props: { elements: AudioPlayed[] }): React.ReactElement;
+> import type { CurveModuleState as _CurveModuleState } from '@sourceacademy/bundle-curve/types';
+> declare function CurveRenderer(props: { elements: _CurveModuleState['drawnCurves'] }): React.ReactElement;
 > // ---cut---
+> import type { CurveModuleState } from '@sourceacademy/bundle-curve/types';
 > import { getModuleState } from '@sourceacademy/modules-lib/tabs/utils';
 >
 > const body = (context: DebuggerContext): React.ReactElement => {
->   const { audioPlayed } = getModuleState<SoundModuleState>(context, 'sound')!;
->   return <SoundTab elements={audioPlayed} />;
+>   const { drawnCurves } = getModuleState<CurveModuleState>(context, 'curve')!;
+>   return <CurveRenderer elements={drawnCurves} />;
 > };
 > ```
 >

docs/src/modules/3-tabs/5-animations/5-animations.md

@@ -97,9 +97,9 @@ export default function HollusionCanvas({ rune }: Props) {
   const renderFuncRef = useRef<(time: number) => void>(undefined);
 
   const { setCanvas } = useAnimation({
-    callback({ timestamp, canvas }) {
+    async callback({ timestamp, canvas }) {
       if (renderFuncRef.current === undefined) {
-        renderFuncRef.current = rune.draw(canvas);
+        renderFuncRef.current = await rune.draw(canvas);
       }
       renderFuncRef.current(timestamp);
     },
@@ -244,7 +244,7 @@ type RuneAnimation = (t: number) => Rune;
 But Source doesn't have the ability to enforce this at runtime, so a cadet might accidentally return something that isn't a rune:
 
 ```ts twoslash
-// @noErrors: 2322
+// @errors: 2614 7006
 import { animate_rune, heart } from '@sourceacademy/bundle-rune';
 
 animate_rune(1, 60, t => t < 60 ? heart : 0);

docs/src/modules/5-advanced/context.md

@@ -7,21 +7,21 @@ Some times, a bundle needs to be able to maintain some state information, or sen
 
 Every time `js-slang` evaluates Source code, it creates an evaluation context. Bundles can access this context by using this import:
 
-```ts twoslash [sound/functions.ts]
+```ts twoslash [curve/functions.ts]
 // @paths: { "js-slang/context": ["./context.d.ts"] }
 // @filename: context.d.ts
 import type { Context } from 'js-slang';
 declare const ctx: Context;
 export default ctx;
 
 // @filename: curve.ts
-import type { AudioPlayed } from '@sourceacademy/bundle-sound/types';
+import type { CurveModuleState } from '@sourceacademy/bundle-curve/types';
 // ---cut---
 import context from 'js-slang/context';
 
-const audioPlayed: AudioPlayed[] = [];
-context.moduleContexts.sound.state = {
-  audioPlayed
+const drawnCurves: CurveModuleState['drawnCurves'] = [];
+context.moduleContexts.curve.state = {
+  drawnCurves
 };
 ```
 
@@ -31,22 +31,22 @@ The `state` object can be of any type - it is up to the developer to decide what
 
 This `state` object can then be accessed by the module's tab, for example:
 
-```tsx twoslash [Sound/index.tsx]
+```tsx twoslash [Curve/index.tsx]
 // @jsx: react-jsx
 import type { DebuggerContext } from '@sourceacademy/modules-lib/types';
-declare function SoundTab(props: { context: DebuggerContext }): React.ReactElement;
+declare function CurveRenderer(props: { context: DebuggerContext }): React.ReactElement;
 // ---cut---
 import { defineTab, getModuleState } from '@sourceacademy/modules-lib/tabs/utils';
-import type { SoundModuleState } from '@sourceacademy/bundle-sound/types';
+import type { CurveModuleState } from '@sourceacademy/bundle-curve/types';
 
 export default defineTab({
   toSpawn: context => {
-    const state = getModuleState<SoundModuleState>(context, 'sound');
-    return !!state && state.audioPlayed.length > 0;
+    const state = getModuleState<CurveModuleState>(context, 'curve');
+    return !!state && state.drawnCurves.length > 0;
   },
-  body: (context) => <SoundTab context={context} />,
-  label: 'Sounds',
-  iconName: 'music'
+  body: (context) => <CurveRenderer context={context} />,
+  label: 'Curves',
+  iconName: 'graph'
 });
 ```
 

eslint.config.js

@@ -257,7 +257,9 @@ export default defineConfig(
           'categoryDescription',
           'defaultValue',
           'hidden',
-          'title'
+          'title',
+          'publicType',
+          'publicReturnType'
         ],
         inlineTags: ['link', 'see'],
       }],
@@ -304,6 +306,7 @@ export default defineConfig(
         }
       ],
       'prefer-const': ['warn', { destructuring: 'all' }],
+      'require-yield': 'off',
 
       '@sourceacademy/default-import-name': ['warn', { path: 'pathlib' }],
       '@sourceacademy/no-barrel-imports': ['error', ['lodash']],
@@ -443,7 +446,10 @@ export default defineConfig(
     ignores: ['src/bundles/**/__tests__/*.ts*'],
     rules: {
       // Rule doesn't work properly on CI
-      '@sourceacademy/throw-runtime-error': process.env.CI ? 'off' : 'error'
+      '@sourceacademy/throw-runtime-error': process.env.CI ? 'off' : ['error', {
+        // Conductor's own protocol-level errors, unrelated to js-slang's RuntimeSourceError
+        ignoredNames: ['EvaluatorTypeError', 'EvaluatorRuntimeError', 'EvaluatorParameterTypeError']
+      }]
     }
   },
   {

lib/buildtools/package.json

@@ -5,6 +5,7 @@
   "version": "1.1.0",
   "devDependencies": {
     "@commander-js/extra-typings": "^15.0.0",
+    "@sourceacademy/conductor": "catalog:",
     "@types/estree": "^1.0.0",
     "@types/http-server": "^0.12.4",
     "@types/node": "^24.0.0",