Skip to content

Migrate pix_n_flix module to Conductor - #824

Merged
martin-henz merged 53 commits into
masterfrom
feat/migrate-pix-n-flix
Jul 31, 2026
Merged

Migrate pix_n_flix module to Conductor#824
martin-henz merged 53 commits into
masterfrom
feat/migrate-pix-n-flix

Conversation

@Akshay-2007-1

@Akshay-2007-1 Akshay-2007-1 commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Replaces the array-of-arrays Pixel/Pixels/Filter API with opaque image handles, accessed one channel at a time via get_pixel_value(source, x, y, p)/set_pixel_value(dest, x, y, p, v) - matching the design Martin laid out for this module rather than letting students index dest[x][y] directly.
  • Splits the bundle/tab boundary into two channels: a control channel (makeRpc - dimensions, fps, volume, input source) and a dedicated frame channel that transfers raw ArrayBuffers instead of structured-cloning them. A plain RPC call always clones its arguments, which would copy a full video frame twice per frame.
  • get_pixel_value/set_pixel_value carry an unconditional sync twin backed by the module's own buffer registry (keyed by the same identifier Conductor's opaque_make assigns), so per-pixel access from a student filter can skip the async-generator round trip - up to widthheight8 calls/frame otherwise.
  • All camera/video/canvas/requestAnimationFrame ownership moves to the tab, since the module now runs in a Worker with no DOM access.

Dependencies

This depends on two still-open engine PRs for the sync fast path to actually activate at runtime:

Until both land (and the conductor catalog pin here is bumped), get_pixel_value/set_pixel_value still work correctly, just through the existing async path.

Not in this PR

red_of/green_of/blue_of/alpha_of/set_rgba and the old Pixel type are intentionally left out of this migration's exports rather than guessing at their replacement - a follow-up decision once the opaque-handle pipeline is confirmed working end to end.

Test plan

  • tsc --noEmit and eslint clean on both the bundle and the tab
  • New unit tests for the buffer-shape helpers (functions.test.ts) pass
  • Manual browser verification (camera feed + a real filter) - not done yet, needed before merging out of draft

martin-henz and others added 29 commits April 13, 2026 15:50
Deploys build artifacts from the conductor-migration branch to
source-academy/modules-conductor via GitHub Pages, allowing the
conductor version of modules to coexist with the current deployment.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ntation) (#698)

* feat(repeat): migrate initial repeat module

* feat(conductor): fix conductor documentation

* chore: add testing plugin

* fix: add chaining for undefined blockTags

* fix: make changes as per review
Resolves conflicts from master's "Better Type Errors" refactor (#607)
landing on the stale conductor-migration branch:

- lib/buildtools/src/build/docs/index.ts: keep master's typedoc-plugin
  based output generation, re-add normalizeConductorDocs() calls.
- src/bundles/repeat/package.json: merge master's version bump/catalog
  deps with the Conductor devDependencies.
- src/bundles/repeat/src/functions.ts: keep the Conductor
  async-generator implementation, add back integer-range validation
  for n, and keep a synchronous repeat_internal export since the rune
  bundle depends on it directly.
- src/bundles/repeat/src/index.ts: add required `override` modifiers
  after master's stricter noImplicitOverride setting.
- lib/buildtools/src/build/docs/__tests__/conductor.test.ts: update
  initTypedocForJson() call site for its new outDir parameter.
- yarn.lock: regenerated via `yarn install`.

Verified: tsc, lint, and tests pass for buildtools, repeat, and rune.
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
* Migrate binary_tree module to Conductor

Rewrites the binary_tree bundle as a Conductor BaseModulePlugin, backed
by IDataHandler pair/list primitives instead of js-slang's stdlib. Tree
entries are stored as OPAQUE values at the module boundary; is_tree and
is_empty_tree declare no arg type so they can accept any DataType and
answer false rather than throw, matching their predicate semantics.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* Address review feedback: null guards and EvaluatorRuntimeError

is_tree/is_empty_tree/assertNonEmptyTree now guard against a
missing/undefined value instead of crashing with a raw TypeError, and
the plugin's arity-check throws now use EvaluatorRuntimeError (already
used elsewhere in this module) instead of a generic Error.

