zebra-report/Makefile
Russell Ballestrini f4dbc5cc6c
zebra-spaces: formalize self-listener as FSM — pure spec + observer-driven side effects + 12 unit tests
Fox 2026-06-04 directive: every system should be a state machine
with unit + integration + functional test coverage. Implicit-state
defects keep biting (kicked-listener-UI-still-green, two-kick race,
cohost-toggle-kills-phone, audio-wedge-no-recovery). Starting the
formalization with the most-broken-today system: self-listener mode.

Spec (selfListenerSpec):
  off ──ENABLE / TOGGLE──▶ on
  on ──DISABLE / TOGGLE / UNMUTE / DEMOTED / CLEAR──▶ off

Sits next to publishSpec, subscribeSpec, callSpec, remoteTileSpec
in zebra-spaces.html. Composed by wireZebraMachines() into
roomMachines.selfListener.

UNMUTE edge encodes fox's invariant: "unmuting should seamlessly
switch them back to the now of the conversation webrtc mesh" — if
the user clicks unmute while on, they implicitly drop back to off.

Side effects (mic mute, streamMode enrolment, remoteAudio muting)
move out of enableSelfListenerMode/disableSelfListenerMode (deleted)
into runSelfListenerEnable / runSelfListenerDisable, called by an
observer attached to the FSM. Pure spec stays Node-testable; the
runtime drives the actual audio plumbing from observed transitions.

Boolean selfListenerMode flag deleted. window.selfListenerMode is
now a getter against the FSM state — single source of truth, no
drift possible. All callers (toggle-button click, mute-unmute,
peer-joined, role-demote, leave) now dispatch FSM events instead
of calling helpers directly.

Tests in test/self-listener-fsm.test.js:
- starts in off
- TOGGLE / ENABLE / DISABLE transitions
- UNMUTE drops to off (the fox-invariant)
- UNMUTE / CLEAR while off is no-op
- DEMOTED drops to off
- CLEAR drops to off
- unknown event refuses
- observer fires on real transitions with prev/state
- runtime observer skips prev===state edges

Existing test/zebra-fsm.test.js updated to extract+expose
selfListenerSpec alongside the other specs (the wireZebraMachines
extract is the integration test).

Makefile gets test-self-listener target + slot in test-all.

All test suites green:
- self-listener:        12 / 12
- zebra-fsm:            83 / 83
- mod-actions:           6 / 6
- web-protocol:       3348 / 3348
- multi-peer-mesh:       8 / 8
- video-track-removal:  18 / 18
2026-06-04 13:10:29 -04:00

138 lines
5.3 KiB
Makefile

