- Worker skill: solidjs-worker (SKILL.md) - Services manifest (services.yaml) - Init script (init.sh) - Library: architecture.md, environment.md, user-testing.md, solidjs-patterns.md Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
3.5 KiB
3.5 KiB
SolidJS Patterns
Patterns and conventions for the SolidJS migration.
What belongs here: SolidJS-specific patterns, reactivity gotchas, store design patterns. What does NOT belong here: General architecture (use architecture.md), environment details (use environment.md).
Store vs Signal Decision
| Data Type | Use | Why |
|---|---|---|
| Float32Array outputs | createSignal |
Store proxies break typed arrays |
| Structured config | createStore |
Fine-grained reactivity on nested properties |
| Opaque handles (IML, engines) | Module-scope variables | Not reactive — referenced imperatively |
| Event streams | Signal bus topic | equals: false for event semantics |
Reactive Inference Pattern
// Inference runs when inputs change, NOT on rAF
createEffect(() => {
const x = inputState.joyX;
const y = inputState.joyY;
const iml = getActiveIml();
if (!iml) return;
iml.setInput(0, x);
iml.setInput(1, y);
iml.process();
setOutputs(new Float32Array(iml.getOutputs()));
});
Canvas Component Pattern
const MyCanvas = () => {
let canvasRef: HTMLCanvasElement;
const data = bus.topic<Float32Array>('output.visual');
onMount(() => {
const ctx = canvasRef.getContext('2d')!;
let raf: number;
const loop = () => {
const d = data();
if (d) renderFrame(ctx, d);
raf = requestAnimationFrame(loop);
};
raf = requestAnimationFrame(loop);
onCleanup(() => cancelAnimationFrame(raf));
});
return <canvas ref={canvasRef!} />;
};
Provider Pattern
const MLContext = createContext<MLStore>();
export const MLProvider = (props: { children: any }) => {
const [outputs, setOutputs] = createSignal(new Float32Array(126));
const [mlState, setMlState] = createStore({ /* ... */ });
const store = { outputs, setOutputs, mlState, setMlState };
return <MLContext.Provider value={store}>{props.children}</MLContext.Provider>;
};
export const useML = () => useContext(MLContext)!;
Debug Probe (Synchronous)
// Must bypass SolidJS batching for sync probe
if (urlParams.debug) {
window.__nisps = {
setInputs: (x, y) => {
batch(() => {
setInputState({ joyX: x, joyY: y });
});
// Imperative: run inference directly
iml.setInput(0, x);
iml.setInput(1, y);
iml.process();
setOutputs(new Float32Array(iml.getOutputs()));
},
getOutputs: () => Array.from(outputs()),
// ... etc
};
}
CSS Pattern
/* Per-component CSS files, no framework */
.component-name {
/* Use CSS custom properties from root */
background: var(--glass-bg);
backdrop-filter: blur(var(--glass-blur));
border: 1px solid var(--glass-border);
}
Worker Cleanup
// Always clean up workers
onCleanup(() => {
trainingWorker?.terminate();
arpeggiatorWorker?.terminate();
imlJoy?.destroy();
imlHand?.destroy();
});
Key Gotchas
- Store proxies and typed arrays: NEVER put Float32Array in a store. Use createSignal.
- equals: false: Required for bus topics. Every emit triggers subscribers even with same data.
- CSS animations: Use classList toggling on stable DOM nodes. Don't use
<Show>for animated elements. - EOC resize cascade: Cannot be a reactive effect (needs confirmation dialog). Use pending action pattern.
- Probe synchrony: All probe methods must be synchronous. Use batch() + imperative IML calls.
- Idle inference waste: Don't run inference on rAF. Use reactive createEffect on inputs.