TuneCell and Modulation History code refactor and cleanup

Author: PLAINSOUND

src/app.jsx

@@ -11,7 +11,7 @@ import {
   deriveCurrentFundamentalForHistory,
   replayModulationHistoryForFrame,
   spellWorkspaceForFrame,
-} from "./notation/notation-frame-runtime.js";
+} from "./tuning/modulation-frame-runtime.js";
 import { parseExactInterval } from "./tuning/interval.js";
 
 import useSynthWiring from "./use-synth-wiring.js";
@@ -622,6 +622,12 @@ const App = () => {
   const [modulationState, setModulationState] = useState(null);
   const [deferredModulationHistory, setDeferredModulationHistory] = useState([]);
   const [presetModulationLibrary, setPresetModulationLibrary] = useState([]);
+  const [presetRuntimeResetRevision, setPresetRuntimeResetRevision] = useState(0);
+
+  const { onImport, importCount, bumpImportCount } = useImport(settings, setSettings, {
+    onReady: () => setReady(true),
+    onUserInteraction: () => setUserHasInteracted(true),
+  });
 
   const {
     activeSource,
@@ -638,6 +644,9 @@ const App = () => {
   } = usePresets(settings, setSettings, {
     synthRef,
     onUserInteraction: () => setUserHasInteracted(true),
+    bumpImportCount,
+    bumpPresetRuntimeReset: () =>
+      setPresetRuntimeResetRevision((revision) => revision + 1),
     currentModulationLibrary: modulationState?.history ?? presetModulationLibrary,
     setPresetModulationLibrary,
     onPresetModulationLibraryLoaded: (library) => {
@@ -648,11 +657,6 @@ const App = () => {
     },
   });
 
-  const { onImport, importCount, bumpImportCount } = useImport(settings, setSettings, {
-    onReady: () => setReady(true),
-    onUserInteraction: () => setUserHasInteracted(true),
-  });
-
   const {
     synth,
     midi,
@@ -896,12 +900,17 @@ const App = () => {
   const tuningImpactKey = useMemo(() => settingsImpactKey(settings, "tuning"), [settings]);
   const structuralImpactKey = useMemo(() => settingsImpactKey(settings, "structural"), [settings]);
   const keysReconstructionImpactKey = useMemo(
-    () => settingsImpactKey(settings, "keysReconstruction", { midiAccess, midiTick }),
-    [settings, midiAccess, midiTick],
+    () =>
+      settingsImpactKey(settings, "keysReconstruction", {
+        midiAccess,
+        midiTick,
+        presetRuntimeResetRevision,
+      }),
+    [settings, midiAccess, midiTick, presetRuntimeResetRevision],
   );
   const musicalSurfaceResetImpactKey = useMemo(
-    () => settingsImpactKey(settings, "musicalSurfaceReset"),
-    [settings],
+    () => settingsImpactKey(settings, "musicalSurfaceReset", { presetRuntimeResetRevision }),
+    [settings, presetRuntimeResetRevision],
   );
   const colorImpactKey = useMemo(() => settingsImpactKey(settings, "colors"), [settings]);
   const inputRuntimeImpactKey = useMemo(() => settingsImpactKey(settings, "inputRuntime"), [settings]);
@@ -963,6 +972,13 @@ const App = () => {
   const deferredModulationHistoryRef = useRef(modulationHistory);
   deferredModulationHistoryRef.current = modulationHistory;
   useEffect(() => {
+    if ((modulationState?.mode ?? "idle") === "idle") {
+      const nextHistory = deferredModulationHistoryRef.current;
+      setDeferredModulationHistory(
+        Array.isArray(nextHistory) ? nextHistory.map((entry) => ({ ...entry })) : [],
+      );
+      return;
+    }
     let timeoutId = null;
     const syncWhenNotesAreClear = () => {
       if (keysRef.current && !keysRef.current.isSoundInteractionIdle?.()) {
@@ -978,7 +994,7 @@ const App = () => {
     return () => {
       if (timeoutId != null) clearTimeout(timeoutId);
     };
-  }, [activeModulationHistoryKey]);
+  }, [activeModulationHistoryKey, modulationState?.mode]);
   const deferredModulationHistoryKey = useMemo(
     () => modulationHistoryKey(deferredModulationHistory),
     [deferredModulationHistory],

src/app.test.js

@@ -17,6 +17,7 @@ import { act } from "preact/test-utils";
 import { parseExactInterval } from "./tuning/interval.js";
 
 let lastKeyboardProps = null;
+let lastUsePresetsOptions = null;
 let mockDetectedController = null;
 let mockControllerById = null;
 
@@ -115,19 +116,22 @@ vi.mock("./use-query", () => ({
   ExtractJoinedString: {},
 }));
 vi.mock("./use-presets.js", () => ({
-  default: () => ({
-    activeSource: "",
-    activePresetName: "",
-    isPresetDirty: false,
-    persistOnReload: false,
-    setPersistOnReload: vi.fn(),
-    presetChanged: vi.fn(),
-    onLoadCustomPreset: vi.fn(),
-    onClearUserPresets: vi.fn(),
-    onRevertBuiltin: vi.fn(),
-    onRevertUser: vi.fn(),
-    onUserScaleEdit: vi.fn(),
-  }),
+  default: (_settings, _setSettings, options) => {
+    lastUsePresetsOptions = options;
+    return {
+      activeSource: "",
+      activePresetName: "",
+      isPresetDirty: false,
+      persistOnReload: false,
+      setPersistOnReload: vi.fn(),
+      presetChanged: vi.fn(),
+      onLoadCustomPreset: vi.fn(),
+      onClearUserPresets: vi.fn(),
+      onRevertBuiltin: vi.fn(),
+      onRevertUser: vi.fn(),
+      onUserScaleEdit: vi.fn(),
+    };
+  },
   SCALE_KEYS_TO_CLEAR: [],
 }));
 vi.mock("./use-import.js", () => ({
@@ -203,12 +207,39 @@ describe("Loading", () => {
 
 beforeEach(() => {
   lastKeyboardProps = null;
+  lastUsePresetsOptions = null;
   mockDetectedController = null;
   mockControllerById = null;
   synthWiringState.linnstrumentRawPorts = null;
   vi.clearAllMocks();
 });
 
+describe("preset runtime reset wiring", () => {
+  it("changes the keyboard reconstruction key only when the sidebar preset refresh path requests it", async () => {
+    window.matchMedia = vi.fn().mockReturnValue({
+      matches: false,
+      addEventListener: vi.fn(),
+      removeEventListener: vi.fn(),
+    });
+    render(<App />);
+
+    await waitFor(() => {
+      expect(lastKeyboardProps).not.toBeNull();
+      expect(lastUsePresetsOptions?.bumpPresetRuntimeReset).toBeTypeOf("function");
+    });
+
+    const initialReconstructionKey = lastKeyboardProps.reconstructionKey;
+
+    await act(async () => {
+      lastUsePresetsOptions.bumpPresetRuntimeReset();
+    });
+
+    await waitFor(() => {
+      expect(lastKeyboardProps.reconstructionKey).not.toBe(initialReconstructionKey);
+    });
+  });
+});
+
 describe("modulationRouteLabelPair", () => {
   it("renders an equave offset for an octave-displaced target ratio", () => {
     const pair = modulationRouteLabelPair(

src/input/keys-expression-runtime.js

@@ -526,7 +526,10 @@ export function reapplyCurrentInputBends() {
 
 export function refreshSoundingHexNeighbors() {
   const refresh = (hex) => {
-    const [, , , , , centsPrev, centsNext] = this.hexCoordsToCents(hex.coords);
+    const pitchAtCoords = typeof this.hexCoordsToLiveCents === "function"
+      ? this.hexCoordsToLiveCents(hex.coords)
+      : this.hexCoordsToCents(hex.coords);
+    const [, , , , , centsPrev, centsNext] = pitchAtCoords;
     hex.cents_prev = centsPrev;
     hex.cents_next = centsNext;
   };

src/keyboard/keys-frame-runtime.js

@@ -3,6 +3,8 @@
 // that describe the current harmonic transposition and any fixed-do geometry
 // shift. It does not interpret controller input or render anything directly.
 
+import { deriveGeometryShiftForHistory } from "../tuning/modulation-geometry-runtime.js";
+
 export function createKeysFrame(options = {}) {
   return {
     id: options.id ?? "",
@@ -69,25 +71,7 @@ export function deriveFrameForHistory(options = {}) {
       return sum + count * (targetDegree - sourceDegree);
     }, 0)
     : 0;
-  const geometryShift = fixedDoEnabled
-    ? activeRoutes.reduce((sum, route) => {
-      const count = Number.isFinite(route?.count) ? Math.trunc(route.count) : 0;
-      const deltaRSteps = Number.isFinite(route?.deltaRSteps)
-        ? Math.trunc(route.deltaRSteps)
-        : Number.isFinite(route?.surfaceDeltaX)
-          ? Math.trunc(route.surfaceDeltaX)
-          : 0;
-      const deltaDrSteps = Number.isFinite(route?.deltaDrSteps)
-        ? Math.trunc(route.deltaDrSteps)
-        : Number.isFinite(route?.surfaceDeltaY)
-          ? Math.trunc(route.surfaceDeltaY)
-          : 0;
-      return {
-        geometryShiftRSteps: sum.geometryShiftRSteps + count * deltaRSteps,
-        geometryShiftDrSteps: sum.geometryShiftDrSteps + count * deltaDrSteps,
-      };
-    }, { geometryShiftRSteps: 0, geometryShiftDrSteps: 0 })
-    : { geometryShiftRSteps: 0, geometryShiftDrSteps: 0 };
+  const geometryShift = deriveGeometryShiftForHistory(activeRoutes, fixedDoEnabled);
   const effectiveFundamental = fundamental * Math.pow(2, transpositionCents / 1200);
   const route = activeRoutes[activeRoutes.length - 1] ?? null;
 
@@ -97,8 +81,8 @@ export function deriveFrameForHistory(options = {}) {
     targetDegree: route?.targetDegree ?? null,
     transpositionSteps,
     transpositionCents,
-    geometryShiftRSteps: geometryShift.geometryShiftRSteps,
-    geometryShiftDrSteps: geometryShift.geometryShiftDrSteps,
+    geometryShiftRSteps: geometryShift.deltaRSteps,
+    geometryShiftDrSteps: geometryShift.deltaDrSteps,
     effectiveFundamental,
   });
 }