CC = gcc
CFLAGS = -Wall -Wextra -O2 -Iinclude $(shell pkg-config --cflags libpulse)
LDFLAGS = $(shell pkg-config --libs libpulse) -lrt -lpthread
PULSE = src/pulse.c
.PHONY: all clean serve blog test test-all test-web test-zebra-spaces stamp zebrad
# stamp each web page with today's date + its own md5/sha256 (run before deploy)
stamp:
@node web/stamp.js web/chat.html web/zebra-audio.html web/zebra-spaces.html web/how-it-works.html web/host-your-own.html
all: tx rx chat bt carrier zebrad
test: test/unit
@./test/unit
# web modem/protocol tests — pure Node, no browser or second device needed
test-web:
@node test/web-protocol.test.js
# zebra-spaces state-machine tests — pure unit tests for the FSM framework
# + each machine spec (publish / subscribe / call / remote-tile). Extracts
# the live code from web/zebra-spaces.html so the tests track the page.
test-fsm:
@node test/zebra-fsm.test.js
# Receive-side stream lifecycle (watchVideoTrackForRemoval) — fake-clock
# state-machine tests covering 'when is it safe to remove a tile'. Catches
# the regressions where transient mutes (NACK gaps, network blips, mobile
# handoffs, hard-refresh renegotiation churn) would otherwise kill live
# tiles. Extracts the function from the page and the shipped mute window
# so the assertions track what's live.
test-video-removal:
@node test/video-track-removal.test.js
# Mesh state-sync invariant tests — pins the contract fox stated as
# "whatever one device shares all should see, and when unshared none
# should see." Runs the shipped handleRemoteSfuTrack + renderVideoTile +
# removeVideoTile + watchVideoTrackForRemoval against multi-peer
# scenarios with synthetic ontrack/mute/unmute/ended events. Catches
# regressions where one peer's publish/unpublish leaves another peer
# out of sync.
test-mesh:
@node test/multi-peer-mesh.test.js
# Mod-action serializer — pins the kick race fix fox hit 2026-06-04
# ("kicked two phones, only one was kicked"). Extracts runModSerial +
# awaitStateUpdate + resolvePendingStateUpdate from the live page so
# the assertions track the shipped code, then drives synthetic mod
# actions through them with a stubbed roomEpoch counter to prove the
# second action signs against the FRESH epoch.
test-mod-actions:
@node test/mod-action-serializer.test.js
# SelfListenerFSM — pins the state-machine contract for the speaker/
# cohost/host "switch myself to the buffered HTTP listener stream"
# toggle. Extracts createFSM + selfListenerSpec from the live page so
# the spec can't drift from shipped transitions (off↔on with
# TOGGLE/ENABLE/DISABLE/UNMUTE/DEMOTED/CLEAR edges).
test-self-listener:
@node test/self-listener-fsm.test.js
# zebra-spaces JS↔Go protocol parity + vault + ed25519 + (optionally) a live
# server flow. The live-server tier auto-runs when proxy.unturf.com sits
# alongside this checkout AND has a Go toolchain — we build the relay binary
# transparently and point the test at it. Otherwise that tier is skipped and
# only the pure-protocol/crypto tiers run.
test-zebra-spaces:
@bin=""; \
if [ -d ../proxy.unturf.com/cmd/zebra-spaces-signal ]; then \
go=$$(command -v go || echo /home/fox/.local/go/bin/go); \
if [ -x "$$go" ]; then \
echo "Building zebra-spaces-signal for live-server test..."; \
(cd ../proxy.unturf.com && "$$go" build -o /tmp/zspc-signal-test ./cmd/zebra-spaces-signal/) && bin=/tmp/zspc-signal-test; \
fi; \
fi; \
ZEBRA_SPACES_BINARY=$$bin node test/zebra-spaces.test.js; \
rc=$$?; rm -f /tmp/zspc-signal-test; exit $$rc
test-all: test/unit test/integration test/functional test-web test-fsm test-video-removal test-mesh test-mod-actions test-self-listener test-zebra-spaces
@echo "--- unit ---"
@./test/unit
@echo "--- integration ---"
@./test/integration
@echo "--- functional ---"
@./test/functional
@echo "--- web protocol ---"
@node test/web-protocol.test.js
@echo "--- zebra-fsm ---"
@node test/zebra-fsm.test.js
@echo "--- video-track-removal ---"
@node test/video-track-removal.test.js
@echo "--- multi-peer-mesh ---"
@node test/multi-peer-mesh.test.js
@echo "--- mod-action serializer ---"
@node test/mod-action-serializer.test.js
@echo "--- self-listener FSM ---"
@node test/self-listener-fsm.test.js
@echo "--- zebra-spaces ---"
@$(MAKE) -s test-zebra-spaces
test/unit: test/unit.c include/zebra.h include/modem.h test/test.h
$(CC) $(CFLAGS) -o $@ test/unit.c
test/integration: test/integration.c src/pulse.c include/zebra.h include/modem.h test/test.h
$(CC) $(CFLAGS) -o $@ test/integration.c src/pulse.c $(LDFLAGS)
test/functional: test/functional.c src/pulse.c include/zebra.h include/modem.h test/test.h
$(CC) $(CFLAGS) -o $@ test/functional.c src/pulse.c $(LDFLAGS)
tx: src/tx.c $(PULSE)
$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
rx: src/rx.c $(PULSE)
$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
chat: src/chat.c $(PULSE)
$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
bt: src/bt.c $(PULSE)
$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
carrier: src/carrier.c
$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
zebrad: src/zebrad.c include/zebra.h
$(CC) $(CFLAGS) -o $@ src/zebrad.c $(LDFLAGS) -lm
blog:
python3 blog/build.py
serve: blog
cd web && python3 -m http.server 8765
clean:
rm -f tx rx chat bt carrier zebrad test/unit test/integration test/functional
rm -rf web/blog/001-volume-modem web/blog/002-sse-chatroom web/blog/index.html