Also adds the same __bindExportedMethods() workaround repeat/rune use
for the unbound-method issue in BaseModulePlugin.initialise()
(conductor#41), since this fix isn't merged upstream yet.

* Validate left/right are trees in make_tree

master's binary_tree gained this validation while conductor-migration
was diverging (make_tree(0, 0, null) previously constructed a
malformed tree silently instead of throwing). Ports the same check,
using EvaluatorTypeError to match this module's existing Conductor
error style rather than modules-lib's InvalidParameterTypeError, which
doesn't apply here since this module no longer goes through js-slang.

* binary_tree: remove __bindExportedMethods workaround

The upstream binding fix (source-academy/conductor#41) is merged and
published, making the per-module bind workaround unnecessary. Also drops the
constructor override, which was left as a pure passthrough to the base class
once the workaround was removed.

* fix: pin @sourceacademy/conductor to a real published version everywhere

repeat and testplugin depended on conductor via a bare, unpinned GitHub URL.
yarn.lock had resolved and locked that to a commit from before even the
BaseModulePlugin binding fix (conductor#41) - a real `yarn install` builds
against that stale, broken conductor entirely silently, since nothing
forces Yarn to re-resolve an already-locked git dependency. Other bundles
(rune, etc.) already depend on the versioned npm release; switched these
two to match (^0.7.0), which also resolves a duplicate-package TS error
that showed up in any bundle depending on both specs simultaneously.

* binary_tree: pin @sourceacademy/conductor to a published version

Was depending on conductor via a bare, unpinned GitHub URL, which yarn.lock
had resolved and locked to a commit from before the BaseModulePlugin binding
fix (conductor#41). Switched to the versioned npm range other bundles
already use (^0.7.0), matching the same fix applied to midi.

* binary_tree: add override modifiers required by conductor-migration's stricter tsconfig

Picked up as part of merging conductor-migration in - noImplicitOverride is
now enabled repo-wide, and exportedNames/channelAttach shadow members
declared on BaseModulePlugin.

* lock file fixed

* Fix lint errors blocking pre-push: unnecessary type assertions and Conductor error allowlist

- lib/buildtools, lib/testplugin: drop assertions that no longer change
  the expression's type (same pattern as master's a2f369e fix).
- eslint.config.js: allowlist EvaluatorTypeError/EvaluatorRuntimeError in
  @sourceacademy/throw-runtime-error — they're Conductor's own
  protocol-level error hierarchy, unrelated to js-slang's
  RuntimeSourceError that the rule checks for. binary_tree is the first
  Conductor-based bundle to throw these.
- binary_tree test: drop a now-unnecessary type assertion.

---------

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
Co-authored-by: henz <henz@comp.nus.edu.sg>
* feat: migrate rune

* fix: update hollusion canvas to use promise based loading

* fix: restore curve's gl-matrix

* fix: make fixes to rune and repeat

* feat: add type safety for attachModuleMethod

* feat: add custom tags

* chore: lint files

* chore: make Lee Yi's changes

* fix: post-merge fallout from conductor-migration merge

- rune bundle index.ts: add override modifiers required by the
  BaseModulePlugin signature in conductor 0.7.1 (this branch was on
  0.6.0 before the merge's dependency consolidation), fix implicit-any
  indexing when dynamically forwarding Rune-typed static fields, and
  throw GeneralRuntimeError instead of a plain Error to satisfy the
  throw-runtime-error lint rule.
- Rune tab index.tsx: this file wasn't touched by the merge conflict
  (only hollusion_canvas.tsx and Rune.test.tsx were), so it still
  referenced the pre-rename AnaglyphRune/HollusionRune/NormalRune
  classes that conductor-migration renamed to Drawn*Rune. Updated all
  usages and switched the instanceof check to the isHollusionRune type
  guard the bundle already exports for this purpose.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* chore: bump conductor version

* chore: add type documentation for module method attachments

* chore: add type tests

* fix: do not unregister tab on destroy

---------

Co-authored-by: Akshay-2007-1 <akshayvemulapalli2007@gmail.com>
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
Co-authored-by: henz <henz@comp.nus.edu.sg>
…lock tags

Typedoc warned "Encountered an unknown block tag" for every @publicType/
@publicReturnType JSDoc tag since they were never registered, and CI runs
buildtools build docs with --ci (errorOnWarning), turning those warnings
into a hard failure. rune is the first bundle using these tags in real
source (repeat only exercised them in tests), so this only surfaced now.
… migration

- HollusionCanvas sample: DrawnHollusionRune.draw() is async, await it before
  assigning/calling the returned render function.
- Error Handling sample: animate_rune is now a RuneModulePlugin method, not a
  free export, so the import no longer type-checks as written. Widen the
  twoslash directive to the errors Typescript now actually reports (2614, 7006)
  instead of the stale @Noerrors: 2322 from before the migration.
…tation

Aarav caught this: 659ea90 ("feat: add custom tags") deliberately removed
declarations.ts and its decorator-based type inference in favour of the
@publicType/@publicReturnType JSDoc tags normalizeSignature() already
handles. That commit never cleaned up conductor.test.ts and
fixtures/conductorDeclarations.ts, which were written earlier (cb84fef)
against the old decorator system - so they were orphaned, not unfinished,
when I found them failing and reimplemented the removed feature.

- utils.ts: drop the source-file/decorator parsing helpers and their use in
  cloneParameter/copyPluginSignature/copyPluginVariable/isExportedVariable;
  restored to match how rune's real @publicType/@publicReturnType tags are
  already handled by normalisation.ts, untouched by any of this.
- conductor.test.ts: delete the test exercising the removed decorator
  system; rename the rune-bundle test to reflect what it actually verifies
  (@publicType/@publicReturnType tags, which pass without any of the above).
- delete the now-fully-unused fixtures/conductorDeclarations.ts.

Kept: the initTypedocForJson outDir arg fix, and the isConductorReference
qualifiedName-matching fix (traces back to 7c75a40, predates and is
unrelated to the decorator removal).
* Migrate scrabble module to Conductor

scrabble exports four static word/letter lists rather than functions,
so there's nothing for the usual exportedNames/@moduleMethod closure
path to wrap. Exposes them via DataType.OPAQUE (opaque_make in an
initialise() override) instead of DataType.ARRAY, since array_make has
no bulk constructor and the full word list is 172,820 entries.

Also drops the two full-array snapshot tests (scrabble_words/
scrabble_letters) - snapshotting 172,820 entries produced a
multi-million-line .snap file that hung vitest's serializer. The
existing index spot-checks already cover the full arrays; only the
~1,728-entry _tiny variants are snapshotted now.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* Run opaque_make calls concurrently in scrabble initialise()

The four exports are independent, so awaiting them one at a time added
needless latency. Addresses gemini-code-assist review comment on #792.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* Switch scrabble's word lists from OPAQUE to real DataType.ARRAY

array_make's lack of a bulk constructor (one array_set call per
element) looked prohibitive for 172,820 words, so this used
opaque_make instead. That was never measured, and the actual cost is
~246ms one-time (TestDataHandler, same-thread as the evaluator - no
postMessage boundary between a module and its evaluator) for both
scrabble_words and the nested scrabble_letters. Cheap enough that
there's no reason to give up real indexing/print/iteration for it.

Follows from source-academy/py-slang#217's module-interop fixes and
the team's decision that Python lists/JS arrays should be the only
built-in data structure modules hand back - opaque_make stays reserved
for genuinely opaque payloads (e.g. binary_tree's node values), not
plain collections.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

---------

Co-authored-by: Shrey Jain <“shreyjain5132@email.com>
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
…795)

* fix: pin @sourceacademy/conductor to a real published version everywhere

repeat and testplugin depended on conductor via a bare, unpinned GitHub URL.
yarn.lock had resolved and locked that to a commit from before even the
BaseModulePlugin binding fix (conductor#41) - a real `yarn install` builds
against that stale, broken conductor entirely silently, since nothing
forces Yarn to re-resolve an already-locked git dependency. Other bundles
(rune, etc.) already depend on the versioned npm release; switched these
two to match (^0.7.0), which also resolves a duplicate-package TS error
that showed up in any bundle depending on both specs simultaneously.

* fix: address review feedback on conductor pin PR

- Add @sourceacademy/conductor to npmPreapprovedPackages to bypass the age gate
- Reset yarn.lock to base state and rerun yarn install so only conductor's resolution changes, undoing unintentional dependency downgrades

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* fix: pin vite to a single resolved version workspace-wide

vitest's own dependency on vite ("^6.0.0 || ^7.0.0 || ^8.0.0") isn't
constrained to match the version hoisted for direct consumers
(lib/buildtools, lib/repotools), so Yarn can hoist a second, older
nested copy depending on install order. When that happens,
loadConfigFromFile (imported from the bare "vite" package) and
vitest/config's ViteUserConfig type augmentation are built against
two structurally different UserConfig types, breaking lib/repotools'
tsc with TS2339/TS2321 errors.

Reported by Prof Martin Henz while testing PR #791 locally.

---------

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
The blanket `resolutions: { "vite": "^8.1.0" }` from #795 forced
*every* vite consumer in the workspace onto 8.1.0, including
vitepress@1.6.4 (used by the docs/docserver build), which has a
hard, non-floating dependency on vite@^5.4.14 and is not compatible
with Vite 8 internally. That broke the docserver and plotly builds
on the very next install after #795 merged.

Scope the resolution to `vitest/vite` so it only overrides vite as
resolved through vitest's own dependency graph (the actual source of
the duplicate-copy TS error), leaving vitepress's separate vite@5
tree untouched.
…812)

reflection.children! assumed every documented module has at least one
child reflection. That breaks for scrabble: after the conductor doc
pipeline strips its plugin class, there's nothing left to promote,
since all four of scrabble's exports (scrabble_words, etc.) are built
entirely at runtime via this.exports.push(...) rather than as
statically-analyzable class methods/properties. TypeDoc then leaves
children undefined instead of [], and the reduce() over it throws
"Cannot read properties of undefined (reading 'reduce')", which broke
build:docs (and therefore the conductor-migration -> modules-conductor
deploy) for the whole workspace as soon as #792 (scrabble) merged.
* Migrate midi module to Conductor

Splits midi into a pure, evaluator-free functions.ts (unchanged
signatures) and a Conductor-facing index.ts plugin, since sound and
stereo_sound import midi_note_to_frequency and friends directly as
plain TypeScript and sound/stereo_sound's own Source-facing APIs
re-export several of these functions. Migrating index.ts's exports to
require an IDataHandler would have broken both call sites immediately.

- functions.ts / scales.ts / utils.ts / types.ts: untouched pure logic
- conductorAdapters.ts: undecorated helpers (scale-list <-> Conductor
  list conversion, accidental validation) used by the plugin; kept
  separate from index.ts so they stay importable from vitest, which
  hits a decorator syntax error importing index.ts directly
- index.ts: BaseModulePlugin subclass wrapping the pure functions;
  SHARP/FLAT/NATURAL are pushed onto `exports` directly in the
  constructor since BaseModulePlugin.initialise() only registers
  exportedNames that are functions
- Includes the same __bindExportedMethods() workaround as
  repeat/rune/binary_tree for the unbound-method issue in
  BaseModulePlugin.initialise() (source-academy/conductor#41)
- sound/stereo_sound's functions.ts and index.ts updated to import
  midi's pure functions from the new `/functions` subpath instead of
  the bundle root, which now exports the Conductor plugin

* Address review feedback: use string literals instead of .name

Function.prototype.name gets mangled under minification, which would
turn these error messages into cryptic garbage like "t expects...".
Two of these were carried over unchanged from the original module; the
third is in the new Conductor-facing index.ts.

* Port midi's master-only functions and validation

conductor-migration's midi had drifted from master: 6 functions
(is_note_with_octave, add_octave_to_note, get_octave, get_note_name,
get_accidental, key_signature_to_key) and input validation on the
existing ones (midi_note_to_frequency now range-checks its input) only
existed on master, added there while this migration was in flight.
Confirmed against the published docs page
(source-academy.github.io/modules/documentation/modules/midi.html)
that this is now the complete function/constant list, no more, no
less - verified end-to-end through the actual compiled bundle, not
just unit tests, driving every export exactly the way a real evaluator
calls a closure (detached, not bound to any instance).

Also fixes midi_note_to_letter_name/key_signature_to_key's accidental
parameter to match master: it's the Accidental enum value ('#'/'b'),
not the word 'flat'/'sharp' my first pass used before I'd found the
drift. midi_note_to_letter_name silently treats anything other than
exactly SHARP as flat (matching master's actual, slightly loose
behavior) rather than validating it - key_signature_to_key is the one
that validates, since its own switch has an explicit default case for
that.

Validation now uses conductor's new EvaluatorParameterTypeError /
assertNumberWithinRange (source-academy/conductor#42) in place of
modules-lib's InvalidParameterTypeError / assertNumberWithinRange,
which functions.ts can't depend on without pulling js-slang's
modules-lib re-exports (and everything under it) into sound/
stereo_sound's dependency graph transitively. Message format is
unchanged - verified identical to master's existing test expectations.

* midi: adapt to conductor's options-object assertNumberWithinRange signature

* midi: fix scales' runtime js-slang dependency and address review feedback

scales.ts called pair() from js-slang/dist/stdlib/list at runtime, which is
unavailable under Conductor's module loader (the require() shim it's given is
a no-op), throwing "Cannot read properties of undefined (reading 'pair')" for
any scale function. Build the intermediate list with a plain array tuple
instead, since Pair<H, T> is just [H, T] structurally.

Also addresses Aarav's review comments on #791:
- Removes __bindExportedMethods now that the upstream binding fix
  (source-academy/conductor#41) is merged and published.
- Widens letter_name_to_midi_note/midi_note_to_letter_name/
  letter_name_to_frequency/add_octave_to_note/get_octave/get_note_name/
  get_accidental/key_signature_to_key's note/accidental parameters to plain
  string, removing the unsafe `as NoteWithOctave`/`as Accidental...` casts in
  index.ts. Doing this exposed two real validation gaps that the casts had
  been silently papering over: add_octave_to_note never validated `note` at
  all (just interpolated it into the result string), and
  midi_note_to_letter_name/midiNoteToNoteName treated any non-SHARP
  accidental as FLAT instead of rejecting it. Both now throw
  EvaluatorParameterTypeError for invalid input, with regression tests added.

* midi: drop unnecessary js-slang runtime dependency, fix real dependency resolution

scales.ts and conductorAdapters.ts only ever needed js-slang's List/Pair type
shape, not js-slang itself. Replaced with a local Scale type; js-slang moves
to devDependencies since only the test suite still uses it.

Also: midi depended on @sourceacademy/conductor via a bare, unpinned GitHub
URL, which yarn.lock had resolved and locked to a commit from before even the
BaseModulePlugin binding fix (conductor#41). A real `yarn install` (not using
a local portal: link for testing) was building against that stale, broken
conductor entirely silently. Switched to the same versioned npm range other
bundles already use (^0.7.0), and reverted the two calls to
assertNumberWithinRange that had been written against conductor PR #43's
still-unpublished options-object signature back to the options actually
published in 0.7.0.

* midi: add override modifiers and fix scale test type error

Picked up as part of merging conductor-migration in - noImplicitOverride
is now enabled repo-wide, and exportedNames/channelAttach shadow members
declared on BaseModulePlugin. Also fixed a test that built its input
scale via js-slang's untyped list() instead of midi's own js-slang-free
Scale shape, which only surfaced as a real tsc error once the merge
brought stricter checking back online.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* midi: align @sourceacademy/conductor pin with catalog: convention

Matches the same fix already applied on #795 and #796: adds
@sourceacademy/conductor to the yarn catalog and
npmPreapprovedPackages, and switches midi's own package.json to
"catalog:" instead of a literal "^0.7.0" pin, so this PR doesn't
leave midi on the old convention once #795 lands.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* midi: reuse parseNoteWithOctave as the canonical validator in add_octave_to_note

Addresses CodeRabbit's review comment on PR #796 (surfaced there via
shared branch history with sound, but the finding is midi's own):
add_octave_to_note's inline regex accepted note spellings that
noteToValues/parseNoteWithOctave reject elsewhere (B#, E#, Cb, Fb -
accidentals that don't exist for those note names), and let lowercase
input escape unnormalized through a type assertion. Now validates via
parseNoteWithOctave (rejecting digits upfront, since that function
alone would accept an octave already being present) and reconstructs
using the normalized note name, preserving the original accidental
spelling exactly as given.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* Pin vite to one version workspace-wide, fixing a local yarn install failure

Prof Martin hit a build failure running yarn install locally: lib/repotools'
own tsc failed with "Property 'test' does not exist on type 'UserConfig'"
and "Excessive stack depth comparing types 'UserConfig' and 'UserConfig'"
in src/testing/index.ts.

Root cause: two different resolved copies of vite existed side by side -
the workspace root hoists vite@8.1.4 (requested directly by lib/buildtools
and devserver, both "^8.1.0"), but vitest@4.1.9's own internal dependency
on vite resolved its own nested copy at 8.0.12 instead, since nothing
constrained it to match. src/testing/index.ts imports loadConfigFromFile
from the bare "vite" package (resolving to the hoisted 8.1.4) while
vitest/config's ViteUserConfig type augmentation is built against vitest's
own nested 8.0.12 UserConfig - TypeScript sees these as two structurally
different types instead of the same one, hence the errors. Reported as
non-deterministic since it depends on exactly how Yarn happens to hoist
things on a given install.

Fixed with a resolutions entry pinning every resolution of vite to
^8.1.0 workspace-wide (matching Prof Martin's own suggested fix) - the
nested copy under vitest/node_modules is now gone entirely after
reinstalling, both consumers resolve the identical module, and
lib/repotools' tsc (and lib/buildtools', the other direct vite consumer)
are both clean.

* Add real JSDoc to index.ts's wrapper methods so docs actually regenerate

Mirrors rune's pattern (#765): the doc generator reads JSDoc off the
@moduleMethod-decorated wrapper methods in index.ts, not off the real
implementations in functions.ts/scales.ts they delegate to - a thin
wrapper with no comment of its own means the generated docs.json comes
back "No description available" for every export, even though the real
JSDoc is sitting right there on the underlying function.

Copied each wrapper's description/@param/@returns/@example from its
functions.ts/scales.ts counterpart. No @publicType/@publicReturnType
overrides needed here (unlike rune's Rune/OPAQUE case) - every one of
midi's parameter and return types (NUMBER, CONST_STRING, BOOLEAN, LIST)
already has an unambiguous native mapping.

Verified by rebuilding docs: all 19 exports now show real descriptions
instead of "No description available" (confirmed per-export, not just
absence of warnings). tsc/lint/test (33/33) all clean.

---------

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
yarn install --immutable was failing on conductor-migration ("The lockfile
would have been modified by this install") since the midi merge, breaking
the deploy-to-modules-conductor pipeline at the Install Dependencies step.
The committed lockfile was missing a batch of esbuild@0.21.5 optional
platform-dependency entries that a fresh install adds back. Regenerated
via a plain yarn install; no dependency version changes, just filling in
the entries the merge left out.
* Migrate midi module to Conductor

Splits midi into a pure, evaluator-free functions.ts (unchanged
signatures) and a Conductor-facing index.ts plugin, since sound and
stereo_sound import midi_note_to_frequency and friends directly as
plain TypeScript and sound/stereo_sound's own Source-facing APIs
re-export several of these functions. Migrating index.ts's exports to
require an IDataHandler would have broken both call sites immediately.

- functions.ts / scales.ts / utils.ts / types.ts: untouched pure logic
- conductorAdapters.ts: undecorated helpers (scale-list <-> Conductor
  list conversion, accidental validation) used by the plugin; kept
  separate from index.ts so they stay importable from vitest, which
  hits a decorator syntax error importing index.ts directly
- index.ts: BaseModulePlugin subclass wrapping the pure functions;
  SHARP/FLAT/NATURAL are pushed onto `exports` directly in the
  constructor since BaseModulePlugin.initialise() only registers
  exportedNames that are functions
- Includes the same __bindExportedMethods() workaround as
  repeat/rune/binary_tree for the unbound-method issue in
  BaseModulePlugin.initialise() (source-academy/conductor#41)
- sound/stereo_sound's functions.ts and index.ts updated to import
  midi's pure functions from the new `/functions` subpath instead of
  the bundle root, which now exports the Conductor plugin

* Address review feedback: use string literals instead of .name

Function.prototype.name gets mangled under minification, which would
turn these error messages into cryptic garbage like "t expects...".
Two of these were carried over unchanged from the original module; the
third is in the new Conductor-facing index.ts.

* Port midi's master-only functions and validation

conductor-migration's midi had drifted from master: 6 functions
(is_note_with_octave, add_octave_to_note, get_octave, get_note_name,
get_accidental, key_signature_to_key) and input validation on the
existing ones (midi_note_to_frequency now range-checks its input) only
existed on master, added there while this migration was in flight.
Confirmed against the published docs page
(source-academy.github.io/modules/documentation/modules/midi.html)
that this is now the complete function/constant list, no more, no
less - verified end-to-end through the actual compiled bundle, not
just unit tests, driving every export exactly the way a real evaluator
calls a closure (detached, not bound to any instance).

Also fixes midi_note_to_letter_name/key_signature_to_key's accidental
parameter to match master: it's the Accidental enum value ('#'/'b'),
not the word 'flat'/'sharp' my first pass used before I'd found the
drift. midi_note_to_letter_name silently treats anything other than
exactly SHARP as flat (matching master's actual, slightly loose
behavior) rather than validating it - key_signature_to_key is the one
that validates, since its own switch has an explicit default case for
that.

Validation now uses conductor's new EvaluatorParameterTypeError /
assertNumberWithinRange (source-academy/conductor#42) in place of
modules-lib's InvalidParameterTypeError / assertNumberWithinRange,
which functions.ts can't depend on without pulling js-slang's
modules-lib re-exports (and everything under it) into sound/
stereo_sound's dependency graph transitively. Message format is
unchanged - verified identical to master's existing test expectations.

* midi: adapt to conductor's options-object assertNumberWithinRange signature

* midi: fix scales' runtime js-slang dependency and address review feedback

scales.ts called pair() from js-slang/dist/stdlib/list at runtime, which is
unavailable under Conductor's module loader (the require() shim it's given is
a no-op), throwing "Cannot read properties of undefined (reading 'pair')" for
any scale function. Build the intermediate list with a plain array tuple
instead, since Pair<H, T> is just [H, T] structurally.

Also addresses Aarav's review comments on #791:
- Removes __bindExportedMethods now that the upstream binding fix
  (source-academy/conductor#41) is merged and published.
- Widens letter_name_to_midi_note/midi_note_to_letter_name/
  letter_name_to_frequency/add_octave_to_note/get_octave/get_note_name/
  get_accidental/key_signature_to_key's note/accidental parameters to plain
  string, removing the unsafe `as NoteWithOctave`/`as Accidental...` casts in
  index.ts. Doing this exposed two real validation gaps that the casts had
  been silently papering over: add_octave_to_note never validated `note` at
  all (just interpolated it into the result string), and
  midi_note_to_letter_name/midiNoteToNoteName treated any non-SHARP
  accidental as FLAT instead of rejecting it. Both now throw
  EvaluatorParameterTypeError for invalid input, with regression tests added.

* midi: drop unnecessary js-slang runtime dependency, fix real dependency resolution

scales.ts and conductorAdapters.ts only ever needed js-slang's List/Pair type
shape, not js-slang itself. Replaced with a local Scale type; js-slang moves
to devDependencies since only the test suite still uses it.

Also: midi depended on @sourceacademy/conductor via a bare, unpinned GitHub
URL, which yarn.lock had resolved and locked to a commit from before even the
BaseModulePlugin binding fix (conductor#41). A real `yarn install` (not using
a local portal: link for testing) was building against that stale, broken
conductor entirely silently. Switched to the same versioned npm range other
bundles already use (^0.7.0), and reverted the two calls to
assertNumberWithinRange that had been written against conductor PR #43's
still-unpublished options-object signature back to the options actually
published in 0.7.0.

* midi: add override modifiers and fix scale test type error

Picked up as part of merging conductor-migration in - noImplicitOverride
is now enabled repo-wide, and exportedNames/channelAttach shadow members
declared on BaseModulePlugin. Also fixed a test that built its input
scale via js-slang's untyped list() instead of midi's own js-slang-free
Scale shape, which only surfaced as a real tsc error once the merge
brought stricter checking back online.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* sound: rebuild playback/recording on a self-contained Conductor channel

Scraps the earlier plugins-repo sound-io plugin pair in favor of the
pattern confirmed against rune's migration (PR #765): SoundModulePlugin
declares its own channelAttach directly, and modules/src/tabs/Sound
implements IPlugin/SoundTabRpc as the host-side counterpart, talking
over Conductor's makeRpc helper - no separate runner/web plugin
package needed at all.

Also fixes plotly's draw_sound_2d, the one other consumer of
bundle-sound's types, for the Wave type's redesign from a plain
(t: number) => number to an async generator (so that stepping and
nested user closures evaluate correctly on the CSE machine).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* sound: unify with stereo_sound - one module, Sound is always stereo

Retires stereo_sound as a separate bundle/tab entirely. Sound becomes
{leftWave, rightWave, duration} always; "mono" isn't a separate type,
it's just the common case where leftWave === rightWave (same
reference), produced by make_sound. make_stereo_sound builds a
genuinely stereo Sound from two different waves. Every combinator
(consecutively/simultaneously/adsr/phase_mod/stacking_adsr/
instruments) now operates on this one shape via small per-channel
helpers (joinWaves/sumWaves/adsrWave/phaseModWave), so composing a
"mono" sound with a stereo one is a non-issue - there's nothing to
convert, and none of stereo_sound's oscillator/envelope math is
duplicated a second time the way it was as a separate bundle.

get_wave/get_left_wave/get_right_wave: get_wave keeps meaning "the"
wave (== left channel), so existing SICP-style code (play(sine_sound(...)),
get_wave(sound)) keeps working unchanged for the common mono case.

Adds a lower Wave-returning layer alongside the existing Sound layer
(sine_wave/square_wave/triangle_wave/sawtooth_wave/noise_wave/
silence_wave), with sine_sound etc. as thin convenience wrappers
(sine_sound = (freq, dur) => make_sound(sine_wave(freq), dur)).

record()/record_for() use however many channels the input device
actually has - a mono microphone (the common case) produces a Sound
whose left and right channels are the same wave; no separate
record_stereo. play/samplesToSound skip redoing work for a mono
Sound (sampled once, not twice) by checking leftWave === rightWave.

New stereo-specific operations: make_stereo_sound, play_waves,
pan, pan_mod, squash, get_left_wave, get_right_wave.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* sound: rebuild Sound/functions/index/tab for the sound+stereo_sound unification

Continuation of the previous commit (which only picked up the
stereo_sound/StereoSound deletions due to a failed multi-pathspec git
add) - this is the actual Sound={leftWave,rightWave,duration} rework
of the sound bundle and its tab described there.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* align @sourceacademy/conductor pins with PR #795's catalog: convention

#795 (fix/conductor-dependency-pin) is about to merge into
conductor-migration first, establishing @sourceacademy/conductor in
the yarn catalog and npmPreapprovedPackages. Switching midi/sound/
tab-Sound's package.json over to "catalog:" now (matching #795
verbatim) avoids re-doing this exact reconciliation the next time
this branch merges conductor-migration in.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* sound: fix O(N) nested yield* delegation in consecutively/simultaneously

Addresses Gemini's high-priority review comments on PR #796: reduce()
was nesting joinWaves/sumWaves closures sounds.length deep, so
sampling near the end of a long chain meant up to N nested async
generator delegations per sample at 44100 Hz - real overhead for
async generators that plain synchronous functions (the pre-migration
implementation) never had. Rewritten as a flat scan that picks the
active sound directly and yield*s into it once, keeping delegation
depth O(1) regardless of how many sounds are combined, while still
threading through user closures correctly.

Also fixes a real (if narrow) NaN: linear_decay(0) computed 1 - 0/0
when release_ratio (or a future caller with decay_ratio) is exactly
0, corrupting the sample at that instant. Sample rate/instrument
functions never happened to hit it because of how the surrounding
branch conditions are structured, but adsr's release branch can.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* midi: align @sourceacademy/conductor pin with catalog: convention

Matches the same fix already applied on #795 and #796: adds
@sourceacademy/conductor to the yarn catalog and
npmPreapprovedPackages, and switches midi's own package.json to
"catalog:" instead of a literal "^0.7.0" pin, so this PR doesn't
leave midi on the old convention once #795 lands.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* sound: address CodeRabbit review findings on PR #796

- validateDuration now rejects NaN/Infinity, not just negatives
  (both used to slip through and crash sampleWave's Float32Array
  allocation with a raw RangeError instead of a clean module error).
- closureToWave validates the closure's result is actually a number
  before returning it - a student-supplied wave returning e.g. a
  string previously corrupted playback silently via `as number`.
- stacking_adsr validates each envelope-list element is a closure
  before invoking it, for the same reason.
- consecutively/simultaneously/adsr/phase_mod/conductorToSound all
  preserve the "mono means leftWave === rightWave" invariant again -
  building both channels independently (even from identical inputs)
  produced two behaviourally-identical-but-distinct waves, silently
  doubling sampling work and losing the fast path in play()/etc.
- play()/stop() guard against a stale playSamples() completion
  clobbering a newer play()'s isPlaying state via a generation token
  (stop-A/start-B/late-settle-A ordering).
- tab: requestMicPermission() disposes the previous MediaStream
  before re-requesting, so a denied re-request can't leave stale
  tracks running and reusable by startRecording().
- tab: startRecording() now actually awaits MediaRecorder's start
  event (and rejects on error) instead of resolving as soon as
  .start() returns, matching the SoundTabRpc contract.

Not addressed (flagged as false positive or out of scope for a
quick fix, not silently dropped):
- The module doc's "a wave returns a number" description is correct
  as written - it's the student-facing Source-language contract, not
  the internal async-generator implementation detail (which is
  already documented separately on the Wave type in types.ts).
- Overlapping/concurrent recording sessions (record/record_for only
  gate on isPlaying, not a dedicated recording-state flag) and
  pan/pan_mod sampling the shared source/modulator wave twice per
  channel are both real but non-trivial fixes requiring more
  substantial state-tracking/sampling-order changes; left for a
  follow-up rather than a rushed partial fix.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* sound: cross-reference Wave's internal async-generator contract in the module doc

Partial concession on CodeRabbit's doc-comment finding: the primary
description stays as the Source-facing "number -> number" contract
(that's the actual, correct student experience - the CSE machine
threads the async-generator machinery transparently), but adds a
one-line pointer to where the internal TS contract is documented, for
maintainers reading this file.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* midi: reuse parseNoteWithOctave as the canonical validator in add_octave_to_note

Addresses CodeRabbit's review comment on PR #796 (surfaced there via
shared branch history with sound, but the finding is midi's own):
add_octave_to_note's inline regex accepted note spellings that
noteToValues/parseNoteWithOctave reject elsewhere (B#, E#, Cb, Fb -
accidentals that don't exist for those note names), and let lowercase
input escape unnormalized through a type assertion. Now validates via
parseNoteWithOctave (rejecting digits upfront, since that function
alone would accept an octave already being present) and reconstructs
using the normalized note name, preserving the original accidental
spelling exactly as given.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* Fix playback/recording races and add ADSR validation, found via manual testing

Manually testing all three migrated modules (binary_tree, midi, sound)
together against a local frontend build surfaced several issues
specific to sound, now fixed:

- play() threw "Previous sound still playing!" on any overlapping or
  looped call. Repeated/looped play() calls now queue and play one
  after another instead (like consecutively, but built up call-by-call
  rather than pre-combined into one Sound). stop() cancels anything
  still queued behind the currently-playing sound, not just the
  current one.
- The tab's "Constructing..." status (shown while play() samples a
  Wave into a buffer - a duration-proportional step that happens
  entirely before actual playback starts) never actually appeared,
  since the notification was fire-and-forget and could race the tab's
  own asynchronous loading. Now a real acknowledged RPC call, awaited
  before sampling begins.
- init_record() was fire-and-forget: it kicked off the permission
  request but returned immediately, so calling record()/record_for()
  right after (the natural way to write it) could race the still-
  pending permission grant and throw even though permission had
  genuinely just been granted. init_record() now awaits the actual
  permission result before returning.
- record()/record_for()'s returned "sound promise" threw "recording
  still being processed" until called again later, requiring manual
  polling. Both now return a promise that genuinely awaits the
  recording finishing processing instead.
- adsr() had no validation that attack_ratio + decay_ratio +
  release_ratio stays within 1, or that each ratio/sustain_level is a
  finite number in [0, 1] - silently producing a discontinuous
  envelope instead of an error. Added validation, with the actual
  envelope-shaping logic split into an unvalidated adsrTransformer()
  used internally by piano/violin/cello/trombone/bell, so validating
  adsr() doesn't retroactively break trombone's second-harmonic
  envelope (ratios summing to 1.0236, a quirk present since before
  the Conductor migration - preserved rather than silently changed).

* Move playback sequencing to the host tab; fix premature AudioContext teardown

Found via extensive live testing against a local frontend build:

- The Worker running a program is terminated as soon as the script
  finishes (conduit.terminate(), called after every Run to fix a
  worker-leak). play() is intentionally fire-and-forget, so a script
  can finish - and the Worker be killed - well before queued playback
  has actually started or finished. Sequencing that playback via a
  Worker-side queue (the previous design) meant anything still queued
  when the Worker died simply never got its playSamples() RPC sent at
  all.
- functions.ts' play() now dispatches its playSamples() call
  immediately once sampling finishes, instead of waiting its turn in
  a local queue - so the RPC always gets sent before the Worker can be
  torn down. Actual sequencing (so playback doesn't overlap) moves to
  SoundTabPlugin on the host side, which outlives the Worker: it now
  owns its own playback queue and a stop-generation counter so a
  still-queued call correctly gets cancelled by stop().
- SoundTabPlugin.destroy() (called on every Run's teardown) no longer
  closes the AudioContext or unregisters the tab immediately - both
  are deferred until whatever's playing (or still queued) finishes
  naturally, tracked via a dedicated pending-playback counter rather
  than activeSources.size, which hits 0 momentarily between any one
  sound ending and the next queued one starting and was otherwise
  misread as "everything is done," silently killing the AudioContext
  mid-queue.
- notifyConstructing()/playSamples() status updates are now
  recomputed from combined constructing+active-source state instead
  of set unconditionally, so an earlier sound finishing can't clobber
  a later sound's still-in-flight 'constructing' status.

* sound: fast synchronous path for module-native waves, skip per-sample async overhead

Wave is AsyncGenerator-based so a wave wrapping a user-supplied Conductor closure
(closureToWave, in index.ts) can be driven through evaluator.closure_call_unchecked -
itself an AsyncGenerator, since it steps the calling evaluator's CSE machine. But
every wave built entirely from module-native math (oscillators, envelopes,
instruments, and every combinator) got the same generator wrapper even though it
never actually yields - and every AsyncGenerator#next() resolves via microtask
regardless of whether anything inside really awaits. sampleWave calls a wave once
per sample (44100 times per second of audio), so a multi-second Sound made of nothing
but built-in instruments was paying real async overhead - measured as the dominant
cost of play() for a ~21s cello passage - for zero actual asynchrony.

Adds Wave.sync: an optional plain (t: number) => number twin, present iff a wave
provably never needs to cross into user code. syncWave() builds both forms from one
computation. Every combinator (clipToDuration, consecutiveWave, simultaneousWave,
adsrWave, phaseModWave, gainWave, squash, panModAmountWave, pan_mod, interpolatedWave)
propagates sync when every wave feeding into it has one, and falls back to the
existing yield*-driven path the moment a closure-backed wave (which never sets sync)
is anywhere in the composition - so a student-supplied wave function's stepping/
breakpoint visibility, and Conductor's worker-boundary async contract, are entirely
unaffected. sampleWave itself takes the fast path whenever the wave it's sampling has
one.

Confirms the fast path is a pure performance change, not a semantic one: correctness
depends only on the fallback being exact, which the existing PAIR/ARRAY module-interop
and existing sound-bundle test suite (64 tests, all passing) already exercise the
composition shapes for.

* sound: sync fast path for student-authored wave closures, when the evaluator supports it

closureToWave wrapped every student-supplied wave function as a plain async
generator calling evaluator.closure_call_unchecked - correct, but paying a real
microtask (and a full evaluator round-trip) per sample even for the simplest
possible wave, sampled 44100x/sec. The built-in-wave fast path landed earlier in
this file's siblings (functions.ts) doesn't help here: a student's own wave has
to actually run inside whichever engine (CSE/PVML/py2js) is executing the
program - there's no way for the module itself to skip that call.

An engine can now opt a closure into a synchronous fast path by implementing
closure_call_sync (py-slang's GenericDataHandler, exposed so far only by py2js,
whose dual-compiled functions already have a synchronous body internally -
rt.callSync - that just wasn't reachable from outside py-slang before). This
module checks for the method generically - closureToWave attaches wave.sync
only when the evaluator actually provides closure_call_sync, and every other
engine (CSE, PVML, until they grow the same capability) is completely
unaffected: the method simply doesn't exist on their evaluator instance, so
every wave stays on the existing async path, unchanged.

The one correctness wrinkle worth being explicit about: closure_call_sync
returning undefined means "no sync form for this closure" - safe as a signal
before the closure has run, but from inside wave.sync (a plain function, not a
generator - there's no way to suspend and retry via the async path once we're
in here) a missing sync form after the fact is treated as a hard internal
error rather than silently producing a wrong sample.

* sound: waveToConductorClosure was silently dropping the sync fast path

closureToWave (Conductor closure -> internal Wave) already picks up wave.sync
from the evaluator's closure_call_sync when available, but the reverse
direction didn't: waveToConductorClosure (internal Wave -> Conductor closure)
always built a plain async-only wrapper, with no way for anything downstream
to know the original wave ever had a sync form. Since make_sound/
make_stereo_sound/get_wave/etc. all round-trip a Sound's waves through this
function to hand it back to Python, every Sound handed back to a student -
even one built entirely from a py2js closure that supports closure_call_sync -
permanently lost the fast path the instant it was constructed. play() on that
same Sound later would then find closure_call_sync returning undefined (no
.sync on the re-wrapped closure) and hit the "no synchronous form" internal
error closureToWave raises for exactly this shouldn't-happen case.

Fixed by having waveToConductorClosure attach the same kind of .sync twin
(reusing wave.sync, converting its number result to/from a TypedValue) before
handing the function to closure_make, mirroring closureToWave's direction
exactly. No behavior change for a wave with no sync form (CSE closures, or a
wave that genuinely needs a host round-trip) - conductorWave.sync is simply
never attached.

* sound: address review feedback on record/record_for and error messages

- record/record_for: stop hardcoding the function name in error messages
  (record: ..., record_for: ...) - use `${record.name}`/`${record_for.name}`
  like every other error in this file, so a rename can't silently go stale.
  Same fix for play's EvaluatorParameterTypeError/duration-negative error,
  which had the same hardcoded-literal bug.
- record/record_for: replace the nested setTimeout+.then() towers with a
  single async IIFE using es-toolkit's delay(), preserving the exact same
  event ordering (pre-recording-signal pause, recording signal, pre-recording
  pause, recording, recording signal) but as flat sequential awaits.

* sound: accept DataType.ARRAY as equally valid to PAIR for Sound values

py-slang's module interface no longer has a distinct "pair" representation
(source-academy/py-slang#307): pythonToModule now builds every Python list/
pair as a flat DataType.ARRAY, never a DataType.PAIR/EMPTY_LIST chain. A Sound
built here via soundToConductor and round-tripped out to Python (assigned to
a variable, passed to another module call like get_wave/is_sound/play) then
arrives tagged ARRAY, not PAIR - conductorToSound/is_sound hardcoded
`value.type !== DataType.PAIR` checks broke on this, same class of bug as
binary_tree's #813.

Fixed the same way: isPairLike(value) accepts either DataType.PAIR or
DataType.ARRAY wherever a Sound's own tag is checked - pair_head/pair_tail
already read either shape identically (py-slang's GenericDataHandler
bridge), so this is purely about validation, not traversal.

Also fixed conductorListToSounds (consecutively/simultaneously's list
argument) and stacking_adsr's envelopes list: a genuine Python list of any
length now crosses as a flat ARRAY too, not just a 2-element pair, so the
old PAIR-chain-only walk would silently return zero elements for a real
multi-sound list. Added readListElements to read either an ARRAY (via
array_length/array_get) or a PAIR/EMPTY_LIST chain, matching py-slang's own
GenericDataHandler.readListElements pattern.

soundToConductor's own construction (pair_make calls) is unchanged - it
always freshly builds a genuine PAIR; only validation of an incoming
(possibly round-tripped) value needed to widen.

* sound: don't crash when closure_call_sync exists but this closure has no .sync twin

closure_call_sync lives on GenericDataHandler, the shared IDataHandler
implementation across all of py-slang's engines - it's always present
regardless of which engine is actually running, so closureToWave's old check
("does the method exist") was never actually engine-specific despite its own
comment claiming otherwise. Only some py2js closures ever carry a real
.sync twin; CSE and PVML closures never do. Every student-authored wave
function played via play()/play_wave() on CSE or PVML was hitting the
'Internal error: closure_call_sync unexpectedly had no synchronous form'
throw on its very first sample, since .sync was attached unconditionally
whenever the method merely existed.

Fixed by determining sync-capability once, with a real probe call, before
ever exposing .sync on the Wave at all - closure_call_sync's own contract
only returns undefined for an unsupported argument type before the closure
ever runs (a wave's argument is always a plain number, always supported),
so the probe is free unless the closure genuinely has a .sync twin, in
which case its result is reused as the Wave's first real sample instead of
being thrown away. If .sync isn't available, the Wave silently stays on the
existing async path - no crash, matches every other Sound consumer's
existing async fallback.

* sound: correct closure-cache comment per Martin's ruling on identity preservation

Martin: the module-evaluator bridge isn't obligated to be identity-preserving
- two JS functions that are === may be represented by two Python functions
that aren't 'is' to each other, and that's fine as a general FFI property.
The earlier comment claimed the wave/closure caches make
get_wave(s) == get_left_wave(s) a reliable invariant - they don't, since
each engine's own moduleToPython still builds a fresh Python-side wrapper
per conversion regardless of what's cached on the Conductor side. The
caches stay (still real, just for avoiding redundant closure_make calls),
the comment now says what they actually guarantee.

* sound: describe mono behaviorally, not by reference identity, in doc comments

Per Martin: avoid 'identical' when describing the two channels of a mono
Sound in specs - say left_wave(t) == right_wave(t) for all t instead of
claiming the two waves are the same object/reference. Reworded the public-
facing docblocks (index.ts's and functions.ts's @module comments, the Sound
type's own doc in types.ts, get_wave/record's JSDoc) to describe the
behavioral contract a cadet program can actually observe, rather than an
internal reference-equality detail. Where a comment is genuinely about this
file's own implementation choice (make_sound assigning one Wave object to
both fields, and later code taking advantage of that via leftWave ===
rightWave checks), left those as-is and called out explicitly that it's an
implementation detail, not something the Sound Discipline promises.

---------

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
* sound: fix lint errors - EvaluatorParameterTypeError gap and a plain Error

@sourceacademy/throw-runtime-error doesn't yet recognize
EvaluatorParameterTypeError as assignable to RuntimeSourceError (same known
gap already worked around in midi) - added the same eslint-disable +
explanatory comment at each of the 6 call sites in functions.ts/index.ts.

conductorToSound's invalid() helper was throwing a plain Error, not a
Conductor error type at all - a real bug, not just a lint gap, since it
would bypass proper student-facing error formatting. Fixed to
EvaluatorRuntimeError; inlined the three call sites since the indirection
through a helper function was itself what kept the linter from recognizing
a type it accepts fine when thrown directly.

The constructor's soundChannel wiring guard is left as a plain Error with a
disable comment - a genuine internal precondition (Conductor host failed to
provide the channel), never reachable from student code.

Also fixed two @stylistic/member-delimiter-style warnings in
recording.test.ts (semicolons vs commas in an inline type).

* docs: fix stale sound-module type references breaking the docs build

#796's Conductor migration removed AudioPlayed/SoundModuleState entirely
(the old js-slang moduleContexts.sound.state pattern doesn't apply to
Conductor-based modules) and reshaped Sound from a Pair to
{leftWave, rightWave, duration} - several doc pages' embedded, type-checked
code samples still referenced the old shapes, failing the docs build's
twoslash validation:

- 2-bundle/4-conventions/3-errors.md: make_sound sample used pair() from
  js-slang/dist/stdlib/list against the old Sound type - rewritten to
  return the real {leftWave, rightWave, duration} shape.
- 5-advanced/context.md, 3-tabs/1-overview.md, 3-tabs/3-editing.md: all
  three used sound as their example bundle for the general js-slang module
  context / getModuleState pattern, referencing AudioPlayed/SoundModuleState
  which no longer exist at all. Swapped to curve, which still legitimately
  uses this pattern (sound moved to Conductor's own channel-based state
  instead) - reused curve's actual CurveModuleState/drawnCurves shape and
  the real Curve tab's own getModuleState usage as the reference.

Verified the two rewritten make_sound/context samples against a real tsc
--strict run (not just eyeballing) - both type-check clean.

4-testing/4-unit/3-mock.md and 2-bundle/1-overview/1-overview.md also
reference bundle-sound but only via imports/calls that stay valid regardless
of Sound's internal shape (no destructuring assuming the old pair shape) -
left as-is, not build-blocking, though mock.md's AudioContext example is now
semantically stale (play() no longer touches AudioContext directly) and
could use a follow-up pass.
…es (#819)

CurveDrawn is imported into curve/types.ts from ./curves_webgl but never
re-exported from it - only CurveModuleState (which uses CurveDrawn as part
of its drawnCurves field type) is actually exported from
@sourceacademy/bundle-curve/types. #818's context.md fix imported CurveDrawn
directly, which doesn't exist at that import path (TS2459), breaking the
docs build again. Fixed by deriving the element type via
CurveModuleState['drawnCurves'] instead - the same pattern already used
correctly in this PR's other two fixed files (3-tabs/1-overview.md,
3-tabs/3-editing.md), just missed here.

Verified against a real tsc --strict run this time, not just eyeballing -
all imports across all 4 previously-touched doc pages checked against their
actual compiled .d.ts exports, not just what's declared in bundle source.
is_sound (sound), is_tree/is_empty_tree (binary_tree), and
is_note_with_octave (midi) are @moduleMethod-decorated predicates meant to
accept one value of any Conductor DataType and answer false rather than
throw. They were declared with an empty args array ([]), which correctly
signals "no fixed type" but incorrectly reports arity 0 via
closure_arity() - the array's length is the only thing engines can read
back as "how many parameters this closure takes."

Every engine reads this same signature (GenericDataHandler.closure_arity),
but only py2js treats it as an exact contract, so a real call like
is_sound(s) threw "is_sound() takes 0 arguments but 1 was given" there
while CSE and PVML worked fine. Found while debugging that report.

DataType.ANY exists in conductor precisely for "one argument, unrestricted
type" - using it instead of [] reports the correct arity (1) without
changing any runtime behavior (GenericDataHandler never type-checks args
against the declared signature, only counts them). Requires bumping the
conductor catalog range to ^0.7.2 (ANY was added in 0.7.1; 0.7.0 predates
it) and normalizing binary_tree's package.json off a hardcoded
"^0.7.0" onto the shared "catalog:" entry, which was silently out of step
with every other bundle.


Claude-Session: https://claude.ai/code/session_01KrwJGug3rCXijRseRjys9V

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
PR source-academy/conductor#53 makes hostLoadPlugin/requestLoadPlugin
async (Promise<void> instead of void) and renames the RPC procedure
from the notification $requestLoadPlugin to the awaitable
requestLoadPlugin.

No module in this repo calls hostLoadPlugin/requestLoadPlugin directly
(only IModulePlugin/type-level conductor surface is used), so this is
purely a version bump. modules-lib's conductor test suite
(src/conductor/__tests__/methods.test.ts) passes unchanged.
Replaces the array-of-arrays Pixel/Pixels/Filter API with opaque image
handles accessed via get_pixel_value/set_pixel_value, matching the
opaque-handle plus accessor-function design Martin Henz laid out for
this module. Splits the bundle/tab boundary into a control channel
(makeRpc, dimensions/fps/volume/input source) and a dedicated frame
channel that transfers raw ArrayBuffers instead of structured-cloning
them, since a full video frame would otherwise get copied twice per
frame. get_pixel_value/set_pixel_value carry a sync fast path backed by
the module's own buffer registry, so per-pixel access from a student
filter avoids the async-generator round trip on every call.

All camera/video/canvas/requestAnimationFrame ownership moves to the
tab, since the module now runs in a Worker with no DOM access.

Depends on two engine-side PRs (conductor#54, py-slang#353) for the
sync fast path to actually take effect at runtime; falls back to the
existing async path until those land.
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@Akshay-2007-1
Akshay-2007-1 marked this pull request as ready for review July 28, 2026 05:21
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@Akshay-2007-1

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

PixNFlix was reworked from standalone functions and a React tab into Conductor module and tab plugins. The implementation now transfers RGBA frames through dedicated channels, applies filters using opaque image buffers, supports synchronous pixel operations, and provides updated media controls and UI state handling.

Changes

PixNFlix migration

Layer / File(s) Summary
Image buffer contracts and utilities
src/bundles/pix_n_flix/src/types.ts, src/bundles/pix_n_flix/src/functions.ts, src/bundles/pix_n_flix/src/__tests__/functions.test.ts
Introduces ImageBuffer, RGBA buffer creation, coordinate and channel validation, pixel access, dimension-checked copying, and utility tests.
Conductor module and frame protocol
src/bundles/pix_n_flix/src/protocol.ts, src/bundles/pix_n_flix/src/index.ts
Defines control and frame channels, implements the module plugin, manages frame buffers and filters, exposes media controls, and adds synchronous pixel methods.
Tab capture and rendering plugin
src/tabs/Pixnflix/src/index.tsx
Adds the Conductor tab plugin with camera/media input handling, frame capture and rendering, playback controls, RPC handlers, and React UI.
Bundle and tab project configuration
src/bundles/pix_n_flix/package.json, src/bundles/pix_n_flix/tsconfig.json, src/tabs/Pixnflix/package.json, src/tabs/Pixnflix/tsconfig.json
Updates dependencies and TypeScript configuration for the new bundle and tab source layout.

Estimated code review effort: 4 (Complex) | ~60 minutes

Sequence Diagram(s)

sequenceDiagram
  participant PixNFlixTabPlugin
  participant FrameChannel
  participant PixNFlixModulePlugin
  participant FilterClosure
  PixNFlixTabPlugin->>FrameChannel: send captured-frame
  FrameChannel->>PixNFlixModulePlugin: deliver captured frame
  PixNFlixModulePlugin->>FilterClosure: apply filter
  FilterClosure-->>PixNFlixModulePlugin: return filtered buffer
  PixNFlixModulePlugin->>FrameChannel: send filtered-frame
  FrameChannel->>PixNFlixTabPlugin: render filtered frame
Loading

Suggested reviewers: martin-henz, leeyi45

Poem

A rabbit hops through frames of light,
Buffers glow in black and white.
Filters dance, then channels sing,
Cameras loop on every spring.
Conductor guides the pixel flow—
“Hop approved!” the bunnies know.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely identifies the primary change: migrating the pix_n_flix module to Conductor.
Description check ✅ Passed The description explains the migration, motivation, dependencies, intentional omissions, and test status, but it omits the template’s type and checklist sections.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/migrate-pix-n-flix

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

🧹 Nitpick comments (5)
src/bundles/pix_n_flix/src/index.ts (2)

344-347: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Stray blank line inside the guard.

Line 345 is an empty line between the if and its throw; also worth noting __ensureTabLoaded() runs before the argument check, so an invalid pause_at still spawns the tab.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/bundles/pix_n_flix/src/index.ts` around lines 344 - 347, Remove the stray
blank line between the pause_time guard and its throw in the pause_at validation
logic. Do not alter the surrounding validation or __ensureTabLoaded() behavior.

352-374: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick win

Inconsistent validation feedback across the control methods.

pause_at throws on bad input, while set_dimensions (Lines 358-360) and set_fps (Lines 370-372) silently no-op out-of-range values, and set_loop_count (Line 422) accepts any negative number as "infinite". For students, a silent no-op is hard to debug; consider throwing EvaluatorNumberRangeError consistently (or documenting the clamping) across all four.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/bundles/pix_n_flix/src/index.ts` around lines 352 - 374, The control
methods use inconsistent out-of-range handling. Update set_dimensions, set_fps,
and set_loop_count to validate inputs consistently with pause_at by throwing
EvaluatorNumberRangeError for invalid values, while preserving valid-value
behavior and the intentional infinite-loop representation if applicable.
src/tabs/Pixnflix/src/index.tsx (3)

313-327: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Element sizes are set imperatively but hard-coded in JSX.

updateDimensions mutates video/image/canvas .width/.height directly while the JSX (Lines 474-476) renders them with the constant DEFAULT_WIDTH/DEFAULT_HEIGHT. The state already carries the current dimensions — driving the JSX attributes from state.width/state.height keeps the DOM authoritative under React and avoids silently reverting to defaults on any remount.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/tabs/Pixnflix/src/index.tsx` around lines 313 - 327, Update the JSX
rendering of the video, image, and canvas elements to use the current
state.width and state.height values instead of DEFAULT_WIDTH and DEFAULT_HEIGHT.
Keep updateDimensions responsible for updating state so React remains the
authoritative source after remounts.

474-487: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Small a11y gaps in the view.

The hidden <img> (Line 474) has no alt attribute, and the volume range input (Line 486) is only visually labelled by the adjacent "Volume:" text. Add alt="" for the decorative image and associate the slider with a <label htmlFor>/aria-label.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/tabs/Pixnflix/src/index.tsx` around lines 474 - 487, Update the JSX view
around the hidden img and volume slider: add alt="" to the decorative img, and
give the range input an accessible name by associating it with a label via
htmlFor/id or adding an aria-label. Preserve the existing volume behavior and
visibility conditions.

404-417: 🩺 Stability & Availability | 🔵 Trivial | 💤 Low value

Object URLs are never revoked.

Each dropped/selected file creates a blob URL that is retained for the lifetime of the page. Revoke the previous one when replacing src (e.g. in onload/onloadeddata).

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/tabs/Pixnflix/src/index.tsx` around lines 404 - 417, Update
__handleFileDrop to track and revoke the previous object URL whenever a new
video or image file replaces the media source, and revoke each newly created URL
after the corresponding media element has loaded. Preserve the existing playback
and state transitions while ensuring dropped-file blob URLs are not retained for
the page lifetime.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/bundles/pix_n_flix/src/index.ts`:
- Around line 426-437: Update the stop() method and its documentation so
stopping the module also stops the tab-side requestAnimationFrame capture loop,
camera stream, and further frame handling via the existing
__tabRpc/frame-channel mechanism; add the corresponding tab-side stop handling
and ensure __endStreaming() still lets the Run terminate naturally.
- Around line 155-157: Update __handleCapturedFrame and its __frameChannel
subscription so every asynchronous failure, including opaque_make and send, is
caught rather than becoming an unhandled rejection. On failure, emit a
filtered-frame using the unmodified captured source so the tab’s pending-frame
promise resolves and capture processing continues. Preserve normal
filtered-frame behavior when processing succeeds.
- Around line 196-205: Update __unregisterBuffer to release the evaluator opaque
handle using the active evaluator/interface’s supported free or delete operation
before removing it from __buffers. Ensure every per-frame opaque created by
__registerBuffer is released when its destination/result handle reaches the end
of its lifetime.

In `@src/tabs/Pixnflix/src/index.tsx`:
- Around line 234-239: Update __stopCapture to clear the in-flight
__pendingFrame state when stopping capture, and settle its associated
__captureAndSendFrame promise by rejecting or otherwise explicitly abandoning
it. Ensure a subsequent __startCapture allows __tick to schedule frames
normally, while preserving the existing cancellation and timestamp reset
behavior.
- Around line 203-219: Update __releaseCamera to clear the video element’s
srcObject after stopping all MediaStream tracks, so __requestCamera can
reacquire the camera during detach/re-attach and tab-hide cycles. Preserve the
existing track cleanup behavior.
- Around line 272-275: Update the keep-aspect-ratio branch in the canvas
rendering method around ctx.rect and ctx.fill to call ctx.beginPath() before
defining the letterbox rectangle, ensuring each frame fills only the current
rect instead of accumulating prior paths.

---

Nitpick comments:
In `@src/bundles/pix_n_flix/src/index.ts`:
- Around line 344-347: Remove the stray blank line between the pause_time guard
and its throw in the pause_at validation logic. Do not alter the surrounding
validation or __ensureTabLoaded() behavior.
- Around line 352-374: The control methods use inconsistent out-of-range
handling. Update set_dimensions, set_fps, and set_loop_count to validate inputs
consistently with pause_at by throwing EvaluatorNumberRangeError for invalid
values, while preserving valid-value behavior and the intentional infinite-loop
representation if applicable.

In `@src/tabs/Pixnflix/src/index.tsx`:
- Around line 313-327: Update the JSX rendering of the video, image, and canvas
elements to use the current state.width and state.height values instead of
DEFAULT_WIDTH and DEFAULT_HEIGHT. Keep updateDimensions responsible for updating
state so React remains the authoritative source after remounts.
- Around line 474-487: Update the JSX view around the hidden img and volume
slider: add alt="" to the decorative img, and give the range input an accessible
name by associating it with a label via htmlFor/id or adding an aria-label.
Preserve the existing volume behavior and visibility conditions.
- Around line 404-417: Update __handleFileDrop to track and revoke the previous
object URL whenever a new video or image file replaces the media source, and
revoke each newly created URL after the corresponding media element has loaded.
Preserve the existing playback and state transitions while ensuring dropped-file
blob URLs are not retained for the page lifetime.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 24e90763-d4fb-4a7f-8ed7-0d4926f4db4e

📥 Commits

Reviewing files that changed from the base of the PR and between 6ad0dce and 12b0bcc.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (14)
  • src/bundles/pix_n_flix/package.json
  • src/bundles/pix_n_flix/src/__tests__/functions.test.ts
  • src/bundles/pix_n_flix/src/__tests__/index.test.tsx
  • src/bundles/pix_n_flix/src/functions.ts
  • src/bundles/pix_n_flix/src/index.ts
  • src/bundles/pix_n_flix/src/protocol.ts
  • src/bundles/pix_n_flix/src/start.ts
  • src/bundles/pix_n_flix/src/types.ts
  • src/bundles/pix_n_flix/tsconfig.json
  • src/bundles/pix_n_flix/vitest.config.ts
  • src/tabs/Pixnflix/index.tsx
  • src/tabs/Pixnflix/package.json
  • src/tabs/Pixnflix/src/index.tsx
  • src/tabs/Pixnflix/tsconfig.json
💤 Files with no reviewable changes (4)
  • src/bundles/pix_n_flix/vitest.config.ts
  • src/bundles/pix_n_flix/src/start.ts
  • src/tabs/Pixnflix/index.tsx
  • src/bundles/pix_n_flix/src/tests/index.test.tsx

Comment thread src/bundles/pix_n_flix/src/index.ts
Comment thread src/bundles/pix_n_flix/src/index.ts
Comment thread src/bundles/pix_n_flix/src/index.ts
Comment thread src/tabs/Pixnflix/src/index.tsx
Comment thread src/tabs/Pixnflix/src/index.tsx
Comment thread src/tabs/Pixnflix/src/index.tsx
@source-academy source-academy deleted a comment from coderabbitai Bot Jul 28, 2026
@source-academy source-academy deleted a comment from coderabbitai Bot Jul 28, 2026
@source-academy source-academy deleted a comment from coderabbitai Bot Jul 28, 2026
@source-academy source-academy deleted a comment from coderabbitai Bot Jul 28, 2026
- release camera stream reference (srcObject) on stop, not just the tracks
- clear pending captured frame on stop to avoid stale frame reuse
- reset canvas path before drawing the aspect-ratio-preserving rect fill
- add $stopStreaming tab RPC so stop() fully tears down capture and camera
- keep opaque buffer registration inside the try block so a failure during
  registration cannot leave a dangling handle unregistered
- catch and log any failure escaping __handleCapturedFrame instead of
  letting it become an unhandled rejection with no reply ever sent
- settle (not just abandon) an in-flight captured frame's promise when
  capture stops, so the awaiting async call resolves instead of hanging
  and pinning its closed-over buffer in memory
@martin-henz

Copy link
Copy Markdown
Member

Review by Claude (Sonnet):

Review: PR #824 — Migrate pix_n_flix module to Conductor

Scope: 15 files, +1250/−1550. Replaces pix_n_flix's array-of-arrays Pixel API with opaque image handles (get_pixel_value/set_pixel_value), splits the module/tab boundary into a control RPC channel + a dedicated zero-copy frame channel, and moves all DOM/camera/canvas ownership into the tab since the module now runs in a Worker.

Overview

This is a substantial, well-reasoned architectural migration mirroring the already-migrated sound module's patterns (RPC via makeRpc, tab-owned DOM, sync/async closure dual path). The code is heavily commented explaining why (dual-mode compilation, sync fast-path constraints, transfer vs. structured-clone), which is genuinely valuable here given how much engine-internals knowledge this PR encodes — appropriate given the complexity, even though it's far more comment-dense than typical.

Correctness issues

  1. Lost parameter validation on set_dimensions, set_fps, set_loop_count (src/index.ts). Pre-migration, these threw a student-facing error via assertNumberWithinRange for out-of-range/non-integer input:
  • set_dimensions/set_fps now silently no-op on out-of-range values instead of throwing — a student calling set_dimensions(9999, 9999) gets no feedback at all instead of a clear error.
  • set_loop_count has no validation at all now (old code rejected non-integers like 0.5 or "a" with a thrown error). A fractional loop count now silently flows into the tab's __loopCount, where __handleVideoEnded's this.__loopsPlayed > this.__loopCount comparison will behave subtly wrong (e.g. stopping after 1 loop instead of the old "less than 1 → treated as 1" semantics) rather than failing loudly.

@moduleMethod's DataType list only enforces type (is-a-number), not range/integer constraints — those need the same manual assertInRange-style guard already used for pixel coordinates. Worth adding before merge, since silent behavior changes are worse for students than the previous explicit errors.
2. Camera un-mirroring is new, undocumented behavior (src/tabs/Pixnflix/src/index.tsx, __captureAndSendFrame). The capture step now applies ctx.translate(width, 0); ctx.scale(-1, 1) for the camera feed to counter the OS "selfie" mirror convention. The pre-migration tab never did this — it's a genuine visual/pixel-data change for every student using the live camera, not called out in the PR description, and it's exactly the kind of thing the PR's own checklist flags as unverified ("Manual browser verification … not done yet"). Worth confirming this is intentional and testing it explicitly, since it changes what red_of-successor filters see at each (x,y).
3. Unused export: PIX_N_FLIX_TAB_NAME (protocol.ts) doesn't appear to be referenced anywhere — the module uses tabLoader.tabs[0] and the tab uses its own local PIX_N_FLIX_TAB_ID. Minor, but worth removing or wiring up if it was meant to be used for the tab-loader lookup instead of the positional tabs[0].

Risks / things to confirm before merging out of draft

  • Backward compatibility break, called out by the author but worth restating: red_of/green_of/blue_of/alpha_of/set_rgba and the old array-based Pixel type are dropped entirely with no replacement yet. Any existing assessments/missions using the old API will break. This needs coordination with content owners, not just an engineering follow-up.
  • Test coverage gap: the new unit tests (functions.test.ts) only cover the pure buffer helpers. The much larger and more novel surface — PixNFlixModulePlugin (RPC wiring, callFilterClosure's sync/async fast-path selection, frame handling, buffer registry lifecycle) and the entire tab-side plugin (camera lifecycle, capture loop, backpressure) — has zero automated coverage. Given this is where most of the real complexity and risk lives, and manual browser verification is explicitly still pending, this is the biggest outstanding risk on the PR.
  • External dependency: the sync fast path (the main performance win described in the PR) is inert until conductor#54 and py-slang#353 land and the catalog pin is bumped. Fine as a staged rollout, but worth a tracking note/issue so it doesn't get forgotten once this merges.

Nits

  • pause_at throws a plain EvaluatorRuntimeError while functions.ts/copyImageBuffer use EvaluatorNumberRangeError/EvaluatorParameterTypeError with an eslint-disable for the throw-runtime-error rule — worth double-checking this is deliberate (i.e. EvaluatorRuntimeError is the rule-compliant type) rather than an oversight, since it's the one throw site without that comment.
  • __ensureTabLoaded hardcodes tabLoader.tabs[0]; fine for a single-tab module but slightly fragile if that ever changes.

Verdict

Solid architecture and clearly reasons through the hard parts (RPC vs. transferable frames, sync/async closure duality, buffer lifecycle). Before taking it out of draft, I'd prioritize: (1) restoring range/integer validation on set_dimensions/set_fps/set_loop_count, (2) confirming the camera-mirroring change is intentional via manual testing, and (3) at least some integration-level tests or manual verification of the module↔tab frame round-trip before relying on it in production.

…rors

- bump @sourceacademy/conductor catalog pin to ^0.8.2, the version that
  actually contains the sync fast-path fixes (conductor#54/#61)
- restore range/integer validation on set_dimensions, set_fps and
  set_loop_count, matching pre-migration behavior (these previously threw
  a student-facing error on invalid input, the migration silently dropped
  it instead)
- report a filter's runtime error through conductor's error channel, not
  just console.error, so a student sees why their filter reverted to the
  default copy filter instead of getting no feedback at all
- remove unused PIX_N_FLIX_TAB_NAME export

@martin-henz martin-henz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is ready to be merged. Best have a version in "production" for Avengers to play with.

Backward-compatible with the pre-migration Pixel-accessor API's exact
signatures and 0-255 value range, adapted to the opaque-handle design:
get_pixel(image, x, y) replaces direct src[x][y] indexing (not otherwise
restorable - opaque values aren't indexable at the language level in
either engine), returning a pixel reference the other five functions
consume.

A pixel reference packs the image's opaque handle plus (x, y) into a
single number, wrapped as its own OPAQUE value, deliberately never
registered through evaluator.opaque_make/opaque_get (both async-only).
This is what lets all six functions carry genuine .sync twins matching
get_pixel_value/set_pixel_value's own fast path, with no conductor or
py-slang changes needed - each accessor decodes the reference and looks
up the buffer directly against this module's own buffer map, throwing a
clear error if it doesn't resolve to a currently-live image rather than
reading or writing something unintended.

writeChannel now takes its function/parameter name as arguments instead
of hardcoding set_pixel_value's, so set_rgba's own r/g/b/a range errors
report the right function.
…flix

# Conflicts:
#	lib/testplugin/src/index.ts
#	src/bundles/csg/package.json
#	yarn.lock
@Akshay-2007-1

Copy link
Copy Markdown
Contributor Author

Test Snippets to run (Examples)

1. Local File usage with filter

from pix_n_flix import use_local_file, get_pixel, red_of, green_of, blue_of, alpha_of, set_rgba, image_width, image_height, install_filter

def invert(src, dest):
    w = round(image_width())
    h = round(image_height())
    for x in range(w):
        for y in range(h):
            p = get_pixel(src, x, y)
            q = get_pixel(dest, x, y)
            set_rgba(q, 255 - red_of(p), 255 - green_of(p), 255 - blue_of(p), alpha_of(p))

use_local_file()
install_filter(invert)

2. set_dimensions / set_fps / set_volume / keep_aspect_ratio

from pix_n_flix import set_dimensions, set_fps, set_volume, keep_aspect_ratio, install_filter, copy_image

install_filter(copy_image)
set_dimensions(320, 240)
set_fps(20)
set_volume(75)
keep_aspect_ratio(True)

3. pause_at / get_video_time

from pix_n_flix import install_filter, copy_image, pause_at, get_video_time

install_filter(copy_image)
pause_at(5000)
elapsed = get_video_time()
print(elapsed)

4. get_pixel/red_of/green_of/blue_of/alpha_of/set_rgba, ALONG with invert

from pix_n_flix import get_pixel, red_of, green_of, blue_of, alpha_of, set_rgba, image_width, image_height, install_filter

def invert(src, dest):
    w = round(image_width())
    h = round(image_height())
    for x in range(w):
        for y in range(h):
            p = get_pixel(src, x, y)
            q = get_pixel(dest, x, y)
            set_rgba(q, 255 - red_of(p), 255 - green_of(p), 255 - blue_of(p), alpha_of(p))

install_filter(invert)

5. Compose Filter

from pix_n_flix import get_pixel_value, set_pixel_value, image_width, image_height, install_filter, compose_filter

def grayscale(src, dest):
    w = round(image_width())
    h = round(image_height())
    for x in range(w):
        for y in range(h):
            r = get_pixel_value(src, x, y, 0)
            g = get_pixel_value(src, x, y, 1)
            b = get_pixel_value(src, x, y, 2)
            avg = (r + g + b) / 3
            set_pixel_value(dest, x, y, 0, math_floor(avg))
            set_pixel_value(dest, x, y, 1, math_floor(avg))
            set_pixel_value(dest, x, y, 2, math_floor(avg))
            set_pixel_value(dest, x, y, 3, math_floor(get_pixel_value(src, x, y, 3)))

def invert(src, dest):
    w = round(image_width())
    h = round(image_height())
    for x in range(w):
        for y in range(h):
            for p in range(3):
                set_pixel_value(dest, x, y, p, 255 - get_pixel
            set_pixel_value(dest, x, y, 3, math_floor(get_pixel_value(src, x, y, 3)))

install_filter(compose_filter(grayscale, invert))

6. Reset filter

from pix_n_flix import install_filter, reset_filter, copy_image

def my_filter(src, dest):
    copy_image(src, dest)

install_filter(my_filter)
reset_filter()

7. pause_at/get_video_time (since stateful REPL isnt a thing, we use timeout for sync times)

from pix_n_flix import install_filter, copy_image, pause_at, get_video_time

install_filter(copy_image)
pause_at(5000)

def report_time():
    elapsed = get_video_time()
    print(elapsed)

set_timeout(report_time, 5000)

8. stop

from pix_n_flix import install_filter, copy_image, stop

install_filter(copy_image)
stop()

Expect no video buffer for the same!

9. Image URLs

from pix_n_flix import get_pixel_value, set_pixel_value, image_width, image_height, install_filter, compose_filter, use_image_url

def grayscale(src, dest):
    w = round(image_width())
    h = round(image_height())
    for x in range(w):
        for y in range(h):
            r = get_pixel_value(src, x, y, 0)
            g = get_pixel_value(src, x, y, 1)
            b = get_pixel_value(src, x, y, 2)
            avg = (r + g + b) / 3
            set_pixel_value(dest, x, y, 0, math_floor(avg))
            set_pixel_value(dest, x, y, 1, math_floor(avg))
            set_pixel_value(dest, x, y, 2, math_floor(avg))
            set_pixel_value(dest, x, y, 3, math_floor(get_pixel_value(src, x, y, 3)))

use_image_url("https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcT24VCmiHF__F7Uku7XftFlctyMmOUJJXkosTVhKfWEIZwkd_0iQcRZgxk&s=10")
install_filter(grayscale)

10. Video URLs

from pix_n_flix import use_local_file, use_image_url, use_video_url, install_filter, copy_image, image_width, image_height, set_pixel_value, get_pixel_value

def invert(src, dest):
    w = round(image_width())
    h = round(image_height())
    for x in range(w):
        for y in range(h):
            for p in range(3):
                set_pixel_value(dest, x, y, p, 255 - get_pixel_value(src, x, y, p))
            set_pixel_value(dest, x, y, 3, math_floor(get_pixel_value(src, x, y, 3)))

use_video_url("https://samplelib.com/mp4/sample-20s-360p.mp4")
install_filter(invert)

The merge took master's yarn.lock wholesale to resolve conflicts, which
wiped pix_n_flix's own Conductor dependency entries since that content
doesn't exist on master outside this branch. Re-running install restores
them correctly.
Comment thread src/tabs/Pixnflix/src/index.tsx Dismissed
Comment thread src/tabs/Pixnflix/src/index.tsx Dismissed
@martin-henz
martin-henz merged commit 244bad9 into master Jul 31, 2026
12 checks passed
@martin-henz
martin-henz deleted the feat/migrate-pix-n-flix branch July 31, 2026 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants