refactor(timeline): move the unstarted-events switch into settings

It shipped as a pill in the board's own header, beside the stacking and scale controls. That is the wrong company: those two reshape what is already on the board, which is why they are reached for while reading it, and this one decides what is on it at all — the same question "Show events I've finished" and "Show events I'm ignoring" answer, from the panel where both of those live. It is the only one of the three scoped to a single view, so the row says so instead of reading as a promise about the whole app. The board loses the count the pill carried; with nothing left running it still says how many are waiting and names the setting, and the page header has said "N live · N upcoming" all along. Controls had no tests at all, so the three view filters get some: what each checkbox is bound to is invisible in a diff and obvious only to the reader it happens to. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
2026-08-19 05:46:38 +02:00
parent 440144fdc1
commit a66803384a
5 changed files with 151 additions and 81 deletions
@@ -0,0 +1,101 @@
+import { describe, expect, test } from "bun:test";
+import { renderToStaticMarkup } from "react-dom/server";
+import { Controls } from "../src/client/components/Controls.tsx";
+import { GameMetaProvider } from "../src/client/state/gameMeta.tsx";
+import { metaFor } from "../src/shared/games.ts";
+import type { Prefs } from "../src/client/state/usePrefs.ts";
+
+/**
+ * The settings panel's view filters.
+ *
+ * Three rows answer the same question — *what am I allowed to look at?* — and
+ * they are the only place two of them can be reached from, so what they are
+ * bound to is worth pinning. A checkbox wired to the wrong preference is
+ * invisible in a diff and obvious only to the reader it happens to.
+ */
+
+const PREFS: Prefs = {
+  region: "europe",
+  hiddenGames: [],
+  focusGame: null,
+  sort: "ending",
+  view: "soon",
+  timelineDayWidth: 32,
+  timelineGroup: "game",
+  timelineUpcoming: false,
+  detectDaily: false,
+  showCompleted: true,
+  showIgnored: false,
+  theme: "dark",
+  regionConfirmed: true,
+  onboarded: true,
+};
+
+function render(prefs: Prefs, ignoredCount = 0): string {
+  return renderToStaticMarkup(
+    <GameMetaProvider value={(id) => metaFor(id, {})}>
+      <Controls
+        games={["genshin", "hsr"]}
+        prefs={prefs}
+        onToggleGame={() => {}}
+        onUpdate={() => {}}
+        ignoredCount={ignoredCount}
+        onExport={() => {}}
+        onImport={() => {}}
+        own={{
+          games: {},
+          events: {},
+          lanes: ["genshin", "hsr"],
+          onAddGame: () => {},
+          onEditGame: () => {},
+          onRemoveGame: () => ({ removed: true, blockedBy: 0 }),
+          onAddEvent: () => {},
+        }}
+      />
+    </GameMetaProvider>,
+  );
+}
+
+/** The nth checkbox's `checked` attribute, in document order. */
+function checkboxes(html: string): boolean[] {
+  return [...html.matchAll(/<input type="checkbox"[^>]*>/g)].map((m) =>
+    m[0].includes('checked=""'),
+  );
+}
+
+describe("Controls: what am I allowed to look at", () => {
+  test("the unstarted-events switch is here, in the reader's words", () => {
+    // It used to be a pill in the board's own header, next to the stacking and
+    // scale controls. Those two reshape what is already on the board; this one
+    // decides what is on it at all, which is the question the two rows beside
+    // it answer.
+    const html = render(PREFS);
+    expect(html).toContain("Show events that haven&#x27;t started");
+    expect(html).toContain("Show events I&#x27;ve finished");
+  });
+
+  test("it says the board is what it applies to", () => {
+    // Sitting between two app-wide filters, a row that named no scope would
+    // read as a promise about the whole app — and the checklist lists these
+    // whatever this says.
+    const html = render(PREFS);
+    expect(html).toContain("On the timeline");
+    expect(html).toContain("Not started yet");
+  });
+
+  test("it reads its own preference and not a neighbour's", () => {
+    // Both neighbours are on and this one is off, so a checkbox bound to the
+    // wrong key shows up as the wrong count of ticks.
+    const off = checkboxes(render(PREFS));
+    const on = checkboxes(render({ ...PREFS, timelineUpcoming: true }));
+    expect(off.filter(Boolean)).toHaveLength(1);
+    expect(on.filter(Boolean)).toHaveLength(2);
+  });
+
+  test("the ignored row appears only once something is ignored", () => {
+    // Nothing to restore means nothing to offer — the row would be a filter
+    // over an empty set.
+    expect(render(PREFS)).not.toContain("I&#x27;m ignoring");
+    expect(render(PREFS, 3)).toContain("Show the 3 events I&#x27;m");
+  });
+});
@@ -261,7 +261,6 @@ describe("Timeline stacking", () => {
        group={group}
        onGroup={() => {}}
        showUpcoming={false}
-        onShowUpcoming={() => {}}
        onOpen={() => {}}
        isDone={() => false}
      />,
@@ -316,22 +315,19 @@ describe("Timeline: events that have not started", () => {
        group="ending"
        onGroup={() => {}}
        showUpcoming={showUpcoming}
-        onShowUpcoming={() => {}}
        onOpen={() => {}}
        isDone={() => false}
      />,
    );

-  test("the board holds them back by default and says how many", () => {
+  test("the board holds them back by default", () => {
    // Off is the default because the board answers "how does the time I am in
-    // lay out?" — but an absence nobody mentioned is indistinguishable from a
-    // quiet fortnight, which is the wrong thing for this app to imply.
+    // lay out?", and it draws its span from what it plots — so a next patch on
+    // every lane pushes the running bars the reader came for off to the left.
    const html = board(false);
    expect(html).toContain("Closing Ceremony");
    expect(html).not.toContain("Frost Parade");
    expect(html).not.toContain("Long Way Round");
-    expect(html).toContain("Not started");
-    expect(html).toContain(">3<");
  });

  test("switching it on plots them", () => {
@@ -340,26 +336,20 @@ describe("Timeline: events that have not started", () => {
    expect(html).toContain("Long Way Round");
  });

-  test("the control says which way it is set", () => {
-    expect(board(false)).toContain('aria-pressed="false"');
-    expect(board(true)).toContain('aria-pressed="true"');
-  });
-
-  test("nothing waiting and switched off means no control at all", () => {
-    // A toggle that cannot change anything invites a tap that does nothing.
-    expect(board(false, [row("Closing Ceremony", "genshin", 100)])).not.toContain(
-      "Not started",
-    );
-  });
-
  test("a board with only future events says so rather than reading empty", () => {
    // Otherwise the reader is looking at "nothing to plot" while three events
-    // are scheduled, and the reason is a control they did not notice.
+    // are scheduled, and an absence nobody mentioned is indistinguishable from
+    // a quiet fortnight. It names the setting, since the switch is not on the
+    // board any more.
    const html = board(false, rows.slice(1));
    expect(html).toContain("Nothing is running right now");
    expect(html).toContain("3 events have not started yet");
-    // The control is still there to act on what the sentence just told them.
-    expect(html).toContain("Not started");
+    expect(html).toContain("Show events that haven&#x27;t started");
+  });
+
+  test("one waiting event is counted in words, not as \"1 events\"", () => {
+    const html = board(false, [rows[1]!]);
+    expect(html).toContain("One event has not started yet");
  });

  test("each clump of starts is marked in words", () => {