af2949677a
* Update GitHub repo references from feedback* to feedBack* * rename: slopsmith -> feedBack, byron -> got-feedBack Renames across the entire codebase: - slopsmith/Slopsmith/SLOPSMITH/SlopSmith -> feedBack/FeedBack/FEEDBACK/FeedBack - byron/Byron/Byrongamatos -> got-feedBack/got-feedBack/got-feedBack - /home/byron/ -> /opt/got-feedBack/ - byron@ougsoft.com -> hi@got-feedBack.org - github.com/byrongamatos/ -> github.com/got-feedback/ - com.byron. -> com.got-feedback. - SLOPSMITH_ env vars -> FEEDBACK_ with backward-compat fallback - Protocol/storage strings migrated with read-old/write-new pattern - window.slopsmith JS API -> window.feedBack (canonical) + backward-compat alias Refs: #rename-slopsmith * rename: complete regen against current main + fix backward-compat alias Regenerated the slopsmith->feedBack / byron->got-feedBack rename on top of current main (3 commits had landed since the branch: #572/#554/#574), resolving the four content conflicts in favour of main's newer content (autoplay/auto-exit, accuracy-badge, Virtuoso re-home, feedpak badge). Completion fixes on top of the mechanical rename: - Re-apply rename to post-branch content the original rename never saw: window.slopsmith(.Tour) consumers in lessons.js / notifications.js / onboarding-tour.js, and the matching JS + python tests (autoplay_exit, progression_*, test_feedpak_extension FEEDBACK_* env vars). The test env vars now match server.py (which reads FEEDBACK_SYNC_STARTUP / FEEDBACK_SKIP_STARTUP_TASKS), so the sync-startup test exercises the real path again. - Restore the window.slopsmith backward-compat alias dropped during conflict resolution, and move the bus aliases to AFTER the _feedBackExisting merge block so they reference the fully-assembled object (also fixes the loop_api.test.js API-surface regex, which the original PR latently broke). - Drop the stray empty data/web_library.db (runtime DB lives in CONFIG_DIR) and gitignore it. - Fix stale tone-source test: feed[dB]ack -> fee[dB]ack to match shipped source labels. Verified locally (org CI billing-blocked): JS 819/819 pass; pytest 1669 passed / 1683 collected with 0 import errors; zero residual slopsmith/byron except the two intentional window.slopsmith aliases. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * rename: implement advertised backward-compat + prune dead community plugins Address gaps where PR #537's "Backward compatibility" section was advertised but not implemented, and clean up the community plugin list. Env vars (FEEDBACK_* canonical, legacy SLOPSMITH_* honoured): - New lib/env_compat.py (getenv_compat / env_flag_compat) + tests. server.py (_env_flag + all FEEDBACK_* reads), diagnostics_hardware, gp2midi and tailwind_rebuild now resolve the legacy alias, so existing SLOPSMITH_UI / SLOPSMITH_PLUGINS_DIR / etc. deployments keep working. - Fix the rename collapsing plugins/__init__.py and minigames/routes.py from `FEEDBACK_PLUGINS_DIR or SLOPSMITH_PLUGINS_DIR` into a redundant `FEEDBACK_ or FEEDBACK_` (the fallback was silently lost). Storage (app.js update-channel): - Read feedBack-update-channel, fall back to legacy slopsmith-update-channel, and clear the legacy key on write — so a user's update-channel preference survives the rename instead of resetting to "stable". Community plugin list (README): the rename rewrote third-party repo URLs we don't own. Probed every one; their owners never renamed, so: - Restore the 13 live community plugins to their real slopsmith-* names. - Prune 6 that are 404 to the public (topkoa splitscreen/stems, OmikronApex tuner, Jafz2001 nam-rig-builder, DeathlySin song-preview, Erikcb91 shuffle). - Fix a pre-existing Guitar Theory clone-command typo (nam-tone -> guitar-theory). Verified: env_compat 7/7, JS 819/819, pytest 1690 collected / 0 import errors, rename-sensitive + startup suites green. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: byrongamatos <xasiklas@gmail.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
5.2 KiB
Spec 012 — MIDI-Input Control-Plane Capability Domain
Status: active (control-plane slice) · Issues: #873 (impl), #880 (this spec) · Base: release/v0.3.0
Summary
midi-input is a core-owned provider-coordinator capability domain for MIDI
device discovery, selection, and open/close session lifecycle — the MIDI analog
of audio-input (spec 006). It gives every MIDI consumer in FeedBack (the
input_setup onboarding wizard, the piano/keys and drums plugins, and — as
a follow-up — note-detection's Web-MIDI provider) one device-access boundary:
one permission prompt, one source list, one redaction boundary.
Motivation
Today each MIDI consumer calls navigator.requestMIDIAccess() privately
(piano, drums, plugin-midi, note-detection's midi provider kind), so there is
no shared source list, no single permission prompt, and no common redaction of
device labels. The onboarding input-setup step (#874/#876/#877) needs a single
governed surface to pick and verify a MIDI device per instrument.
Why not reuse audio-input
audio-input's source/source.open contract is audio-frame-centric:
channelSummary/channelCount/channelShape, requiredChannelShape, and
redaction keyed to audio handles/buffers/samples. MIDI carries discrete messages
and has no channel shape. Folding MIDI in would overload the audio contract and
its redaction boundary. A sibling domain keeps both contracts clean and lets
each evolve independently — the same reasoning that made audio-input and
audio-monitoring siblings rather than one domain.
Why core-owned (not plugin-owned)
An input control plane outlives any one feature; audio-input is
core.audio.session-owned, not owned by a feature plugin. If input_setup
owned midi-input, the domain's lifetime would be coupled to the wizard, and
migrating ownership later (every consumer, persistence key, diagnostics schema
references the owner) is costly. The domain is core.midi-input.
Contract
- Owner:
core.midi-input, kindprovider-coordinator, safetysensitive. - Public commands:
inspect,list-sources,discover,select-source,open-source,close-source. - Provider operations:
source.enumerate,source.describe,source.open,source.close. - Events:
provider-registered,provider-unregistered,availability-changed,sources-changed,source-selected,source-opened,source-closed.
Sources & identity
Providers register source summaries with providerId, a stable sourceId, a
derived redaction-safe logicalSourceKey (providerId::sourceId),
kind: "midi", a label, and availability. Persistence and diagnostics use the
logicalSourceKey, never the human device label.
Permission model (Web-MIDI nuance)
requestMIDIAccess() gates the whole input list, so discover is the
permission boundary (not open-source, as it is for audio). inspect /
list-sources / select-source are prompt-free and never request access.
discover records denied / unavailable outcomes; open-source attaches a
shared listener session to an already-discovered source and never re-prompts.
Sessions
One shared open session per source across requesters (refcounted); the provider
receives source.close only after the last requester releases. Live MIDI
message delivery (for the "play a note / hit a pad" calibration check) is exposed
to in-page consumers via the public window.feedBack.midiInput session handle
only — never as raw capability events or in diagnostics.
Persistence & redaction
Selected source persists under feedBack.midiInput.selectedLogicalSourceKey.
Diagnostics (feedBack.midi_input.diagnostics.v1) carry provider ids, source
ids/keys/kinds/availability, the selected key, and open-session keys; device
labels are redacted and no raw MIDI messages are ever included.
Split from midi-control
The reserved midi-control domain is narrowed to control mappings only
(CC/pitchbend/note → action routing) and will consume midi-input for device
access. This spec carves out the device control plane so midi-control can stay
mappings-only (#882).
Consumers (separate issues)
input_setuponboarding wizard — keys/drums device pick + verify (#876/#877).piano/drumsplugins — consumemidi-inputinstead of privaterequestMIDIAccess()(via the sub-flow issues; legacy retired through bridges).- note-detection's Web-MIDI provider migrates onto
midi-input(#881).
Acceptance
- Owner registers; appears in the Capability Inspector with the commands above.
discoveris the only command that triggersrequestMIDIAccess();inspect/list-sources/select-sourcenever prompt.- Selection persists across reload by
logicalSourceKey. - Diagnostics contain no device labels or raw MIDI messages.
- A consumer can
discover→select-source→open-source→ receive live note-on for the calibration check →close-source(session refcount releases).
Out of scope (follow-ups)
midi-controlmapping/routing domain (#882).- note-detection provider migration onto
midi-input(#881). - Retiring per-plugin
requestMIDIAccess()in piano/drums via compatibility bridges (tracked with the sub-flow issues).